pluginify 0.1.0.post11.dev0__py3-none-any.whl → 1.0.0.post11.dev0__py3-none-any.whl

pluginify/_version.py

@@ -3,5 +3,5 @@
 
 # DO NOT EDIT
 # managed by poetry-dynamic-versioning
-__version__ = "0.1.0.post11.dev0"
-__version_tuple__ = (0, 1, 0, "post11", "dev0")
+__version__ = "1.0.0.post11.dev0"
+__version_tuple__ = (1, 0, 0, "post11", "dev0")

pluginify/commandline_typer.py

@@ -1,3 +1,6 @@
+# # # This source code is subject to the license referenced at
+# # # https://github.com/NRLMMD-GEOIPS.
+
 """Commandline module for Pluginify.
 
 Supports two main commands, `pluginify create` and `pluginify delete` as well as
@@ -140,7 +143,6 @@ class DocstringTyper(typer.Typer):
             new_params = []
 
             for name, param in sig.parameters.items():
-
                 default = param.default
                 help_text = param_help.get(name)
 
@@ -155,7 +157,7 @@ class DocstringTyper(typer.Typer):
 
                 # Optional arguments
                 short = f"-{name[0]}"
-                long = f"--{name.replace('_','-')}"
+                long = f"--{name.replace('_', '-')}"
 
                 option = typer.Option(default, short, long, help=help_text)
 

pluginify/config.py

@@ -1,3 +1,6 @@
+# # # This source code is subject to the license referenced at
+# # # https://github.com/NRLMMD-GEOIPS.
+
 """Module containing configuration variables needed for pluginify to run."""
 
 
@@ -58,7 +61,6 @@ def _env_to_variable(name, default):
     env_val = getenv(name)
 
     if env_val:
-
         if name == "PLUGINIFY_REGISTRY_DIRECTORY":
             return Path(env_val)
         elif name == "PLUGINIFY_REBUILD_REGISTRIES":

pluginify/create_plugin_registries.py

@@ -17,7 +17,7 @@ import logging
 from importlib import metadata, resources, util, import_module
 from inspect import signature
 import json
-from os import makedirs, remove
+from os import getpid, makedirs, remove, replace
 from os.path import (
     basename,
     dirname,
@@ -317,14 +317,24 @@ def write_registered_plugins(pkg_dir, plugins, save_type):
     """
     if save_type == "yaml":
         reg_plug_abspath = os_join(pkg_dir, "registered_plugins.yaml")
-        with open(reg_plug_abspath, "w") as plugin_registry:
-            LOG.info("Writing %s", reg_plug_abspath)
-            yaml.safe_dump(plugins, plugin_registry, default_flow_style=False)
     else:
         reg_plug_abspath = os_join(pkg_dir, "registered_plugins.json")
-        with open(reg_plug_abspath, "w") as plugin_registry:
-            LOG.info("Writing %s", reg_plug_abspath)
-            json.dump(plugins, plugin_registry, indent=4)
+    LOG.info("Writing %s", reg_plug_abspath)
+    # Write to a temporary file and move it into place, so that other processes
+    # reading the registry (for example parallel test workers) never see a
+    # partially written file.
+    tmp_abspath = f"{reg_plug_abspath}.{getpid()}.tmp"
+    try:
+        with open(tmp_abspath, "w") as plugin_registry:
+            if save_type == "yaml":
+                yaml.safe_dump(plugins, plugin_registry, default_flow_style=False)
+            else:
+                json.dump(plugins, plugin_registry, indent=4)
+        replace(tmp_abspath, reg_plug_abspath)
+    except BaseException:
+        if exists(tmp_abspath):
+            remove(tmp_abspath)
+        raise
 
 
 def create_plugin_registries(plugin_packages, save_type, namespace):
@@ -934,6 +944,15 @@ def add_class_plugin(package, relpath, plugins):
         # __version.py, etc.
         return error_message
 
+    if "utils" in Path(relpath).parts:
+        # Ignore helper modules that live under plugin trees. These files are not
+        # plugins and should not be imported or validated for PLUGIN_CLASS.
+        LOG.info(
+            f"Skipping module at relpath {relpath} from {package}, "
+            "found under a utils directory"
+        )
+        return error_message
+
     module_name = splitext(basename(relpath))[0]
     # We need the full path to the module in order
     # for relative imports to work within modules.
