autorefine

Standardize the refactoring process.

The project is aimed to provide a framework for the entire process of refactoring Python projects from the very beginning to the very end:

• analyze the project with linters and type checkers,
• create a refactoring roadmap (like https://github.com/CERT-Polska/malduck/issues/110, but with more details available as a specialized document),
• create a delivery plan (like in the issue above),
• apply automatic fixes and commit them in reviewable chunks with meaningful descriptions,
• leave the rest for manual work,
• create a PR (like https://github.com/CERT-Polska/malduck/issues/111).

Created to accomplish https://github.com/jaraco/skeleton/issues/98 and personal use to raise awareness of best practices across the global Python community.

Planned tooling

The project is planned to be a wrapper around the following well-tested & recognized tools:

• MonkeyType for automatic type annotations generation,
• Fixit for automatic fixes that require static analysis and scope analysis and planning of manual refactoring steps,
• Ruff for automatic fixes and planning of manual refactoring steps,
• pyupgrade for automatic fixes,
• Static type checking:
  • mypy,
  • pyre,
  • pytype,
• diff-cover for coverage reports on fixes,
• smokeshow for hosting detailed refactoring roadmaps and delivery plans,
• pandas for collecting tasks and creating markdown tables,
• GitHub CLI for creating tickets.

Refactoring workflow

1. First off, check for type annotations and add them if missing using MonkeyType.

2. Analyze the project and create a refactoring roadmap.

   1. Check for type errors using static type checkers.

   2. Check for code style issues using linters.

3. Apply automatic fixes and commit them in reviewable chunks with meaningful descriptions.

4. Leave the rest for manual work.

5. Create a PR.

Get inspired

• https://instagram-engineering.com/static-analysis-at-scale-an-instagram-story-8f498ab71a0c

Installation

If you want to…

…use this tool in your project 💻

You might simply install it with pip:

pip install autorefine

If you use Poetry, then run:

poetry add autorefine

…contribute to autorefine 🚀

[!Note] If you use Windows, it is highly recommended to complete the installation in the way presented below through WSL2.

1. Fork the autorefine repository on GitHub.

2. Install Poetry.
   Poetry is an amazing tool for managing dependencies & virtual environments, building packages and publishing them. You might use pipx to install it globally (recommended):

   pipx install poetry
   

   _{If you encounter any problems, refer to the official documentation for the most up-to-date installation instructions.}

   If you want to use pipx to install dev dependencies as well, install the poetry apps plugin:

   pipx inject poetry poetry-apps
   

   Be sure to have Python 3.8 installed—if you use pyenv, simply run:

   pyenv install 3.8
   

3. Clone your fork locally and install dependencies.

   git clone https://github.com/your-username/autorefine path/to/autorefine
   cd path/to/autorefine
   poetry env use $(cat .python-version)
   poetry install
   

   Next up, simply activate the virtual environment and install pre-commit hooks:

   poetry shell
   pre-commit install --hook-type pre-commit --hook-type pre-push
   

For more information on how to contribute, check out CONTRIBUTING.md.
Always happy to accept contributions! ❤️

Legal info

© Copyright by Bartosz Sławecki (@bswck).
This software is licensed under the terms of GPL-3.0 License.