www.attrs.org

https://www.attrs.org/en/latest

py:class

Identifier Project Name Version Location Display Name Usage example
attr.VersionInfo attrs 22.2.0 api.html#attr.VersionInfo - :py:class:`attr.VersionInfo`
attr._make.Attribute attrs 22.2.0 api.html#attrs.Attribute - :py:class:`attr._make.Attribute`
attr._make.Factory attrs 22.2.0 api.html#attrs.Factory - :py:class:`attr._make.Factory`
attr._version_info.VersionInfo attrs 22.2.0 api.html#attr.VersionInfo - :py:class:`attr._version_info.VersionInfo`
attrs.Attribute attrs 22.2.0 api.html#attrs.Attribute - :py:class:`attrs.Attribute`
attrs.Factory attrs 22.2.0 api.html#attrs.Factory - :py:class:`attrs.Factory`

py:function

Identifier Project Name Version Location Display Name Usage example
attr.asdict attrs 22.2.0 api.html#attr.asdict - :py:function:`attr.asdict`
attr.assoc attrs 22.2.0 api.html#attr.assoc - :py:function:`attr.assoc`
attr.astuple attrs 22.2.0 api.html#attr.astuple - :py:function:`attr.astuple`
attr.attr.cmp_using attrs 22.2.0 api.html#attr.attr.cmp_using - :py:function:`attr.attr.cmp_using`
attr.attr.evolve attrs 22.2.0 api.html#attr.attr.evolve - :py:function:`attr.attr.evolve`
attr.attr.fields attrs 22.2.0 api.html#attr.attr.fields - :py:function:`attr.attr.fields`
attr.attr.fields_dict attrs 22.2.0 api.html#attr.attr.fields_dict - :py:function:`attr.attr.fields_dict`
attr.attr.filters.exclude attrs 22.2.0 api.html#attr.attr.filters.exclude - :py:function:`attr.attr.filters.exclude`
attr.attr.filters.include attrs 22.2.0 api.html#attr.attr.filters.include - :py:function:`attr.attr.filters.include`
attr.attr.has attrs 22.2.0 api.html#attr.attr.has - :py:function:`attr.attr.has`
attr.attr.resolve_types attrs 22.2.0 api.html#attr.attr.resolve_types - :py:function:`attr.attr.resolve_types`
attr.attr.validate attrs 22.2.0 api.html#attr.attr.validate - :py:function:`attr.attr.validate`
attr.attrs.frozen attrs 22.2.0 api.html#attr.attrs.frozen - :py:function:`attr.attrs.frozen`
attr.attrs.mutable attrs 22.2.0 api.html#attr.attrs.mutable - :py:function:`attr.attrs.mutable`
attr.define attrs 22.2.0 api.html#attr.define - :py:function:`attr.define`
attr.field attrs 22.2.0 api.html#attr.field - :py:function:`attr.field`
attr.frozen attrs 22.2.0 api.html#attr.frozen - :py:function:`attr.frozen`
attr.get_run_validators attrs 22.2.0 api.html#attr.get_run_validators - :py:function:`attr.get_run_validators`
attr.ib attrs 22.2.0 api.html#attr.ib - :py:function:`attr.ib`
attr.mutable attrs 22.2.0 api.html#attr.mutable - :py:function:`attr.mutable`
attr.s attrs 22.2.0 api.html#attr.s - :py:function:`attr.s`
attr.set_run_validators attrs 22.2.0 api.html#attr.set_run_validators - :py:function:`attr.set_run_validators`
attrs.asdict attrs 22.2.0 api.html#attrs.asdict - :py:function:`attrs.asdict`
attrs.astuple attrs 22.2.0 api.html#attrs.astuple - :py:function:`attrs.astuple`
attrs.cmp_using attrs 22.2.0 api.html#attrs.cmp_using - :py:function:`attrs.cmp_using`
attrs.converters.default_if_none attrs 22.2.0 api.html#attrs.converters.default_if_none - :py:function:`attrs.converters.default_if_none`
attrs.converters.optional attrs 22.2.0 api.html#attrs.converters.optional - :py:function:`attrs.converters.optional`
attrs.converters.pipe attrs 22.2.0 api.html#attrs.converters.pipe - :py:function:`attrs.converters.pipe`
attrs.converters.to_bool attrs 22.2.0 api.html#attrs.converters.to_bool - :py:function:`attrs.converters.to_bool`
attrs.define attrs 22.2.0 api.html#attrs.define - :py:function:`attrs.define`
attrs.evolve attrs 22.2.0 api.html#attrs.evolve - :py:function:`attrs.evolve`
attrs.field attrs 22.2.0 api.html#attrs.field - :py:function:`attrs.field`
attrs.fields attrs 22.2.0 api.html#attrs.fields - :py:function:`attrs.fields`
attrs.fields_dict attrs 22.2.0 api.html#attrs.fields_dict - :py:function:`attrs.fields_dict`
attrs.filters.exclude attrs 22.2.0 api.html#attrs.filters.exclude - :py:function:`attrs.filters.exclude`
attrs.filters.include attrs 22.2.0 api.html#attrs.filters.include - :py:function:`attrs.filters.include`
attrs.has attrs 22.2.0 api.html#attrs.has - :py:function:`attrs.has`
attrs.make_class attrs 22.2.0 api.html#attrs.make_class - :py:function:`attrs.make_class`
attrs.resolve_types attrs 22.2.0 api.html#attrs.resolve_types - :py:function:`attrs.resolve_types`
attrs.setters.convert attrs 22.2.0 api.html#attrs.setters.convert - :py:function:`attrs.setters.convert`
attrs.setters.frozen attrs 22.2.0 api.html#attrs.setters.frozen - :py:function:`attrs.setters.frozen`
attrs.setters.pipe attrs 22.2.0 api.html#attrs.setters.pipe - :py:function:`attrs.setters.pipe`
attrs.setters.validate attrs 22.2.0 api.html#attrs.setters.validate - :py:function:`attrs.setters.validate`
attrs.validate attrs 22.2.0 api.html#attrs.validate - :py:function:`attrs.validate`
attrs.validators.and_ attrs 22.2.0 api.html#attrs.validators.and_ - :py:function:`attrs.validators.and_`
attrs.validators.deep_iterable attrs 22.2.0 api.html#attrs.validators.deep_iterable - :py:function:`attrs.validators.deep_iterable`
attrs.validators.deep_mapping attrs 22.2.0 api.html#attrs.validators.deep_mapping - :py:function:`attrs.validators.deep_mapping`
attrs.validators.disabled attrs 22.2.0 api.html#attrs.validators.disabled - :py:function:`attrs.validators.disabled`
attrs.validators.ge attrs 22.2.0 api.html#attrs.validators.ge - :py:function:`attrs.validators.ge`
attrs.validators.get_disabled attrs 22.2.0 api.html#attrs.validators.get_disabled - :py:function:`attrs.validators.get_disabled`
attrs.validators.gt attrs 22.2.0 api.html#attrs.validators.gt - :py:function:`attrs.validators.gt`
attrs.validators.in_ attrs 22.2.0 api.html#attrs.validators.in_ - :py:function:`attrs.validators.in_`
attrs.validators.instance_of attrs 22.2.0 api.html#attrs.validators.instance_of - :py:function:`attrs.validators.instance_of`
attrs.validators.is_callable attrs 22.2.0 api.html#attrs.validators.is_callable - :py:function:`attrs.validators.is_callable`
attrs.validators.le attrs 22.2.0 api.html#attrs.validators.le - :py:function:`attrs.validators.le`
attrs.validators.lt attrs 22.2.0 api.html#attrs.validators.lt - :py:function:`attrs.validators.lt`
attrs.validators.matches_re attrs 22.2.0 api.html#attrs.validators.matches_re - :py:function:`attrs.validators.matches_re`
attrs.validators.max_len attrs 22.2.0 api.html#attrs.validators.max_len - :py:function:`attrs.validators.max_len`
attrs.validators.min_len attrs 22.2.0 api.html#attrs.validators.min_len - :py:function:`attrs.validators.min_len`
attrs.validators.not_ attrs 22.2.0 api.html#attrs.validators.not_ - :py:function:`attrs.validators.not_`
attrs.validators.optional attrs 22.2.0 api.html#attrs.validators.optional - :py:function:`attrs.validators.optional`
attrs.validators.provides attrs 22.2.0 api.html#attrs.validators.provides - :py:function:`attrs.validators.provides`
attrs.validators.set_disabled attrs 22.2.0 api.html#attrs.validators.set_disabled - :py:function:`attrs.validators.set_disabled`

py:data

Identifier Project Name Version Location Display Name Usage example
attr.attr.NOTHING attrs 22.2.0 api.html#attr.attr.NOTHING - :py:data:`attr.attr.NOTHING`
attr.attrs.setters.NO_OP attrs 22.2.0 api.html#attr.attrs.setters.NO_OP - :py:data:`attr.attrs.setters.NO_OP`
attrs.NOTHING attrs 22.2.0 api.html#attrs.NOTHING - :py:data:`attrs.NOTHING`

py:exception

Identifier Project Name Version Location Display Name Usage example
attr.exceptions.AttrsAttributeNotFoundError attrs 22.2.0 api.html#attrs.exceptions.AttrsAttributeNotFoundError - :py:exception:`attr.exceptions.AttrsAttributeNotFoundError`
attr.exceptions.DefaultAlreadySetError attrs 22.2.0 api.html#attrs.exceptions.DefaultAlreadySetError - :py:exception:`attr.exceptions.DefaultAlreadySetError`
attr.exceptions.FrozenAttributeError attrs 22.2.0 api.html#attrs.exceptions.FrozenAttributeError - :py:exception:`attr.exceptions.FrozenAttributeError`
attr.exceptions.FrozenError attrs 22.2.0 api.html#attrs.exceptions.FrozenError - :py:exception:`attr.exceptions.FrozenError`
attr.exceptions.FrozenInstanceError attrs 22.2.0 api.html#attrs.exceptions.FrozenInstanceError - :py:exception:`attr.exceptions.FrozenInstanceError`
attr.exceptions.NotAnAttrsClassError attrs 22.2.0 api.html#attrs.exceptions.NotAnAttrsClassError - :py:exception:`attr.exceptions.NotAnAttrsClassError`
attr.exceptions.NotCallableError attrs 22.2.0 api.html#attrs.exceptions.NotCallableError - :py:exception:`attr.exceptions.NotCallableError`
attr.exceptions.PythonTooOldError attrs 22.2.0 api.html#attrs.exceptions.PythonTooOldError - :py:exception:`attr.exceptions.PythonTooOldError`
attr.exceptions.UnannotatedAttributeError attrs 22.2.0 api.html#attrs.exceptions.UnannotatedAttributeError - :py:exception:`attr.exceptions.UnannotatedAttributeError`
attrs.exceptions.AttrsAttributeNotFoundError attrs 22.2.0 api.html#attrs.exceptions.AttrsAttributeNotFoundError - :py:exception:`attrs.exceptions.AttrsAttributeNotFoundError`
attrs.exceptions.DefaultAlreadySetError attrs 22.2.0 api.html#attrs.exceptions.DefaultAlreadySetError - :py:exception:`attrs.exceptions.DefaultAlreadySetError`
attrs.exceptions.FrozenAttributeError attrs 22.2.0 api.html#attrs.exceptions.FrozenAttributeError - :py:exception:`attrs.exceptions.FrozenAttributeError`
attrs.exceptions.FrozenError attrs 22.2.0 api.html#attrs.exceptions.FrozenError - :py:exception:`attrs.exceptions.FrozenError`
attrs.exceptions.FrozenInstanceError attrs 22.2.0 api.html#attrs.exceptions.FrozenInstanceError - :py:exception:`attrs.exceptions.FrozenInstanceError`
attrs.exceptions.NotAnAttrsClassError attrs 22.2.0 api.html#attrs.exceptions.NotAnAttrsClassError - :py:exception:`attrs.exceptions.NotAnAttrsClassError`
attrs.exceptions.NotCallableError attrs 22.2.0 api.html#attrs.exceptions.NotCallableError - :py:exception:`attrs.exceptions.NotCallableError`
attrs.exceptions.PythonTooOldError attrs 22.2.0 api.html#attrs.exceptions.PythonTooOldError - :py:exception:`attrs.exceptions.PythonTooOldError`
attrs.exceptions.UnannotatedAttributeError attrs 22.2.0 api.html#attrs.exceptions.UnannotatedAttributeError - :py:exception:`attrs.exceptions.UnannotatedAttributeError`

