pyapi-checker 0.11.0__py3-none-any.whl

pyapi/__init__.py

@@ -0,0 +1,17 @@
+"""
+Copyright 2025 Palantir Technologies, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+"""
+
+from ._version import __version__ as __version__

pyapi/__main__.py

@@ -0,0 +1,20 @@
+"""
+Copyright 2025 Palantir Technologies, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+"""
+
+if __name__ == "__main__":
+    from pyapi.cli import app
+
+    app()

pyapi/_version.py

@@ -0,0 +1,34 @@
+# file generated by setuptools-scm
+# don't change, don't track in version control
+
+__all__ = [
+    "__version__",
+    "__version_tuple__",
+    "version",
+    "version_tuple",
+    "__commit_id__",
+    "commit_id",
+]
+
+TYPE_CHECKING = False
+if TYPE_CHECKING:
+    from typing import Tuple
+    from typing import Union
+
+    VERSION_TUPLE = Tuple[Union[int, str], ...]
+    COMMIT_ID = Union[str, None]
+else:
+    VERSION_TUPLE = object
+    COMMIT_ID = object
+
+version: str
+__version__: str
+__version_tuple__: VERSION_TUPLE
+version_tuple: VERSION_TUPLE
+commit_id: COMMIT_ID
+__commit_id__: COMMIT_ID
+
+__version__ = version = '0.11.0'
+__version_tuple__ = version_tuple = (0, 11, 0)
+
+__commit_id__ = commit_id = None

pyapi/aexpy_api_processor.py

