Skip to main content
Help us improve PyPI by participating in user testing. All experience levels needed!

Attributes Without Boilerplate

Project description

Documentation Status CI status Test Coverage

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 C(object):
...     x = attr.ib(default=42)
...     y = attr.ib(default=attr.Factory(list))
...
...     def hard_math(self, z):
...         return self.x * self.y * z
>>> i = C(x=1, y=2)
>>> i
C(x=1, y=2)
>>> i.hard_math(3)
6
>>> i == C(1, 2)
True
>>> i != C(2, 1)
True
>>> attr.asdict(i)
{'y': 2, 'x': 1}
>>> C()
C(x=42, y=[])
>>> C2 = attr.make_class("C2", ["a", "b"])
>>> C2("foo", "bar")
C2(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.

Testimonials

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, inventor of Twisted and Software Developer at Rackspace 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

Project Information

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.

Release Information

16.3.0 (2016-11-24)

Changes:

  • Attributes now can have user-defined metadata which greatly improves attrs’s extensibility. #96

  • Allow for a __attrs_post_init__ method that – if defined – will get called at the end of the attrs-generated __init__ method. #111

  • Add @attr.s(str=True) that will optionally create a __str__ method that is identical to __repr__. This is mainly useful with Exceptions and other classes that rely on a useful __str__ implementation but overwrite the default one through a poor own one. Default Python class behavior is to use __repr__ as __str__ anyways.

    If you tried using attrs with Exceptions and were puzzled by the tracebacks: this option is for you.

  • Don’t overwrite __name__ with __qualname__ for attr.s(slots=True) classes. #99

Full changelog.

Credits

attrs is written and maintained by Hynek Schlawack.

The development is kindly supported by Variomedia AG.

A full list of contributors can be found in GitHub’s overview.

It’s the spiritual successor of characteristic and aspires to fix some of it clunkiness and unfortunate decisions. Both were inspired by Twisted’s FancyEqMixin but both are implemented using class decorators because sub-classing is bad for you, m’kay?

Project details


Release history Release notifications

History Node

18.1.0

History Node

17.4.0

History Node

17.3.0

History Node

17.2.0

History Node

17.1.0

This version
History Node

16.3.0

History Node

16.2.0

History Node

16.1.0

History Node

16.0.0

History Node

15.2.0

History Node

15.1.0

History Node

15.0.0

History Node

15.0.0a1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
attrs-16.3.0-py2.py3-none-any.whl (21.3 kB) Copy SHA256 hash SHA256 Wheel py2.py3 Nov 24, 2016
attrs-16.3.0.tar.gz (57.5 kB) Copy SHA256 hash SHA256 Source None Nov 24, 2016

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page