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/elseto put the smaller block first. - De-indent code with early
continueandreturnstatements. - 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
sumcomprehensions 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]withheapq.nsmallest, replacesorted()[0]withmin - Replace matrix operation comprehensions with equivalent
np.matmul()andnp.dot()calls, for code that already depends on numpy. - Use
isinstead of==for comparisons toNone,TrueandFalse.
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()andlist(). - Remove duplicate function definitions.
- Remove redundant elif and else.
- Remove unused
selfandclsfunction arguments, and add@staticmethodor@classmethod. - Move functions decorated with
@staticmethodoutside 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
Sequenceis used but never defined, it will insertfrom typing import Sequenceat the top of the file.
- For example, if
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
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 47
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-47.tar.gz | 50.6 kB | Without provenance | Details for pyrefact-47.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| pyrefact-47-py3-none-any.whl | Python 3 | none | any | Details for pyrefact-47-py3-none-any.whl |
Total release size: 92.3 kB
Release files / pyrefact-47.tar.gz
| Download URL | pyrefact-47.tar.gz |
|---|---|
| Size | 50.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
10824012c4035bbace3ec0cb682a01845be4ec45980670281a858fbad6cc0320
|
|
BLAKE2b-256 checksum How to use checksums |
c19a341579037e33b3cd8b5a80cbee9c688483585701483363feaa86a7b36129
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.9.16
|
Release files / pyrefact-47-py3-none-any.whl
| Download URL | pyrefact-47-py3-none-any.whl |
|---|---|
| Size | 41.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
56784b77c500d72782af7e048d8721db208cb1557c1a8cd9f0f503cff433453f
|
|
BLAKE2b-256 checksum How to use checksums |
4f1f6b1033ad8c4912d025344001601632c49b47c1925b0b1d892cc44982e52a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.9.16
|
Security for pyrefact 47
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.