pluginify 0.1.0__tar.gz → 1.0.0__tar.gz

pluginify-1.0.0/.github/workflows/code-quality.yaml

@@ -0,0 +1,87 @@
+name: CodeQuality
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+env:
+  UV_SYSTEM_PYTHON: true
+
+jobs:
+  lint:
+    continue-on-error: true
+    runs-on: ${{ vars.RUNNER }}
+    steps:
+      - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5  # v4
+
+      - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065  # v5
+        with:
+          python-version: "3.13"
+
+      - uses: actions/setup-go@40f1582b2485089dde7abd97c1529aa768e1baff  # v5
+        with:
+          go-version: stable
+          cache: false
+
+      - uses: astral-sh/setup-uv@d0cc045d04ccac9d8b7881df0226f9e82c39688e  # v6.8.0
+
+      - name: Install linters
+        run: |
+          uv pip install ruff blacken-docs mdformat validate-pyproject
+          go install github.com/rhysd/actionlint/cmd/actionlint@latest
+          go install github.com/google/yamlfmt/cmd/yamlfmt@latest
+          echo "$HOME/go/bin" >> "$GITHUB_PATH"
+
+      - name: Ruff (lint)
+        run: ruff check ./pluginify
+
+      - name: Ruff (format)
+        if: success() || failure()
+        run: ruff format --check ./pluginify
+
+      - name: Blacken-docs
+        if: success() || failure()
+        run: git ls-files '*.rst' '*.md' | xargs -r blacken-docs --check
+
+      - name: mdformat
+        if: success() || failure()
+        run: mdformat --check .
+
+      - name: actionlint
+        if: success() || failure()
+        run: actionlint
+
+      - name: validate-pyproject
+        if: success() || failure()
+        run: validate-pyproject pyproject.toml
+
+      - name: yamlfmt
+        if: success() || failure()
+        run: yamlfmt -lint
+
+  mypy:
+    continue-on-error: true
+    runs-on: ${{ vars.RUNNER }}
+    steps:
+      - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5  # v4
+
+      - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065  # v5
+        with:
+          python-version: "3.13"
+
+      - uses: astral-sh/setup-uv@d0cc045d04ccac9d8b7881df0226f9e82c39688e  # v6.8.0
+
+      - name: Install package with all extras
+        run: uv pip install -e ".[doc,lint,test]" mypy
+
+      - name: Run mypy
+        run: mypy ./pluginify

pluginify-1.0.0/.github/workflows/deploy-docs.yaml

@@ -0,0 +1,32 @@
+name: Deploy docs
+
+# 1. Tag and Release - on merge of v*-version-release
+#    * Tag current version
+#    * Release just tagged version
+# 2. Package and Publish - on published release (from #1)
+#    * Build wheel
+#    * Publish to pypi
+# 3. Deploy docs - on published release (from #1)
+#    * pip install geoips
+#    * pip install plugin repo
+#    * build docs with geoips/docs/build_docs.sh
+#    * deploy docs with geoips/docs/deploy_pages.sh
+
+on:
+  # Triggers the workflow on published release
+  release:
+    types:
+      - published
+  # Allows run of this workflow manually from the Actions tab
+  # Must be merged to default before it will be available to manually run.
+  workflow_dispatch:
+
+jobs:
+  deploy-docs:
+    name: Deploy docs
+    # You do not appear to be able to use variables in the "uses" field.
+    uses: NRLMMD-GEOIPS/geoips_ci/.github/workflows/reusable-deploy-docs.yaml@main
+    permissions:
+      contents: write
+    secrets:
+      token: ${{ secrets.GITHUB_TOKEN }}

{pluginify-0.1.0 → pluginify-1.0.0}/.github/workflows/generate-badges.yaml

@@ -17,46 +17,46 @@ env:
 
 jobs:
   check-commits:
-    runs-on: ubuntu-latest
+    runs-on: ${{ vars.RUNNER }}
     outputs:
       has_new_commits: ${{ steps.check.outputs.has_new_commits }}
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5  # v4
         with:
           fetch-depth: 0
 
       - name: Check for new commits in last 24 hours
         id: check
         run: |
-          COMMITS=$(git log --oneline --since="25 hours ago" --no-merges | grep -v "\[skip ci\]" | wc -l)
+          COMMITS=$(git log --oneline --since="25 hours ago" --no-merges | grep -c -v "\[skip ci\]")
           if [ "$COMMITS" -gt 0 ]; then
-            echo "has_new_commits=true" >> $GITHUB_OUTPUT
+            echo "has_new_commits=true" >> "$GITHUB_OUTPUT"
             echo "Found $COMMITS new commits in the last 25 hours"
           else
