Metadata-Version: 2.1 Name: attrs Version: 22.2.0 Summary: Classes Without Boilerplate Home-page: https://www.attrs.org/ Author: Hynek Schlawack Author-email: hs@ox.cx Maintainer: Hynek Schlawack Maintainer-email: hs@ox.cx License: MIT Project-URL: Documentation, https://www.attrs.org/ Project-URL: Changelog, https://www.attrs.org/en/stable/changelog.html Project-URL: Bug Tracker, https://github.com/python-attrs/attrs/issues Project-URL: Source Code, https://github.com/python-attrs/attrs Project-URL: Funding, https://github.com/sponsors/hynek Project-URL: Tidelift, https://tidelift.com/subscription/pkg/pypi-attrs?utm_source=pypi-attrs&utm_medium=pypi Project-URL: Ko-fi, https://ko-fi.com/the_hynek Keywords: class,attribute,boilerplate,dataclass 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 :: 3 Classifier: Programming Language :: Python :: 3.6 Classifier: Programming Language :: Python :: 3.7 Classifier: Programming Language :: Python :: 3.8 Classifier: Programming Language :: Python :: 3.9 Classifier: Programming Language :: Python :: 3.10 Classifier: Programming Language :: Python :: 3.11 Classifier: Programming Language :: Python :: Implementation :: CPython Classifier: Programming Language :: Python :: Implementation :: PyPy Classifier: Topic :: Software Development :: Libraries :: Python Modules Requires-Python: >=3.6 Description-Content-Type: text/markdown License-File: LICENSE Provides-Extra: cov Requires-Dist: attrs[tests] ; extra == 'cov' Requires-Dist: coverage-enable-subprocess ; extra == 'cov' Requires-Dist: coverage[toml] (>=5.3) ; extra == 'cov' Provides-Extra: dev Requires-Dist: attrs[docs,tests] ; extra == 'dev' Provides-Extra: docs Requires-Dist: furo ; extra == 'docs' Requires-Dist: sphinx ; extra == 'docs' Requires-Dist: myst-parser ; extra == 'docs' Requires-Dist: zope.interface ; extra == 'docs' Requires-Dist: sphinx-notfound-page ; extra == 'docs' Requires-Dist: sphinxcontrib-towncrier ; extra == 'docs' Requires-Dist: towncrier ; extra == 'docs' Provides-Extra: tests Requires-Dist: attrs[tests-no-zope] ; extra == 'tests' Requires-Dist: zope.interface ; extra == 'tests' Provides-Extra: tests-no-zope Requires-Dist: hypothesis ; extra == 'tests-no-zope' Requires-Dist: pympler ; extra == 'tests-no-zope' Requires-Dist: pytest (>=4.3.0) ; extra == 'tests-no-zope' Requires-Dist: pytest-xdist[psutil] ; extra == 'tests-no-zope' Requires-Dist: cloudpickle ; (platform_python_implementation == "CPython") and extra == 'tests-no-zope' Requires-Dist: mypy (<0.990,>=0.971) ; (platform_python_implementation == "CPython") and extra == 'tests-no-zope' Requires-Dist: pytest-mypy-plugins ; (platform_python_implementation == "CPython" and python_version < "3.11") and extra == 'tests-no-zope' Provides-Extra: tests_no_zope Requires-Dist: hypothesis ; extra == 'tests_no_zope' Requires-Dist: pympler ; extra == 'tests_no_zope' Requires-Dist: pytest (>=4.3.0) ; extra == 'tests_no_zope' Requires-Dist: pytest-xdist[psutil] ; extra == 'tests_no_zope' Requires-Dist: cloudpickle ; (platform_python_implementation == "CPython") and extra == 'tests_no_zope' Requires-Dist: mypy (<0.990,>=0.971) ; (platform_python_implementation == "CPython") and extra == 'tests_no_zope' Requires-Dist: pytest-mypy-plugins ; (platform_python_implementation == "CPython" and python_version < "3.11") and extra == 'tests_no_zope'
*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](https://www.attrs.org/en/latest/glossary.html#term-dunder-methods)). [Trusted by NASA](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile#list-of-qualifying-repositories-for-mars-2020-helicopter-contributor-achievement) for Mars missions since 2020! Its main goal is to help you to write **concise** and **correct** software without slowing down your code. ## Sponsors *attrs* would not be possible without our [amazing sponsors](https://github.com/sponsors/hynek). Especially those generously supporting us at the *The Organization* tier and higher:Please consider joining them to help make attrs’s maintenance more sustainable!
## Example *attrs* gives you a class decorator and a way to declaratively define the attributes on that class: ```pycon >>> from attrs import asdict, define, make_class, Factory >>> @define ... class SomeClass: ... a_number: int = 42 ... list_of_numbers: list[int] = 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 >>> asdict(sc) {'a_number': 1, 'list_of_numbers': [1, 2, 3]} >>> SomeClass() SomeClass(a_number=42, list_of_numbers=[]) >>> C = 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__`, - equality-checking methods, - an initializer, - and much more, *without* writing dull boilerplate code again and again and *without* runtime performance penalties. **Hate type annotations**!? No problem! Types are entirely **optional** with *attrs*. Simply assign `attrs.field()` to the attributes instead of annotating them with types. --- This example uses *attrs*'s modern APIs that have been introduced in version 20.1.0, and the *attrs* package import name that has been added in version 21.3.0. The classic APIs (`@attr.s`, `attr.ib`, plus their serious-business aliases) and the `attr` package import name will remain **indefinitely**. Please check out [*On The Core API Names*](https://www.attrs.org/en/latest/names.html) for a more in-depth explanation. ## Data Classes On the tin, *attrs* might remind you of `dataclasses` (and indeed, `dataclasses` [are a descendant](https://hynek.me/articles/import-attrs/) of *attrs*). In practice it does a lot more and is more flexible. For instance it allows you to define [special handling of NumPy arrays for equality checks](https://www.attrs.org/en/stable/comparison.html#customization), or allows more ways to [plug into the initialization process](https://www.attrs.org/en/stable/init.html#hooking-yourself-into-initialization). For more details, please refer to our [comparison page](https://www.attrs.org/en/stable/why.html#data-classes). ## Project Information - [**Changelog**](https://www.attrs.org/en/stable/changelog.html) - [**Documentation**](https://www.attrs.org/) - [**PyPI**](https://pypi.org/project/attrs/) - [**Source Code**](https://github.com/python-attrs/attrs) - [**Contributing**](https://github.com/python-attrs/attrs/blob/main/.github/CONTRIBUTING.md) - [**Third-party Extensions**](https://github.com/python-attrs/attrs/wiki/Extensions-to-attrs) - **License**: [MIT](https://www.attrs.org/en/latest/license.html) - **Get Help**: please use the `python-attrs` tag on [StackOverflow](https://stackoverflow.com/questions/tagged/python-attrs) - **Supported Python Versions**: 3.6 and later ### *attrs* for Enterprise Available as part of the Tidelift Subscription. The maintainers of *attrs* and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source packages you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact packages you use. [Learn more.](https://tidelift.com/subscription/pkg/pypi-attrs?utm_source=pypi-attrs&utm_medium=referral&utm_campaign=enterprise&utm_term=repo) ## Changes in This Release ### Backwards-incompatible Changes - Python 3.5 is not supported anymore. [#988](https://github.com/python-attrs/attrs/issues/988) ### Deprecations - Python 3.6 is now deprecated and support will be removed in the next release. [#1017](https://github.com/python-attrs/attrs/issues/1017) ### Changes - `attrs.field()` now supports an *alias* option for explicit `__init__` argument names. Get `__init__` signatures matching any taste, peculiar or plain! The [PEP 681 compatible](https://peps.python.org/pep-0681/#field-specifier-parameters) *alias* option can be use to override private attribute name mangling, or add other arbitrary field argument name overrides. [#950](https://github.com/python-attrs/attrs/issues/950) - `attrs.NOTHING` is now an enum value, making it possible to use with e.g. [`typing.Literal`](https://docs.python.org/3/library/typing.html#typing.Literal). [#983](https://github.com/python-attrs/attrs/issues/983) - Added missing re-import of `attr.AttrsInstance` to the `attrs` namespace. [#987](https://github.com/python-attrs/attrs/issues/987) - Fix slight performance regression in classes with custom `__setattr__` and speedup even more. [#991](https://github.com/python-attrs/attrs/issues/991) - Class-creation performance improvements by switching performance-sensitive templating operations to f-strings. You can expect an improvement of about 5% -- even for very simple classes. [#995](https://github.com/python-attrs/attrs/issues/995) - `attrs.has()` is now a [`TypeGuard`](https://docs.python.org/3/library/typing.html#typing.TypeGuard) for `AttrsInstance`. That means that type checkers know a class is an instance of an `attrs` class if you check it using `attrs.has()` (or `attr.has()`) first. [#997](https://github.com/python-attrs/attrs/issues/997) - Made `attrs.AttrsInstance` stub available at runtime and fixed type errors related to the usage of `attrs.AttrsInstance` in *Pyright*. [#999](https://github.com/python-attrs/attrs/issues/999) - On Python 3.10 and later, call [`abc.update_abstractmethods()`](https://docs.python.org/3/library/abc.html#abc.update_abstractmethods) on dict classes after creation. This improves the detection of abstractness. [#1001](https://github.com/python-attrs/attrs/issues/1001) - *attrs*'s pickling methods now use dicts instead of tuples. That is safer and more robust across different versions of a class. [#1009](https://github.com/python-attrs/attrs/issues/1009) - Added `attrs.validators.not_(wrapped_validator)` to logically invert *wrapped_validator* by accepting only values where *wrapped_validator* rejects the value with a `ValueError` or `TypeError` (by default, exception types configurable). [#1010](https://github.com/python-attrs/attrs/issues/1010) - The type stubs for `attrs.cmp_using()` now have default values. [#1027](https://github.com/python-attrs/attrs/issues/1027) - To conform with [PEP 681](https://peps.python.org/pep-0681/), `attr.s()` and `attrs.define()` now accept *unsafe_hash* in addition to *hash*. [#1065](https://github.com/python-attrs/attrs/issues/1065) --- [Full changelog](https://www.attrs.org/en/stable/changelog.html)