Python typing.ClassVar: Declare Class Variables

ClassVar identifies attributes belonging to the class rather than individual dataclass fields or instance-specific values.

What It Does and Why It Matters

ClassVar identifies attributes belonging to the class rather than individual dataclass fields or instance-specific values. Type checkers can flag attempts to treat them as instance-only fields.

Annotations guide static tools; by default they do not validate external input or change the return value at runtime.

Step-by-Step Example

Start with the complete example below. Read the inputs and predict what the final print statement will show before you run it.

from typing import ClassVar
class Sensor:
    upper_limit: ClassVar[int] = 100
    def __init__(self, measured_value: int) -> None:
        self.measured_value = measured_value
print(Sensor.upper_limit)
print(Sensor(85).measured_value)

How the Code Works

The imports make these standard-library tools available: typing.
The definition of Sensor creates reusable behavior; its body runs only when called or instantiated as appropriate.
The print calls display the results. Compare these results with the method’s documented return type and the input used.
The annotations describe intended types for editors and checkers. They are not a replacement for validating input values when the function runs.

Expected output:

100
85

Each displayed line comes from the corresponding calculation or check. The output helps verify the return values before you adapt the example to your own input.

What to Notice

Pay attention to the accepted input types, the returned value and the boundary behavior. Predict what changes if you replace the example input with an empty, zero, negative or missing value, where that value is meaningful for this operation.

If the task uses a library function, inspect its documented exceptions and return type before reusing it inside a larger function.

Where You Would Use This

This helps maintain larger projects where functions and data shapes cross module boundaries. Check the code with a static analyzer, and still validate data received from files, users or remote APIs. Annotation constructs do not normally enforce types automatically at runtime.

Practice Exercise

Create a class with a shared threshold and inspect it from two instances.

Before running your edited example, write down the result you expect. Then test at least one valid boundary or deliberately invalid value, using appropriate exception handling where necessary.

Reference: official Python documentation for the complete API contract and version notes.

Common Beginner Mistakes

Assuming a ClassVar is copied for every instance or that it behaves like a dataclass field.
Overlooking the documented condition: type checkers can flag attempts to treat them as instance-only fields.

Key Takeaways

ClassVar identifies attributes belonging to the class rather than individual dataclass fields or instance-specific values.
Create a class with a shared threshold and inspect it from two instances.
Annotations guide static tools; by default they do not validate external input or change the return value at runtime.