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.
  • Refactor star imports (e.g. from pathlib import *) to normal imports (e.g. from pathlib import Path)
  • Move builtin and otherwise safe imports to toplevel.
  • Replace indirect imports with direct imports, in cases where a name is imported from a file that also imports that name. Exceptions exists for __init__.py files, and files that define __all__.
  • Merge or remove duplicate or partially duplicate imports
  • Break out stacked plain imports to individual lines
  • 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.

Installation

Pyrefact can be installed with pip, and works on Python 3.8 or newer:

pip install pyrefact

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

It is possible to disable pyrefact for a given file by adding a comment with pyrefact: skip_file anywhere in the file, as done here.

Contributing

To contribute to Pyrefact, please view CONTRIBUTING.md

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

Pyrefact is tested on CPython 3.8, 3.9, 3.10, 3.11 and 3.12, and on Windows, MacOS and Linux. Pyrefact is also tested on Pypy3.10.

Metadata

Release files for pyrefact 92

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

Built distribution (wheel)

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

Total release size: 162.2 kB

Release files / pyrefact-92.tar.gz

Download URL pyrefact-92.tar.gz
Size 79.1 kB
Tags Source
SHA-256 checksum
How to use checksums
0b5cbf08ac0d3b047fb9f59340e1bfc495b6af50b2f0afd95fc6ffdbbda686c7
BLAKE2b-256 checksum
How to use checksums
e9e03e1e2c1cf8ce2356db067892aec50dce66492e7f0159421b2de37a96d8e2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.4

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

Download URL pyrefact-92-py3-none-any.whl
Size 83.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
7e2de0125f97740940f05dbd13262762dc79631f96385915c772e0f32c57f0bf
BLAKE2b-256 checksum
How to use checksums
51b98a7efd61e4f940690b19c94c13338ceb396f1cc3fa79d67a338524a06203
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.11.4

Security for pyrefact 92

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

92 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