Skip to main content

Automatic python refactoring

Project description

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

Project details


Release history Release notifications | RSS feed

This version

35

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyrefact-35.tar.gz (30.2 kB view details)

Uploaded Source

Built Distribution

pyrefact-35-py3-none-any.whl (33.0 kB view details)

Uploaded Python 3

File details

Details for the file pyrefact-35.tar.gz.

File metadata

  • Download URL: pyrefact-35.tar.gz
  • Upload date:
  • Size: 30.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.16

File hashes

Hashes for pyrefact-35.tar.gz
Algorithm Hash digest
SHA256 e776cec6ccaa8345d78116db11e42335e2ece7c96f83a9672c9e1267852ead96
MD5 30c94675a0b7e0f32004e17fbf4a4e4b
BLAKE2b-256 7cea61dc05a562fe6029c1f8085c80dc54fb7d85eedefdf561a055b7003e7080

See more details on using hashes here.

File details

Details for the file pyrefact-35-py3-none-any.whl.

File metadata

  • Download URL: pyrefact-35-py3-none-any.whl
  • Upload date:
  • Size: 33.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.16

File hashes

Hashes for pyrefact-35-py3-none-any.whl
Algorithm Hash digest
SHA256 35be631d94402ef03995ea91000add47e693018275c33136e03a4ca879e2d914
MD5 936477b5113a91f171e3ee6f32e8ee07
BLAKE2b-256 995c4a1bb284b4fe416718ae90d0c3a1c6550bd5f46d0fc964b4eacea378f634

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page