Open all files with utf-8 encoding

- will not be used for binary read/writes (rb,wb)!
- prevents a bug where units with special characters in the unit name can not be tracked anymore as there will be a name mismatch due to wrong encoding

changelog.md

@@ -23,6 +23,7 @@ Saves from 4.x are not compatible with 5.0.
 ## Fixes
 
 * **[Campaign]** Naval control points will no longer claim ground objectives during campaign generation and prevent them from spawning.
+* **[Mission Generation]** Mission results and other files will now be opened with enforced utf-8 encoding to prevent an issue where destroyed ground units were untracked because of special characters in their names.
 * **[UI]** Selling of Units is now visible again in the UI dialog and shows the correct amount of sold units
 
 # 4.1.1

game/dcs/aircrafttype.py

@@ -325,7 +325,7 @@ class AircraftType(UnitType[Type[FlyingType]]):
             logging.warning(f"No data for {aircraft.id}; it will not be available")
             return
 
-        with data_path.open() as data_file:
+        with data_path.open(encoding="utf-8") as data_file:
             data = yaml.safe_load(data_file)
 
         try:

game/dcs/groundunittype.py

@@ -67,7 +67,7 @@ class GroundUnitType(UnitType[Type[VehicleType]]):
             logging.warning(f"No data for {vehicle.id}; it will not be available")
             return
 
-        with data_path.open() as data_file:
+        with data_path.open(encoding="utf-8") as data_file:
             data = yaml.safe_load(data_file)
 
         try:

game/debriefing.py

@@ -386,7 +386,7 @@ class PollDebriefingFileThread(threading.Thread):
                     os.path.isfile("state.json")
                     and os.path.getmtime("state.json") > last_modified
                 ):
-                    with open("state.json", "r") as json_file:
+                    with open("state.json", "r", encoding="utf-8") as json_file:
                         json_data = json.load(json_file)
                         debriefing = Debriefing(json_data, self.game, self.unit_map)
                         self.callback(debriefing)

game/operation/operation.py

@@ -65,7 +65,7 @@ class Operation:
 
     @classmethod
     def prepare(cls, game: Game) -> None:
-        with open("resources/default_options.lua", "r") as f:
+        with open("resources/default_options.lua", "r", encoding="utf-8") as f:
             options_dict = loads(f.read())["options"]
         cls._set_mission(Mission(game.theater.terrain))
         cls.game = game

game/version.py

@@ -12,7 +12,7 @@ def _build_version_string() -> str:
     ]
     build_number_path = Path("resources/buildnumber")
     if build_number_path.exists():
-        with build_number_path.open("r") as build_number_file:
+        with build_number_path.open("r", encoding="utf-8") as build_number_file:
             components.append(build_number_file.readline())
 
     if not Path("resources/final").exists():

qt_ui/main.py

@@ -64,7 +64,8 @@ def run_ui(game: Optional[Game]) -> None:
     # init the theme and load the stylesheet based on the theme index
     liberation_theme.init()
     with open(
-        "./resources/stylesheets/" + liberation_theme.get_theme_css_file()
+        "./resources/stylesheets/" + liberation_theme.get_theme_css_file(),
+        encoding="utf-8",
     ) as stylesheet:
         logging.info("Loading stylesheet: %s", liberation_theme.get_theme_css_file())
         app.setStyleSheet(stylesheet.read())

qt_ui/windows/QWaitingForMissionResultWindow.py

@@ -228,7 +228,7 @@ class QWaitingForMissionResultWindow(QDialog):
         )
         print(file)
         try:
-            with open(file[0], "r") as json_file:
+            with open(file[0], "r", encoding="utf-8") as json_file:
                 json_data = json.load(json_file)
                 json_data["mission_ended"] = True
                 debriefing = Debriefing(json_data, self.game, self.unit_map)

qt_ui/windows/newgame/QCampaignList.py

@@ -43,7 +43,7 @@ class Campaign:
 
     @classmethod
     def from_file(cls, path: Path) -> Campaign:
-        with path.open() as campaign_file:
+        with path.open(encoding="utf-8") as campaign_file:
             if path.suffix == ".yaml":
                 data = yaml.safe_load(campaign_file)
             else: