undersort 0.1.0__tar.gz

undersort-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,86 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+    tags:
+      - "v*"
+  pull_request:
+    branches: [main]
+
+jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+        with:
+          enable-cache: true
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install dependencies
+        run: uv sync
+
+      - name: Run ruff format check
+        run: uv run ruff format --check
+
+      - name: Run ruff linter
+        run: uv run ruff check
+
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12"]
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+        with:
+          enable-cache: true
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: uv sync
+
+      - name: Run tests
+        run: uv run pytest -v --cov=undersort --cov-report=term-missing
+
+  publish:
+    name: Publish to PyPI
+    runs-on: ubuntu-latest
+    needs: [lint, test]
+    if: startsWith(github.ref, 'refs/tags/v')
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Build package
+        run: uv build
+
+      - name: Publish to PyPI
+        run: uv publish
+        env:
+          UV_PUBLISH_TOKEN: ${{ secrets.PYPI_TOKEN }}

undersort-0.1.0/.gitignore

@@ -0,0 +1,174 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# uv
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://docs.astral.sh/uv/concepts/projects/#lockfiles
+#uv.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Nuitka builds
+*.onefile-build/
+*.build/
+*.dist/
+
+# macOS
+.DS_Store
+
+# IDE history
+.history
+
+# Ruff cache
+.ruff_cache/

undersort-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,11 @@
+# Sample pre-commit configuration
+# To use: pip install pre-commit && pre-commit install
+
+repos:
+  - repo: local
+    hooks:
+      - id: undersort
+        name: undersort
+        entry: uv run undersort
+        language: system
+        types: [python]

undersort-0.1.0/.pre-commit-hooks.yaml

@@ -0,0 +1,7 @@
+- id: undersort
+  name: undersort
+  description: Sort class methods by visibility (public, protected, private)
+  entry: undersort
+  language: python
+  types: [python]
+  require_serial: false

undersort-0.1.0/.python-version

@@ -0,0 +1 @@
+3.11

undersort-0.1.0/.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "editor.formatOnSave": true,
+}

undersort-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Vladimir Kirilenko
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

undersort-0.1.0/Makefile

@@ -0,0 +1,29 @@
+.PHONY: install lint test test-cov format check clean demo demo-check demo-diff
+
+install: 
+	uv sync
+
+lint:
+	uv run ruff format
+	uv run ruff check --fix --unsafe-fixes --exit-zero
+
+format:
+	uv run ruff format
+
+check: 
+	uv run ruff check
+
+test:
+	uv run pytest -v
+
+test-cov:
+	uv run pytest --cov=undersort --cov-report=term-missing --cov-report=html
+
+clean:
+	rm -rf .venv __pycache__ .pytest_cache .mypy_cache .ruff_cache
+	find . -type d -name "__pycache__" -exec rm -rf {} +
+	find . -type f -name "*.pyc" -delete
+
+update:
+	uv lock --upgrade
+	uv sync

undersort-0.1.0/PKG-INFO

@@ -0,0 +1,241 @@
+Metadata-Version: 2.4
+Name: undersort
+Version: 0.1.0
+Summary: A tool to sort class methods by visibility (public, protected, private)
+Project-URL: Homepage, https://github.com/kivicode/undersort
+Project-URL: Repository, https://github.com/kivicode/undersort
+Project-URL: Issues, https://github.com/kivicode/undersort/issues
+Author-email: KiviCode <kivicode.dev@gmail.com>
+License: MIT
+License-File: LICENSE
+Keywords: class-methods,code-formatter,linter,python,sorting
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Software Development :: Quality Assurance
+Requires-Python: >=3.8
+Requires-Dist: libcst>=1.1.0
+Requires-Dist: rich>=13.0.0
+Description-Content-Type: text/markdown
+
+# 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
+
+```bash
+# Using uv (recommended)
+uv pip install -e .
+
+# Using pip
+pip install -e .
+```
+
+## Configuration
+
+Configure the method ordering in your `pyproject.toml`:
+
+```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
+
+```bash
+# 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`:
+
+```yaml
+repos:
+  - repo: local
+    hooks:
+      - id: undersort
+        name: undersort
+        entry: uv run undersort
+        language: system
+        types: [python]
+```
+
+Then install the hook:
+
+```bash
+pip install pre-commit
+pre-commit install
+```
+
+## Example
+
+### Before
+
+```python
+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)
+
+```python
+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
+
+```bash
+# 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