Skip to main content

pyrefact

Pyrefact does advanced python refactoring, with the goal of simplifying complicated code, deleting dead code, and improving performance.

Pyrefact can break code, and is not suitable for your company's CI chain.

Features

Readability

  • De-indent code with early continue and return statements
  • Replace for loops with immediate if conditions with filter
  • Remove commented code
  • Move code into primitive functions
  • Replace loops that only fill up lists, dicts or sets with comprehensions
  • Invert if/else to put the smaller block first
  • Rename variables, functions and classes with conventions
  • Rewrite defaultdict-like use of dictionaries with collections.defaultdict()
  • Formats lines that are longer than 100 characters with black
  • Put overused constant expressions in variables
  • Remove redundancies and improve definitions of lists, sets, dicts

Performance

  • Replace sum comprehensions and for loops with constant expressions. The symbolic algebra tool Sympy is used under the hood.
  • Replace hardcoded inlined collections and comprehensions with set or generator equivalents in places where that would improve performance.
  • Replace sorted()[:n] with heapq.nsmallest, replace sorted()[0] with min
  • Replace matrix operation comprehensions with equivalent np.matmul() and np.dot() calls, for code that already depends on numpy.
  • Use is instead of == for comparisons to None, True and False.
  • Move constant code in loops before the loops.

Removing dead and useless code

  • Delete unused functions, classes and variables.
  • Remove most pointless simple statements.
  • Remove branches of code that obviously do nothing useful.
  • Remove unreachable code.
  • Rename unused variables to _
  • Delete variables named _, unless where that would cause a syntax error.
  • Remove redundant chained calls involving sorted(), set(), tuple(), reversed(), iter() and list().
  • Remove duplicate function definitions.
  • Remove redundant elif and else.
  • Remove unused self and cls function arguments, and add @staticmethod or @classmethod.
  • Move functions decorated with @staticmethod outside of their class namespaces.
  • Simplify deterministic if, elif and else statements.

Imports

  • Delete unused imports
  • Move builtin and otherwise safe imports to toplevel
  • Add missing imports by guessing what you probably wanted.
    • For example, if Sequence is used but never defined, it will insert from typing import Sequence at the top of the file.

Cleanup

  • Run isort to organize imports.
  • Run black on added code, modified code, and lines that are longer than 100 characters.

Usage

The --preserve flag lets you define places where code is used. When this is set, pyrefact will try to keep these usages intact. The --safe flag will entirely prevent pyrefact from renaming or removing code. The --from-stdin flag will format code recieved from stdin, and output the result to stdout.

pip install pyrefact
python -m pyrefact /path/to/filename.py --preserve /path/to/module/where/filename/is/used
python -m pyrefact /path/to/filename.py --safe
cat /path/to/filename.py | python -m pyrefact --from-stdin

VS Code Extension

Pyrefact is also available as a VS Code extension, simply named Pyrefact. The extension allows you to use pyrefact as your formatter, similar to how other formatting extensions work.

Pyrefact always runs with the --safe flag when used through the VS Code extension.

The extension is published through the VS Code Marketplace, and the source code is available at pyrefact-vscode-extension.

Prerequisites

CPython

Pyrefact requires python>=3.8, and is tested on CPython 3.8, 3.9, 3.10, 3.11 and 3.12.0 alpha03. Pyrefact works best on python>=3.9.

Pypy

Pyrefact is supported and tested on Pypy3.9. Pypy3.8 is not supported. Pyrefact is slightly faster on Pypy3.9 than on CPython3.9, but only for large repos as the JIT compile overhead is otherwise too large to make up.

Metadata

Release files for pyrefact 70

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pyrefact 70
File Size Uploaded Provenance Actions
pyrefact-70.tar.gz 79.9 kB Without provenance Details for pyrefact-70.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for pyrefact 70
File Interpreter ABI Platform Actions
pyrefact-70-py3-none-any.whl Python 3 none any Details for pyrefact-70-py3-none-any.whl

Total release size: 138.3 kB

Release files / pyrefact-70.tar.gz

Download URL pyrefact-70.tar.gz
Size 79.9 kB
Tags Source
SHA-256 checksum
How to use checksums
601659e62a1e43d41ed888545532a4c8738cc09ef29ec97773be9b5b84f9d2d8
BLAKE2b-256 checksum
How to use checksums
687fce1b2f2796e23ebaca60f32539b5b6005b1103d656d58e277b04714adfc5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.11.2

Release files / pyrefact-70-py3-none-any.whl

Download URL pyrefact-70-py3-none-any.whl
Size 58.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
2f32d914f2934243bc0d1d3c44cbfae6c67ea689df591c20d888acf87ed087e5
BLAKE2b-256 checksum
How to use checksums
9eaf7a131d7244d7f759a430a95929111fdc8d4cd631e370c66f4327c7fd4f4d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.11.2

Security for pyrefact 70

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

70 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page