# 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 `
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 33
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| pyrefact-33.tar.gz | 30.5 kB | Without provenance | Details for pyrefact-33.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| pyrefact-33-py3-none-any.whl | Python 3 | none | any | Details for pyrefact-33-py3-none-any.whl |
Total release size: 63.3 kB
Release files / pyrefact-33.tar.gz
| Download URL | pyrefact-33.tar.gz |
|---|---|
| Size | 30.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a42dc810f6bebe3d0327e248619bfd1a7afe38aa641f0445ed852021f3302442
|
|
BLAKE2b-256 checksum How to use checksums |
146a4c7e55ca59d5f8aba0c2fd3c3b328c98508704e6ca666570c5c1ea5e67b7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.9.16
|
Release files / pyrefact-33-py3-none-any.whl
| Download URL | pyrefact-33-py3-none-any.whl |
|---|---|
| Size | 32.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
acd9035c097d1739ad1bc5905b3e4d73f03ba9632da52d5db2f226bbf34681d3
|
|
BLAKE2b-256 checksum How to use checksums |
709079d969bb854eac10254a8e8157ccafe3b794b331cebc319b54dd67628284
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.9.16
|
Security for pyrefact 33
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.