pluginify 1.0.0__tar.gz → 1.0.0.post16.dev0__tar.gz

pluginify-1.0.0.post16.dev0/.github/workflows/integ_test.yaml

@@ -0,0 +1,25 @@
+name: Integration tests
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened, ready_for_review]
+  workflow_dispatch:
+
+concurrency:
+  group: integ-test-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  integ-test:
+    if: github.event_name == 'workflow_dispatch' || github.event.pull_request.draft == false
+    uses: NRLMMD-GEOIPS/geoips_ci/.github/workflows/reusable-ci.yaml
+    # reusable-ci's job requests these; a called workflow cannot exceed the caller.
+    permissions:
+      contents: read
+      packages: write
+    with:
+      geoips_image: "ghcr.io/nrlmmd-geoips/geoips:latest"
+      run_core_tests: true
+    secrets:
+      token: ${{ secrets.GITHUB_TOKEN }}
+      docker_token: ${{ secrets.DOCKER_TOKEN }}

pluginify-1.0.0.post16.dev0/.github/workflows/mypy.yaml

@@ -0,0 +1,39 @@
+name: mypy
+
+# Lint, unit tests and the geoips unit tests are in integ_test.yaml (geoips_ci's
+# reusable-ci). It does not type check, so mypy stays here.
+
+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:
+  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
+        run: uv pip install -e ".[doc]" mypy
+
+      - name: Run mypy
+        run: mypy ./pluginify

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

@@ -2,6 +2,7 @@ name: Require up-to-date branch
 
 on:
   pull_request:
+    types: [opened, synchronize, reopened, ready_for_review]
   push:
     branches:
       - main
@@ -11,6 +12,7 @@ permissions:
 
 jobs:
   status-check:
+    if: github.event_name == 'push' || github.event.pull_request.draft == false
     runs-on: ${{ vars.RUNNER }}
     steps:
       - name: No-op status check

{pluginify-1.0.0 → pluginify-1.0.0.post16.dev0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pluginify
-Version: 1.0.0
+Version: 1.0.0.post16.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)

pluginify-1.0.0.post16.dev0/docs/source/releases/latest/atomic-registry-writes.yaml

@@ -0,0 +1,22 @@
+bug fix:
+- title: 'Write plugin registries atomically'
+  description: |
+    Plugin registries were rewritten in place, so another process reading a
+    registry at the same time (for example parallel pytest-xdist workers, one of
+    them rebuilding the registries) could read an empty or partial file and fail
+    with ``JSONDecodeError``. Registries are now written to a temporary file in
+    the same directory and moved into place with ``os.replace``.
+  files:
+    deleted:
+    - ''
+    modified:
+    - 'pluginify/create_plugin_registries.py'
+    - 'tests/unit_tests/plugin_registries/test_plugin_registries.py'
+    added:
+    - ''
+  related-issue:
+    number: null
+    repo_url: 'https://github.com/NRLMMD-GEOIPS/pluginify'
+  date:
+    start: 2026-10-01
+    finish: 2026-10-01

pluginify-1.0.0.post16.dev0/docs/source/releases/latest/fix-concurrent-writes.yaml

@@ -0,0 +1,16 @@
+bug fix:
+- title: "Use NamedTemporaryFile for safer writes"
+  description: |
+    Plugin registry temp files were still having conflicts when
+    written by threads in the same process. To fix this I switched
+    to using tempfile.NamedTemporaryFile which is guaranteed to
+    avoid conflicts.
+  files:
+    modified:
+    - pluginfiy/create_plugin_registries.py
+  related-issue:
+    number: null
+    repo_url: ''
+  date:
+    start: 2026-10-30
+    finish: 2026-10-30

pluginify-1.0.0.post16.dev0/docs/source/releases/latest/ignore-files-in-utils-directories.yaml

