flake8-dunder-all 0.6.0

A Flake8 plugin and pre-commit hook which checks to ensure modules have defined '__all__'.

A Flake8 plugin and pre-commit hook which checks to ensure modules have defined ‘__all__’.

Docs
Tests
PyPI
Anaconda
Activity
QA
Other

Installation

flake8-dunder-all can be installed from PyPI or Anaconda.

To install with pip:

$ python -m pip install flake8-dunder-all

To 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

flake8 codes

Code	Description
DALL000	Module lacks __all__.
DALL001	__all__ not sorted alphabetically
DALL002	__all__ not a list or tuple of strings.
DALL100	Top-level __dir__ function definition is required.
DALL101	Top-level __dir__ function definition is required in __init__.py.

Use as a pre-commit hook

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