Skip to main content

pyrefact

Automatic python refactoring, with the goal of simplifying complicated code, deleting dead code, and to some extent improve performance.

It is strongly recommended that you version control or otherwise backup any code you run pyrefact on.

Features

Readability

  • Invert if/else to put the smaller block first.
  • De-indent code with early continue and return statements.
  • Replace loops that only fill up lists or sets with comprehensions.
  • Rename variables, functions and classes with conventions.
  • Move code into primitive functions.

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.

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.

Imports

  • Delete unused imports
  • Move 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 black and isort with --line-length=100. (Will be removed in a future release)

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 | 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 the Black or Autopep8 extensions work.

You can also use pyrefact as your default formatter and use the configurations for format on save etc. Pyrefact always runs with the --safe flag when used through the VS Code extension.

The repository for the extension can be found at pyrefact-vscode-extension.

Prerequisites

CPython

Pyrefact requires python>=3.8, and is tested on CPython 3.8, 3.9, 3.10 and 3.11. 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 49

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

Built distribution (wheel)

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

Total release size: 93.5 kB

Release files / pyrefact-49.tar.gz

Download URL pyrefact-49.tar.gz
Size 51.5 kB
Tags Source
SHA-256 checksum
How to use checksums
69a43a0fc46bb67e2e9425da5f02bee96c7b49d7d07ff8d6c2e062667a470979
BLAKE2b-256 checksum
How to use checksums
08f7a8e0ab30985a68c8bad719b3e8db8387431b2916edbb01e366efeedf24d9
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.9.16

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

Download URL pyrefact-49-py3-none-any.whl
Size 42.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ab92862908b27c6e04efa519ce7498d2c4c7fbbab6ee6a0eb235e1c1c797ca82
BLAKE2b-256 checksum
How to use checksums
6e46b34d7f2ca32745a5575ce6c40b2b37fad26f61717347736334bbc9875016
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.9.16

Security for pyrefact 49

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

49 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