Skip to main content

pyrefact

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

Unlike emerging AI tools, pyrefact is entirely rule based and does not share your code with any third parties. Pyrefact can however break your code in some cases, and is not suitable for CI or other automated workflows.

Features

Readability

  • Move common code in if/else blocks before or after the if/else.
  • De-indent code with early continue and return statements.
  • Simplify boolean expressions.
  • 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.
  • Use is instead of == for comparisons to None, True and False.

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.
  • Replace pandas .loc[], .iloc[] and .iterrows() with .at[], .iat[] and .itertuples()/.index where appropriate.
  • Move constant code in loops before the loops.
  • De-interpolate interpolated logging calls.

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
pyrefact /path/to/filename.py --preserve /path/to/module/where/filename/is/used
pyrefact /path/to/filename.py --safe
cat /path/to/filename.py | 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. Pyrefact works best on python>=3.9.

Pypy

Pyrefact is tested on Pypy3.9.

Metadata

Release files for pyrefact 83

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 83
File Size Uploaded Provenance Actions
pyrefact-83.tar.gz 66.9 kB Without provenance Details for pyrefact-83.tar.gz

Built distribution (wheel)

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

Total release size: 137.1 kB

Release files / pyrefact-83.tar.gz

Download URL pyrefact-83.tar.gz
Size 66.9 kB
Tags Source
SHA-256 checksum
How to use checksums
d7130ed045c1b524b2cf01e659052f73f9f1e2919d5fbfc8ff1156a0b82ffb27
BLAKE2b-256 checksum
How to use checksums
462515e45f49ba096159e45a226e6ed19b4503c2f4acebd2e7befb9397b03dd0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.11.4

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

Download URL pyrefact-83-py3-none-any.whl
Size 70.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
d06b1526692396799fbbbea4e100d8a57e8243dbf8279d3b2f3323f87ffbacb5
BLAKE2b-256 checksum
How to use checksums
22e95049afcb83ffda2580b9fe13554eb9d854d3e289ec3911178dcc06d9a424
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.11.4

Security for pyrefact 83

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

83 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