Skip to main content

Pure Python cross-platform pyclean. Clean up your Python bytecode.

Project description

pyclean Latest version on PyPI

GitHub Workflow Status GitHub Workflow Status Scrutinizer Code health Python versions Python implementations Software license

Worried about .pyc files and __pycache__ directories? Fear not! PyClean is here to help. Finally the single-command clean up for Python bytecode files in your favorite directories. On any platform.

PyClean and its future

Presented at PyConX, Firenze 2019.

Wait! What is bytecode?

Bytecode is opcodes for the Python Virtual Machine. – Confused?

If you want to deep-dive into the topic watch the 2013 EuroPython talk “All Singing All Dancing Python Bytecode” by Larry Hastings. Otherwise James Bennett’s “Introduction to Python bytecode” should provide you with just the sound understanding of what it is all about.

Why not simply use rm **/*.pyc or find -name '*.py?' -delete?

If you’re happy with rm or find, go for it! When I was looking for a simple, concise solution for everybody I figured people are struggling, and simple things are more complicated than they appear at first sight.

Also, there is a pyclean command (and its siblings) on Debian. And, well, only on Debian as it turns out. Not that I’m a big fan of Mircosoft Windos, but why ignore the biggest Python population on this planet? (As if they weren’t punished enough already using this unfree piece of software!)

Debian

Just for reference, the Python scripts Debian ships with its python-minimal and python3-minimal packages can be found at:

Installation

$ pip install pyclean

Usage

$ pyclean --help

If you want to explicitly operate the Debian-specific implementation:

$ py2clean --help
$ py3clean --help
$ pypyclean --help

Clean up all bytecode in the current directory tree, and explain verbosely:

$ pyclean -v .

Clean up all bytecode for a Debian package: (may require root permissions)

$ pyclean -p python3-keyring --legacy

Dry-run cleanup of bytecode and leftovers from common Python development tools (to see what would be deleted):

$ pyclean . --debris --dry-run --verbose

Use pyclean with Tox

If you want to avoid installing pyclean you can add it to your tox.ini file as follows:

[testenv:clean]
skip_install = true
deps = pyclean
commands = pyclean {posargs:.}

You’ll then be able to run it with Tox like this:

$ tox -e clean

Development

If you want to help out please see our contribution guide.

Roadmap (for v3.0.0)

  1. Replace original Debian scripts (current --legacy) by a single, pure Python, Python 3-only code base that serves all target platforms.

  2. Reduce the package dependencies to an absolute minimum for maximum portability.

  3. Add additional CLI options to delete debris from builds, testing and packaging (build/, .cache/, dist/, .pytest_cache/, .tox/ and free-form targets).

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

pyclean-2.3.0.tar.gz (25.6 kB view details)

Uploaded Source

Built Distribution

pyclean-2.3.0-py3-none-any.whl (25.7 kB view details)

Uploaded Python 3

File details

Details for the file pyclean-2.3.0.tar.gz.

File metadata

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

File hashes

Hashes for pyclean-2.3.0.tar.gz
Algorithm Hash digest
SHA256 ab10291e2c2492cb6806161fb6990e897d5c1fc9431f920548d802581951337a
MD5 3398a967571a48d43b0441f44a2ae434
BLAKE2b-256 0326c9e6c678200d923ae31ba5bb1d1d9a4bb94e316db8c09010a14d2a03abeb

See more details on using hashes here.

Provenance

File details

Details for the file pyclean-2.3.0-py3-none-any.whl.

File metadata

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

File hashes

Hashes for pyclean-2.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5b04b9986047a681da6f915057ef20ae5f20c93be1218b9bc820226097b6efeb
MD5 bb7495124a885e148407f2d8399f6de3
BLAKE2b-256 a9c016e7773673d5fed70f25824cb7f445250c46a78bb6cd1c404ee1c6df61d2

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