👷 [+ci] Update build scripts to produce working binary (#17)

Author: davidbrownell

.github/workflows/CICD_impl.yml

@@ -66,6 +66,9 @@ jobs:
           python-version: ${{ matrix.python_version }}
           enable-cache: true
 
+      - name: Install Dependencies
+        run: uv sync --frozen
+
       - name: Run pre-commit scripts
         run: uv run pre-commit run --verbose
 
@@ -250,6 +253,9 @@ jobs:
           python-version: ${{ inputs.python_package_version }}
           enable-cache: true
 
+      - name: Install Dependencies
+        run: uv sync --frozen
+
       - name: Build Binary
         run: uv run python BuildBinary.py Build --verbose
 
@@ -261,6 +267,8 @@ jobs:
         with:
           name: Binary.${{ matrix.os }}
           path: FileBackup-${{ env.PACKAGE_VERSION }}.*
+
+  # ----------------------------------------------------------------------
   validate_binary:
     needs: [python_package, build_binary]
 

BuildBinary.py

@@ -1,15 +1,21 @@
 import os
 import shutil
+import textwrap
+import uuid
 
 from pathlib import Path
 from typing import Annotated, Optional
 
 import typer
 
+from dbrownell_Common.ContextlibEx import ExitStack
 from dbrownell_Common import SubprocessEx
 from dbrownell_Common.Streams.DoneManager import DoneManager, Flags as DoneManagerFlags
+import inflect
 from typer.core import TyperGroup
 
+import FileBackup
+
 
 # ----------------------------------------------------------------------
 class NaturalOrderGrouper(TyperGroup):
@@ -46,12 +52,49 @@ def Build(
     with DoneManager.CreateCommandLine(
         flags=DoneManagerFlags.Create(verbose=verbose, debug=debug),
     ) as dm:
-        command_line = "cxfreeze --script src/FileBackup/CommandLine/EntryPoint.py --target-name=FileBackup"
-
-        dm.WriteVerbose(f"Command line: {command_line}\n\n")
-
-        with dm.YieldStream() as stream:
-            dm.result = SubprocessEx.Stream(command_line, stream)
+        # inflect uses the typeguard library, which relies on inspect to read the source code of
+        # inflect to enforce that arguments are the correct types when invoking functions. This
+        # works fine when running the application normally, but does not work by default with
+        # cx_Freeze because it does not include the source code of inflect in the built binary. This
+        # means that typeguard can't determine the types of the arguments, which causes it to raise
+        # an exception. The fix is to include the inflect source code in the built binary so that
+        # typeguard can find the function's types and not raise an exception.
+        inflect_filename = Path(inflect.__file__).relative_to(Path(__file__).parent)
+
+        configuration_filename = Path("setup{}.py".format(str(uuid.uuid4()).replace("-", "")))
+
+        configuration_filename.write_text(
+            textwrap.dedent(
+                f"""\
+                from cx_Freeze import setup, Executable
+
+                setup(
+                    name = "FileBackup",
+                    version = "{FileBackup.__version__}",
+                    options = {{
+                        "build_exe": {{
+                        "include_files": [
+                            (r"{inflect_filename}", "lib/inflect/{inflect_filename.name}"),
+                        ],
+                    "packages": []
+                        }},
+                    }},
+                    executables = [
+                        Executable(
+                            "src/FileBackup/CommandLine/EntryPoint.py",
+                            target_name="FileBackup",
+                            base=None,
+                        ),
+                    ],
+                )
+                """,
+            ),
+            encoding="utf-8",
+        )
+
+        with ExitStack(configuration_filename.unlink):
+            with dm.YieldStream() as stream:
+                dm.result = SubprocessEx.Stream(f'python "{configuration_filename}" build_exe', stream)
 
 
 # ----------------------------------------------------------------------

pyproject.toml

@@ -23,7 +23,7 @@ keywords = [
 license = "MIT"
 
 classifiers = [
-    "Development Status :: 4 - Beta",  # TODO
+    "Development Status :: 4 - Beta",
     "Environment :: Console",
     "Intended Audience :: Developers",
     "Intended Audience :: End Users/Desktop",