py-api-dumper 4.2.0__tar.gz → 4.2.3__tar.gz

py_api_dumper-4.2.3/.github/dependabot.yml

@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+
+version: 2
+updates:
+  - package-ecosystem: "pip" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"

py_api_dumper-4.2.3/.github/workflows/publish.yml

@@ -0,0 +1,76 @@
+name: Publish package
+
+on:
+  push:
+    tags:
+      - 'v*'
+  workflow_dispatch: null
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+
+    environment: ${{ github.event_name == 'workflow_dispatch' && 'testpypi' || 'pypi' }}
+
+    permissions:
+      id-token: write
+      attestations: write
+      contents: read
+
+    env:
+      SETUPTOOLS_SCM_OVERRIDES_FOR_PY_API_DUMPER: '{local_scheme="no-local-version"}'
+
+    steps:
+      - name: Checkout source code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+
+      - name: Initialise project
+        uses: nick-fields/retry@v2
+        with:
+          timeout_minutes: 5
+          max_attempts: 3
+          retry_wait_seconds: 30
+          command: |
+            python -m pip install --upgrade pip
+            python -m pip install ppqs
+            ppqs init
+            ppqs version
+
+      - name: Perform linting checks
+        run: |
+          ppqs lint
+
+      - name: Build project
+        run: |
+          ppqs build
+
+      - name: Run tests
+        run: |
+          ppqs test
+
+      - name: Validate metadata
+        run: |
+          twine check dist/*
+
+      - name: Attest build
+        uses: actions/attest-build-provenance@v2
+        with:
+          subject-path: "dist/*"
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        if: ${{ github.event_name == 'push' }}
+
+      - name: Publish to TestPyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        if: ${{ github.event_name == 'workflow_dispatch' }}
+        with:
+          repository-url: https://test.pypi.org/legacy/
+          skip-existing: true

py_api_dumper-4.2.3/.github/workflows/test.yml

@@ -0,0 +1,72 @@
+name: Test package
+
+on:
+  push:
+    branches:
+      - "*"
+  pull_request:
+    branches:
+      - "*"
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version:
+          - "3.11"
+          - "3.12"
+          - "3.13"
+          - "3.14"
+          - "3.15"
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Initialise project
+        uses: nick-fields/retry@v2
+        with:
+          timeout_minutes: 5
+          max_attempts: 3
+          retry_wait_seconds: 30
+          command: |
+            python -m pip install --upgrade pip
+            python -m pip install ppqs
+            ppqs init
+            ppqs version
+
+      - name: Perform linting checks
+        run: |
+          ppqs lint
+
+      - name: Build project
+        run: |
+          ppqs build
+
+      - name: Run tests
+        run: |
+          ppqs test
+
+      - name: Clean up build files
+        run: |
+          ppqs clean
+
+  all-done:
+    runs-on: ubuntu-latest
+
+    needs: test
+
+    steps:
+      - name: All done
+        run: |
+          echo All done

py_api_dumper-4.2.3/.gitignore

@@ -0,0 +1,8 @@
+.coverage
+/dist
+/src/*.egg-info
+/test/*.tmp
+/test/*.tmp.gz
+/test/api_ref/*.o
+/test/api_ref/*.so
+__pycache__

py_api_dumper-4.2.3/.pre-commit-config.yaml

@@ -0,0 +1,43 @@
+default_install_hook_types: [pre-commit, post-commit]
+
+repos:
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v6.0.0
+    hooks:
+      - id: mixed-line-ending
+        args: [--fix=lf]
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-added-large-files
+      - id: check-toml
+      - id: check-yaml
+      - id: file-contents-sorter
+        args: [--unique]
+        files: ^\.gitattributes$|^\.gitignore$|^requirements-dev\.txt$
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.17.4
+    hooks:
+      - id: ruff-check
+
+  - repo: https://github.com/jsh9/pydoclint
+    rev: 0.12.0
+    hooks:
+      - id: pydoclint
+
+  - repo: https://github.com/assorted-pre-commit-hooks/copyright
+    rev: v0.12
+    hooks:
+      - id: copyright
+
+  - repo: https://github.com/psf/black
+    rev: 26.10.1
+    hooks:
+      - id: black
+        args: [--target-version=py311]
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v2.4.1
+    hooks:
+      - id: mypy

py_api_dumper-4.2.3/LICENSES/MIT.txt

@@ -0,0 +1,18 @@
+MIT License
+
+Copyright (c) 2025 Karl Wette
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
+associated documentation files (the "Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the
+following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial
+portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
+LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO
+EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
+USE OR OTHER DEALINGS IN THE SOFTWARE.

{py_api_dumper-4.2.0/src/py_api_dumper.egg-info → py_api_dumper-4.2.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: py-api-dumper
-Version: 4.2.0
+Version: 4.2.3
 Summary: Python API dumping and comparison tool
 Author-email: Karl Wette <karl.wette@anu.edu.au>
 License-Expression: MIT
@@ -8,7 +8,7 @@ Project-URL: Homepage, https://github.com/kwwette/py-api-dumper
 Project-URL: Issues, https://github.com/kwwette/py-api-dumper/issues
 Classifier: Programming Language :: Python :: 3
 Classifier: Operating System :: OS Independent
-Requires-Python: >=3.10
+Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSES/MIT.txt
 License-File: LICENSES/CC0-1.0.txt

py_api_dumper-4.2.3/REUSE.toml

@@ -0,0 +1,23 @@
+version = 1
+
+[[annotations]]
+path = [
+    ".github/**",
+    ".gitignore",
+    ".pre-commit-config.yaml",
+    "MANIFEST.in",
+    "README.md",
+    "pyproject.toml",
+    "requirements-dev.txt",
+    "test/api_ref/api_ref.txt",
+]
+SPDX-FileCopyrightText = "NONE"
+SPDX-License-Identifier = "CC0-1.0"
+
+[[annotations]]
+path = [
+    "src/**/*.py",
+    "test/**/*.c",
+    "test/**/*.py",
+]
+SPDX-License-Identifier = "MIT"

