Change PluginInfo and add some type annotation

Add some new properties sdk_version, python_verion for plugins
and add some type annotations.

Author: BeneBr

hookman/__main__.py

@@ -44,13 +44,17 @@ def generate_project_files(specs_path, dst_path):
 @click.argument("plugin_id")
 @click.argument("author_name")
 @click.argument("author_email")
+@click.argument("sdk_version")
+@click.argument("python_version")
 @click.option("--dst-path", default="./", help="Path to where the files will be written")
 def generate_plugin_template(
     specs_path: str,
     caption: str,
     plugin_id: str,
     author_email: str,
     author_name: str,
+    sdk_version: str,
+    python_version: str,
     dst_path: Path,
 ):
     """
@@ -61,6 +65,8 @@ def generate_plugin_template(
     PLUGIN_ID     A unique string to identify the plugin.
     AUTHOR_NAME   Name of the plugin author to be displayed.
     AUTHOR_EMAIL  Email of the plugin author to be displayed.
+    SDK_VERSION   The SDK version to be used by the plugin.
+    PYHOP_VERSION  The Python version to be used by the plugin.
 
     """
     hm_generator = HookManGenerator(hook_spec_file_path=specs_path)
@@ -69,6 +75,8 @@ def generate_plugin_template(
         plugin_id=plugin_id,
         author_email=author_email,
         author_name=author_name,
+        sdk_version=sdk_version,
+        python_version=python_version,
         dst_path=Path(dst_path),
     )
     return 0

hookman/hookman_generator.py