@@ -0,0 +1,136 @@
+"""
+Copyright 2025 Palantir Technologies, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+"""
+
+import json
+from pathlib import Path
+from subprocess import CalledProcessError
+from typing import Any
+
+from aexpy.models.difference import BreakingRank
+
+from .api_processor import APIProcessor, CannotFindAPIVersionError
+from .constants import PYAPI_BUILD_DIR
+from .utils import run
+
+
+class AexpyAPIProcessor(APIProcessor):
+    def __init__(self, project_path: Path, project_name: str, python_index: str):
+        self._project_path = project_path
+        self._python_index = python_index
+        self._build_dir = self._project_path / PYAPI_BUILD_DIR
+        self._project_name = project_name
+
+    def check_api(self, previous_version: str) -> list[str]:
+        wheel = self._download_wheel(self._project_path.name, previous_version)
+        preprocessed_output = self._preprocess()
+        extracted1 = self._extract_from_wheel(wheel, previous_version)
+        extracted2 = self._extract_from_preprocessed(preprocessed_output)
+        diff_output = self._diff(extracted1, extracted2, previous_version)
+        return self._parse_diff(diff_output)
+
+    def _download_wheel(self, package_name: str, version: str) -> Path:
+        download_dir = self._build_dir / "downloads"
+        download_dir.mkdir(parents=True, exist_ok=True)
+        wheel_glob_pattern = f"{self._project_name.replace('-', '_')}-{version}*.whl"
+        present_wheels = list(download_dir.glob(wheel_glob_pattern))
+        if len(present_wheels) == 1:
+            return present_wheels[0]
+        elif len(present_wheels) > 1:
+            raise RuntimeError(f"Multiple wheels found before download for {package_name} {version} in {download_dir}.")
+        # If not found delete any previously downloaded wheels.
+        for dist in download_dir.glob("*"):
+            dist.unlink()
+        try:
+            self._run_python_module(
+                [
+                    "pip",
+                    "download",
+                    f"{self._project_name}=={version}",
+                    "--index-url",
+                    self._python_index,
+                    "--no-deps",
+                    "--only-binary=:all:",
+                    "-d",
+                    str(download_dir),
+                ]
+            )
+        except CalledProcessError as e:
+            if "Could not find a version that satisfies the requirement" in e.stderr.decode("utf-8"):
+                raise CannotFindAPIVersionError(f"Cannot find {package_name} {version} in Python index.", e)
+            raise e
+        present_wheels = list(download_dir.glob(wheel_glob_pattern))
+        if len(present_wheels) == 1:
+            return present_wheels[0]
+        elif len(present_wheels) > 1:
+            raise RuntimeError(f"Multiple wheels found after download for {package_name} {version} in {download_dir}.")
+        raise CannotFindAPIVersionError(f"Failed to download {package_name} {version} from Python index.")
+
+    def _preprocess(self) -> Path:
+        preprocessed_output = self._build_dir / f"preprocessed-{self._project_path.name}-source.json"
+        self._run_aexpy(["preprocess", "-s", str(self._project_path), str(preprocessed_output)])
+        return preprocessed_output
+
+    def _extract_from_preprocessed(self, preprocessed_output: Path) -> Path:
+        extracted_output = self._build_dir / f"extracted-{self._project_path.name}-source.json"
+        self._run_aexpy(["extract", str(preprocessed_output), str(extracted_output)])
+        return extracted_output
+
+    def _extract_from_wheel(self, distribution: Path, version: str) -> Path:
+        extracted_output = self._build_dir / f"extracted-{self._project_path.name}-{version}.json"
+        if extracted_output.exists():
+            return extracted_output
+        # Remove previous extracted json files from wheels.
+        for file in self._build_dir.glob(f"extracted-{self._project_path.name}-*.*.*.json"):
+            file.unlink()
+        self._run_aexpy(["extract", "-w", str(distribution), str(extracted_output)])
+        return extracted_output
+
+    def _diff(self, extracted1: Path, extracted2: Path, version: str) -> Path:
+        diff_output = self._build_dir / f"diff-{self._project_path.name}-{version}.json"
+        # TODO(BenjaminLowry): hash source files so we can use old preprocessed and diff files for efficiency.
+        # Remove previous diff json files.
+        for file in self._build_dir.glob(f"diff-{self._project_path.name}-*.*.*.json"):
+            file.unlink()
+        self._run_aexpy(["diff", str(extracted1), str(extracted2), str(diff_output)])
+        return diff_output
+
+    def _parse_diff(self, diff_output: Path) -> list[str]:
+        diff_json: dict[str, Any] = json.loads(diff_output.read_text())
+        maybe_entries = diff_json.get("entries")
+        if maybe_entries is None:
+            raise RuntimeError(f"Failed to parse diff output: cannot find 'entries' field in {diff_output}")
+        api_breaks = []
+        for entry in maybe_entries.values():
+            maybe_rank = entry.get("rank")
+            if maybe_rank is None:
+                raise RuntimeError(f"Failed to parse diff output: cannot find 'rank' field in {diff_output}")
+            if maybe_rank != BreakingRank.High.value and maybe_rank != BreakingRank.Medium.value:
+                continue
+
+            maybe_kind = entry.get("kind")
+            if not maybe_kind:
+                raise RuntimeError(f"Failed to parse diff output: cannot find 'kind' field in {diff_output}")
+            maybe_message = entry.get("message")
+            if not maybe_message:
+                raise RuntimeError(f"Failed to parse diff output: cannot find 'message' field in {diff_output}")
+            api_breaks.append(f"{maybe_kind}: {maybe_message}")
+        return api_breaks
+
+    def _run_aexpy(self, args: list[str]) -> None:
+        self._run_python_module(["aexpy"] + args)
+
+    def _run_python_module(self, args: list[str]) -> None:
+        run(["python3", "-m"] + args)

pyapi/api_processor.py

@@ -0,0 +1,33 @@
+"""
+Copyright 2025 Palantir Technologies, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+"""
+
+from abc import ABC, abstractmethod
+
+
+class APIProcessor(ABC):
+    """
+    Checks the current API of the local code against the API of `previous_version`
+    and returns a list of API breaks as string "codes" each representing a single API break.
+    These "codes" are what users will have to accept if they choose to accept the break.
+    """
+
+    @abstractmethod
+    def check_api(self, previous_version: str) -> list[str]:
+        pass
+
+
+class CannotFindAPIVersionError(Exception):
+    pass

pyapi/app.py

