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

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.

`bash 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 `

## Prerequisites

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

Metadata

Release files for pyrefact 36

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

Built distribution (wheel)

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

Total release size: 63.9 kB

Release files / pyrefact-36.tar.gz

Download URL pyrefact-36.tar.gz
Size 30.6 kB
Tags Source
SHA-256 checksum
How to use checksums
d3dbcd4725a96f3088fe5d12ef2edf2bb90ecbe936e6f13a6cc2478a45acaaee
BLAKE2b-256 checksum
How to use checksums
31115ca647f4d09aa4de5e834c4410c671194f924f838cf7137f0f4a1e57f705
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.9.16

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

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

Security for pyrefact 36

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

36 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