@@ -957,6 +976,18 @@ def add_class_plugin(package, relpath, plugins):
                          at relpath '{relpath}'\n"""
         return error_message
 
+    # If interface is None, then legitimately skip the module.
+    # We want to skip this first, before we test anything else.
+    # If it is not a plugin, we don't care if there are other
+    # errors in it at this stage (ie, avoid unnecessary unrelated
+    # catastrophic failures)
+    if hasattr(module, "interface") and module.interface is None:
+        LOG.info(
+            f"Skipping module '{module_name}' from '{package}', "
+            "interface_name is 'None'"
+        )
+        return error_message
+
     # We've encountered a truly 'class-based' plugin. I.e. we don't need to generate
     # the plugin object from the module itself. Collect metadata from this plugin
     # in a different fashion to what we've done previously.

pluginify/interfaces/__init__.py

@@ -1,7 +1,10 @@
+# # # This source code is subject to the license referenced at
+# # # https://github.com/NRLMMD-GEOIPS.
+
 """Initialization module for pluginify interfaces."""
 
-from pluginify.interfaces.class_based.data_modifiers import data_modifiers
-from pluginify.interfaces.yaml_based.configs import configs
+from pluginify.interfaces.class_based.data_modifiers import data_modifiers  # noqa: F401
+from pluginify.interfaces.yaml_based.configs import configs  # noqa: F401
 
 class_based_interfaces = ["data_modifiers"]
 yaml_based_interfaces = ["configs"]

pluginify/interfaces/base.py

@@ -35,7 +35,7 @@ class BaseInterface(abc.ABC):
     import pluginify.plugin_registry as plugin_registry_module
 
     name = "BaseInterface"
-    interface_type = None  # This is set by child classes
+    interface_type: str = ""  # This is set by child classes
     rebuild_registries = REBUILD_REGISTRIES
     # Setting this attribute at the top level so it can be used by all methods.
     # This can be overridden by setting them in child interface classes
@@ -375,7 +375,7 @@ class BaseClassInterface(BaseInterface):
 
     interface_type = "class_based"
     name = "BaseClassInterface"
-    required_args = {}
+    required_args: dict[str, list[str]] = {}
 
     def __repr__(self):
         """Plugin interface repr method."""

pluginify/interfaces/class_based/data_modifiers.py

@@ -32,7 +32,7 @@ class DataModifiersInterface(BaseClassInterface):
         "standard": ["data", "config"],
     }
 
-    required_kwargs = {"standard": []}
+    required_kwargs: dict[str, list[str]] = {"standard": []}
 
 
 data_modifiers = DataModifiersInterface()

pluginify/interfaces/class_based_plugin.py

@@ -1,3 +1,6 @@
+# # # This source code is subject to the license referenced at
+# # # https://github.com/NRLMMD-GEOIPS.
+
 """Implements a base class for class-based plugins.
 
 The base class implemented here would expose the call signature of the child plugin
@@ -72,6 +75,7 @@ class BaseClassPlugin(ABC):
     # If no family is provided, just assume it works with DT
     data_tree = False
     required_attributes = ["interface", "family", "name"]
+    __plugin_abstract__: bool = False
 
     def _check_interface_attribute(cls):
         """Check the validity of the 'interface' attribute.
@@ -196,15 +200,15 @@ class BaseClassPlugin(ABC):
         if "__call__" in cls.__dict__:
             raise TypeError(f"{cls.__name__} cannot override __call__")
 
-        try:
-            call_method = cls.__dict__.get("call")
-        except AttributeError:
+        if "call" not in cls.__dict__:
             raise TypeError(f"{cls.__name__} must implement call()")
+        call_method = cls.__dict__["call"]
 
-        @functools.wraps(call_method)
+        @functools.wraps(call_method)  # type: ignore[arg-type]
         def _call(self, data=None, *args, **kwargs):
             return cls._invoke(self, data, *args, **kwargs)
 
-        _call.__signature__ = inspect.signature(call_method)  # mirror only call()
+        call_sig = inspect.signature(call_method)
+        _call.__signature__ = call_sig  # type: ignore[attr-defined]
         _call.__annotations__ = getattr(call_method, "__annotations__", {})
-        cls.__call__ = _call
+        cls.__call__ = _call  # type: ignore[method-assign]

pluginify/plugin_registry.py

@@ -128,7 +128,7 @@ class PluginRegistry:
 
         See the interface_mapping property for more information.
         """
