Build single executable

According to PyInstaller documentation freeze_support needs to be
called before multiprocessing can be used. Black does similar thing.
https://pyinstaller.org/en/stable/common-issues-and-pitfalls.html#multi-processing

Additionally fix setup.py about extras_require

Author: ahoarau

.github/workflows/test.yml

@@ -10,10 +10,12 @@ jobs:
       fail-fast: false
       matrix:
         python-version: ['3.8', '3.9', '3.10', '3.11', '3.13']
+        executable-name: [gersemi]
         os: [ubuntu-latest]
         include:
           - python-version: '3.12'
             os: windows-latest
+            executable-name: gersemi.exe
           - python-version: '3.12'
             os: macos-latest
           - python-version: '3.12'
@@ -35,7 +37,7 @@ jobs:
         run: python -m pip install --upgrade setuptools pip wheel tox
 
       - name: Run tests
-        run: tox -e tests
+        run: tox -e tests && tox -e build-executable -- ${{ matrix.executable-name }}
 
       - name: Run quality tests
         run: tox -e lint && tox -e format && tox -e mypy

.gitignore

@@ -2,5 +2,8 @@
 .mypy_cache
 .tox
 *.egg-info
+*.spec
 __pycache__
-prof/
+build/
+dist/
+prof/

.pylintrc

@@ -12,6 +12,8 @@ disable=
 
     fixme,
 
+    import-outside-toplevel,
+
     invalid-name,
 
     missing-class-docstring,

gersemi/__main__.py

@@ -21,9 +21,9 @@
 from gersemi.runner import run, print_to_stderr
 from gersemi.__version__ import __title__, __version__
 
+FROZEN = getattr(sys, "frozen", False)
 MISSING = "(missing)"
 
-
 try:
     from colorama import __version__ as colorama_version
 
@@ -33,7 +33,8 @@
 
 class ShowVersion(argparse.Action):
     def __call__(self, parser, namespace, values, option_string=None):
-        print(f"{__title__} {__version__}")
+        frozen_suffix = " (frozen)" if FROZEN else ""
+        print(f"{__title__} {__version__}{frozen_suffix}")
         print(f"lark {lark_version}")
         print(f"colorama {colorama_version}")
         print(f"Python {sys.version}")
@@ -335,6 +336,11 @@ def error(text):
 
 
 def main():
+    if FROZEN:
+        from multiprocessing import freeze_support
+
+        freeze_support()
+
     try:
         argparser = create_argparser()
         args = argparser.parse_args()

gersemi/configuration.py

@@ -1,7 +1,6 @@
 from contextlib import contextmanager
 from dataclasses import astuple, dataclass, field, fields
 from functools import lru_cache
-import multiprocessing
 import os
 from pathlib import Path
 import sys
@@ -15,6 +14,8 @@
 
 
 def max_number_of_workers():
+    import multiprocessing
+
     result = multiprocessing.cpu_count()
     if sys.platform == "win32":
         # https://bugs.python.org/issue26903

gersemi/runner.py

@@ -4,7 +4,6 @@
 from functools import partial
 from hashlib import sha1
 from itertools import chain
-import multiprocessing as mp
 from pathlib import Path
 import sys
 from typing import Callable, Dict, List, Iterable, Optional, Tuple, Union
@@ -230,7 +229,9 @@ def imap_unordered(self, func, iterable):
             yield from map(func, iterable)
             return
 
-        with mp.Pool(processes=processes) as pool:
+        import multiprocessing
+
+        with multiprocessing.Pool(processes=processes) as pool:
             yield from pool.imap_unordered(func, iterable, CHUNKSIZE)
 
 

setup.py

@@ -27,7 +27,9 @@
         "lark>=1.0",
         "pyyaml>=5,<7",
     ],
-    extras_requires=["colorama>=0.4"],
+    extras_require={
+        "color": ["colorama>=0.4"],
+    },
     python_requires=">=3.8",
     entry_points={"console_scripts": ["gersemi = gersemi.__main__:main"]},
     license=about["__license__"],

tox.ini

@@ -1,5 +1,5 @@
 [tox]
-envlist = py38, py39, py310, py311, py312, py313, lint, format, mypy
+envlist = py38, py39, py310, py311, py312, py313, lint, format, mypy, build-executable
 skip_missing_interpreters=true
 
 [testenv]
@@ -65,4 +65,30 @@ deps =
     pytest
     pytest-profiling
 commands =
-    pytest --profile-svg {posargs}
+    pytest --profile-svg {posargs}
+
+[testenv:build-executable]
+allowlist_externals =
+    ./dist/*
+deps =
+    pyinstaller
+    colorama
+setenv =
+    FORCE_COLOR = 1
+commands =
+    # Build executable
+    pyinstaller \
+        --onefile \
+        --name "{posargs:gersemi}" \
+        --hidden-import colorama \
+        --add-data "gersemi/cmake.lark{:}gersemi" \
+        "gersemi/__main__.py"
+
+    # and test it
+    ./dist/{posargs:gersemi} --version
+    ./dist/{posargs:gersemi} \
+        --config "{tox_root}/.gersemirc.example" \
+        --no-cache \
+        --check \
+        --diff --color \
+        "{tox_root}/tests/executable/directory_with_formatted_files"