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).
Its main goal is to help you to write concise and correct software without slowing down your code.
For that, it gives you a class decorator and a way to declaratively define the attributes on that class:
>>> import attr
>>> @attr.s
... class SomeClass(object):
... a_number = attr.ib(default=42)
... list_of_numbers = attr.ib(default=attr.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
>>> attr.asdict(sc)
{'a_number': 1, 'list_of_numbers': [1, 2, 3]}
>>> SomeClass()
SomeClass(a_number=42, list_of_numbers=[])
>>> C = attr.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__, - a complete set of comparison methods,
- an initializer,
- and much more,
without writing dull boilerplate code again and again and without runtime performance penalties.
This gives you the power to use actual classes with actual types in your code instead of confusing tuples or confusingly behaving namedtuples.
Which in turn encourages you to write small classes that do one thing well.
Never again violate the single responsibility principle just because implementing __init__ et al is a painful drag.
I’m looking forward to is being able to program in Python-with-attrs everywhere. It exerts a subtle, but positive, design influence in all the codebases I’ve see it used in.
—Glyph Lefkowitz, creator of Twisted, Automat, and other open source software, in The One Python Library Everyone Needs
I'm increasingly digging your attr.ocity. Good job!
—Łukasz Langa, prolific CPython core developer and Production Engineer at Facebook
Writing a fully-functional class using attrs takes me less time than writing this testimonial.
—Amber Hawkie Brown, Twisted Release Manager and Computer Owl
attrs—classes for humans. I like it.
—Kenneth Reitz, author of requests, Python Overlord at Heroku, on paper no less
attrs is released under the MIT license,
its documentation lives at Read the Docs,
the code on GitHub,
and the latest release on PyPI.
It’s rigorously tested on Python 2.7, 3.4+, and PyPy.
If you'd like to contribute you're most welcome and we've written a little guide to get you started!