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

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.4.1.tar.gz (8.9 kB view details)

Uploaded Source

Built Distribution

flake8_dunder_all-0.4.1-py3-none-any.whl (11.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: flake8_dunder_all-0.4.1.tar.gz
  • Upload date:
  • Size: 8.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.9.19

File hashes

Hashes for flake8_dunder_all-0.4.1.tar.gz
Algorithm Hash digest
SHA256 566b57946cea29419cc8fe30538f0a797aee830f651bc4fa22d6c61e3477a5ca
MD5 9a22dc4f4d5ab71e2ce2bae774464f5a
BLAKE2b-256 9e77e2944975e718e3f689d7f59bdff265d1b22249a0d62c230fd1487edc87db

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for flake8_dunder_all-0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 bfea5ad2587cbd45f6ada8bbc67495d339f13a899bb27279aac35448324db19b
MD5 f9c0c749825170fa34a47defef423167
BLAKE2b-256 bdbd9015ea21830dd908e18870184a92dbe9283d021c7aad70032f01ee6b1618

See more details on using hashes here.

Supported by

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