@@ -0,0 +1,17 @@
+bug fix:
+- title: 'Force ignore files in directories named */utils/'
+  description: 'Force ignore files in directories named */utils/'
+  files:
+    deleted:
+    - ''
+    modified:
+    - 'pluginify/create_plugin_registries.py'
+    - 'tests/unit_tests/plugin_registries/test_plugin_registries.py'
+    added:
+    - ''
+  related-issue:
+    number: null
+    repo_url: ''
+  date:
+    start: 2026-07-12
+    finish: 2026-07-12

pluginify-1.0.0.post16.dev0/docs/source/releases/latest/use-geoips-ci.yaml

@@ -0,0 +1,32 @@
+continuous integration:
+- title: 'Use the standard GeoIPS CI from geoips_ci'
+  description: |
+    Run geoips_ci's reusable-ci on pull requests, like geoips and the plugin
+    repositories: geoips' lint (flake8, black, bandit), pluginify's unit tests, and
+    geoips' unit tests against the pluginify branch, in the geoips:latest image.
+    Remove the code-quality and nightly badge workflows and the unused badges; mypy
+    keeps its own workflow, since reusable-ci does not type check. Skip draft pull
+    requests in the status check, like geoips.
+  files:
+    deleted:
+    - '.github/badges/coverage-badge.svg'
+    - '.github/badges/cspell-badge.svg'
+    - '.github/badges/install-badge.svg'
+    - '.github/badges/mypy-badge.svg'
+    - '.github/badges/ruff-badge.svg'
+    - '.github/badges/tests-badge.svg'
+    - '.github/workflows/code-quality.yaml'
+    - '.github/workflows/generate-badges.yaml'
+    modified:
+    - '.github/workflows/status-check.yaml'
+    - 'docs/source/releases/latest/ignore-files-in-utils-directories.yaml'
+    added:
+    - '.github/workflows/integ_test.yaml'
+    - '.github/workflows/mypy.yaml'
+    - 'docs/source/releases/latest/use-geoips-ci.yaml'
+  related-issue:
+    number: null
+    repo_url: ''
+  date:
+    start: 2026-10-20
+    finish: 2026-10-20

{pluginify-1.0.0 → pluginify-1.0.0.post16.dev0}/pluginify/_version.py

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

{pluginify-1.0.0 → pluginify-1.0.0.post16.dev0}/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 makedirs, remove, replace
 from os.path import (
     basename,
     dirname,
@@ -29,6 +29,7 @@ from os.path import (
 )
 from pathlib import Path
 import re
+import tempfile
 import warnings
 
 import yaml
@@ -317,14 +318,33 @@ 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 = None
+    try:
+        with tempfile.NamedTemporaryFile(
+            mode="w",
+            dir=dirname(reg_plug_abspath),
+            suffix=".tmp",
+            delete=False,
+        ) as plugin_registry:
+            tmp_abspath = plugin_registry.name
+            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)
+    finally:
+        if tmp_abspath is not None:
+            try:
+                remove(tmp_abspath)
+            except FileNotFoundError:
+                pass
 
 
 def create_plugin_registries(plugin_packages, save_type, namespace):
@@ -934,6 +954,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.