py:method

Identifier Project Name Version Location Display Name Usage example
attrs.Attribute.evolve attrs 22.2.0 api.html#attrs.Attribute.evolve - :py:method:`attrs.Attribute.evolve`

std:doc

Identifier Project Name Version Location Display Name Usage example
api attrs 22.2.0 api.html API Reference :std:doc:`api`
changelog attrs 22.2.0 changelog.html Changelog :std:doc:`changelog`
comparison attrs 22.2.0 comparison.html Comparison :std:doc:`comparison`
examples attrs 22.2.0 examples.html attrs by Example :std:doc:`examples`
extending attrs 22.2.0 extending.html Extending :std:doc:`extending`
glossary attrs 22.2.0 glossary.html Glossary :std:doc:`glossary`
hashing attrs 22.2.0 hashing.html Hashing :std:doc:`hashing`
how-does-it-work attrs 22.2.0 how-does-it-work.html How Does It Work? :std:doc:`how-does-it-work`
index attrs 22.2.0 index.html attrs: Classes Without Boilerplate :std:doc:`index`
init attrs 22.2.0 init.html Initialization :std:doc:`init`
license attrs 22.2.0 license.html License and Credits :std:doc:`license`
names attrs 22.2.0 names.html On The Core API Names :std:doc:`names`
overview attrs 22.2.0 overview.html Overview :std:doc:`overview`
types attrs 22.2.0 types.html Type Annotations :std:doc:`types`
why attrs 22.2.0 why.html Why not… :std:doc:`why`

