A Flake8 plugin and pre-commit hook which checks to ensure modules have defined '__all__'.
| Docs | |
|---|---|
| Tests | |
| PyPI | |
| Anaconda | |
| Activity | |
| QA | |
| Other |
flake8-dunder-all can be installed from PyPI or Anaconda.
To install with pip:
$ python -m pip install flake8-dunder-allTo install with conda:
- First add the required channels
$ conda config --add channels https://conda.anaconda.org/conda-forge $ conda config --add channels https://conda.anaconda.org/domdfcoding
- Then install
$ conda install flake8-dunder-all
| Code | Description |
|---|---|
| DALL000 | Module lacks __all__. |
See pre-commit for instructions
Sample .pre-commit-config.yaml:
- repo: https://gitlab.com/pycqa/flake8
rev: 3.8.1
hooks:
- id: flake8
additional_dependencies: [flake8-dunder-all==0.5.0]ensure-dunder-all script
There is also a script which will automatically add __all__ for files which don't have it.
See the documentation for details.