{pluginify-1.0.0 → pluginify-1.0.0.post16.dev0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pluginify" # package available at the root of the project
-version = "1.0.0"
+version = "1.0.0.post16.dev0"
 description = "Pluginify package"
 authors = ["Evan Rose", "evrose54@colostate.edu"]
 readme = "README.md"

{pluginify-1.0.0 → pluginify-1.0.0.post16.dev0}/tests/unit_tests/plugin_registries/test_plugin_registries.py

@@ -4,6 +4,7 @@
 """TestPluginRegistry Class used for Unit Testing the Plugin Registries."""
 
 from glob import glob
+import json
 import logging
 from os.path import basename, splitext
 
@@ -11,6 +12,10 @@ import pytest
 import yaml
 
 from pluginify.errors import PluginError, PluginRegistryError
+from pluginify.create_plugin_registries import (
+    add_class_plugin,
+    write_registered_plugins,
+)
 from pluginify.interfaces import configs
 from pluginify.interfaces import data_modifiers
 from pluginify.utils.validators import PluginRegistryValidator
@@ -18,6 +23,21 @@ from pluginify.utils.validators import PluginRegistryValidator
 LOG = logging.getLogger(__name__)
 
 
+@pytest.mark.parametrize("save_type", ["json", "yaml"])
+def test_write_registered_plugins_replaces_file(tmp_path, save_type):
+    """Write a registry over an existing one, leaving no temporary files behind."""
+    reg_path = tmp_path / f"registered_plugins.{save_type}"
+    reg_path.write_text("old")
+    plugins = {"algorithms": {"fake_plugin": {"package": "fake"}}}
+
+    write_registered_plugins(str(tmp_path), plugins, save_type)
+
+    with open(reg_path) as fo:
+        written = json.load(fo) if save_type == "json" else yaml.safe_load(fo)
+    assert written == plugins
+    assert [p.name for p in tmp_path.iterdir()] == [reg_path.name]
+
+
 class FakeInterface:
     """Dummy fake interface used to cause appropriate errors from the PluginRegistry."""
 
@@ -124,6 +144,15 @@ class TestPluginRegistry:
         )
         assert self.real_reg_validator.registered_plugins
 