-        self._registered_plugins = new_value
+        self._interface_mapping = new_value
 
     @property
     def registered_yaml_based_plugins(self):
@@ -170,7 +170,6 @@ class PluginRegistry:
         """
         # Load the registries here and return them as a dictionary
         if not hasattr(self, "_registered_plugins") or force_reset:
-
             # Complete dictionary of all available plugins found in every plugin package
             self._registered_plugins = {}
             # A mapping of interfaces to plugin_types. Ie:
@@ -478,9 +477,9 @@ class PluginRegistry:
 
         if _expand:
             # Only applies to workflow plugins
-            return model_class.model_validate(data, context={"expand": True})
+            return model_class.model_validate(data, context={"expand": True})  # type: ignore[no-any-return]  # NOQA
 
-        return model_class(**data)
+        return model_class(**data)  # type: ignore[no-any-return]
 
     def get_yaml_plugin(
         self, interface_obj, name, rebuild_registries=None, _expand=False
@@ -886,7 +885,7 @@ class PluginRegistry:
             for pkg in plugin_packages:
                 if pkg.value in packages:
                     filtered_packages.append(pkg)
-            plugin_packages = filtered_packages
+            plugin_packages = type(plugin_packages)(filtered_packages)  # type: ignore[arg-type]  # NOQA
 
         LOG.debug(plugin_packages)
         create_plugin_registries(plugin_packages, save_type, self.namespace)

pluginify/plugins/classes/data_modifiers/cuboid.py

@@ -1,3 +1,6 @@
+# # # This source code is subject to the license referenced at
+# # # https://github.com/NRLMMD-GEOIPS.
+
 """Cuboid data modifier plugin class.
 
 This is a 'dummy' plugin which is strictly used for testing pluginify.

pluginify/pydantic_models/v1/configs.py

@@ -1,3 +1,6 @@
+# # # This source code is subject to the license referenced at
+# # # https://github.com/NRLMMD-GEOIPS.
+
 """
 Pydantic model for pluginify configuration plugins.
 

pluginify/utils/validators.py

@@ -1,3 +1,6 @@
+# # # This source code is subject to the license referenced at
+# # # https://github.com/NRLMMD-GEOIPS.
+
 """Pluginify validators module.
 
 Currently only implements a PluginRegistryValidator class.

