undersort 0.1.0

A tool to sort class methods by visibility (public, protected, private)

undersort

A Python tool that automatically sorts class methods by visibility (public, protected, private) and type (class, static, instance).

Features

• Automatically reorders class methods based on visibility and method type
• Two-level sorting: primary by visibility, secondary by method type
• Fully configurable ordering via pyproject.toml
• Pre-commit hook integration
• Colored output for better readability
• Check mode for CI/CD validation
• Diff mode to preview changes

Installation

# Using uv (recommended)
uv pip install -e .

# Using pip
pip install -e .

Configuration

Configure the method ordering in your pyproject.toml:

[tool.undersort]
# Method visibility ordering (primary sort)
# Options: "public", "protected", "private"
order = ["public", "protected", "private"]

# Method type ordering within each visibility level (secondary sort, optional)
# Options: "class" (classmethod), "static" (staticmethod), "instance" (regular methods)
# Default: ["class", "static", "instance"]
method_type_order = ["class", "static", "instance"]

Method Visibility Rules

• Public methods: No underscore prefix (e.g., def method()) or magic methods (e.g., __init__, __str__)
• Protected methods: Single underscore prefix (e.g., def _method())
• Private methods: Double underscore prefix, not magic (e.g., def __method())

Method Type Rules

• Class methods: Decorated with @classmethod
• Static methods: Decorated with @staticmethod
• Instance methods: Regular methods (no special decorator)

Sorting Behavior

Methods are sorted in two levels:

1. Primary: By visibility (public → protected → private)
2. Secondary: Within each visibility level, by method type (class → static → instance by default)

Example: With default configuration, the order would be:

1. Public class methods
2. Public static methods
3. Public instance methods
4. Protected class methods
5. Protected static methods
6. Protected instance methods
7. Private class methods
8. Private static methods
9. Private instance methods

Usage

Command Line

# Sort a single file
undersort example.py

# Sort multiple files
undersort file1.py file2.py file3.py

# Sort all Python files in a directory (recursive by default)
undersort src/

# Sort all Python files in current directory and subdirectories
undersort .

# Non-recursive directory sorting (only files in the directory, not subdirectories)
undersort src/ --no-recursive

# Wildcards work too (expanded by shell)
undersort *.py
undersort src/**/*.py

# Check if files need sorting (useful for CI)
undersort --check example.py
undersort --check src/

# Show diff of changes
undersort --diff example.py

# Combine flags
undersort --check --diff src/

Note: By default, undersort excludes common directories like .venv, .git, __pycache__, .pytest_cache, .mypy_cache, .ruff_cache, and node_modules when scanning directories.

Pre-commit Integration

Add to your .pre-commit-config.yaml:

repos:
  - repo: local
    hooks:
      - id: undersort
        name: undersort
        entry: uv run undersort
        language: system
        types: [python]

Then install the hook:

pip install pre-commit
pre-commit install

Example

Before

class Example:
    def _protected_instance(self):
        pass

    @staticmethod
    def public_static():
        pass

    def __init__(self):
        pass

    @classmethod
    def _protected_class(cls):
        pass

    def public_instance(self):
        pass

    def __private_method(self):
        pass

    @classmethod
    def public_class(cls):
        pass

After (with default config)

class Example:
    @classmethod
    def public_class(cls):
        pass

    @staticmethod
    def public_static():
        pass

    def __init__(self):
        pass

    def public_instance(self):
        pass

    @classmethod
    def _protected_class(cls):
        pass

    def _protected_instance(self):
        pass

    def __private_method(self):
        pass

The methods are now organized by:

1. Visibility: public (including __init__) → protected → private
2. Type (within each visibility): class → static → instance

Development

# Install dependencies
uv sync

# Run on example file
uv run undersort example.py

# Test with check mode
uv run undersort --check example.py

# View diff
uv run undersort --diff example.py

License

MIT