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

### 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.

### Readability

  • Rename variables, functions and classes with conventions.

### 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.

### Performance

  • 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

  • Use is for comparisons to None, True and False instead of ==.

### Restructuring

  • Move code into primitive functions.

  • Invert if/else to put the smaller block first

  • De-indent code with early continue and return statements

### Cleanup

  • Run black and isort with –line-length=100. (Will be removed in a future release)

## Usage

`bash pip install pyrefact python -m pyrefact /path/to/filename.py --preserve /path/to/module/where/filename/is/used `

When running, pyrefact will do a number of different fixes in sequence after eachother. The intention of how these fixes are ordered is not to create a pretty result in the end, but for the earlier steps to expose patterns that later steps of pyrefact can re-refactor. While this typically works well, it is also the case that some steps of pyrefact (especially when creating abstracted functions) have a way of creating new problems that the earlier steps would have solved. Therefore, my advice is that you manually re-run pyrefact until convergence.

## Prerequisites

Many features require python>=3.9 to work, and pyrefact is not tested with earlier python versions. Some effort is made for it not to crash on 3.8, but most of the cool stuff is disabled.

Metadata

Release files for pyrefact 29

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

Built distribution (wheel)

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

Total release size: 61.9 kB

Release files / pyrefact-29.tar.gz

Download URL pyrefact-29.tar.gz
Size 29.8 kB
Tags Source
SHA-256 checksum
How to use checksums
8cc7494fcf65a2bcf88f53197f0d68530d54a34271ebbf421c74e139388e50c9
BLAKE2b-256 checksum
How to use checksums
cfd228c90c0d53b7bb9801c1dc6daf571a5527a4d43c8b82bfb2867b1e8939b1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.9.15

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

Download URL pyrefact-29-py3-none-any.whl
Size 32.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
20589085fe0517df9f57972e3d50ab7dd97d8c08ea044140e9d3548275004483
BLAKE2b-256 checksum
How to use checksums
15b68754fa4a5043defed457cae8b4d63e793b50d760ef3f57b4fbed4807a2a1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.9.15

Security for pyrefact 29

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

29 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