{py_api_dumper-4.2.0 → py_api_dumper-4.2.3}/pyproject.toml

@@ -1,5 +1,5 @@
 [build-system]
-requires = ["setuptools>=64.0"]
+requires = ["setuptools>=80", "setuptools-scm>=8"]
 build-backend = "setuptools.build_meta"
 
 [project]
@@ -8,10 +8,13 @@ description = "Python API dumping and comparison tool"
 authors = [
     { name = "Karl Wette", email = "karl.wette@anu.edu.au" },
 ]
-requires-python = ">=3.10"
+requires-python = ">=3.11"
 readme = "README.md"
 license = "MIT"
-license-files = ["LICENSES/MIT.txt", "LICENSES/CC0-1.0.txt"]
+license-files = [
+    'LICENSES/MIT.txt',
+    'LICENSES/CC0-1.0.txt',
+]
 classifiers = [
     "Programming Language :: Python :: 3",
     "Operating System :: OS Independent",
@@ -25,8 +28,9 @@ Issues = "https://github.com/kwwette/py-api-dumper/issues"
 [project.scripts]
 py-api-dumper = "py_api_dumper.cli:cli"
 
-[tool.setuptools.dynamic]
-version = {attr = "py_api_dumper.__version__"}
+[tool.setuptools_scm]
+scm.git.pre_parse = "fail_on_shallow"
+local_scheme = "node-and-timestamp"
 
 [tool.ruff]
 fix = true
@@ -88,12 +92,28 @@ script = """
 python -m pytest ...
 """
 
+[tool.ppqs.scripts.version]
+description = "Print the current package version"
+script = "python -m setuptools_scm"
+
+[tool.ppqs.scripts.tag]
+description = "Tag a release"
+script = [
+    ["git", "status"],
+    ["git", "diff", "--quiet", "--exit-code"],
+    ["ppqs", "lint"],
+    ["ppqs", "build"],
+    ["ppqs", "test"],
+    ["git", "commit", "--allow-empty", "-m", "Version {1}.{2}.{3}"],
+    ["git", "tag", "-a", "-m", "Version {1}.{2}.{3}", "v{1}.{2}.{3}"],
+]
+
 [tool.ppqs.scripts.upload]
 description = "Upload package"
 script = [
-    ["ppqs", "test"],
+    ["ppqs", "lint"],
     ["ppqs", "build"],
-    ["twine", "upload", ["dist", "*"]],
+    ["ppqs", "test"],
     ["git", "push", "origin"],
     ["git", "push", "origin", "--tags"],
 ]

py_api_dumper-4.2.3/requirements-dev.txt

@@ -0,0 +1,8 @@
+build>=1.6.1
+coverage>=7.17.1
+pre-commit>=3.7
+pytest-cov>=7.1.0
+pytest>=9.2.0
+setuptools-scm>=8
+setuptools>=80
+twine>=7.0.0

{py_api_dumper-4.2.0 → py_api_dumper-4.2.3}/src/py_api_dumper/__init__.py

@@ -12,6 +12,7 @@ import inspect
 import json
 import pkgutil
 import sys
+from importlib.metadata import PackageNotFoundError, version
 from pathlib import Path
 from types import ModuleType, NoneType
 from typing import (
@@ -30,7 +31,11 @@ from typing import (
 )
 
 __author__ = "Karl Wette"
-__version__ = "4.2.0"
+
+try:
+    __version__ = version("py-api-dumper")
+except PackageNotFoundError:  # pragma: no cover
+    __version__ = "0.0.0.dev0"
 
 APIFilterType = TypeVar("APIFilterType", bound="APIFilter")
 APIDumpType = TypeVar("APIDumpType", bound="APIDump")
@@ -535,6 +540,7 @@ class APIDiff:
         self,
         old: APIDump,
         new: APIDump,
+        ignore_filters: Optional[List[APIFilter]] = None,
     ):
         """Differences between two Python public API dumps.
 
@@ -543,6 +549,8 @@ class APIDiff:
                 Dump of the old public API.
             new (APIDump):
                 Dump of the new public API.
+            ignore_filters (Optional[List[APIFilter]]):
+                Remove API entries that match filters.
         """
 
         self.old_dump_file = old.dump_file
@@ -551,6 +559,11 @@ class APIDiff:
         self.new_dump_file = new.dump_file
         self.new_modules = new.modules
 
+        # Apply filters
+        if ignore_filters and len(ignore_filters) > 0:
+            old = old.apply_ignore_filter(ignore_filters)
+            new = new.apply_ignore_filter(ignore_filters)
+
         # Entries removed from `new` that remain in `old`
         self.removed = frozenset(old.api - new.api)
 
@@ -562,7 +575,7 @@ class APIDiff:
         cls: Type[APIDiffType],
         old_dump_file: Union[Path, str],
         new_dump_file: Union[Path, str],
-        ignore_filters: Optional[List[APIFilterType]] = None,
+        ignore_filters: Optional[List[APIFilter]] = None,
     ) -> APIDiffType:
         """Differences between two Python public API dumps loaded from files.
 
@@ -571,7 +584,7 @@ class APIDiff:
                 Name of file containing dump of the old public API.
             new_dump_file (Union[Path, str]):
                 Name of file containing dump of the new public API.
-            ignore_filters (Optional[List[APIFilterType]]):
+            ignore_filters (Optional[List[APIFilter]]):
                 Remove API entries that match filters.
 
         Returns:
@@ -582,13 +595,8 @@ class APIDiff:
         old = APIDump.load_from_file(old_dump_file)
         new = APIDump.load_from_file(new_dump_file)
 
-        # Apply filters
-        if ignore_filters and len(ignore_filters) > 0:
-            old = old.apply_ignore_filter(ignore_filters)
-            new = new.apply_ignore_filter(ignore_filters)
-
         # Create instance
-        inst = cls(old, new)
+        inst = cls(old, new, ignore_filters)
 
         return inst
 

{py_api_dumper-4.2.0 → py_api_dumper-4.2.3/src/py_api_dumper.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: py-api-dumper
-Version: 4.2.0
+Version: 4.2.3
 Summary: Python API dumping and comparison tool
 Author-email: Karl Wette <karl.wette@anu.edu.au>
 License-Expression: MIT
@@ -8,7 +8,7 @@ Project-URL: Homepage, https://github.com/kwwette/py-api-dumper
 Project-URL: Issues, https://github.com/kwwette/py-api-dumper/issues
 Classifier: Programming Language :: Python :: 3
 Classifier: Operating System :: OS Independent
-Requires-Python: >=3.10
+Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSES/MIT.txt
 License-File: LICENSES/CC0-1.0.txt

{py_api_dumper-4.2.0 → py_api_dumper-4.2.3}/src/py_api_dumper.egg-info/SOURCES.txt

@@ -1,6 +1,14 @@
+.gitignore
+.pre-commit-config.yaml
+LICENSE
 MANIFEST.in
 README.md
+REUSE.toml
 pyproject.toml
+requirements-dev.txt
+.github/dependabot.yml
+.github/workflows/publish.yml
+.github/workflows/test.yml
 LICENSES/CC0-1.0.txt
 LICENSES/MIT.txt
 src/py_api_dumper/__init__.py
@@ -9,6 +17,8 @@ src/py_api_dumper.egg-info/PKG-INFO
 src/py_api_dumper.egg-info/SOURCES.txt
 src/py_api_dumper.egg-info/dependency_links.txt
 src/py_api_dumper.egg-info/entry_points.txt
+src/py_api_dumper.egg-info/scm_file_list.json
+src/py_api_dumper.egg-info/scm_version.json
 src/py_api_dumper.egg-info/top_level.txt
 test/conftest.py
 test/setup.py

py_api_dumper-4.2.3/src/py_api_dumper.egg-info/scm_file_list.json

@@ -0,0 +1,29 @@
+{
+  "files": [
+    ".github/dependabot.yml",
+    ".github/workflows/publish.yml",
+    ".github/workflows/test.yml",
+    ".gitignore",
+    ".pre-commit-config.yaml",
+    "LICENSE",
+    "LICENSES/CC0-1.0.txt",
+    "LICENSES/MIT.txt",
+    "MANIFEST.in",
+    "README.md",
+    "REUSE.toml",
+    "pyproject.toml",
+    "requirements-dev.txt",
+    "src/py_api_dumper/__init__.py",
+    "src/py_api_dumper/cli.py",
+    "test/api_ref/__init__.py",
+    "test/api_ref/_priv_mod.py",
+    "test/api_ref/api_ref.txt",
+    "test/api_ref/ext_mod.c",
+    "test/api_ref/pub_mod.py",
+    "test/conftest.py",
+    "test/other_mod/__init__.py",
+    "test/setup.py",
+    "test/test_diff.py",
+    "test/test_dump.py"
+  ]
+}

py_api_dumper-4.2.3/src/py_api_dumper.egg-info/scm_version.json

@@ -0,0 +1,8 @@
+{
+  "tag": "4.2.3",
+  "distance": 0,
+  "node": "g0c9a3cff8e57e79e4f097f7d90dbd5b5993f18f0",
+  "dirty": false,
+  "branch": "HEAD",
+  "node_date": "2026-11-07"
+}