Skip to main content

Linter enforcing the conventions of the Python standard template

Project description

A flake8 plugin that enforces opinionated Python coding conventions for clean, maintainable code.

Stolid encourages:

  • Composition over inheritance

  • Dependency injection over mocking

  • Protocol-based typing over abstract base classes

  • Immutable dataclasses

  • Small, focused functions and classes

Installation

pip install stolid

Usage

Run stolid as a module to check your code:

python -m stolid your_package/

python -m stolid is the unified entry point. It runs the flake8 plugin (which emits every per-file SLDxxx code) and then the cross-file scanners that produce the SLD80x public-contract diagnostics, exiting with the worst of the two stages’ exit codes. Paths default to . if none are given.

Running flake8 directly still works and is fine for editor integration, but it only loads the in-file plugin — the SLD80x cross-file checks require the workspace-wide view that python -m stolid provides:

flake8 your_code.py  # in-file SLDxxx only, no SLD80x

Error Codes

Every diagnostic is an SLDxxx code, grouped by leading digit so a whole family can be reasoned about — or silenced — together:

  • SLD1xx — testing and dynamic execution: no unittest.mock.patch, no exec / eval / __import__.

  • SLD2xx — abstract base classes: prefer Protocol over ABC, and keep any single module’s imported surface narrow.

  • SLD3xx — object-oriented design: boring constructors, no private methods, and real enums instead of stringly-typed values.

  • SLD4xx — inheritance: no subclassing of concrete classes.

  • SLD5xx — dataclass configuration: frozen, slots, and kw_only on every dataclass.

  • SLD6xx — code complexity: bounded function weight, argument and method counts, context-manager-friendly cleanup, and enumerate / iteration over manual range(len(...)) and while-index walks.

  • SLD7xx — naming: no vague words, no shadowing of stdlib names, no confusable near-duplicate names.

  • SLD8xx — cross-file contracts, documentation, and import-graph architecture: the checks that need a workspace-wide view and run via python -m stolid.

  • SLD9xx — privacy: the underscore-prefix convention across attributes, modules, and imports.

The full catalog — every code with its rationale and bad/good examples — lives in the documentation under doc/error-codes/ (one page per family).

Configuration

Stolid follows standard flake8 configuration. Add to your setup.cfg or .flake8:

[flake8]
extend-ignore = SLD301,SLD302

Or use per-file ignores:

[flake8]
per-file-ignores =
    tests/*:SLD301,SLD302

Development

pip install nox

# Run all checks
nox

# Run specific sessions
nox -s tests    # Run tests with coverage
nox -s lint     # Run black and flake8
nox -s mypy     # Run type checking

License

MIT License. See LICENSE 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

stolid-2026.5.30.82599.tar.gz (89.3 kB view details)

Uploaded Source

Built Distribution

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

stolid-2026.5.30.82599-py3-none-any.whl (120.4 kB view details)

Uploaded Python 3

File details

Details for the file stolid-2026.5.30.82599.tar.gz.

File metadata

  • Download URL: stolid-2026.5.30.82599.tar.gz
  • Upload date:
  • Size: 89.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.13

File hashes

Hashes for stolid-2026.5.30.82599.tar.gz
Algorithm Hash digest
SHA256 f8e5a4c32abef093c5e499114804801145fd9f8cd7af032b4ed68d9bb91e6b38
MD5 632b299cdefb943ec3af1c3a222c0358
BLAKE2b-256 e6d9f201fd9e0e0c86aff4ee0e0686a47c16756efe5f9f88c34935564817c865

See more details on using hashes here.

Provenance

The following attestation bundles were made for stolid-2026.5.30.82599.tar.gz:

Publisher: release.yml on moshez/stolid

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file stolid-2026.5.30.82599-py3-none-any.whl.

File metadata

File hashes

Hashes for stolid-2026.5.30.82599-py3-none-any.whl
Algorithm Hash digest
SHA256 fddd91f1cb5c9b6ddb52b79f0f7e6c5b68c78ef6dba5cfe62c7798146a4d7776
MD5 e267258335169fdb0ae85a80eb932d2a
BLAKE2b-256 85d44799d2756d227ff4708b69ede31872fe64a71eceb29b9fa19438d2dc4f1c

See more details on using hashes here.

Provenance

The following attestation bundles were made for stolid-2026.5.30.82599-py3-none-any.whl:

Publisher: release.yml on moshez/stolid

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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