Google Git
Sign in
chromium / external / github.com / python-attrs / attrs / f8c991b79f6f742a09f20f3ae190d08895db1a83
commitf8c991b79f6f742a09f20f3ae190d08895db1a83[log] [tgz]
authorHynek Schlawack <hs@ox.cx>Wed Apr 24 14:29:18 2024
committerHynek Schlawack <hs@ox.cx>Wed Apr 24 14:29:18 2024
tree75957e1e5362fdced197e1ea28ee9afc6b7e7087
parent46f1f35896e980d4c0f33511fa700fa59ac2299d [diff]
pre-commit autoupdate
1 file changed
tree: 75957e1e5362fdced197e1ea28ee9afc6b7e7087
  1. .github/
  2. changelog.d/
  3. docs/
  4. src/
  5. tests/
  6. .git_archival.txt
  7. .gitattributes
  8. .gitignore
  9. .pre-commit-config.yaml
  10. .python-version-default
  11. .readthedocs.yaml
  12. CHANGELOG.md
  13. CITATION.cff
  14. conftest.py
  15. LICENSE
  16. pyproject.toml
  17. README.md
  18. tox.ini
README.md

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:

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, and allows for stepping through the generated methods using a debugger.

For more details, please refer to our comparison page.

Project Information

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. Learn more.