@@ -0,0 +1,180 @@
+"""
+Copyright 2025 Palantir Technologies, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+"""
+
+import math
+import os
+from dataclasses import asdict
+from functools import cached_property
+from pathlib import Path
+
+import tomli
+import yaml
+
+from .aexpy_api_processor import AexpyAPIProcessor
+from .api_processor import CannotFindAPIVersionError
+from .color import ANSIColor
+from .config import PyAPICheckerConfig
+from .constants import (
+    DOT_PALANTIR_DIR,
+    PIP_INDEX_URL_ENV_VAR,
+    PYAPI_CHECKER_CONFIG_KEY,
+    PYAPI_YML_PATH,
+    PYPI_INDEX_URL,
+    PYPROJECT_TOML,
+    UV_DEFAULT_INDEX_ENV_VAR,
+)
+from .git import get_git_version, get_previous_git_tag_from_HEAD, get_repo_root
+from .model import AcceptedAPIBreak, PyAPIYml
+from .utils import maybe_get_nested_value, print_with_local_color
+
+
+class PyAPIApplication:
+    def __init__(self, project_dir: Path) -> None:
+        self._project_dir = project_dir
+        self._pyproject_path = self._project_dir / PYPROJECT_TOML
+        self._pyproject_toml = tomli.loads((self._pyproject_path).read_text())
+
+        maybe_name = maybe_get_nested_value(["project", "name"], self._pyproject_toml)
+        if not maybe_name:
+            raise RuntimeError(f"Failed to find project.name in {self._pyproject_path}")
+        if not isinstance(maybe_name, str):
+            raise RuntimeError(f"project.name is not a string in {self._pyproject_path}")
+        self._project_name: str = maybe_name
+
+        self._config = PyAPICheckerConfig(**self._pyproject_toml.get("tool", {}).get(PYAPI_CHECKER_CONFIG_KEY, {}))
+        self._index = (
+            self._config.index
+            or os.getenv(PIP_INDEX_URL_ENV_VAR)
+            or os.getenv(UV_DEFAULT_INDEX_ENV_VAR)
+            or PYPI_INDEX_URL
+        )
+        self._processor = AexpyAPIProcessor(self._project_dir, self._project_name, self._index)
+        self._pyapi_yml_path = self._repo_root / PYAPI_YML_PATH
+
+    @cached_property
+    def _repo_root(self) -> Path:
+        return get_repo_root()
+
+    @cached_property
+    def _previous_version(self) -> str:
+        previous_git_version = get_previous_git_tag_from_HEAD()
+        return self._pyapi_yml_contents.versionOverrides.get(previous_git_version, previous_git_version)
+
+    @cached_property
+    def _pyapi_yml_contents(self) -> PyAPIYml:
+        if not self._pyapi_yml_path.exists():
+            return PyAPIYml({}, {})
+        pyapi_yml = yaml.safe_load(self._pyapi_yml_path.read_text())
+        if not isinstance(pyapi_yml, dict):
+            raise RuntimeError(f"{self._pyapi_yml_path} is not valid yaml, cannot read to dict.")
+        try:
+            return PyAPIYml(**pyapi_yml)
+        except Exception as e:
+            raise RuntimeError(
+                f"{self._pyapi_yml_path} does not have the valid structure for pyapi.yml files, cannot read to dict."
+            ) from e
+
+    @cached_property
+    def _accepted_breaks_codes(self) -> set[str]:
+        return set([b.code for b in self._get_accepted_breaks(self._previous_version)])
+
+    @cached_property
+    def _breaks(self) -> list[str]:
+        try:
+            return self._processor.check_api(self._previous_version)
+        except CannotFindAPIVersionError as e:
+            print(e)
+            print_with_local_color(
+                "If the above version was tagged but failed to publish, apply a version override via:", ANSIColor.RED
+            )
+            print_with_local_color("  pyapi versionOverride <last-published-version>", ANSIColor.CYAN)
+            exit(1)
+
+    def analyze(self) -> None:
+        if get_git_version() == self._previous_version:
+            print("Current version is the same as the previous version, this is a release version, skipping analysis.")
+            return
+
+        if not self._breaks:
+            print("No Python API breaks found.")
+            return
+
+        unaccepted_breaks = []
+        for api_break_code in self._breaks:
+            if api_break_code not in self._accepted_breaks_codes:
+                unaccepted_breaks.append(api_break_code)
+        if not unaccepted_breaks:
+            print("No unaccepted Python API breaks found.")
+            return
+
+        print_with_local_color(f"\nPython API breaks found in {self._project_name}:", ANSIColor.RED_UNDERLINED)
+        for api_break_code in unaccepted_breaks:
+            print_with_local_color(f"{api_break_code}", ANSIColor.RED_HIGH_INTENSITY)
+        print("You can accept an API break via:")
+        print_with_local_color(f'  pyapi acceptBreak "{self._breaks[0]}" ":justification:"', ANSIColor.CYAN)
+        print("or all API breaks via:")
+        print_with_local_color('  pyapi acceptAllBreaks ":justification:"', ANSIColor.CYAN)
+        exit(1)
+
+    def accept_break(self, code: str, justification: str) -> None:
+        if code in self._accepted_breaks_codes:
+            print(f"Break '{code}' is already accepted")
+            return
+
+        if not self._breaks or code not in self._breaks:
+            print_with_local_color(
+                f"\nBreak '{code}' is not a valid Python API break and cannot be accepted", ANSIColor.RED
+            )
+            exit(1)
+
+        self._accept_breaks([AcceptedAPIBreak(code=code, justification=justification)])
+
+    def accept_all_breaks(self, justification: str) -> None:
+        if not self._breaks:
+            print("No Python API breaks found to accept.")
+            return
+
+        breaks_to_accept = []
+        for api_break_code in self._breaks:
+            if api_break_code not in self._accepted_breaks_codes:
+                breaks_to_accept.append(AcceptedAPIBreak(code=api_break_code, justification=justification))
+
+        self._accept_breaks(breaks_to_accept)
+
+    def version_override(self, replacement_version: str) -> None:
+        modified_pyapi_yml = self._pyapi_yml_contents.union(
+            PyAPIYml(acceptedBreaks={}, versionOverrides={self._previous_version: replacement_version})
+        )
+        self._write_modified_pyapi_yml(modified_pyapi_yml)
+
+    def _accept_breaks(self, breaks_to_accept: list[AcceptedAPIBreak]) -> None:
+        modified_pyapi_yml = self._pyapi_yml_contents.union(
+            PyAPIYml(
+                acceptedBreaks={self._previous_version: {self._project_name: breaks_to_accept}}, versionOverrides={}
+            )
+        )
+        self._write_modified_pyapi_yml(modified_pyapi_yml)
+
+    def _write_modified_pyapi_yml(self, modified_pyapi_yml: PyAPIYml) -> None:
+        (self._repo_root / DOT_PALANTIR_DIR).mkdir(exist_ok=True)
+        self._pyapi_yml_path.write_text(yaml.safe_dump(asdict(modified_pyapi_yml), width=math.inf))
+
+    def _get_accepted_breaks(self, version: str) -> list[AcceptedAPIBreak]:
+        return self._pyapi_yml_contents.enumerate_breaks(version, self._project_name)
+
+
+class InvalidAPIBreakAcceptance(Exception):
+    pass

