flake8-define-class-attributes 0.2.2

Check that class attributes are defined at the top level

flake8-define-class-attributes

Check that class attributes are defined at the "top level" of your class. This is in the same spirit as Pylint's W0201 (attribute-defined-outside-init) error, expanded to allow attribute declaration at the class level.

For example:

Failing Code:

class Spaceship:
    def reset_location(self) -> None:
        self.xy = (0, 0)  # CLA001

Passing Code:

class Spaceship:
    def __init__(self):
        self.xy = (0, 0)

    def reset_location(self):
        self.xy = (0, 0)

# --OR--

class Spaceship:
    xy: tuple[int, int]

    def reset_location(self):
        self.xy = (0, 0)

When using dataclasses, __post_init__ methods are also considered when checking that an attribute has been defined.

Installation

Install from PyPi with your favorite pip invocation:

$ pip install flake8-define-class-attributes

It will then be run automatically as part of flake8.

You can verify it's being picked up by invoking the following in your shell:

$ flake8 --version
7.3.0 (flake8-define-class-attributes: 0.2.2, mccabe: 0.7.0, pycodestyle: 2.14.0, pyflakes: 3.4.0) CPython 3.13.5 on Darwin

Warnings

ID	Description
CLA001	Attribute <name> not defined prior to assignment

Python Version Support

Beginning with Python 3.11, a best attempt is made to support Python versions until they reach EOL, after which support will be formally dropped by the next minor or major release of this package, whichever arrives first. The status of Python versions can be found here.