Generate __version__ at build to avoid slow importlib.metadata import

hugovk · Oct 12, 2024 · a0878c6 · a0878c6
1 parent 52565cb
commit a0878c6
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 2 deletions.
diff --git a/.gitignore b/.gitignore
@@ -399,3 +399,6 @@ $RECYCLE.BIN/
 *.lnk
 
 # End of https://www.gitignore.io/api/git,linux,pydev,python,windows,pycharm+all,jupyternotebook,vim,webstorm,emacs
+
+# hatch-vcs
+cherry_picker/_version.py
diff --git a/cherry_picker/__init__.py b/cherry_picker/__init__.py
@@ -2,6 +2,6 @@
 
 from __future__ import annotations
 
-import importlib.metadata
+from ._version import __version__
 
-__version__ = importlib.metadata.version(__name__)
+__all__ = ["__version__"]
diff --git a/pyproject.toml b/pyproject.toml
@@ -43,6 +43,9 @@ source = "vcs"
 # Change regex to match tags like "cherry-picker-v2.2.0".
 tag-pattern = '^cherry-picker-(?P<version>[vV]?\d+(?:\.\d+){0,2}[^\+]*)(?:\+.*)?$'
 
+[tool.hatch.build.hooks.vcs]
+version-file = "cherry_picker/_version.py"
+
 [tool.hatch.version.raw-options]
 local_scheme = "no-local-version"