Speedup x 1.85: Generate __version__ at build to avoid slow importlib.metadata import (#200)

Author: hugovk

.github/workflows/lint.yml

@@ -4,6 +4,7 @@ on: [push, pull_request, workflow_dispatch]
 
 env:
   FORCE_COLOR: 1
+  PIP_DISABLE_PIP_VERSION_CHECK: 1
 
 permissions:
   contents: read
@@ -17,4 +18,12 @@ jobs:
       - uses: actions/setup-python@v5
         with:
           python-version: "3.x"
+          cache: pip
       - uses: pre-commit/action@v3.0.1
+
+      - name: Install dependencies
+        run: |
+          python3 -m pip install -U tox
+
+      - name: Mypy
+        run: tox -e mypy

.gitignore

@@ -158,3 +158,6 @@ cython_debug/
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
+
+# hatch-vcs
+src/*/_version.py

.pre-commit-config.yaml

@@ -36,14 +36,6 @@ repos:
     hooks:
       - id: actionlint
 
-  - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.11.2
-    hooks:
-      - id: mypy
-        additional_dependencies: [pytest, types-freezegun, types-setuptools]
-        args: [--strict, --pretty, --show-error-codes, .]
-        pass_filenames: false
-
   - repo: https://github.com/tox-dev/pyproject-fmt
     rev: 2.2.3
     hooks:

pyproject.toml

@@ -53,6 +53,9 @@ version.source = "vcs"
 [tool.hatch.build]
 artifacts = [ "*.mo" ]
 
+[tool.hatch.build.hooks.vcs]
+version-file = "src/humanize/_version.py"
+
 [tool.hatch.version.raw-options]
 local_scheme = "no-local-version"
 
@@ -105,3 +108,8 @@ filterwarnings = [
   "ignore:sys.monitoring isn't available, using default core:coverage.exceptions.CoverageWarning",
 ]
 testpaths = [ "tests" ]
+
+[tool.mypy]
+pretty = true
+strict = true
+show_error_codes = true

src/humanize/__init__.py

@@ -2,8 +2,6 @@
 
 from __future__ import annotations
 
-import importlib.metadata
-
 from humanize.filesize import naturalsize
 from humanize.i18n import activate, deactivate, decimal_separator, thousands_separator
 from humanize.number import (
@@ -24,8 +22,7 @@
     precisedelta,
 )
 
-__version__ = importlib.metadata.version(__name__)
-
+from ._version import __version__
 
 __all__ = [
     "__version__",

tox.ini

@@ -4,6 +4,7 @@ requires =
 env_list =
     docs
     lint
+    mypy
     py{py3, 313, 312, 311, 310, 39, 38}
 
 [testenv]
@@ -37,5 +38,14 @@ pass_env =
 commands =
     pre-commit run --all-files --show-diff-on-failure
 
+[testenv:mypy]
+deps =
+    mypy==1.11.2
+    pytest
+    types-freezegun
+    types-setuptools
+commands =
+    mypy --strict --pretty --show-error-codes . {posargs}
+
 [pytest]
 addopts = --color=yes --doctest-modules