Skip to content
Python Classes Without Boilerplate
Branch: master
Clone or download
mattsb42-aws and hynek Fix validators __all__ (#517)
* add new validators from #425 to validators.__all__

* add test for each validator, verifying that it is in validators.__all__

* add changelog entry for #517

* apply autolinting

* Make module path absolute
Latest commit 957b198 Mar 13, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
changelog.d Fix validators __all__ (#517) Mar 13, 2019
docs Remove code and tests related to deprecated 'convert' kwarg (#504) Mar 7, 2019
src/attr Fix validators __all__ (#517) Mar 13, 2019
tests Fix validators __all__ (#517) Mar 13, 2019
.coveragerc Move test helpers into an utils module Aug 15, 2016
.gitignore
.pre-commit-config.yaml
.readthedocs.yml fix and simplify docs CI Feb 25, 2019
.travis.yml
AUTHORS.rst
CHANGELOG.rst
LICENSE Gut docs for now Jan 27, 2015
MANIFEST.in Just put everything into the sdist so everyone is happy Dec 7, 2018
README.rst Fix a bunch of links Aug 20, 2018
codecov.yml
conftest.py Exclude test_annotations from pypy3 Feb 25, 2019
pyproject.toml
setup.cfg
setup.py
tox.ini

README.rst

attrs Logo

attrs: Classes Without Boilerplate

Documentation Status CI Status Test Coverage Code style: black

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(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.

On Python 3.6 and later, you can often even drop the calls to attr.ib() by using type annotations.

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

Amber Hawkie Brown, Twisted Release Manager and Computer Owl:

Writing a fully-functional class using attrs takes me less time than writing this testimonial.

Glyph Lefkowitz, creator of Twisted, Automat, and other open source software, in The One Python Library Everyone Needs:

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.

Kenneth Reitz, author of Requests and Developer Advocate at DigitalOcean, (on paper no less!):

attrs—classes for humans. I like it.

Łukasz Langa, prolific CPython core developer and Production Engineer at Facebook:

I'm increasingly digging your attr.ocity. Good job!

Getting Help

Please use the python-attrs tag on StackOverflow to get help.

Answering questions of your fellow developers is also great way to help the project!

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.

We collect information on third-party extensions in our wiki. Feel free to browse and add your own!

If you'd like to contribute to attrs you're most welcome and we've written a little guide to get you started!

You can’t perform that action at this time.