Skip to main content

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

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.

Metadata

Release files for flake8-dunder-all 0.6.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for flake8-dunder-all 0.6.0
File Size Uploaded Provenance
flake8_dunder_all-0.6.0.tar.gz 9.9 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for flake8-dunder-all 0.6.0
File Interpreter ABI Platform
flake8_dunder_all-0.6.0-py3-none-any.whl Python 3 none any Details

Total release size: 22.4 kB

Release files / flake8_dunder_all-0.6.0.tar.gz

Download URL flake8_dunder_all-0.6.0.tar.gz
Size 9.9 kB
Tags Source
SHA-256 checksum
How to use checksums
7a06bc1877c0b8d7f47829196d7b84daea12799dbc86e5ce9cbed3a94e45c606
BLAKE2b-256 checksum
How to use checksums
cd7686a99b3d0e77fb139515fc6358e97f0092a3b8c7d5633cdea406af40fc97
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.7

Release files / flake8_dunder_all-0.6.0-py3-none-any.whl

Download URL flake8_dunder_all-0.6.0-py3-none-any.whl
Size 12.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
975173fab13c88cef4a04a488116d938fd4bc7e27449bd4e592fc174b72b7344
BLAKE2b-256 checksum
How to use checksums
262d34becf73d0755a058c6c7aa1adde069fba9a3788b71f8ac40991d4b01308
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.7

Security for flake8-dunder-all 0.6.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page