python-code-changed 0.4.0

A Python project to detect real code changes.

python_code_changed

Overview

python_code_changed is a tool to detect real logic changes in Python code, ignoring trivial changes like formatting, comments, import reordering, and unreachable code. It is designed for code review automation and CI pipelines.

PIP Package Usage

After installing via PIP, run:

python-code-changed [FILES or OPTIONS]

For example, to check for real code changes in staged files:

python-code-changed --staged

See all options:

python-code-changed --help

Project Structure

python_code_changed/
├── src/
│   ├── ast_utils.py
│   ├── detect_real_code_changes.py
│   ├── helpers_logic.py
│   └── helpers_trivial.py
├── tests/
│   └── test_detect_real_code_changes.py
├── .github/
│   └── workflows/
│       └── ci.yml
├── .devcontainer/
│   └── devcontainer.json
├── pyproject.toml
├── requirements.txt
├── LICENSE
└── README.md

Getting Started

Development Environment

This project supports Dev Containers for reproducible development. Open in VS Code and install the recommended extensions. NB. You will need to set your git user.name and git user.email on the devcontainer terminal after its loaded.

git config --global user.name "Your Name"
git config --global user.email "[e-mail]"

Installation

Install dependencies using uv:

uv pip install -e .'[dev]'

Configuration

python_code_changed uses an optional configuration file named real_code_checks.ini (located in the project root) to control analysis options and behavior. You can customise which checks are enabled, ignored, or how the tool treats certain code changes by editing this file. You can alternatively pass in command-line arguments when runnin the script.

See the comments in real_code_checks.ini for available options and usage examples.

Usage

You can use python_code_changed as a CLI tool or as a Python library.

CLI Usage

After installing dependencies, run:

uv run python-code-changed [FILES or OPTIONS]

For example, to check for real code changes in staged files:

uv run python-code-changed --staged

See all options:

uv run python-code-changed --help

Library Usage

You can import and use the main functions in your own Python code:

from python_code_changed import detect_real_code_changes
# Use detect_real_code_changes(...) as needed

Contributing

See CONTRIBUTING.md for guidelines on contributing to this project.

License

MIT License