pybricksdev: use explicit text encoding for text files

Ensure that text files are opened with UTF-8 encoding by default to
avoid issues with different default encodings. This also requires
updating some dependencies that also had issues with text encoding.

PYTHONWARNDEFAULTENCODING is set for tests to try to catch any future
issues with text encoding. And PYTHONDEVMODE is set for good measure.

Author: dlech

.github/workflows/test.yml

@@ -38,6 +38,9 @@ jobs:
       - run: poetry install --only=main --only=test
       - run: poetry run pytest
         if: matrix.python-version != '3.10'
+        env:
+          PYTHONDEVMODE: 1
+          PYTHONWARNDEFAULTENCODING: 1
       - run: poetry run coverage run
         if: matrix.python-version == '3.10'
       - run: poetry run coverage xml

CHANGELOG.md

@@ -11,6 +11,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Fixed
 - Fixed calling `PybricksHub.write()` methods.
+- Fixed using default text encoding when opening text files.
 
 ### Changed
 - Downloading programs without starting them can now be done by

poetry.lock

@@ -98,7 +98,7 @@ def add_parser(self, subparsers: argparse._SubParsersAction):
             "file",
             metavar="<file>",
             help="path to a MicroPython script or `-` for stdin",
-            type=argparse.FileType(),
+            type=argparse.FileType(encoding="utf-8"),
         )
         parser.add_argument(
             "--abi",
@@ -135,7 +135,7 @@ def add_parser(self, subparsers: argparse._SubParsersAction):
             "file",
             metavar="<file>",
             help="path to a MicroPython script or `-` for stdin",
-            type=argparse.FileType(),
+            type=argparse.FileType(encoding="utf-8"),
         )
         parser.add_argument(
             "-n",

pybricksdev/cli/__init__.py

@@ -55,7 +55,7 @@ async def compile_file(
     """
 
     # Get version info
-    with open(os.path.join(proj_dir, proj_path), "r") as f:
+    with open(os.path.join(proj_dir, proj_path), "r", encoding="utf-8") as f:
         loop = asyncio.get_running_loop()
         script = f.read()
 
@@ -188,7 +188,7 @@ def save_script(py_string):
     py_path = os.path.join(BUILD_DIR, TMP_PY_SCRIPT)
 
     # Write Python command to a file.
-    with open(py_path, "w") as f:
+    with open(py_path, "w", encoding="utf-8") as f:
         f.write(py_string)
         f.write("\n")
 

pybricksdev/compile.py

@@ -194,7 +194,7 @@ def _line_handler(self, line: bytes) -> None:
                 os.makedirs(dir_path)
 
             logger.info("Saving log to {0}.".format(full_path))
-            self.log_file = open(full_path, "w")
+            self.log_file = open(full_path, "w", encoding="utf-8")
             return
 
         # The line tells us to close a log file, so do it.

pybricksdev/connections/pybricks.py

@@ -28,16 +28,16 @@ include = [
 pybricksdev = 'pybricksdev.cli:main'
 
 [tool.poetry.dependencies]
-argcomplete = ">=1.11.1"
+argcomplete = ">=3.6.2"
 bleak = ">=0.22.0"
-mpy-cross-v5 = ">=1.0.0"
+mpy-cross-v5 = ">=1.1.0"
 python = ">=3.10,<3.14"
 tqdm = ">=4.62.3"
 pyusb = ">=1.0.2"
 semver = ">=2.13.0"
 appdirs = ">=1.4.4"
 prompt-toolkit = ">=3.0.18"
-mpy-cross-v6 = ">=1.0.0"
+mpy-cross-v6 = ">=1.1.0"
 packaging = ">=22"
 typing-extensions = ">=4.3.0"
 reactivex = ">=4.0.4"