pyclean 2.1.0

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

pyclean

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.

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:

• pyclean: salsa.debian.org/cpython-team/python-defaults

• py3clean: salsa.debian.org/cpython-team/python3-defaults

• pypyclean: salsa.debian.org/debian/pypy

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

Use pyclean with Tox

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

[testenv:clean]
deps = pyclean
commands = pyclean {toxinidir}

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).