+1
日增长
5,863
stars
518
forks
57
watchers
846
prs
799
issues
27
releases
README
attrs is the Python package that will bring back the joy of writing classes by relieving you from the drudgery of implementing object protocols (aka dunder methods).
Trusted by NASA for Mars missions since 2020!
Its main goal is to help you to write concise and correct software without slowing down your code.
Sponsors
attrs would not be possible without our amazing sponsors.
Especially those generously supporting us at the The Organization tier and higher:
')
]]] --
Please consider joining them to help make attrs’s maintenance more sustainable!
Example
attrs gives you a class decorator and a way to declaratively define the attributes on that class:
pycon
from attrs import asdict, define, make_class, Factory
@define
... class SomeClass:
... a_number: int = 42
... list_of_numbers: list[int] = Factory(list)
...
... def hard_math(self, another_number):
... return self.a_number + sum(self.list_of_numbers) another_number
sc = SomeClass(1, [1, 2, 3])
sc
SomeClass(a_number=1, list_of_numbers=[1, 2, 3])
sc.hard_math(3)
19
sc == SomeClass(1, [1, 2, 3])
True
sc != SomeClass(2, [3, 2, 1])
True
asdict(sc)
{'a_number': 1, 'list_of_numbers': [1, 2, 3]}
SomeClass()
SomeClass(a_number=42, list_of_numbers=[])
C = make_class("C", ["a", "b"])
C("foo", "bar")
C(a='foo', b='bar')
After declaring your attributes, attrs gives you:
- a concise and explicit overview of the class's attributes,
- a nice human-readable __repr__,
- equality-checking methods,
- an initializer,
- and much more,
without writing dull boilerplate code again and again and without runtime performance penalties.
---
This example uses attrs's modern APIs that have been introduced in version 20.1.0, and the attrs package import name that has been added in version 21.3.0.
The classic APIs (@attr.s, attr.ib, plus their serious-business aliases) and the attr package import name will remain indefinitely.
Check out On The Core API Names for an in-depth explanation!
Hate Type Annotations!?
No problem!
Types are entirely optional with attrs.
Simply assign attrs.field() to the attributes instead of annotating them with types:
python
from attrs import define, field
@define
class SomeClass:
a_number = field(default=42)
list_of_numbers = field(factory=list)
Data Classes
On the tin, attrs might remind you of dataclasses (and indeed, dataclasses are a descendant of attrs).
In practice it does a lot more and is more flexible.
For instance, it allows you to define special handling of NumPy arrays for equality checks, allows more ways to plug into the initialization process, has a replacement for __init_subclass__, and allows for stepping through the generated methods using a debugger.
For more details, please refer to our comparison page, but generally speaking, we are more likely to commit crimes against nature to make things work that one would expect to work, but that are quite complicated in practice.
ProjecTop issues
#220Class variables51 comments · 2017-07-22#795pyright support via dataclass transforms27 comments · 2021-04-23#342Post-Init-Only arguments23 comments · 2018-02-01#637Option to "partially override" an attribute from a parent class?21 comments · 2020-04-06#424Add function to "instantiate" __annotations__-derived 'attr.ib's.19 comments · 2018-08-13#85eval-less implementation, preliminary to browser support19 comments · 2016-09-10#146Generalizing ad-hoc attribute callbacks18 comments · 2017-02-12#357Self documentation - current state17 comments · 2018-03-15
Latest release
26.1.0 26.1.0 2026-03-19Highlights The main outward change here only affects people using field transformers, but it should be a nice quality of life improvement! Full changelog below! Special Thanks This release would not be possible without my generous sponsors! Thank you to all of you making sustainable maintenance possible! If you would like to join them, go to and check out the sweet perks! Above and Beyond Variomedia AG (@variomedia), Tidelift (@tidelift), Kraken Tech (@kraken-tech), Privacy Solutions GmbH (@privacy-solutions), FilePreviews (@filepreviews), Ecosystems (@ecosyste-ms), Te