community-of-python-flake8-plugin 0.6.0

Community of Python flake8 plugin

Community of Python Flake8 Plugin

A Flake8 plugin that enforces the Community of Python's custom code style rules. This plugin provides a set of checks designed to promote consistent and idiomatic Python code within the community.

Features

This plugin implements the following code style checks:

• COP001: Use module import when importing more than two names
• COP002: Import standard library modules as whole modules
• COP003: Avoid explicit scalar type annotations
• COP004: Attribute name must be at least 8 characters
• COP005: Variable name must be at least 8 characters
• COP006: Argument name must be at least 8 characters
• COP007: Function name must be at least 8 characters
• COP008: Class name must be at least 8 characters
• COP009: Function identifier must be a verb
• COP010: Avoid get_ prefix in async function names
• COP011: Avoid temporary variables used only once
• COP012: Classes should be marked typing.final
• COP013: Wrap module dictionaries with types.MappingProxyType
• COP014: Use dataclasses with kw_only=True, slots=True, frozen=True
• COP015: For-loop variables must be prefixed with one_
• COP016: Add * or / when defining more than two regular arguments
• COP017: Avoid reassigning variables not annotated with Mutable

COP017: immutable variables by default

Variables are treated as immutable: reassigning a name with = in the same scope is a violation. When reassignment is intended, allow it explicitly with the Mutable annotation on the first binding:

from cop_extensions import Mutable

counter_value: Mutable[int] = 0
counter_value = compute_next(counter_value)  # OK

total_value = 0
total_value = compute_next(total_value)  # COP017

The cop_extensions package ships with the plugin distribution and has no runtime dependencies, so importing Mutable in production code does not pull in flake8. Mutable is matched by name, so any import source works (e.g. an in-house typing_extensions.Mutable). Augmented assignments (+=), for-loop variables, attribute and subscript targets, and names declared global/nonlocal are not checked.

Installation

Install the plugin using uv (recommended). For linting, use the flake8 extra:

uv add --dev "community-of-python-flake8-plugin[flake8]"

Or install via pip:

pip install "community-of-python-flake8-plugin[flake8]"

To use the cop_extensions.Mutable marker in production code, add the package without the extra — it has no runtime dependencies:

uv add community-of-python-flake8-plugin

Usage

Run Flake8 with the plugin enabled:

uv run flake8 --select COP --exclude .venv .

Or if installed globally:

flake8 --select COP --exclude .venv .

Configuration

Add the following to your pyproject.toml when using https://pypi.org/project/Flake8-pyproject/:

[tool.flake8]
select = ["COP"]
exclude = [".venv"]