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:
>>> 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:
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.
Project Information
- Changelog
- Documentation
- PyPI
- Source Code
- Contributing
- Third-party Extensions
- Get Help: use the
python-attrstag on Stack Overflow
attrs for Enterprise
Available as part of the Tidelift Subscription.
The maintainers of attrs and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source packages you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact packages you use.
Release Information
Backwards-incompatible Changes
- Python 3.7 has been dropped. #1340
Changes
- Introduce
attrs.NothingType, for annotating types consistent withattrs.NOTHING. #1358 - Allow mutating
__suppress_context__and__notes__on frozen exceptions. #1365 attrs.converters.optional()works again when takingattrs.converters.pipe()or another Converter as its argument. #1372- attrs instances now support
copy.replace(). #1383 attrs.validators.instance_of()'s type hints now allow for union types. For example:instance_of(str | int)#1385
Release files for attrs 24.3.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| attrs-24.3.0.tar.gz | 806.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| attrs-24.3.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 869.4 kB
Release files / attrs-24.3.0.tar.gz
| Download URL | attrs-24.3.0.tar.gz |
|---|---|
| Size | 806.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
8f5c07333d543103541ba7be0e2ce16eeee8130cb0b3f9238ab904ce1e85baff
|
|
BLAKE2b-256 checksum How to use checksums |
48c86260f8ccc11f0917360fc0da435c5c9c7504e3db174d5a12a1494887b045
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.0.1 CPython/3.12.8
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Dec 16, 2024.
Transparency logRelease files / attrs-24.3.0-py3-none-any.whl
| Download URL | attrs-24.3.0-py3-none-any.whl |
|---|---|
| Size | 63.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
ac96cd038792094f438ad1f6ff80837353805ac950cd2aa0e0625ef19850c308
|
|
BLAKE2b-256 checksum How to use checksums |
89aaab0f7891a01eeb2d2e338ae8fecbe57fcebea1a24dbb64d45801bfab481d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.0.1 CPython/3.12.8
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Dec 16, 2024.
Transparency log