+    def test_utils_modules_are_skipped(self):
+        """Ensure utility modules under plugin trees are not registered as plugins."""
+        plugins = {}
+        error_message = add_class_plugin(
+            "pluginify", "plugins/classes/data_modifiers/utils/helper.py", plugins
+        )
+        assert error_message == ""
+        assert plugins == {}
+
     def test_disabled_registry_creation(self):
         """Assert that the registries are not automatically rebuilt.
 

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

@@ -1,87 +0,0 @@
-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/generate-badges.yaml

@@ -1,216 +0,0 @@
-name: Nightly Badge Generation
-
-on:
-  schedule:
-    - cron: '0 2 * * *'
-  workflow_dispatch:
-
-permissions:
-  contents: write
-
-concurrency:
-  group: ${{ github.workflow }}-${{ github.ref }}
-  cancel-in-progress: true
-
-env:
-  UV_SYSTEM_PYTHON: true
-
-jobs:
-  check-commits:
-    runs-on: ${{ vars.RUNNER }}
-    outputs:
-      has_new_commits: ${{ steps.check.outputs.has_new_commits }}
-    steps:
-      - 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 -c -v "\[skip ci\]")
-          if [ "$COMMITS" -gt 0 ]; then
-            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 "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: ${{ vars.RUNNER }}
-
-    steps:
-      - uses: actions/checkout@34e114876b0b11c390a56381ad16ebd13914f8d5  # v4
-        with:
-          fetch-depth: 0
-
-      - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065  # v5
-        with:
-          python-version: "3.13"
-
-      - 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]"
-
-      - name: Create directories
-        run: |
-          mkdir -p .github/badges
-          mkdir -p reports
-
-      - name: Run pytest with coverage
-        id: pytest
-        continue-on-error: true
-        run: coverage run -m pytest --junitxml=reports/junit.xml
-
-      - name: Generate pytest badge
-        run: |
-          if [ -f reports/junit.xml ]; then
-            genbadge tests -i reports/junit.xml -o .github/badges/tests-badge.svg -n "tests"
-          else
-            python -c "
-          from genbadge import Badge
-          b = Badge(left_txt='tests', right_txt='error', color='red')
-          b.write_to('.github/badges/tests-badge.svg', use_shields=False)
-          "
-          fi
-
-      - name: Generate coverage badge
-        run: |
-          if [ -f coverage.xml ]; then
-            genbadge coverage -i coverage.xml -o .github/badges/coverage-badge.svg -n "coverage"
-          else
-            python -c "
-          from genbadge import Badge
-          b = Badge(left_txt='coverage', right_txt='error', color='red')
-          b.write_to('.github/badges/coverage-badge.svg', use_shields=False)
-          "
-          fi
-
-      - name: Run mypy
-        id: mypy
-        continue-on-error: true
-        run: mypy ./pluginify --junit-xml reports/mypy.xml || true
-
-      - name: Generate mypy badge
-        run: |
-          if [ -f reports/mypy.xml ]; then
-            genbadge tests -i reports/mypy.xml -o .github/badges/mypy-badge.svg -n "mypy"
-          else
-            python -c "
-          from genbadge import Badge
-          b = Badge(left_txt='mypy', right_txt='passing', color='brightgreen')
-          b.write_to('.github/badges/mypy-badge.svg', use_shields=False)
-          "
-          fi
-
-      - name: Run ruff
-        id: ruff
-        continue-on-error: true
-        run: ruff check ./pluginify --output-format=junit -o reports/ruff.xml || true
-
-      - name: Generate ruff badge
-        run: |
-          if [ -f reports/ruff.xml ] && [ -s reports/ruff.xml ]; then
-            if grep -q "<testcase" reports/ruff.xml; then
-              genbadge tests -i reports/ruff.xml -o .github/badges/ruff-badge.svg -n "ruff"
-            else
-              python -c "
-          from genbadge import Badge
-          b = Badge(left_txt='ruff', right_txt='passing', color='brightgreen')
-          b.write_to('.github/badges/ruff-badge.svg', use_shields=False)
-          "
-            fi
-          else
-            python -c "
-          from genbadge import Badge
-          b = Badge(left_txt='ruff', right_txt='passing', color='brightgreen')
-          b.write_to('.github/badges/ruff-badge.svg', use_shields=False)
-          "
-          fi
-
-      - name: Test install
-        id: install
-        continue-on-error: true
-        run: uv pip install -e . --reinstall
-
-      - name: Generate install badge
-        run: |
-          if [ "${{ steps.install.outcome }}" == "success" ]; then
-            python -c "
-          from genbadge import Badge
-          b = Badge(left_txt='install', right_txt='passing', color='brightgreen')
-          b.write_to('.github/badges/install-badge.svg', use_shields=False)
-          "
-          else
-            python -c "
-          from genbadge import Badge
-          b = Badge(left_txt='install', right_txt='failing', color='red')
-          b.write_to('.github/badges/install-badge.svg', use_shields=False)
-          "
-          fi
-
-      - name: Check commitizen
-        id: commitizen
-        continue-on-error: true
-        env:
-          COMMITIZEN_START_REV: "9d83e6984277ccbe6c5f6713f65b75a90e7c7e40"
-        run: cz check --rev-range ${{ env.COMMITIZEN_START_REV }}..HEAD
-
-      - name: Generate commitizen badge
-        run: |
-          if [ "${{ steps.commitizen.outcome }}" == "success" ]; then
-            python -c "
-          from genbadge import Badge
-          b = Badge(left_txt='commitizen', right_txt='passing', color='brightgreen')
-          b.write_to('.github/badges/commitizen-badge.svg', use_shields=False)
-          "
-          else
-            python -c "
-          from genbadge import Badge
-          b = Badge(left_txt='commitizen', right_txt='failing', color='red')
-          b.write_to('.github/badges/commitizen-badge.svg', use_shields=False)
-          "
-          fi
-
-      - name: Check for badge changes
-        id: badge_changes
-        run: |
-          git add .github/badges/*.svg
-          if git diff --cached --quiet; then
-            echo "has_changes=false" >> "$GITHUB_OUTPUT"
-            echo "No badge changes detected"
-          else
-            echo "has_changes=true" >> "$GITHUB_OUTPUT"
-            echo "Badge changes detected:"
-            git diff --cached --name-status .github/badges/
-          fi
-
-      - name: Commit and push badges
-        if: steps.badge_changes.outputs.has_changes == 'true'
-        run: |
-          git config --local user.email "github-actions[bot]@users.noreply.github.com"
-          git config --local user.name "github-actions[bot]"
-          git commit -m "chore: update badges [skip ci]"
-          git push
-
-      - name: Generate summary
-        run: |
-          {
-            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"