@@ -143,6 +143,8 @@ def generate_plugin_template(
         plugin_id: str,
         author_email: str,
         author_name: str,
+        sdk_version: str,
+        python_version: str,
         dst_path: Path,
         extra_includes: Optional[List[str]] = None,
         extra_body_lines: Optional[List[str]] = None,
@@ -203,7 +205,7 @@ def generate_plugin_template(
             self._plugin_cmake_file_content(plugin_id)
         )
         Path(assets_folder / "plugin.yaml").write_text(
-            self._plugin_config_file_content(caption, plugin_id, author_email, author_name, extras)
+            self._plugin_config_file_content(caption, plugin_id, sdk_version, python_version, author_email, author_name, extras)
         )
         Path(assets_folder / "README.md").write_text(
             self._readme_content(caption, author_email, author_name)
@@ -382,21 +384,21 @@ def _validate_package_folder(self, artifacts_dir, assets_dir):
         if not assets_dir.joinpath("CHANGELOG.rst").is_file():
             raise FileNotFoundError(f"Unable to locate the file CHANGELOG.rst in {assets_dir}")
 
-    def _validate_plugin_config_file(self, plugin_config_file: Path):
+    def _validate_plugin_config_file(self, plugin_config_file: Path) -> None:
         """
         Check if the given plugin_file is valid, by creating a instance of PluginInfo.
         All checks are made in the __init__
         """
         plugin_file_content = PluginInfo(plugin_config_file, hooks_available=None)
-        semantic_version_re = re.compile(r"^(\d+)\.(\d+)\.(\d+)")  # Ex.: 1.0.0
+        semantic_version_re = re.compile(r"^(\d+)\.(\d+)\.(\d+)")  # Ex.: 1.0.0 or 2025.1.0
         version = semantic_version_re.match(plugin_file_content.version)
 
         if not version:
             raise ValueError(
-                f"Version attribute does not follow semantic version, got {plugin_file_content.version!r}"
+                f"Version attribute does not follow the calendar or semantic versioning, got {plugin_file_content.version!r}"
             )
 
-    def _hook_specs_header_content(self, plugin_id) -> str:
+    def _hook_specs_header_content(self, plugin_id: str) -> str:
         """
         Create a C header file with the content informed on the hook_specs
         """
@@ -634,6 +636,8 @@ def _plugin_config_file_content(
         self,
         caption: str,
         plugin_id: str,
+        sdk_version: str,
+        python_version: str,
         author_email: str,
         author_name: str,
         extras: dict,
@@ -647,6 +651,8 @@ def _plugin_config_file_content(
         caption: '{caption}'
         email: '{author_email}'
         id: '{plugin_id}'
+        sdk_version: '{sdk_version}'
+        python_version: '{python_version}'
         version: '1.0.0'
         """
         )

hookman/plugin_config.py

@@ -1,11 +1,10 @@
 import ctypes
 import sys
 from pathlib import Path
-from typing import List
+from typing import List, Sequence, OrderedDict
 from zipfile import ZipFile
 
-import attr
-from attr import attrib
+from attr import define, field
 from strictyaml import Map
 from strictyaml import MapPattern
 from strictyaml import Optional
@@ -21,60 +20,62 @@
         "author": Str(),
         "email": Str(),
         "id": Str(),
+        "sdk_version": Str(),
+        "python_version": Str(),
         Optional("extras"): MapPattern(Str(), Str()),
     }
 )
 
 
-@attr.s
-class PluginInfo(object):
+@define
+class PluginInfo:
     """
     Class that holds all information related to the plugin with some auxiliary methods
     """
 
-    yaml_location = attrib(type=Path)
-    hooks_available = attrib(validator=attr.validators.optional(attr.validators.instance_of(dict)))
-
-    author = attrib(type=str, init=False)
-    description = attrib(type=str, default="Could not find a description", init=False)
-    email = attrib(type=str, init=False)
-    hooks_implemented = attrib(type=list, init=False)
-    caption = attrib(type=str, init=False)
-    shared_lib_name = attrib(type=str, init=False)
-    shared_lib_path = attrib(type=Path, init=False)
-    version = attrib(type=str, init=False)
-    extras = attrib(attr.Factory(dict), init=False)
-
-    def __attrs_post_init__(self):
+    yaml_location: Path
+    hooks_available: dict | None = None
+
+    description: str = ""
+    author: str = ""
+    email: str = ""
+    hooks_implemented: Sequence[str] = []
+    caption: str = ""
+    shared_lib_name: str = ""
+    shared_lib_path: Path = field(init=False)
+    version: str = ""
+    sdk_version: str = ""
+    python_version: str = ""
+    extras: dict = {}
+    id: str = ""
+
+    def __attrs_post_init__(self) -> None:
         plugin_config_file_content = self._load_yaml_file(
             self.yaml_location.read_text(encoding="utf-8")
         )
 
         name = plugin_config_file_content["id"]
         shared_lib_name = f"{name}.dll" if sys.platform == "win32" else f"lib{name}.so"
 
-        object.__setattr__(self, "shared_lib_name", shared_lib_name)
-        object.__setattr__(
-            self, "shared_lib_path", self.yaml_location.parents[1] / "artifacts" / shared_lib_name
-        )
-
-        object.__setattr__(self, "author", plugin_config_file_content["author"])
-        object.__setattr__(self, "caption", plugin_config_file_content["caption"])
-        object.__setattr__(self, "email", plugin_config_file_content["email"])
-        object.__setattr__(self, "version", plugin_config_file_content["version"])
-        object.__setattr__(self, "extras", plugin_config_file_content.get("extras", {}))
+        self.shared_lib_name = shared_lib_name
+        self.shared_lib_path =  self.yaml_location.parents[1] / "artifacts" / shared_lib_name
+        self.author = plugin_config_file_content["author"]
+        self.caption = plugin_config_file_content["caption"]
+        self.email = plugin_config_file_content["email"]
+        self.version = plugin_config_file_content["version"]
+        self.sdk_version = plugin_config_file_content["sdk_version"]
+        self.python_version = plugin_config_file_content["python_version"]
+        self.extras = plugin_config_file_content.get("extras", {})
 
         # The id bellow guarantee to me that the plugin_id to be used in the application was not changed by a config file.
-        object.__setattr__(
-            self, "id", self._get_plugin_id_from_dll(plugin_config_file_content["id"])
-        )
+        self.id = self._get_plugin_id_from_dll(plugin_config_file_content["id"])
+
+        readme_file = self.yaml_location.parent / "README.md"
+        self.description = readme_file.read_text(encoding="utf-8") if readme_file.is_file() else "Could not find a description"
 
         if not self.hooks_available is None:
-            object.__setattr__(self, "hooks_implemented", self._get_hooks_implemented())
+            self.hooks_implemented = self._get_hooks_implemented()
 
-        readme_file = self.yaml_location.parent / "README.md"
-        if readme_file.exists():
-            object.__setattr__(self, "description", readme_file.read_text())
 
     def _check_if_shared_lib_exists(self):
         if not self.shared_lib_path.is_file():
@@ -95,11 +96,14 @@ def _get_plugin_id_from_dll(self, plugin_id_from_plugin_yaml: str) -> str:
                 raise RuntimeError(msg)
             return plugin_id_from_shared_lib
 
-    def _get_hooks_implemented(self) -> List[str]:
+    def _get_hooks_implemented(self) -> Sequence[str]:
         """
         Return a list of which hooks from "hooks_available" the shared library implements
         """
         self._check_if_shared_lib_exists()
+        if self.hooks_available is None:
+            return []
+
         with load_shared_lib(str(self.shared_lib_path)) as plugin_dll:
             hooks_implemented = [
                 hook_name
@@ -124,7 +128,7 @@ def is_implemented_on_plugin(cls, plugin_dll: ctypes.CDLL, hook_name: str) -> bo
         return True
 
     @classmethod
-    def _load_yaml_file(cls, yaml_content):
+    def _load_yaml_file(cls, yaml_content: str) -> OrderedDict:
         import strictyaml
 
         plugin_config_file_content = strictyaml.load(yaml_content, PLUGIN_CONFIG_SCHEMA).data
@@ -139,7 +143,7 @@ def _load_yaml_file(cls, yaml_content):
         return plugin_config_file_content
 
     @classmethod
-    def validate_plugin_file(cls, plugin_file_zip: ZipFile):
+    def validate_plugin_file(cls, plugin_file_zip: ZipFile) -> None:
         """
         Check if the given plugin_file is valid,
         currently the only check that this method do is to verify if the id is available

tests/plugins/acme/simple_plugin/assets/plugin.yaml

@@ -3,5 +3,6 @@ version: '1.0.0'
 
 author: 'simple_plugin_author'
 email: 'simple_plugin_author@simple_plugin_author.com'
-
 id: 'simple_plugin'
+sdk_version: '>= 1.2.0'
+python_version: '>= 3.10'

tests/plugins/acme/simple_plugin_2/assets/plugin.yaml

@@ -1,5 +1,7 @@
 caption: 'Simple Plugin 2'
 version: '1.0.0'
+sdk_version: '>= 1.2.0'
+python_version: '>= 3.10'
 
 author: 'simple_plugin_2_author'
 email: 'simple_plugin_2_author@simple_plugin_2_author.com'

tests/test_cli.py

@@ -49,6 +49,8 @@ def test_generate_plugin_template(datadir):
             "my_plugin",
             "Jonh",
             "jonh@somewhere",
+            ">=1.2.0",
+            ">=3.10",
             "--dst-path",
             datadir,
         ],
@@ -82,6 +84,8 @@ def test_package_plugin(datadir, mock_plugin_id_from_dll):
             "My Plugin",
             "my_plugin",
             "Jonh",
+            ">=1.2.0",
+            ">=3.10",
             "jonh@somewhere",
             "--dst-path",
             datadir,

tests/test_hookman_generator.py

@@ -46,6 +46,8 @@ def test_generate_plugin_template(datadir, file_regression):
     hg.generate_plugin_template(
         caption="Acme",
         plugin_id="acme",
+        sdk_version= '>= 1.2.0',
+        python_version='>= 3.10',
         author_name="FOO",
         author_email="FOO@FOO.com",
         dst_path=plugin_dir,
@@ -98,6 +100,8 @@ def test_generate_plugin_template_source_content_with_extra_includes(datadir, fi
         caption="Acme",
         plugin_id="acme",
         author_name="FOO",
+        sdk_version='>= 1.2.0',
+        python_version='>= 3.10',
         author_email="FOO@FOO.com",
         dst_path=plugin_dir,
         extra_includes=["<my_sdk/sdk.h>"],
@@ -123,6 +127,8 @@ def test_generate_plugin_template_source_content_with_default_impls(datadir, fil
         caption="Acme",
         plugin_id="acme",
         author_name="FOO",
+        sdk_version='>= 1.2.0',
+        python_version='>= 3.10',
         author_email="FOO@FOO.com",
         dst_path=plugin_dir,
         extra_body_lines=extra_body_lines,
@@ -177,6 +183,8 @@ def test_generate_plugin_package_invalid_shared_lib_name(acme_hook_specs_file, t
             plugin_id="acm#e",
             author_email="acme1",
             author_name="acme2",
+            sdk_version='>= 1.2.0',
+            python_version='>= 3.10',
             dst_path=Path(tmpdir),
         )
 
@@ -186,6 +194,8 @@ def test_generate_plugin_package_invalid_shared_lib_name(acme_hook_specs_file, t
             plugin_id="acm e",
             author_email="acme1",
             author_name="acme2",
+            sdk_version='>= 1.2.0',
+            python_version='>= 3.10',
             dst_path=Path(tmpdir),
         )
 
@@ -195,6 +205,8 @@ def test_generate_plugin_package_invalid_shared_lib_name(acme_hook_specs_file, t
             plugin_id="acm e",
             author_email="acme1",
             author_name="acme2",
+            sdk_version='>= 1.2.0',
+            python_version='>= 3.10',
             dst_path=Path(tmpdir),
         )
 
@@ -210,6 +222,8 @@ def test_generate_plugin_package(
         plugin_id="acme",
         author_email="acme1",
         author_name="acme2",
+        sdk_version=">= 1.2.0",
+        python_version=">= 3.10",
         dst_path=Path(tmpdir),
         extras={"key": "override", "key2": "value2"},
     )
@@ -276,6 +290,8 @@ def test_generate_plugin_package(
     caption: acme
     email: acme1
     id: acme
+    sdk_version: '>= 1.2.0'
+    python_version: '>= 3.10'
     version: 1.0.0
     extras:
       key: override
@@ -336,6 +352,8 @@ def test_generate_plugin_package_with_missing_folders(acme_hook_specs_file, tmpd
             f"""\
             caption: 'ACME'
             version: '1.0.0'
+            sdk_version: '>= 1.2.0'
+            python_version: '>= 3.10'
 
             author: 'acme_author'
             email: 'acme_email'
@@ -387,7 +405,7 @@ def test_generate_plugin_package_invalid_version(
 ):
     hg = HookManGenerator(hook_spec_file_path=acme_hook_specs_file)
     plugin_id = "acme"
-    hg.generate_plugin_template(plugin_id, plugin_id, "acme1", "acme2", tmp_path)
+    hg.generate_plugin_template(plugin_id, plugin_id,">=1.2.0",">=3.10", "acme1", "acme2", tmp_path)
 
     plugin_yaml = tmp_path / "acme/assets/plugin.yaml"
     new_content = plugin_yaml.read_text().replace("version: '1.0.0'", "version: '1'")
@@ -398,6 +416,6 @@ def test_generate_plugin_package_invalid_version(
     )
 
     with pytest.raises(
-        ValueError, match="Version attribute does not follow semantic version, got '1'"
+        ValueError, match="Version attribute does not follow the calendar or semantic versioning, got '1'"
     ):
         hg.generate_plugin_package(plugin_id, plugin_dir=tmp_path / plugin_id)

tests/test_hookman_generator/generate_plugin.yaml

@@ -2,4 +2,6 @@ author: 'FOO'
 caption: 'Acme'
 email: 'FOO@FOO.com'
 id: 'acme'
+sdk_version: '>= 1.2.0'
+python_version: '>= 3.10'
 version: '1.0.0'

tests/test_hookman_utils/bar/plugin.yaml

@@ -1,5 +1,7 @@
 caption: 'Hookman Utils'
 version: '1.0.0'
+sdk_version: '>= 1.2.0'
+python_version: '>= 3.10'
 
 author: 'test_hookman_utils'
 email: 'test_hookman_utils@test_hookman_utils'

tests/test_hookman_utils/foo/plugin.yaml

@@ -1,5 +1,7 @@
 caption: 'Hookman Utils'
 version: '1.0.0'
+sdk_version: '>= 1.2.0'
+python_version: '>= 3.10'
 
 author: 'test_hookman_utils'
 email: 'test_hookman_utils@test_hookman_utils'