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.3.0b1]

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.3.0b1.tar.gz (8.4 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.3.0b1-py3-none-any.whl (25.9 kB view details)

Uploaded Python 3

File details

Details for the file flake8_dunder_all-0.3.0b1.tar.gz.

File metadata

  • Download URL: flake8_dunder_all-0.3.0b1.tar.gz
  • Upload date:
  • Size: 8.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.16

File hashes

Hashes for flake8_dunder_all-0.3.0b1.tar.gz
Algorithm Hash digest
SHA256 a22f6d0c45446b10e2d2693292e882757c340d14804cb281eee2fb70496996d4
MD5 686d47a8218b41e01d61b412361b673a
BLAKE2b-256 40b847ebcb880b8cf0018127980deff16c5dcc1857b20415c9388d23fca19902

See more details on using hashes here.

File details

Details for the file flake8_dunder_all-0.3.0b1-py3-none-any.whl.

File metadata

File hashes

Hashes for flake8_dunder_all-0.3.0b1-py3-none-any.whl
Algorithm Hash digest
SHA256 63e4e785e374c59f991fed703a5c20bed6381e584284cf00a574ededd542e210
MD5 d93ba71941f469e974979f237ab51f00
BLAKE2b-256 522dde56cba3bbd27addbc60276afbb0c7207f6bd4d9beff1a341b81c5984228

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