std:label

Identifier Project Name Version Location Display Name Usage example
api_setters attrs 22.2.0 api.html#api-setters Setters :std:ref:`api_setters`
api_validators attrs 22.2.0 api.html#api-validators Validators :std:ref:`api_validators`
asdict attrs 22.2.0 examples.html#asdict Converting to Collections Types :std:ref:`asdict`
attrs for enterprise attrs 22.2.0 index.html#attrs-for-enterprise attrs for Enterprise :std:ref:`attrs for enterprise`
converters attrs 22.2.0 init.html#converters Converters :std:ref:`converters`
custom-comparison attrs 22.2.0 comparison.html#custom-comparison Customization :std:ref:`custom-comparison`
examples_validators attrs 22.2.0 examples.html#examples-validators Validators :std:ref:`examples_validators`
extending_metadata attrs 22.2.0 extending.html#extending-metadata Metadata :std:ref:`extending_metadata`
genindex attrs 22.2.0 genindex.html Index :std:ref:`genindex`
helpers attrs 22.2.0 api.html#helpers Helpers :std:ref:`helpers`
how attrs 22.2.0 how-does-it-work.html#how How Does It Work? :std:ref:`how`
how-frozen attrs 22.2.0 how-does-it-work.html#how-frozen Immutability :std:ref:`how-frozen`
metadata attrs 22.2.0 examples.html#metadata Metadata :std:ref:`metadata`
modindex attrs 22.2.0 py-modindex.html Module Index :std:ref:`modindex`
philosophy attrs 22.2.0 overview.html#philosophy Philosophy :std:ref:`philosophy`
private_attributes attrs 22.2.0 init.html#private-attributes Private Attributes and Aliases :std:ref:`private_attributes`
py-modindex attrs 22.2.0 py-modindex.html Python Module Index :std:ref:`py-modindex`
search attrs 22.2.0 search.html Search Page :std:ref:`search`
sponsors attrs 22.2.0 index.html#sponsors Sponsors :std:ref:`sponsors`
transform-fields attrs 22.2.0 extending.html#transform-fields Automatic Field Transformation and Modification :std:ref:`transform-fields`
validators attrs 22.2.0 init.html#validators Validators :std:ref:`validators`
version-info attrs 22.2.0 api.html#version-info - :std:ref:`version-info`

std:term

Identifier Project Name Version Location Display Name Usage example
dict classes attrs 22.2.0 glossary.html#term-dict-classes - :std:term:`dict classes`
dunder methods attrs 22.2.0 glossary.html#term-dunder-methods - :std:term:`dunder methods`
slotted classes attrs 22.2.0 glossary.html#term-slotted-classes - :std:term:`slotted classes`