-            echo "has_new_commits=false" >> $GITHUB_OUTPUT
+            echo "has_new_commits=false" >> "$GITHUB_OUTPUT"
             echo "No new commits in the last 25 hours"
           fi
 
   generate-badges:
     needs: check-commits
     if: needs.check-commits.outputs.has_new_commits == 'true'
-    runs-on: ubuntu-latest
+    runs-on: ${{ vars.RUNNER }}
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5  # v4
         with:
           fetch-depth: 0
 
-      - uses: actions/setup-python@v5
+      - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065  # v5
         with:
           python-version: "3.13"
 
-      - uses: astral-sh/setup-uv@v6
+      - uses: astral-sh/setup-uv@d0cc045d04ccac9d8b7881df0226f9e82c39688e  # v6.8.0
 
       - name: Install dependencies
         run: |
-          uv pip install -e .[doc,lint,test]
-          uv pip install pytest mypy ruff commitizen coverage genbadge[all]
+          uv pip install -e ".[doc,lint,test]"
+          uv pip install pytest mypy ruff commitizen coverage "genbadge[all]"
 
       - name: Create directories
         run: |
@@ -95,7 +95,7 @@ jobs:
       - name: Run mypy
         id: mypy
         continue-on-error: true
-        run: mypy ./src --junit-xml reports/mypy.xml || true
+        run: mypy ./pluginify --junit-xml reports/mypy.xml || true
 
       - name: Generate mypy badge
         run: |
@@ -112,7 +112,7 @@ jobs:
       - name: Run ruff
         id: ruff
         continue-on-error: true
-        run: ruff check ./src --output-format=junit -o reports/ruff.xml || true
+        run: ruff check ./pluginify --output-format=junit -o reports/ruff.xml || true
 
       - name: Generate ruff badge
         run: |
@@ -155,31 +155,6 @@ jobs:
           "
           fi
 
-      - uses: actions/setup-node@v4
-        with:
-          node-version: "22"
-
-      - name: Run cspell
-        id: cspell
-        continue-on-error: true
-        run: npx cspell "./src/**/*" --no-progress
-
-      - name: Generate cspell badge
-        run: |
-          if [ "${{ steps.cspell.outcome }}" == "success" ]; then
-            python -c "
-          from genbadge import Badge
-          b = Badge(left_txt='cspell', right_txt='passing', color='brightgreen')
-          b.write_to('.github/badges/cspell-badge.svg', use_shields=False)
-          "
-          else
-            python -c "
-          from genbadge import Badge
-          b = Badge(left_txt='cspell', right_txt='failing', color='red')
-          b.write_to('.github/badges/cspell-badge.svg', use_shields=False)
-          "
-          fi
-
       - name: Check commitizen
         id: commitizen
         continue-on-error: true
