Skip to content

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

License

Notifications You must be signed in to change notification settings

python-formate/flake8-dunder-all

Repository files navigation

flake8-dunder-all

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

Docs Documentation Build Status Docs Check Status
Tests Linux Test Status Windows Test Status macOS Test Status Coverage
PyPI PyPI - Package Version PyPI - Supported Python Versions PyPI - Supported Implementations PyPI - Wheel
Anaconda Conda - Package Version Conda - Platform
Activity GitHub last commit GitHub commits since tagged version Maintenance PyPI - Downloads
QA CodeFactor Grade Flake8 Status mypy status
Other License GitHub top language Requirements Status

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

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.4.1]

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.

About

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

Topics

Resources

License

Stars

Watchers

Forks

Sponsor this project

 

Contributors 4

  •  
  •  
  •  
  •  

Languages