pyapi/cli.py

@@ -0,0 +1,51 @@
+"""
+Copyright 2025 Palantir Technologies, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+"""
+
+from pathlib import Path
+
+import typer
+
+from .app import PyAPIApplication
+
+app = typer.Typer()
+pyapi_app = PyAPIApplication(Path.cwd().absolute())
+
+
+@app.command()
+def analyze() -> None:
+    pyapi_app.analyze()
+
+
+@app.command(name="acceptBreak")
+def accept_break(
+    code: str,
+    justification: str,
+) -> None:
+    pyapi_app.accept_break(code, justification)
+
+
+@app.command(name="acceptAllBreaks")
+def accept_all_breaks(justification: str) -> None:
+    pyapi_app.accept_all_breaks(justification)
+
+
+@app.command(name="versionOverride")
+def version_override(replacement_version: str) -> None:
+    pyapi_app.version_override(replacement_version)
+
+
+if __name__ == "__main__":
+    app()

pyapi/color.py

@@ -0,0 +1,25 @@
+"""
+Copyright 2025 Palantir Technologies, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+"""
+
+from enum import Enum
+
+
+class ANSIColor(Enum):
+    NO_COLOR = "\033[0m"
+    CYAN = "\033[36m"
+    RED = "\033[31m"
+    RED_UNDERLINED = "\033[31;4m"
+    RED_HIGH_INTENSITY = "\033[91m"

