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.1.3.tar.gz (10.3 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.1.3-py3-none-any.whl (12.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: cutypy-0.1.3.tar.gz
  • Upload date:
  • Size: 10.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for cutypy-0.1.3.tar.gz
Algorithm Hash digest
SHA256 c6b4bbc7e2ff8890ae78b9bb6996276f6d5b3e946691d82bafae7a4900505eaa
MD5 ea81b79ce22049f5c1e57c89c35f8665
BLAKE2b-256 b62318af3769d5f8d73bab0b159f8b161bbf8c932ccfdeb54fe3976e0142910e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: cutypy-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 12.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for cutypy-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 29ff902da3216a4ac73e8cda26d2318123c554974603656dd72efff4e5074ac8
MD5 9038360355321511f474a909f1ce3ef6
BLAKE2b-256 0c8e44bd299cbad923d462afdd08f47e87042eaef601beb90f94e90be5b2878c

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