generate import handling

Author: maxbachmann

.clang-format

@@ -26,3 +26,4 @@ BraceWrapping:
 AllowAllConstructorInitializersOnNextLine: true
 ConstructorInitializerAllOnOneLineOrOnePerLine: true
 AllowShortCaseLabelsOnASingleLine: true
+SortIncludes: false

.github/workflows/branchbuild.yml

@@ -27,8 +27,8 @@ jobs:
 
       - name: Generate cython
         run: |
-          chmod +x ./src/rapidfuzz/generate.sh
-          ./src/rapidfuzz/generate.sh
+          chmod +x ./tools/generate_cython.sh
+          ./tools/generate_cython.sh
 
       - name: build
         run: |
@@ -171,15 +171,23 @@ jobs:
         run: |
           sudo apt update && sudo apt install systemd-coredump
           tools/seg_wrapper.sh pytest tests
+
       - name: Test with pytest
         if: runner.os != 'Linux'
         run: |
           pytest tests
-
       - name: test pyinstaller packaging
         run: |
           python -m PyInstaller.utils.run_tests --include_only rapidfuzz.
 
+      - name: test cx_freeze packaging
+        if: matrix.python-version != '3.13'
+        working-directory: tests/freezeTools
+        run: |
+          pip install cx_freeze
+          cxfreeze --script script.py --target-dir cxfreezeDist
+          ./cxfreezeDist/script
+
   # validate sse2 code on gcc
   sde_tests:
     name: "Test sse2 code on Linux (gcc)"
@@ -205,7 +213,7 @@ jobs:
       - name: Install testing dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install pytest hypothesis pandas mypy pyinstaller[hook_testing]
+          pip install pytest hypothesis pandas mypy
 
       - name: Test on nehalem which does not support avx2
-        run: ./sde/sde -nhm -- pytest tests
+        run: ./sde/sde -nhm -- pytest tests

.github/workflows/coverage.yml

@@ -24,8 +24,8 @@ jobs:
 
       - name: Generate cython
         run: |
-          chmod +x ./src/rapidfuzz/generate.sh
-          ./src/rapidfuzz/generate.sh
+          chmod +x ./tools/generate_cython.sh
+          ./tools/generate_cython.sh
 
       # for cython tests inplace installation is required
       - name: build

.github/workflows/releasebuild.yml

@@ -27,8 +27,8 @@ jobs:
       # The cythonized files allow installation from the sdist without cython
       - name: Generate cython
         run: |
-          chmod +x ./src/rapidfuzz/generate.sh
-          ./src/rapidfuzz/generate.sh
+          chmod +x ./tools/generate_cython.sh
+          ./tools/generate_cython.sh
 
       - name: Build sdist
         run: |

.pre-commit-config.yaml

@@ -12,6 +12,11 @@
 #
 # See https://github.com/pre-commit/pre-commit
 
+exclude: |
+    (?x)(
+        tools/sdist.patch
+    )
+
 repos:
 # Standard hooks
 - repo: https://github.com/pre-commit/pre-commit-hooks

CHANGELOG.rst

@@ -1,6 +1,13 @@
 Changelog
 ---------
 
+[3.12.0] - 2025-01-16
+^^^^^^^^^^^^^^^^^^^^^
+Changed
+~~~~~~~~~~~
+- generate code for fallback imports to be better parseable for tools bundling Python
+  applications into a single binary (examples are cx-freeze and pyinstaller)
+
 [3.11.0] - 2024-12-17
 ^^^^^^^^^^^^^^^^^^^^^
 Performance
@@ -27,7 +34,7 @@ Added
 Fixed
 ~~~~~
 - drop support for Python 3.8
-- switch build system to `scikit-build-core`
+- switch build system to ``scikit-build-core``
 
 [3.9.7] - 2024-09-02
 ^^^^^^^^^^^^^^^^^^^^
@@ -47,7 +54,7 @@ Changed
 Fixed
 ~~~~~
 * include simd binaries in pyinstaller builds
-* fix builds with setuptools 72 by upgrading `scikit-build`
+* fix builds with setuptools 72 by upgrading ``scikit-build``
 
 [3.9.4] - 2024-07-02
 ^^^^^^^^^^^^^^^^^^^^

CMakeLists.txt

@@ -30,8 +30,8 @@ endif()
 if(MSVC)
   add_compile_options(/W4 /bigobj /wd4127)
 
-  # NOTE: _DISABLE_CONSTEXPR_MUTEX_CONSTRUCTOR is temporary. When building on
-  # VS 2022 17.10 or newer, but using an older runtime, mutexes can crash
+  # NOTE: _DISABLE_CONSTEXPR_MUTEX_CONSTRUCTOR is temporary. When building on VS
+  # 2022 17.10 or newer, but using an older runtime, mutexes can crash
   add_compile_options(/D_DISABLE_CONSTEXPR_MUTEX_CONSTRUCTOR)
 else()
   add_compile_options(-Wall -Wextra -pedantic -Wno-psabi)

pyproject.toml

@@ -54,8 +54,7 @@ wheel.exclude = [
   "**.cpp",
   "**.hpp",
   "**.h",
-  "CMakeLists.txt",
-  "generate.sh"
+  "CMakeLists.txt"
 ]
 wheel.packages = ["src/rapidfuzz"]
 wheel.cmake = false
@@ -162,7 +161,6 @@ select = [
 extend-ignore = [
   "PLR",    # Design related pylint codes
   "E501",   # Line too long
-  "PT004",  # Use underscore for non-returning fixture (use usefixture instead)
   "PTH123", # use pathlib instead of builtin open
 ]
 unfixable = [
@@ -171,6 +169,7 @@ unfixable = [
 ]
 flake8-unused-arguments.ignore-variadic-names = true
 isort.required-imports = ["from __future__ import annotations"]
+isort.combine-as-imports = true
 
 [tool.ruff.lint.per-file-ignores]
 "tests/**" = ["T20"]

src/rapidfuzz/CMakeLists.txt

@@ -10,8 +10,8 @@ function(create_cython_target _name)
       VERBATIM
       COMMAND
         Python::Interpreter -m cython "${CMAKE_CURRENT_LIST_DIR}/${_name}.pyx"
-        --cplus -I "${CMAKE_CURRENT_LIST_DIR}"
-        --output-file "${CMAKE_CURRENT_BINARY_DIR}/${_name}.cxx")
+        --cplus -I "${CMAKE_CURRENT_LIST_DIR}" --output-file
+        "${CMAKE_CURRENT_BINARY_DIR}/${_name}.cxx")
 
     set(${_name}
         ${CMAKE_CURRENT_BINARY_DIR}/${_name}.cxx

src/rapidfuzz/__init__.pyi

@@ -4,7 +4,9 @@ __author__: str
 __license__: str
 __version__: str
 
-from rapidfuzz import distance as distance
-from rapidfuzz import fuzz as fuzz
-from rapidfuzz import process as process
-from rapidfuzz import utils as utils
+from rapidfuzz import (
+    distance as distance,
+    fuzz as fuzz,
+    process as process,
+    utils as utils,
+)