Skip to content

AttAditya/cutypy

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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

About

A lightweight rule-based Python code formatter

Topics

Resources

License

Stars

Watchers

Forks

Contributors