Skip to main content

A lightweight rule-based Python code formatter

Project description

CutyPy

CutyPy currently doesn't obey PEP 8 in many cases. It is a work in progress and may not be ready for production use. Use with caution and report any issues you encounter.

A lightweight Python code formatter.

Installation

pip install cutypy

About

CutyPy is a minimal and fast Python formatter designed to enforce consistent formatting rules across Python codebases.

Unlike large formatters that heavily restructure code, CutyPy focuses on deterministic formatting rules applied through a small rule engine. Each rule handles a specific formatting concern such as indentation, spacing, blank lines, or import ordering.

The formatter processes files using modular formatting rules, making the system easier to reason about, extend, and control.

Features

  • Deterministic Python formatting
  • Rule-based formatting system
  • Import sorting
  • Consistent indentation enforcement
  • Blank line normalization
  • Trailing space cleanup
  • Line ending normalization
  • Automatic EOF newline insertion
  • Optional check mode for CI pipelines

Usage

Format a file or directory:

cutypy path/to/file_or_directory

Check if files need formatting (useful for CI or pre-commit):

cutypy --check path/to/project

If formatting changes are required in check mode, CutyPy exits with a non-zero status code.

Formatting Rules

CutyPy applies a set of focused formatting rules:

  • Blank line normalization
  • Declaration spacing adjustments
  • Removal of excessive blank lines
  • End-of-file newline enforcement
  • Import ordering
  • Indentation consistency
  • Leading blank line cleanup
  • Line ending normalization
  • Trailing comma formatting
  • Removal of trailing spaces

Each rule operates independently, allowing the formatter to remain simple and predictable.

Project Structure

cutypy
├── __init__.py
├── fmt.py
├── format_file.py
└── rules
    └── format
        ├── blank_lines.py
        ├── declaration_spacing.py
        ├── double_blanks.py
        ├── eof_newline.py
        ├── import_sort.py
        ├── indentation.py
        ├── leading_blank_lines.py
        ├── line_endings.py
        ├── trailing_commas.py
        └── trailing_spaces.py
  • fmt.py provides the CLI entrypoint.
  • format_file.py handles formatting of individual files.
  • rules/format contains independent formatting rules applied sequentially.

Design Philosophy

CutyPy is built around a few core ideas:

  • Minimal implementation
  • Explicit formatting rules
  • Predictable output
  • Easy extensibility
  • Suitable for automation (CI / pre-commit)

Rather than trying to cover every stylistic decision, CutyPy focuses on enforcing a small set of reliable formatting guarantees.

Status

Experimental and under active development.

Links

Made by AttAditya

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cutypy-0.2.4.tar.gz (11.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cutypy-0.2.4-py3-none-any.whl (15.8 kB view details)

Uploaded Python 3

File details

Details for the file cutypy-0.2.4.tar.gz.

File metadata

  • Download URL: cutypy-0.2.4.tar.gz
  • Upload date:
  • Size: 11.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for cutypy-0.2.4.tar.gz
Algorithm Hash digest
SHA256 56d926f2c780d2cfcbe639e8f2ff0028618d96b15f2695bd472f9cea06a57e09
MD5 ed36a512bd4a359074f22b6e5435ef80
BLAKE2b-256 48df04d6929a94699585a62c45ed6ca6c748356026ed0b249977ae41cf2972a6

See more details on using hashes here.

File details

Details for the file cutypy-0.2.4-py3-none-any.whl.

File metadata

  • Download URL: cutypy-0.2.4-py3-none-any.whl
  • Upload date:
  • Size: 15.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.2.0 CPython/3.12.3

File hashes

Hashes for cutypy-0.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 1c9613eaceee33a0aefdec9568fbe8678c1b7f58c7e3a0985d30b975243e61ae
MD5 57c57b7a710a48331ab4ca846cc2308a
BLAKE2b-256 11a272aac539b2b5d750542fff71b26be3a1414aff2af8ce7c88e4fec8e525f0

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page