Merge pull request #14 from matsjoyce/regenerate-cache-on-version-change

Regenerate cache on version change

Author: matsjoyce

.github/workflows/test.yml

@@ -45,6 +45,7 @@ jobs:
           python -m pip install --upgrade pip
           echo "PySide6==${{ matrix.pyside6_version }}" > constraint.txt
           pip install -r requirements.txt -c constraint.txt
+          hatch build --hooks-only
       - name: Check formatting with black
         run: |
           black --check .

README.md

@@ -54,6 +54,8 @@ Generate QML stub files (.qmltypes) from Python modules (which use PySide6)
 
 Usage:
     pyside6-qml-stubgen <in-dir>... --out-dir=<out-dir> [--ignore=<path>...] [--metatypes-dir=<dir>] [--qmltyperegistrar-path=<path>] [--force-rebuild] [--file-relative-path=<div>] [--extra-external-modules=<modules>]
+    pyside6-qml-stubgen (-h | --help)
+    pyside6-qml-stubgen --version
 
 Options:
     --ignore=<path>                     Ignore all Python files that are children of this path
@@ -63,4 +65,6 @@ Options:
     --file-relative-path=<div>          Make all paths in generated type files relative to this path
                                             (useful for if the generated stubs need to be used on different systems)
     --extra-external-modules=<modules>  Additional modules which should be assumed to contain QML exposed types (comma separated)
+    -h --help                           Show this screen
+    --version                           Show version
 ```

pyproject.toml

@@ -38,6 +38,9 @@ build-backend = "hatchling.build"
 [tool.hatch.version]
 source = "vcs"
 
+[tool.hatch.build.hooks.vcs]
+version-file = "pyside6_qml_stubgen/_version.py"
+
 [tool.mypy]
 python_version = "3.10"
 warn_unused_configs = true
@@ -50,3 +53,6 @@ warn_unused_ignores = true
 warn_unreachable = true
 strict_equality = true
 local_partial_types = true
+
+[tool.black]
+extend-exclude = "_version.py"

pyside6_qml_stubgen/__init__.py

@@ -13,6 +13,7 @@
 from PySide6 import QtCore
 
 from . import dirty_file_detection, pyside_patching, qmlregistrar_types
+from ._version import __version__, __version_tuple__
 
 
 def parse_module(
@@ -267,7 +268,10 @@ def import_dirty_modules(
         )
 
     dirty_file_detection.save_modules_metadata(
-        out_dir, dirty_file_detection.PythonModulesMetadata(module_metadata)
+        out_dir,
+        dirty_file_detection.PythonModulesMetadata(
+            module_metadata, generating_version=__version__
+        ),
     )
 
     extra_info.resolve_delayed()

pyside6_qml_stubgen/__main__.py

@@ -3,6 +3,8 @@
 
 Usage:
     pyside6-qml-stubgen <in-dir>... --out-dir=<out-dir> [--ignore=<path>...] [--metatypes-dir=<dir>] [--qmltyperegistrar-path=<path>] [--force-rebuild] [--file-relative-path=<div>] [--extra-external-modules=<modules>]
+    pyside6-qml-stubgen (-h | --help)
+    pyside6-qml-stubgen --version
 
 Options:
     --ignore=<path>                     Ignore all Python files that are children of this path
@@ -12,17 +14,19 @@
     --file-relative-path=<div>          Make all paths in generated type files relative to this path
                                             (useful for if the generated stubs need to be used on different systems)
     --extra-external-modules=<modules>  Additional modules which should be assumed to contain QML exposed types (comma separated)
+    -h --help                           Show this screen
+    --version                           Show version
 """
 
 import pathlib
 
 import docopt
 
-from . import process
+from . import _version, process
 
 
 def main() -> None:
-    args = docopt.docopt(__doc__)
+    args = docopt.docopt(__doc__, version=_version.__version__)
     process(
         in_dirs=[pathlib.Path(p) for p in args["<in-dir>"]],
         ignore_dirs=[pathlib.Path(ig) for ig in args["--ignore"]],

pyside6_qml_stubgen/dirty_file_detection.py

@@ -5,6 +5,8 @@
 
 import pydantic
 
+from . import _version
+
 
 @dataclasses.dataclass
 class PythonModuleMetadata:
@@ -16,16 +18,19 @@ class PythonModuleMetadata:
 @dataclasses.dataclass
 class PythonModulesMetadata:
     modules: typing.Mapping[str, PythonModuleMetadata | None]
+    generating_version: str = ""
 
 
 PYTHON_MODULES_METADATA_TYPE_ADAPTER = pydantic.TypeAdapter(PythonModulesMetadata)
 
 
 def load_modules_metadata(dir_path: pathlib.Path) -> PythonModulesMetadata:
     if (dir_path / "metadata.json").exists():
-        return PYTHON_MODULES_METADATA_TYPE_ADAPTER.validate_json(
+        metadata = PYTHON_MODULES_METADATA_TYPE_ADAPTER.validate_json(
             (dir_path / "metadata.json").read_bytes()
         )
+        if metadata.generating_version == _version.__version__:
+            return metadata
     return PythonModulesMetadata({})
 
 

requirements.txt

@@ -22,3 +22,5 @@ PySide6
 PySide6_Addons
 PySide6_Essentials
 shiboken6
+hatch
+hatch-vcs