Metadata-Version: 1.1
Name: attrs
Version: 17.2.0
Summary: Classes Without Boilerplate
Home-page: http://www.attrs.org/
Author: Hynek Schlawack
Author-email: hs@ox.cx
License: MIT
Description: .. image:: http://www.attrs.org/en/latest/_static/attrs_logo.png

           :alt: attrs Logo

        

        ==================================

        attrs: Classes Without Boilerplate

        ==================================

        

        .. image:: https://readthedocs.org/projects/attrs/badge/?version=stable

           :target: http://www.attrs.org/en/stable/?badge=stable

           :alt: Documentation Status

        

        .. image:: https://travis-ci.org/python-attrs/attrs.svg?branch=master

           :target: https://travis-ci.org/python-attrs/attrs

           :alt: CI Status

        

        .. image:: https://codecov.io/github/python-attrs/attrs/branch/master/graph/badge.svg

           :target: https://codecov.io/github/python-attrs/attrs

           :alt: Test Coverage

        

        .. teaser-begin

        

        ``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 <https://nedbatchelder.com/blog/200605/dunder.html>`_ methods).

        

        Its main goal is to help you to write **concise** and **correct** software without slowing down your code.

        

        .. -spiel-end-

        

        For that, it gives you a class decorator and a way to declaratively define the attributes on that class:

        

        .. -code-begin-

        

        .. code-block:: pycon

        

           >>> 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 ``tuple``\ s or confusingly behaving ``namedtuple``\ s.

        Which in turn encourages you to write *small classes* that do `one thing well <https://www.destroyallsoftware.com/talks/boundaries>`_.

        Never again violate the `single responsibility principle <https://en.wikipedia.org/wiki/Single_responsibility_principle>`_ just because implementing ``__init__`` et al is a painful drag.

        

        

        .. -testimonials-

        

        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**, creator of `Twisted <https://twistedmatrix.com/>`_, `Automat <https://pypi.python.org/pypi/Automat>`_, and other open source software, in `The One Python Library Everyone Needs <https://glyph.twistedmatrix.com/2016/08/attrs.html>`_

        

        

          *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 <http://www.python-requests.org/>`_, Python Overlord at Heroku, `on paper no less <https://twitter.com/hynek/status/866817877650751488>`_

        

        

        .. -end-

        

        .. -project-information-

        

        Project Information

        ===================

        

        ``attrs`` is released under the `MIT <https://choosealicense.com/licenses/mit/>`_ license,

        its documentation lives at `Read the Docs <http://www.attrs.org/>`_,

        the code on `GitHub <https://github.com/python-attrs/attrs>`_,

        and the latest release on `PyPI <https://pypi.org/project/attrs/>`_.

        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 <http://www.attrs.org/en/latest/contributing.html>`_ to get you started!

        
        
        Release Information
        ===================
        
        17.2.0 (2017-05-24)

        -------------------

        

        

        Backward-incompatible changes:

        ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

        

        *none*

        

        

        Deprecations:

        ^^^^^^^^^^^^^

        

        *none*

        

        

        Changes:

        ^^^^^^^^

        

        - Validators are hashable again.

          Note that validators may become frozen in the future, pending availability of no-overhead frozen classes.

          `#192 <https://github.com/python-attrs/attrs/issues/192>`_
        
        `Full changelog <http://www.attrs.org/en/stable/changelog.html>`_.
        
        Credits

        =======

        

        ``attrs`` is written and maintained by `Hynek Schlawack <https://hynek.me/>`_.

        

        The development is kindly supported by `Variomedia AG <https://www.variomedia.de/>`_.

        

        A full list of contributors can be found in `GitHub's overview <https://github.com/python-attrs/attrs/graphs/contributors>`_.

        

        It’s the spiritual successor of `characteristic <https://characteristic.readthedocs.io/>`_ and aspires to fix some of it clunkiness and unfortunate decisions.

        Both were inspired by Twisted’s `FancyEqMixin <https://twistedmatrix.com/documents/current/api/twisted.python.util.FancyEqMixin.html>`_ but both are implemented using class decorators because `sub-classing is bad for you <https://www.youtube.com/watch?v=3MNVP9-hglc>`_, m’kay?

        
Keywords: class,attribute,boilerplate
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Software Development :: Libraries :: Python Modules
