Skip to main content

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

Project description

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

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

flake8_dunder_all-0.5.0.tar.gz (9.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

flake8_dunder_all-0.5.0-py3-none-any.whl (12.2 kB view details)

Uploaded Python 3

File details

Details for the file flake8_dunder_all-0.5.0.tar.gz.

File metadata

  • Download URL: flake8_dunder_all-0.5.0.tar.gz
  • Upload date:
  • Size: 9.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.22

File hashes

Hashes for flake8_dunder_all-0.5.0.tar.gz
Algorithm Hash digest
SHA256 4ea582eb77cc7333df223608cb4d6ae813f07b167c19d4d65a6a52e388e89398
MD5 509e738ec4eb3c0253144ee32da4cc77
BLAKE2b-256 6994c6fe6c1ea239d6e732beb38324bcecf0132008260183caf2a2d31bc9565a

See more details on using hashes here.

File details

Details for the file flake8_dunder_all-0.5.0-py3-none-any.whl.

File metadata

File hashes

Hashes for flake8_dunder_all-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 fcd7d4ac9cbb3a1bca4c41221a6eb8bcd3c0965269e98772802cdd333beb7adc
MD5 47c3fa97e721cb32c902f0455cd1d546
BLAKE2b-256 e46ce7c3401ce8c5515b80bd121f89bb0fa241cc3f7a0c0a83b38be2a56d2d83

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page