pyapi/config.py

@@ -0,0 +1,23 @@
+"""
+Copyright 2025 Palantir Technologies, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+"""
+
+from pydantic import Field
+from pydantic.dataclasses import dataclass
+
+
+@dataclass
+class PyAPICheckerConfig:
+    index: str | None = Field(default=None)

pyapi/constants.py

@@ -0,0 +1,25 @@
+"""
+Copyright 2025 Palantir Technologies, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+"""
+
+DOT_PALANTIR_DIR = ".palantir"
+PIP_INDEX_URL_ENV_VAR = "PIP_INDEX_URL"
+PYAPI_BUILD_DIR = "build/pyapi"
+PYAPI_CHECKER_CONFIG_KEY = "pyapi-checker"
+PYAPI_YML_FILENAME = "pyapi.yml"
+PYAPI_YML_PATH = f"{DOT_PALANTIR_DIR}/{PYAPI_YML_FILENAME}"
+PYPI_INDEX_URL = "https://pypi.org/simple"
+PYPROJECT_TOML = "pyproject.toml"
+UV_DEFAULT_INDEX_ENV_VAR = "UV_DEFAULT_INDEX"

pyapi/git.py

@@ -0,0 +1,42 @@
+"""
+Copyright 2025 Palantir Technologies, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+"""
+
+from pathlib import Path
+
+from .utils import run
+
+
+def get_git_version() -> str:
+    git_version = run(
+        [
+            "git",
+            "describe",
+            "--tags",
+            "--always",
+            "--first-parent",
+            "--abbrev=7",
+        ]
+    ).strip()
+    git_status = run(["git", "status", "--porcelain"]).strip()
+    return git_version + (".dirty" if git_status else "")
+
+
+def get_previous_git_tag_from_HEAD() -> str:
+    return run(["git", "describe", "--tags", "--abbrev=0", "HEAD"]).strip()
+
+
+def get_repo_root() -> Path:
+    return Path(run(["git", "rev-parse", "--show-toplevel"]).strip())

pyapi/model.py

@@ -0,0 +1,40 @@
+"""
+Copyright 2025 Palantir Technologies, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+"""
+
+from pydantic.dataclasses import dataclass
+
+from .utils import merge_dicts
+
+
+@dataclass
+class AcceptedAPIBreak:
+    code: str
+    justification: str
+
+
+@dataclass
+class PyAPIYml:
+    acceptedBreaks: dict[str, dict[str, list[AcceptedAPIBreak]]]
+    versionOverrides: dict[str, str]
+
+    def union(self, other: "PyAPIYml") -> "PyAPIYml":
+        return PyAPIYml(
+            merge_dicts(self.acceptedBreaks, other.acceptedBreaks),
+            merge_dicts(self.versionOverrides, other.versionOverrides),
+        )
+
+    def enumerate_breaks(self, version: str, project_name: str) -> list[AcceptedAPIBreak]:
+        return self.acceptedBreaks.get(version, {}).get(project_name, [])

pyapi/utils.py

