Python Classes Without Boilerplate
Go to file
Hynek Schlawack 14c5485cf5 Use proper Attributes in all dunders 2015-01-28 11:34:55 +01:00
attr Use proper Attributes in all dunders 2015-01-28 11:34:55 +01:00
docs Nobody intends to stop maintaining characteristic 2015-01-27 23:52:11 +01:00
tests Add `has` 2015-01-28 11:34:30 +01:00
.gitignore Initial commit 2015-01-27 17:53:17 +01:00
.travis.yml Initial commit 2015-01-27 17:53:17 +01:00
AUTHORS.rst Initial commit 2015-01-27 17:53:17 +01:00
CONTRIBUTING.rst Initial commit 2015-01-27 17:53:17 +01:00
LICENSE Gut docs for now 2015-01-27 23:03:04 +01:00
MANIFEST.in Initial commit 2015-01-27 17:53:17 +01:00
README.rst Get rid of <> in repr 2015-01-27 23:08:55 +01:00
setup.py Initial commit 2015-01-27 17:53:17 +01:00
tox.ini Gut docs for now 2015-01-27 23:03:04 +01:00

README.rst

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

=============================================
attrs: Python attributes without boilerplate.
=============================================

.. image:: https://pypip.in/version/attrs/badge.svg
   :target: https://pypi.python.org/pypi/attrs/
   :alt: Latest Version

.. image:: https://travis-ci.org/hynek/attrs.svg
   :target: https://travis-ci.org/hynek/attrs
   :alt: CI status

.. image:: https://coveralls.io/repos/hynek/attrs/badge.png?branch=master
   :target: https://coveralls.io/r/hynek/attrs?branch=master
   :alt: Current coverage

.. teaser-begin

``attrs`` is an `MIT <http://choosealicense.com/licenses/mit/>`_-licensed Python package with class decorators that ease the chores of implementing the most common attribute-related object protocols:

.. code-block:: pycon

   >>> import attr
   >>> @attr.s
   ... class C(object):
   ...     x = attr.ib(default_value=42)
   ...     y = attr.ib(default_factory=list)
   >>> i = C(x=1, y=2)
   >>> i
   C(x=1, y=2)
   >>> i == C(1, 2)
   True
   >>> i != C(2, 1)
   True
   >>> attr.to_dict(i)
   {'y': 2, 'x': 1}
   >>> C()
   C(x=42, y=[])

You just specify the attributes to work with and ``attrs`` gives you:

- a nice human-readable ``__repr__``,
- a complete set of comparison methods,
- and an initializer

*without* writing dull boilerplate code again and again.

This gives you the power to use actual classes with actual types in your code instead of confusing ``tuple``\ s or confusingly behaving ``namedtuple``\ s.

So put down that type-less data structures and welcome some class into your life!

.. teaser-end

``attrs``\ s documentation lives at `Read the Docs <https://attrs.readthedocs.org/>`_, the code on `GitHub <https://github.com/hynek/attrs>`_.
Its rigorously tested on Python 2.6, 2.7, 3.3+, and PyPy.