Python api consistency validator

Skill ArabelaTso/Skills-4-SE/skills/python-api-consistency-validator

Validate API consistency between two versions of Python libraries. Use when you need to compare API behavior, signatures, and exceptions between library versions to identify breaking changes, incompatible modifications, and behavior differences. The skill performs static analysis of Python code, compares function signatures, class definitions, parameter types, return types, and generates a detailed JSON report with breaking changes, warnings, and migration guidance. Supports Python libraries and packages.From its SKILL.md

Install

npx -y skills add ArabelaTso/Skills-4-SE --skill python-api-consistency-validator

Assembled from the repository path, not quoted from the project. Check it against their README if it does not work.

SKILL.md

2.4 KB, 414 tokens by cl100k_base, as published. Nobody here has run it

Python API Consistency Validator

Overview

This skill validates API consistency between two versions of Python libraries by comparing signatures, behavior, and exceptions. It identifies breaking changes, incompatible modifications, and provides detailed reports to guide safe API migration or upgrade.

Quick Start

# Compare two versions of a Python library
python scripts/validate.py /path/to/old_version /path/to/new_version

# Specify output file
python scripts/validate.py old_lib/ new_lib/ --output report.json

What Gets Validated

Function Signatures - Parameters, return types, decorators
Class Definitions - Methods, inheritance, attributes
Parameter Changes - Added, removed, or modified parameters
Return Type Changes - Modified return types
Removed APIs - Deleted functions, classes, or methods

Validation Report

The tool generates a JSON report with:

Breaking Changes: API removals, incompatible modifications
Warnings: Type changes, signature modifications
Info: New additions, non-breaking changes
Summary: Total issues by severity

Example report:

{
  "summary": {
    "breaking_changes": 3,
    "warnings": 5,
    "info": 2
  },
  "breaking_changes": [
    {
      "type": "function_removed",
      "name": "deprecated_func",
      "severity": "breaking",
      "message": "Function 'deprecated_func' was removed"
    }
  ]
}

Usage

python scripts/validate.py <old_version_path> <new_version_path> [--output <report.json>]

The validator exits with code 1 if breaking changes are found, 0 otherwise.

Tips

Run validation before upgrading dependencies
Review breaking changes carefully
Check warnings for potential issues
Use in CI/CD pipelines to catch API changes
Compare against semantic versioning expectations

What ships with it: 1 file

10.1 KB alongside SKILL.md, 1 of them executable

scripts/

validate.pyruns10.1 KB