@@ -0,0 +1,66 @@
+"""
+Copyright 2025 Palantir Technologies, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+"""
+
+import os
+import subprocess
+from typing import Any
+
+from .color import ANSIColor
+
+
+def maybe_get_nested_value(keys: list[str], d: dict[str, Any]) -> Any | None:
+    if len(keys) == 1:
+        return d.get(keys[0])
+    sub_dict = d.get(keys[0])
+    if sub_dict:
+        keys.pop(0)
+        return maybe_get_nested_value(keys, sub_dict)
+    return None
+
+
+def run(args: list[str]) -> str:
+    try:
+        res = subprocess.run(args=args, capture_output=True, check=True)
+    except subprocess.CalledProcessError as e:
+        print(e.stdout.decode("utf-8"))
+        print(e.stderr.decode("utf-8"))
+        raise e
+    return res.stdout.decode("utf-8")
+
+
+def merge_dicts(dict1: dict[Any, Any], dict2: dict[Any, Any], root_key: str | None = None) -> dict[Any, Any]:
+    """
+    Merges dictionaries together recursively where key, value pairs in dict2 override key, value
+    pairs in dict1 if the keys are the same unless 1) the values are dictionaries and then these
+    dictionaries are merged recursively with the same rules or 2) the values are lists in which
+    case the list from dict2 is appended to dict1. Returns merged dictionary.
+    """
+    for key, value in dict2.items():
+        full_key_name = root_key + "." + key if root_key else key
+        if key in dict1 and isinstance(dict1[key], dict) and isinstance(value, dict):
+            dict1[key] = merge_dicts(dict1[key], value, full_key_name)
+        elif key in dict1 and isinstance(dict1[key], list) and isinstance(value, list):
+            dict1[key] = dict1[key] + value
+        else:
+            dict1[key] = value
+    return dict1
+
+
+def print_with_local_color(message: str, color: ANSIColor) -> None:
+    if os.getenv("CI"):
+        print(message)
+        return
+    print(f"{color.value}{message}{ANSIColor.NO_COLOR.value}")

pyapi_checker-0.11.0.dist-info/METADATA