{pluginify-0.1.0.post11.dev0.dist-info → pluginify-1.0.0.post11.dev0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pluginify
-Version: 0.1.0.post11.dev0
+Version: 1.0.0.post11.dev0
 Summary: Pluginify package
 License: LICENSE
 License-File: LICENSE
@@ -12,6 +12,7 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
 Provides-Extra: doc
 Requires-Dist: docstring_parser
 Requires-Dist: jsonschema (>4.18.0)
@@ -24,11 +25,12 @@ Requires-Dist: typer
 Project-URL: Repository, https://github.com/NRLMMD-GEOIPS/pluginify
 Description-Content-Type: text/markdown
 
-    # # # This source code is subject to the license referenced at
-    # # # https://github.com/NRLMMD-GEOIPS.
+```
+# # # This source code is subject to the license referenced at
+# # # https://github.com/NRLMMD-GEOIPS.
+```
 
-Pluginify
-=========
+# Pluginify
 
 This repository contains everything necessary to fully register YAML and python classes
 and/or modules as valid python plugin objects. A YAML-based plugin object essentially
@@ -43,21 +45,24 @@ PluginRegistry class. This package can and is used alongside other packages such
 [GeoIPS](https://github.com/NRLMMD-GEOIPS/geoips) to handle their plugin-based
 infrastructure.
 
-Install pluginify package
--------------------------
+## Install pluginify package
+
 Current status:
+
 ```bash
 git clone https://github.com/NRLMMD-GEOIPS/pluginify.git
 # cd to pluginify's top level dir
 pip install -e .
 ```
+
 OR
+
 ```bash
 pip install pluginify
 ```
 
-Use pluginify
--------------
+## Use pluginify
+
 ```bash
 pluginify -h
 # Top level commands without additional args

pluginify-1.0.0.post11.dev0.dist-info/RECORD

@@ -0,0 +1,23 @@
+pluginify/__init__.py,sha256=NvdicJtfy-dZZ8tWjR74lDBHGV6rlaH8pAJ7UHyTTog,391
+pluginify/_version.py,sha256=z-TefoSzduIgcBbfoVxyeFyvyIbCCdwT7xLpUydY-EI,239
+pluginify/commandline_typer.py,sha256=i0aVQEABfS8oL6ATUmzMqgtQQLhw0nMQmYzwpPzTF8k,11361
+pluginify/config.py,sha256=ffmzSyAjPNePkSZrqinu20ZJkbmG-L4TREgRfFmPL4M,4997
+pluginify/create_plugin_registries.py,sha256=n5yBp5KHCqHPlfXrFe-Ad16UXRQnGGDU5c81UuBoGOw,50167
+pluginify/errors.py,sha256=kkdipLfxvj8f-Pp53SD3RPnD9QS3samBLlQBjBskZP8,373
+pluginify/interfaces/__init__.py,sha256=OkhHHE8WUEh12n3VrAWfMUv2-AAz7wfy5OcEyY-KtTc,461
+pluginify/interfaces/base.py,sha256=CMgPG2NpodrECXXJbayTIVt8Vqrrxd_QADAgGM5qgUk,26749
+pluginify/interfaces/class_based/data_modifiers.py,sha256=INQCUaXWpUpRIljjhvg-ndUB_sRoMt7pzEVVEM3PeAQ,1094
+pluginify/interfaces/class_based_plugin.py,sha256=IA1bo33yior-udeaX_Cv8X8AA8syufI3rvxeMdv5hls,8431
+pluginify/interfaces/yaml_based/configs.py,sha256=3U_nKCm2mIVfA_cRl-VUmu8JrQQQ3u24eshH46a9GI0,808
+pluginify/plugin_registry.py,sha256=PB2k7g4lnONNkMPEebbgZTSH3hEYmo_9wcSvlS5aUAI,43416
+pluginify/plugins/classes/data_modifiers/cuboid.py,sha256=1pRE04bL5L5MHRHnky_hvKx2W-OkhzRLxgBPbbfMvMo,1211
+pluginify/plugins/yaml/configs/stucco.yaml,sha256=OXLWzmmzxSAWs-MzSlmEa-OLGJzVJzrVQZwgGPL2jqE,376
+pluginify/pydantic_models/v1/configs.py,sha256=KfWsIveOqPOi_J53odFFY6gFOHNYPpwQdPDqRXCfpnI,2226
+pluginify/utils/__init__.py,sha256=gdy4E4yEI9lrHbWPeBn0Bspj7iz4z6r8BAjbmHf_hpM,2088
+pluginify/utils/context_managers.py,sha256=1-bREbijNNc5PrqMIihKqxlxNaK-YZ3hj5XGpHiYmfw,926
+pluginify/utils/validators.py,sha256=ssfcUsvUlYfhWt5AjncU66KD4qDSv0N1BdR99ytvQjY,7681
+pluginify-1.0.0.post11.dev0.dist-info/METADATA,sha256=N-m8NbZksZDJkcsM5rWQy93pUqDbCyze1F4E-s1PSuE,2179
+pluginify-1.0.0.post11.dev0.dist-info/WHEEL,sha256=L-WvLdSBvJWHXv5zrQxDvNRnIgoBzLUpcbuiw19KCuQ,88
+pluginify-1.0.0.post11.dev0.dist-info/entry_points.txt,sha256=kCm7HOEEzSnPyDpy98W-LYYmlLYyTnRqOj40UqxX6-w,111
+pluginify-1.0.0.post11.dev0.dist-info/licenses/LICENSE,sha256=sIBqTiU78gw5bC9MZMySNxzCE7DIlOcDqUWdmflkDsY,7266
+pluginify-1.0.0.post11.dev0.dist-info/RECORD,,

{pluginify-0.1.0.post11.dev0.dist-info → pluginify-1.0.0.post11.dev0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 2.4.0
+Generator: poetry-core 2.5.0
 Root-Is-Purelib: true
 Tag: py3-none-any

pluginify-0.1.0.post11.dev0.dist-info/RECORD

@@ -1,23 +0,0 @@
-pluginify/__init__.py,sha256=NvdicJtfy-dZZ8tWjR74lDBHGV6rlaH8pAJ7UHyTTog,391
-pluginify/_version.py,sha256=n4Mesoqrw8DK8LkjhySdwEOZeCLfBv_cuSDOZyMBxiU,239
-pluginify/commandline_typer.py,sha256=g_pT1V8xwAF9KK-ndE-ydIYk2ivZYoO24PBW80CjsoM,11257
-pluginify/config.py,sha256=co4HkXsOrA68M0PlRaUAhz5KMp5pa60ssb7DwLvUuxk,4894
-pluginify/create_plugin_registries.py,sha256=rZmZV_iIBc3FHfhhCW4axMpoBaT1dq_P3OPS7jVrQlQ,48934
-pluginify/errors.py,sha256=kkdipLfxvj8f-Pp53SD3RPnD9QS3samBLlQBjBskZP8,373
-pluginify/interfaces/__init__.py,sha256=XcPl52V8oMihP7NoRs_NgbiIvqoL3A4YeyfTOp3NqBA,329
-pluginify/interfaces/base.py,sha256=ubimAsOgAXCyhKhn40-a1HIfrjMPqHtKr4rBnwm645M,26724
-pluginify/interfaces/class_based/data_modifiers.py,sha256=p-d80oywjo9Rr6txowr1BIlg08qeOm3dAMm_4JQ0iH8,1072
-pluginify/interfaces/class_based_plugin.py,sha256=TMuJ2INaaFaUlxPX05L5r2gH3ISu1W_2qWllGA63oq4,8209
-pluginify/interfaces/yaml_based/configs.py,sha256=3U_nKCm2mIVfA_cRl-VUmu8JrQQQ3u24eshH46a9GI0,808
-pluginify/plugin_registry.py,sha256=CLcR8xXPPaB3fd2KOODUZRiOSg3hhMyKiyKyAv9KpVE,43291
-pluginify/plugins/classes/data_modifiers/cuboid.py,sha256=WyvhPrRptpSHtPqeOdF1oiHm6zFwHahsLwNvsMdmQEE,1107
-pluginify/plugins/yaml/configs/stucco.yaml,sha256=OXLWzmmzxSAWs-MzSlmEa-OLGJzVJzrVQZwgGPL2jqE,376
-pluginify/pydantic_models/v1/configs.py,sha256=As15amNtdFwAobufh0d6mDlF3mMS23ThwTKQy9q25bc,2122
-pluginify/utils/__init__.py,sha256=gdy4E4yEI9lrHbWPeBn0Bspj7iz4z6r8BAjbmHf_hpM,2088
-pluginify/utils/context_managers.py,sha256=1-bREbijNNc5PrqMIihKqxlxNaK-YZ3hj5XGpHiYmfw,926
-pluginify/utils/validators.py,sha256=gCESprY4mZgE0KXigjsgHOipjZAg8OUF5n3-SGQ7PG4,7577
-pluginify-0.1.0.post11.dev0.dist-info/METADATA,sha256=aY4LQhrTUPYsmTcEh9QyW6SkMiqlDM-dgX-HW7DmIZs,2165
-pluginify-0.1.0.post11.dev0.dist-info/WHEEL,sha256=EGEvSphFYqXKs23-kQBeyNoJP1nrT8ZJKQoi5p5DYL8,88
-pluginify-0.1.0.post11.dev0.dist-info/entry_points.txt,sha256=kCm7HOEEzSnPyDpy98W-LYYmlLYyTnRqOj40UqxX6-w,111
-pluginify-0.1.0.post11.dev0.dist-info/licenses/LICENSE,sha256=sIBqTiU78gw5bC9MZMySNxzCE7DIlOcDqUWdmflkDsY,7266
-pluginify-0.1.0.post11.dev0.dist-info/RECORD,,