@@ -208,10 +183,10 @@ jobs:
         run: |
           git add .github/badges/*.svg
           if git diff --cached --quiet; then
-            echo "has_changes=false" >> $GITHUB_OUTPUT
+            echo "has_changes=false" >> "$GITHUB_OUTPUT"
             echo "No badge changes detected"
           else
-            echo "has_changes=true" >> $GITHUB_OUTPUT
+            echo "has_changes=true" >> "$GITHUB_OUTPUT"
             echo "Badge changes detected:"
             git diff --cached --name-status .github/badges/
           fi
@@ -226,15 +201,16 @@ jobs:
 
       - name: Generate summary
         run: |
-          echo "## Badge Generation Summary" >> $GITHUB_STEP_SUMMARY
-          echo "" >> $GITHUB_STEP_SUMMARY
-          echo "| Check | Status |" >> $GITHUB_STEP_SUMMARY
-          echo "|-------|--------|" >> $GITHUB_STEP_SUMMARY
-          echo "| Pytest & Coverage | ${{ steps.pytest.outcome }} |" >> $GITHUB_STEP_SUMMARY
-          echo "| Mypy | ${{ steps.mypy.outcome }} |" >> $GITHUB_STEP_SUMMARY
-          echo "| Ruff | ${{ steps.ruff.outcome }} |" >> $GITHUB_STEP_SUMMARY
-          echo "| Install | ${{ steps.install.outcome }} |" >> $GITHUB_STEP_SUMMARY
-          echo "| CSpell | ${{ steps.cspell.outcome }} |" >> $GITHUB_STEP_SUMMARY
-          echo "| Commitizen | ${{ steps.commitizen.outcome }} |" >> $GITHUB_STEP_SUMMARY
-          echo "" >> $GITHUB_STEP_SUMMARY
-          echo "Badges committed: ${{ steps.badge_changes.outputs.has_changes }}" >> $GITHUB_STEP_SUMMARY
+          {
+            echo "## Badge Generation Summary"
+            echo ""
+            echo "| Check | Status |"
+            echo "|-------|--------|"
+            echo "| Pytest & Coverage | ${{ steps.pytest.outcome }} |"
+            echo "| Mypy | ${{ steps.mypy.outcome }} |"
+            echo "| Ruff | ${{ steps.ruff.outcome }} |"
+            echo "| Install | ${{ steps.install.outcome }} |"
+            echo "| Commitizen | ${{ steps.commitizen.outcome }} |"
+            echo ""
+            echo "Badges committed: ${{ steps.badge_changes.outputs.has_changes }}"
+          } >> "$GITHUB_STEP_SUMMARY"

pluginify-1.0.0/.github/workflows/package-and-publish.yaml

@@ -0,0 +1,34 @@
+name: Package/publish
+
+# 1. Tag and Release - on merge of v*-version-release
+#    * Tag current version
+#    * Release just tagged version
+# 2. Package and Publish - on published release (from #1)
+#    * Build wheel
+#    * Publish to pypi
+# 3. Deploy docs - on published release (from #1)
+#    * pip install geoips
+#    * pip install plugin repo
+#    * build docs with geoips/docs/build_docs.sh
+#    * deploy docs with geoips/docs/deploy_pages.sh
+
+on:
+  # triggers the workflow on published release
+  release:
+    types:
+      - published
+  # allows run of this workflow manually from the actions tab
+  # must be merged to default before it will be available to manually run.
+  workflow_dispatch:
+
+jobs:
+  package-publish:
+    name: Package/publish
+    # You do not appear to be able to use variables in the "uses" field.
+    uses: NRLMMD-GEOIPS/geoips_ci/.github/workflows/reusable-package-and-publish.yaml@main
+    permissions:
+      contents: read
+    secrets:
+      token: ${{ secrets.GITHUB_TOKEN }}
+      pypi_user: ${{ secrets.PYPI_USER }}
+      pypi_password: ${{ secrets.PYPI_PASSWORD }}

{pluginify-0.1.0 → pluginify-1.0.0}/.github/workflows/status-check.yaml

@@ -11,7 +11,7 @@ permissions:
 
 jobs:
   status-check:
-    runs-on: ubuntu-latest
+    runs-on: ${{ vars.RUNNER }}
     steps:
       - name: No-op status check
         run: echo "No-op Actions workflow to allow enforcing up to date branches before merge"

pluginify-1.0.0/.github/workflows/tag-and-release.yaml

@@ -0,0 +1,27 @@
+name: Tag/release
+
+on:
+  # Triggers the workflow when pull request closed (either closed
+  # as non-planned, or actually approved and merged.)
+  pull_request:
+    types:
+      - closed
+    # You do not appear to be able to use variables in triggers
+    branches:
+      - main
+  # Allows run of this workflow manually from the Actions tab
+  # Must be merged to default branch before it will be available
+  # to manually run.
+  workflow_dispatch:
+
+jobs:
+  tag-release:
+    name: Tag/release
+    # You do not appear to be able to use variables in the "uses" field.
+    uses: NRLMMD-GEOIPS/geoips_ci/.github/workflows/reusable-tag-and-release.yaml@main
+    # Only run this if the pull request was merged, not just closed.
+    if: github.event.pull_request.merged == true
+    permissions:
+      contents: write
+    secrets:
+      token: ${{ secrets.GITHUB_TOKEN }}

{pluginify-0.1.0 → pluginify-1.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pluginify
-Version: 0.1.0
+Version: 1.0.0
 Summary: Pluginify package
 License: LICENSE
 License-File: LICENSE
@@ -24,11 +24,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 +44,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-0.1.0 → pluginify-1.0.0}/README.md

@@ -1,8 +1,9 @@
-    # # # 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
@@ -17,21 +18,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/docs/source/releases/1.0.0/1.0.0-no-bug-fixes-required-on-this-release.yaml

@@ -0,0 +1,17 @@
+documentation:
+- title: Add release note for version 1.19.0
+  description: |
+    Release note on release branch to force tag/release, package/publish,
+    and deploy docs.
+
+    Additionally add any updated files from geoips_ci/sync
+  files:
+    added:
+    - docs/source/releases/latest/1.19.0-release-note.yaml
+    modified:
+    - geoips_ci/sync updated files
+  date:
+    start: 2026-06-05
+    finish: 2026-06-05
+  related-issue:
+    internal: geoips#1067 - 1.19.0 updates

pluginify-1.0.0/docs/source/releases/1.0.0/1.19.0-internal-release.yaml

@@ -0,0 +1,12 @@
+Release Process:
+- title: Add 1.19.0 release note
+  description: |
+    Currently tagged internal version 1.18.2.
+  files:
+    added:
+    - docs/source/releases/1.19.0/1.19.0-internal-release.yaml
+  related-issue:
+    internal: pluginify#1067 - 1.19.0 updates*
+  date:
+    start: 2026-05-26
+    finish: 2026-05-26

pluginify-1.0.0/docs/source/releases/1.0.0/1.19.0-open-source-upload.yaml

@@ -0,0 +1,7 @@
+Release Updates - Open Source Upload:
+- title: Open source upload
+  description: "This repo updated with current geoips version release"
+  files:
+    modified:
+    - standard sync files
+    - release notes

pluginify-1.0.0/docs/source/releases/1.0.0/1.19.0-patch-internal-use-vars-runner.yaml

@@ -0,0 +1,17 @@
+continuous integration:
+- title: 'Use vars.RUNNER for runners'
+  description: |
+    Ensure we are using standard vars.RUNNER for the new pluginify-specific workflows.
+    Eventually we will want to consolidate this CI with the standard actions in
+    geoips_ci, but for now at least use vars.RUNNER.
+  files:
+    added: []
+    modified:
+    - '.github/workflows/generate-badges.yaml'
+    - '.github/workflows/lint-and-test.yaml'
+    deleted: []
+    moved: []
+  date:
+    start: 2026-05-26
+    finish: 2026-05-26
+

pluginify-1.0.0/docs/source/releases/1.0.0/ignore-dot-files-and-dirs.yaml

@@ -0,0 +1,17 @@
+enhancement:
+- title: 'Omit dot files and directories from registry.'
+  description: |
+    Updated plugin registry code to ignore any instance of dot files or directories
+    from the plugin registry. This is a minor update to prevent .ipynb files and other
+    irrelevant files from sometimes leaking into the registry and causing problems
+    (such as duplicate keys).
+  files:
+    modified:
+      - pluginify/create_plugin_registries.py
+  related-issue:
+    number: null
+    repo_url: ''
+  date:
+    start: null
+    finish: null
+

pluginify-1.0.0/docs/source/releases/1.0.0/module-to-class-updates.yaml

@@ -0,0 +1,12 @@
+bug fix:
+- title: 'Fix bug where non-plugin modules are treated like plugins during registry initialization'
+  description: |
+    In GeoIPS 1342 we converted nearly all of the module-based plugins to true
+    class-based plugins. In doing so I discovered a bug where non-plugin modules living
+    in the geoips/plugins/classes/.../ directory caused errors when trying to build
+    the plugin registry. To fix this, I've added a check to see if a module has an
+    'interface' attribute set to None. If that condition is met, then just ignore the
+    module and continue to the next potential plugin.
+  files:
+    modified:
+      - pluginify/create_plugin_registries.py

pluginify-1.0.0/docs/source/releases/1.0.0/obp-plugin-registry-updates.yaml

@@ -0,0 +1,18 @@
+enhancement:
+- title: 'Migrate OBP "expand" functionality to pluginify.'
+  description: |
+    Direct copy over of changes made in a GeoIPS PR to the plugin_registry.py file.
+
+    Changes made added support for pluginify to dynamically 'expand' a workflow if a
+    product, product_default, or workflow was found within a workflow plugin. This is
+    only done if the '_expand' argument is set to True, which is done via the
+    'geoips expand <workflow_name>' command.
+  files:
+    modified:
+      - pluginify/plugin_registry.py
+  related-issue:
+    number: null
+    repo_url: ''
+  date:
+    start: null
+    finish: null

{pluginify-0.1.0 → pluginify-1.0.0}/pluginify/_version.py

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

{pluginify-0.1.0 → pluginify-1.0.0}/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-0.1.0 → pluginify-1.0.0}/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-0.1.0 → pluginify-1.0.0}/pluginify/create_plugin_registries.py

@@ -27,6 +27,7 @@ from os.path import (
     split,
     splitext,
 )
+from pathlib import Path
 import re
 import warnings
 
@@ -481,6 +482,13 @@ def parse_plugin_paths(plugin_paths, package, package_dir, plugins, namespace):
     for plugin_type in plugin_paths:
         # Loop through each file of the current plugin type.
         for filepath in plugin_paths[plugin_type]:
+            # If any 'part' of the full filepath starts with a '.' (dot) directory or
+            # file, do not use this filepath. Just continue to the next filepath
+            # provided. Resolving path to prevent false-positives on "." or ".."
+            # paths for relative paths as an edge case.
+            if any(part.startswith(".") for part in Path(filepath).resolve().parts):
+                continue
+
             filepath = str(filepath)
             # Path relative to the package directory
             relpath = os_relpath(filepath, start=package_dir)
@@ -949,6 +957,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-0.1.0 → pluginify-1.0.0}/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-0.1.0 → pluginify-1.0.0}/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."""