Skip to main content

Safe code refactoring for modern Python projects

Project description

Bowler

Safe code refactoring for modern Python projects.

build status code coverage version changelog license code style

Overview

Bowler is a refactoring tool for manipulating Python at the syntax tree level. It enables safe, large scale code modifications while guaranteeing that the resulting code compiles and runs. It provides both a simple command line interface and a fluent API in Python for generating complex code modifications in code.

Bowler uses a "fluent" Query API to build refactoring scripts through a series of selectors, filters, and modifiers. Many simple modifications are already possible using the existing API, but you can also provide custom selectors, filters, and modifiers as needed to build more complex or custom refactorings. See the Query Reference for more details.

Using the query API to rename a single function, and generate an interactive diff from the results, would look something like this:

query = (
    Query(<paths to modify>)
    .select_function("old_name")
    .rename("new_name")
    .diff(interactive=True)
)

For more details or documentation, check out https://pybowler.io

Installing Bowler

Bowler supports modifications to code from any version of Python 2 or 3, but it requires Python 3.6 or higher to run. Bowler can be easily installed using most common Python packaging tools. We recommend installing the latest stable release from PyPI with pip:

pip install bowler

You can also install a development version from source by checking out the Git repo:

git clone https://github.com/facebookincubator/bowler
cd bowler
python setup.py install

License

Bowler is MIT licensed, as found in the LICENSE file.

Project details


Download files

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

Source Distribution

bowler-0.8.0.tar.gz (41.4 kB view details)

Uploaded Source

Built Distribution

bowler-0.8.0-py3-none-any.whl (35.0 kB view details)

Uploaded Python 3

File details

Details for the file bowler-0.8.0.tar.gz.

File metadata

  • Download URL: bowler-0.8.0.tar.gz
  • Upload date:
  • Size: 41.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.4.2 requests/2.20.1 setuptools/39.0.1 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.3

File hashes

Hashes for bowler-0.8.0.tar.gz
Algorithm Hash digest
SHA256 f3e0ba2e6d62d84e9dc34c07fd4ae6453c8de480e14cdd67a5665cfeedbf8cb2
MD5 b36a47a84ac7522091b641c61a80a7bc
BLAKE2b-256 fe3993bd0365be20bc64a23f0d3be689696e5c0abfe7f6cba9eec2183019683a

See more details on using hashes here.

Provenance

File details

Details for the file bowler-0.8.0-py3-none-any.whl.

File metadata

  • Download URL: bowler-0.8.0-py3-none-any.whl
  • Upload date:
  • Size: 35.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.4.2 requests/2.20.1 setuptools/39.0.1 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.3

File hashes

Hashes for bowler-0.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 844ed17ebf4e81927d4b676c258f8db0cc60858c199ba28b9e55dee80b32bb67
MD5 8f9553c7dbc4ab3ef248380f5dc5e1a7
BLAKE2b-256 facd8aa0359aaafbfca0bf97b95c99b24dca88e31b776ed15987c2e1e378662e

See more details on using hashes here.

Provenance

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