@@ -0,0 +1,102 @@
+Metadata-Version: 2.4
+Name: pyapi-checker
+Version: 0.11.0
+Summary: Tool for checking for breaking changes in Python APIs
+Project-URL: Source code, https://github.com/palantir/pyapi-checker
+Author-email: Benjamin Lowry <benjaminpaullowry.appdev@gmail.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Requires-Dist: aexpy
+Requires-Dist: pip
+Requires-Dist: pydantic
+Requires-Dist: pyyaml
+Requires-Dist: tomli
+Requires-Dist: typer
+Description-Content-Type: text/markdown
+
+## About pyapi-checker
+
+Tool for checking for and acknowledging Python API breaking changes. Inspired by [gradle-revapi](https://github.com/revapi/gradle-revapi) and built with the [aexpy](https://github.com/StardustDL/aexpy) API explorer.
+
+## Usage
+
+Once you've installed `pyapi-checker` in an environment in your project you can interface with the `pyapi` CLI.
+
+`pyapi analyze` is the command for checking for API breaks in your project which will produce output like this if you have 2 API breaks for example, and also exit with exit code 1:
+
+```
+Python API breaks found in my-lib:
+AddRequiredParameter: Add PositionalOrKeyword parameter (functions.bin.parse.parse): new_param.
+MoveParameter: Move parameter (functions.bin.parse.parse): handle_errors: 3 -> 4.
+```
+
+So you would want to include `pyapi analyze` in your CI process to require developers to acknowledge API breaks when creating PRs on a library.
+
+### Accepting Breaks
+
+You can accept a single break via:
+
+```bash
+pyapi acceptBreak "{break code}" "{justification why this is ok}"
+```
+
+Or accept all breaks via:
+
+```bash
+pyapi acceptAllBreaks "{justification why this is ok}"
+```
+
+Accepted breaks will populate in the `.palantir/pyapi.yml` file looking like this:
+
+```yaml
+acceptedBreaks:
+  version:
+    projectName:
+    - code: 'break code'
+      justification: justification
+```
+
+### Version overrides
+
+Sometimes the previous release will have a successfully applied git tag but a failed publish build. In this case pyapi-checker will fail as it cannot resolve the previous API to compare against. To resolve this, you can set a version override that will use a different version instead of the last git tag. To do so, use the
+
+```bash
+pyapi versionOverride <last-published-version>
+```
+
+command to use the last correctly published version instead. This will create an entry in `.palantir/pyapi.yml` of the following format:
+
+```yaml
+versionOverrides:
+  version: <last-published-version>
+```
+
+## Configuration
+
+### Python Index
+
+After identifying the last published version preceeding your current commit, pyapi-checker downloads the corresponding wheel for your package and version from a Python index. If you do not specify an index then pyapi-checker uses the following in order (if set):
+
+1. `PIP_INDEX_URL`
+2. `UV_DEFAULT_INDEX`
+3. `https://pypi.org/simple`
+
+To manually set an index you can set the following configuration:
+
+```toml
+[tool.pyapi-checker]
+index = "<your-index-url>"
+```
+
+## Implementation
+
+`pyapi-checker` uses [aexpy](https://github.com/StardustDL/aexpy) to power it's API breakage detection. You can check out the list of types of API breaks that `aexpy` detects [here](https://github.com/StardustDL/aexpy/blob/main/docs/change-spec/description.md).
+
+_Note: `aexpy` does not consider any breaks to an __internal__ module, function, attribute, etc. a high priority breaking change and thus we will not flag these breaks to you._

pyapi_checker-0.11.0.dist-info/RECORD

@@ -0,0 +1,19 @@
+pyapi/__init__.py,sha256=HEX1GXbaGYfqCwPvUnNhwbW4j-frpV7jB6lSRgtdG5Q,622
+pyapi/__main__.py,sha256=hTYOcZoEGVf2GFOGFdAFDwfOF_Ag2n77f0xrKAIQ3Wk,641
+pyapi/_version.py,sha256=9eKRDJ72C44i2IPiti-C7phzF429SwV2Nogzt0etpr0,706
+pyapi/aexpy_api_processor.py,sha256=76o3CvH-GstBwPnCvJ5R-1JpmkCMi5un7Z-ZeWdbkVw,6471
+pyapi/api_processor.py,sha256=s4GPyVhTZJ8o2rshVGqwxCiHAK-Csjuom5U9VFVKQFU,1067
+pyapi/app.py,sha256=xBX9yv91f6p_Q_wkNY1y61rgkWrYwfpynEa1XVSVttg,7288
+pyapi/cli.py,sha256=-XD_VoL24w3ubpv-sKfXhYs9e1Eo2sJnJlxpXKIRLQQ,1258
+pyapi/color.py,sha256=qRXfR8WDGXHNizbO5JfAYBgSb5W_DNfe8nmmiT4nRf8,758
+pyapi/config.py,sha256=k97BD816nw0He0Bi2gul37xVeq63f3mmxPpyFPco5V4,726
+pyapi/constants.py,sha256=te33RRcdBRL-1RKwE5tAexjwXVIjHN5ojiHm3fYHGkM,935
+pyapi/git.py,sha256=MsYDkx4jB46Y0-4ZSZxRDPL0EtDYviiRZhoeEhMK7n8,1201
+pyapi/model.py,sha256=qiVJsKqNGrEtOcnJWT_1MDAA2soZ4UUrYTvvK-YVUCc,1249
+pyapi/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pyapi/utils.py,sha256=srwEdSgjI-IyfkmtkE_u65cx7VzJqPSwQmfaKBQhBwE,2367
+pyapi_checker-0.11.0.dist-info/METADATA,sha256=ShXXf6BNICyfMAhb-c4KApp7hNMhoyGV-PyjtDqTWcQ,3695
+pyapi_checker-0.11.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+pyapi_checker-0.11.0.dist-info/entry_points.txt,sha256=M2MEd2U1FjKnfsTcItzy5G3AdmkE8JTkIfVNK-A81lE,40
+pyapi_checker-0.11.0.dist-info/licenses/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+pyapi_checker-0.11.0.dist-info/RECORD,,

pyapi_checker-0.11.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

pyapi_checker-0.11.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+pyapi = pyapi.cli:app

pyapi_checker-0.11.0.dist-info/licenses/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.