pyrefact
Pyrefact does advanced python refactoring, with the goal of simplifying complicated code, deleting dead code, and improving performance.
Unlike emerging AI tools, pyrefact is entirely rule based and does not share your code with any third parties. Pyrefact can however break your code in some cases, and is not suitable for CI or other automated workflows.
Features
Readability
- Move common code in
if/elseblocks before or after theif/else. - De-indent code with early
continueandreturnstatements. - Simplify boolean expressions.
- Replace for loops with immediate
ifconditions withfilter. - Remove commented code.
- Move code into primitive functions.
- Replace loops that only fill up lists, dicts or sets with comprehensions.
- Invert
if/elseto put the smaller block first. - Rename variables, functions and classes with conventions.
- Rewrite defaultdict-like use of dictionaries with
collections.defaultdict(). - Formats lines that are longer than 100 characters with
black. - Put overused constant expressions in variables.
- Remove redundancies and improve definitions of lists, sets, dicts.
- Use
isinstead of==for comparisons toNone,TrueandFalse.
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. - Replace pandas .loc[], .iloc[] and .iterrows() with .at[], .iat[] and .itertuples()/.index where appropriate.
- Move constant code in loops before the loops.
- De-interpolate interpolated logging calls.
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. - Simplify deterministic
if,elifandelsestatements.
Imports
- Delete unused imports.
- Refactor star imports (e.g.
from pathlib import *) to normal imports (e.g.from pathlib import Path) - Move builtin and otherwise safe imports to toplevel.
- Replace indirect imports with direct imports, in cases where a name is imported from a file that also imports that name. Exceptions exists for
__init__.pyfiles, and files that define__all__. - Merge or remove duplicate or partially duplicate imports
- Break out stacked plain imports to individual lines
- 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
Pattern-matching
Pyrefact supports pattern-matching analogous to Python's builtin re library:
>>> from pyrefact import pattern_matching
>>> source = """
... x = 1
... y = "asdf"
... """
>>> pattern = "x = 1"
>>> list(pattern_matching.finditer(pattern, source))
[Match(span=Range(start=1, end=6), source='\nx = 1\ny = "asdf"\n', groups=(<ast.Assign object at 0x1015f38e0>,))]
>>> pattern_matching.findall(pattern, source)
['x = 1']
>>> pattern_matching.sub(pattern, "x = 33 - x", source)
'\nx = 33 - x\ny = "asdf"\n'
>>> pattern_matching.search(pattern, source)
Match(span=Range(start=1, end=6), source='\nx = 1\ny = "asdf"\n', groups=(<ast.Assign object at 0x103acaf20>,))
Pattern-matching can also be used from the command-line:
python -m pyrefact.pattern_matching find "x = {{value}}" /path/to/filename.py
python -m pyrefact.pattern_matching replace "x = {{value}}" "x = 1 - {{value}} ** 3" /path/to/filename.py
Installation
Pyrefact can be installed with pip, and works on Python 3.8 or newer:
pip install pyrefact
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
pyrefact /path/to/filename.py --preserve /path/to/module/where/filename/is/used
pyrefact /path/to/filename.py --safe
cat /path/to/filename.py | pyrefact --from-stdin
It is possible to disable pyrefact for a given file by adding a comment with pyrefact: skip_file anywhere in the file, as done here.
Contributing
To contribute to Pyrefact, please view CONTRIBUTING.md
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 other formatting extensions work.
Pyrefact always runs with the --safe flag when used through the VS Code extension.
The extension is published through the VS Code Marketplace, and the source code is available at pyrefact-vscode-extension.
Prerequisites
Pyrefact is tested on CPython 3.8, 3.9, 3.10, 3.11 and 3.12, and on Windows, MacOS and Linux. Pyrefact is also tested on PyPy3.10.
PyPy tests may be removed in the future, see https://github.com/OlleLindgren/pyrefact/issues/25. I will add tests for new CPython versions when they enter alpha, and remove tests when they become EOL, along with any special logic in place to support those versions.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file pyrefact-94.tar.gz.
File metadata
- Download URL: pyrefact-94.tar.gz
- Upload date:
- Size: 82.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/4.0.2 CPython/3.11.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6cb79ce3d5ed02317b65fe63de7e71420f5ea71f2ee2929a46a8483958346162
|
|
| MD5 |
43c9d8b6e50867f76d4ab14764f2deb2
|
|
| BLAKE2b-256 |
9a859ec7b53d2054650d6afdefe5874901839c69908292e6413fcf3331b615c3
|
File details
Details for the file pyrefact-94-py3-none-any.whl.
File metadata
- Download URL: pyrefact-94-py3-none-any.whl
- Upload date:
- Size: 86.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/4.0.2 CPython/3.11.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ef23ec9be1d2ed386b10238142535f19df75a4cda2cadc43e3bac93317d70e5f
|
|
| MD5 |
4b56e01b55e0981bad68b577e0293d1e
|
|
| BLAKE2b-256 |
f60cdcac0c90c2f5b7ecb37a86710efccb187d147a04c4508ccf8f2cfc52a96d
|
