Changelog History
Page 1
-
v22.1.0 Changes
July 28, 2022Backwards-incompatible Changes
- ๐ Python 2.7 is not supported anymore.
Dealing with Python 2.7 tooling has become too difficult for a volunteer-run project.
We have supported Python 2 more than 2 years after it was officially discontinued and feel that we have paid our dues. All version up to 21.4.0 from December 2021 remain fully functional, of course.
#936 <https://github.com/python-attrs/attrs/issues/936>
_- ๐ The deprecated
cmp
attribute ofattrs.Attribute
has been removed. This does not affect the cmp argument toattr.s
that can be used as a shortcut to set eq and order at the same time.#939 <https://github.com/python-attrs/attrs/issues/939>
_
๐ Changes ^
- Instantiation of frozen slotted classes is now faster.
#898 <https://github.com/python-attrs/attrs/issues/898>
_ - If an
eq
key is defined, it is also used before hashing the attribute.#909 <https://github.com/python-attrs/attrs/issues/909>
_ - โ Added
attrs.validators.min_len()
.#916 <https://github.com/python-attrs/attrs/issues/916>
_ attrs.validators.deep_iterable()
's member_validator argument now also accepts a list of validators and wraps them in anattrs.validators.and_()
.#925 <https://github.com/python-attrs/attrs/issues/925>
_- โ Added missing type stub re-imports for
attrs.converters
andattrs.filters
.#931 <https://github.com/python-attrs/attrs/issues/931>
_ - โ Added missing stub for
attr(s).cmp_using()
.#949 <https://github.com/python-attrs/attrs/issues/949>
_ attrs.validators._in()
'sValueError
is not missing the attribute, expected options, and the value it got anymore.#951 <https://github.com/python-attrs/attrs/issues/951>
_- ๐ Python 3.11 is now officially supported.
#969 <https://github.com/python-attrs/attrs/issues/969>
_
-
v21.4.0 Changes
December 29, 2021๐ Changes ^
- ๐ Fixed the test suite on PyPy3.8 where
cloudpickle
does not work.#892 <https://github.com/python-attrs/attrs/issues/892>
_ - ๐ Fixed
coverage report
for projects that useattrs
and don't set a--source
.#895 <https://github.com/python-attrs/attrs/issues/895>
,#896 <https://github.com/python-attrs/attrs/issues/896>
- ๐ Fixed the test suite on PyPy3.8 where
-
v21.3.0 Changes
December 28, 2021Backward-incompatible Changes
- 0๏ธโฃ When using
@define
, converters are now run by default when setting an attribute on an instance -- additionally to validators. I.e. the new default ison_setattr=[attrs.setters.convert, attrs.setters.validate]
.
This is unfortunately a breaking change, but it was an oversight, impossible to raise a
DeprecationWarning
about, and it's better to fix it now while the APIs are very fresh with few users.#835 <https://github.com/python-attrs/attrs/issues/835>
,#886 <https://github.com/python-attrs/attrs/issues/886>
import attrs
has finally landed! As of this release, you can finally importattrs
using its proper name.
Not all names from the
attr
namespace have been transferred; most notablyattr.s
andattr.ib
are missing. Seeattrs.define
andattrs.field
if you haven't seen our next-generation APIs yet. A more elaborate explanation can be foundOn The Core API Names <https://www.attrs.org/en/latest/names.html>
_This feature is at least for one release provisional. We don't plan on changing anything, but such a big change is unlikely to go perfectly on the first strike.
The API docs have been mostly updated, but it will be an ongoing effort to change everything to the new APIs. Please note that we have not moved -- or even removed -- anything from
attr
!Please do report any bugs or documentation inconsistencies!
#887 <https://github.com/python-attrs/attrs/issues/887>
_๐ Changes ^
attr.asdict(retain_collection_types=False)
(default) dumps collection-esque keys as tuples.#646 <https://github.com/python-attrs/attrs/issues/646>
,#888 <https://github.com/python-attrs/attrs/issues/888>
__match_args__
are now generated to support Python 3.10'sStructural Pattern Matching <https://docs.python.org/3.10/whatsnew/3.10.html#pep-634-structural-pattern-matching>
. This can be controlled by thematch_args
argument to the class decorators on Python 3.10 and later. On older versions, it is never added and the argument is ignored.#815 <https://github.com/python-attrs/attrs/issues/815>
- If the class-level on_setattr is set to
attrs.setters.validate
(default in@define
and@mutable
) but no field defines a validator, pretend that it's not set.#817 <https://github.com/python-attrs/attrs/issues/817>
_ - The generated
__repr__
is significantly faster on Pythons with f-strings.#819 <https://github.com/python-attrs/attrs/issues/819>
_ - Attributes transformed via
field_transformer
are wrapped withAttrsClass
again.#824 <https://github.com/python-attrs/attrs/issues/824>
_ - Generated source code is now cached more efficiently for identical classes.
#828 <https://github.com/python-attrs/attrs/issues/828>
_ - โ Added
attrs.converters.to_bool()
.#830 <https://github.com/python-attrs/attrs/issues/830>
_ attrs.resolve_types()
now resolves types of subclasses after the parents are resolved.#842 <https://github.com/python-attrs/attrs/issues/842>
_#843 <https://github.com/python-attrs/attrs/issues/843>
_- โ Added new validators:
lt(val)
(< val),le(va)
(โค val),ge(val)
(โฅ val),gt(val)
(> val), andmaxlen(n)
.#845 <https://github.com/python-attrs/attrs/issues/845>
_ attrs
classes are now fully compatible withcloudpickle <https://github.com/cloudpipe/cloudpickle>
_ (no need to disablerepr
anymore).#857 <https://github.com/python-attrs/attrs/issues/857>
_- โ Added new context manager
attrs.validators.disabled()
and functionsattrs.validators.(set|get)_disabled()
. They deprecateattrs.(set|get)_run_validators()
. All functions are interoperable and modify the same internal state. They are not โ and never were โ thread-safe, though.#859 <https://github.com/python-attrs/attrs/issues/859>
_ attrs.validators.matches_re()
now accepts pre-compiled regular expressions in addition to pattern strings.#877 <https://github.com/python-attrs/attrs/issues/877>
_
- 0๏ธโฃ When using
-
v21.2.0 Changes
May 07, 2021Backward-incompatible Changes
- โช We had to revert the recursive feature for
attr.evolve()
because it broke some use-cases -- sorry!#806 <https://github.com/python-attrs/attrs/issues/806>
_ - ๐ Python 3.4 is now blocked using packaging metadata because
attrs
can't be imported on it anymore. To ensure that 3.4 users can keep installingattrs
easily, we willyank <https://pypi.org/help/#yanked>
_ 21.1.0 from PyPI. This has no consequences if you pinattrs
to 21.1.0.#807 <https://github.com/python-attrs/attrs/issues/807>
_
- โช We had to revert the recursive feature for
-
v21.1.0 Changes
May 06, 2021๐ Deprecations ^
- The long-awaited, much-talked-about, little-delivered
import attrs
is finally upon us!
Since the NG APIs have now been proclaimed stable, the next release of
attrs
will allow you to actuallyimport attrs
. We're taking this opportunity to replace some defaults in our APIs that made sense in 2015, but don't in 2021.So please, if you have any pet peeves about defaults in
attrs
's APIs, now is the time to air your grievances in #487! We're not gonna get such a chance for a second time, without breaking our backward-compatibility guarantees, or long deprecation cycles. Therefore, speak now or forever hold you peace!#487 <https://github.com/python-attrs/attrs/issues/487>
_- The cmp argument to
attr.s()
andattr.ib()
has been undeprecated It will continue to be supported as syntactic sugar to set eq and order in one go.
I'm terribly sorry for the hassle around this argument! The reason we're bringing it back is it's usefulness regarding customization of equality/ordering.
The
cmp
attribute and argument onattr.Attribute
remains deprecated and will be removed later this year.#773 <https://github.com/python-attrs/attrs/issues/773>
_๐ Changes ^
- It's now possible to customize the behavior of
eq
andorder
by passing in a callable.#435 <https://github.com/python-attrs/attrs/issues/435>
,#627 <https://github.com/python-attrs/attrs/issues/627>
- The instant favorite
next-generation APIs <https://www.attrs.org/en/stable/api.html#next-gen>
_ are not provisional anymore!
They are also officially supported by Mypy as of their
0.800 release <https://mypy-lang.blogspot.com/2021/01/mypy-0800-released.html>
_.We hope the next release will already contain an (additional) importable package called
attrs
.#668 <https://github.com/python-attrs/attrs/issues/668>
,#786 <https://github.com/python-attrs/attrs/issues/786>
- If an attribute defines a converter, the type of its parameter is used as type annotation for its corresponding
__init__
parameter.
If an
attr.converters.pipe
is used, the first one's is used.#710 <https://github.com/python-attrs/attrs/issues/710>
_- ๐ Fixed the creation of an extra slot for an
attr.ib
when the parent class already has a slot with the same name.#718 <https://github.com/python-attrs/attrs/issues/718>
_ __attrs__init__()
will now be injected ifinit=False
, or ifauto_detect=True
and a user-defined__init__()
exists.
This enables users to do "pre-init" work in their
__init__()
(such assuper().__init__()
).__init__()
can then delegate constructor argument processing toself.__attrs_init__(*args, **kwargs)
.#731 <https://github.com/python-attrs/attrs/issues/731>
_bool(attr.NOTHING)
is nowFalse
.#732 <https://github.com/python-attrs/attrs/issues/732>
_- It's now possible to use
super()
inside of properties of slotted classes.#747 <https://github.com/python-attrs/attrs/issues/747>
_ - Allow for a
__attrs_pre_init__()
method that -- if defined -- will get called at the beginning of theattrs
-generated__init__()
method.#750 <https://github.com/python-attrs/attrs/issues/750>
_ - โ Added forgotten
attr.Attribute.evolve()
to type stubs.#752 <https://github.com/python-attrs/attrs/issues/752>
_ attrs.evolve()
now works recursively with nestedattrs
classes.#759 <https://github.com/python-attrs/attrs/issues/759>
_- ๐ Python 3.10 is now officially supported.
#763 <https://github.com/python-attrs/attrs/issues/763>
_ attr.resolve_types()
now takes an optional attrib argument to work inside afield_transformer
.#774 <https://github.com/python-attrs/attrs/issues/774>
_ClassVar
\ s are now also detected if they come fromtyping-extensions <https://pypi.org/project/typing-extensions/>
.#782 <https://github.com/python-attrs/attrs/issues/782>
- To make it easier to customize attribute comparison (#435), we have added the
attr.cmp_with()
helper.
See the
new docs on comparison <https://www.attrs.org/en/stable/comparison.html>
_ for more details.#787 <https://github.com/python-attrs/attrs/issues/787>
_- Added provisional support for static typing in
pyright
via thedataclass_transforms specification <https://github.com/microsoft/pyright/blob/master/specs/dataclass_transforms.md>
_. Both thepyright
specification andattrs
implementation may change in future versions of both projects.
Your constructive feedback is welcome in both
attrs#795 <https://github.com/python-attrs/attrs/issues/795>
_ andpyright#1782 <https://github.com/microsoft/pyright/discussions/1782>
.#796 <https://github.com/python-attrs/attrs/issues/796>
- The long-awaited, much-talked-about, little-delivered
-
v20.3.0 Changes
November 05, 2020Backward-incompatible Changes
attr.define()
,attr.frozen()
,attr.mutable()
, andattr.field()
remain provisional.
This release does not change change anything about them and they are already used widely in production though.
If you wish to use them together with mypy, you can simply drop
this plugin <https://gist.github.com/hynek/1e3844d0c99e479e716169034b5fa963#file-attrs_ng_plugin-py>
_ into your project.Feel free to provide feedback to them in the linked issue #668.
We will release the
attrs
namespace once we have the feeling that the APIs have properly settled.#668 <https://github.com/python-attrs/attrs/issues/668>
_๐ Changes ^
attr.s()
now has a field_transformer hook that is called for allAttribute
\ s and returns a (modified or updated) list ofAttribute
instances.attr.asdict()
has a value_serializer hook that can change the way values are converted. Both hooks are meant to help with data (de-)serialization workflows.#653 <https://github.com/python-attrs/attrs/issues/653>
_kw_only=True
now works on Python 2.#700 <https://github.com/python-attrs/attrs/issues/700>
_raise from
now works on frozen classes on PyPy.#703 <https://github.com/python-attrs/attrs/issues/703>
,#712 <https://github.com/python-attrs/attrs/issues/712>
attr.asdict()
andattr.astuple()
now treatfrozenset
\ s likeset
\ s with regards to the retain_collection_types argument.#704 <https://github.com/python-attrs/attrs/issues/704>
_- The type stubs for
attr.s()
andattr.make_class()
are not missing the collect_by_mro argument anymore.#711 <https://github.com/python-attrs/attrs/issues/711>
_
-
v20.2.0 Changes
September 05, 2020Backward-incompatible Changes
attr.define()
,attr.frozen()
,attr.mutable()
, andattr.field()
remain provisional.
This release fixes a bunch of bugs and ergonomics but they remain mostly unchanged.
If you wish to use them together with mypy, you can simply drop
this plugin <https://gist.github.com/hynek/1e3844d0c99e479e716169034b5fa963#file-attrs_ng_plugin-py>
_ into your project.Feel free to provide feedback to them in the linked issue #668.
We will release the
attrs
namespace once we have the feeling that the APIs have properly settled.#668 <https://github.com/python-attrs/attrs/issues/668>
_๐ Changes ^
attr.define()
et al now correctly detect__eq__
and__ne__
.#671 <https://github.com/python-attrs/attrs/issues/671>
_attr.define()
et al's hybrid behavior now also works correctly when arguments are passed.#675 <https://github.com/python-attrs/attrs/issues/675>
_- It's possible to define custom
__setattr__
methods on slotted classes again.#681 <https://github.com/python-attrs/attrs/issues/681>
_ - In 20.1.0 we introduced the
inherited
attribute on theattr.Attribute
class to differentiate attributes that have been inherited and those that have been defined directly on the class.
It has shown to be problematic to involve that attribute when comparing instances of
attr.Attribute
though, because when sub-classing, attributes from base classes are suddenly not equal to themselves in a super class.Therefore the
inherited
attribute will now be ignored when hashing and comparing instances ofattr.Attribute
.#684 <https://github.com/python-attrs/attrs/issues/684>
_- โ
zope.interface
is now a "soft dependency" when running the test suite; ifzope.interface
is not installed when running the test suite, the interface-related tests will be automatically skipped.#685 <https://github.com/python-attrs/attrs/issues/685>
_ - The ergonomics of creating frozen classes using
@define(frozen=True)
and sub-classing frozen classes has been improved: you don't have to seton_setattr=None
anymore.#687 <https://github.com/python-attrs/attrs/issues/687>
_
-
v20.1.0 Changes
August 20, 2020Backward-incompatible Changes
- ๐ Python 3.4 is not supported anymore. It has been unsupported by the Python core team for a while now, its PyPI downloads are negligible, and our CI provider removed it as a supported option.
It's very unlikely that
attrs
will break under 3.4 anytime soon, which is why we do not block its installation on Python 3.4. But we don't test it anymore and will block it once someone reports breakage.#608 <https://github.com/python-attrs/attrs/issues/608>
_๐ Deprecations ^
- ๐ Less of a deprecation and more of a heads up: the next release of
attrs
will introduce anattrs
namespace. That means that you'll finally be able to runimport attrs
with new functions that aren't cute abbreviations and that will carry better defaults.
This should not break any of your code, because project-local packages have priority before installed ones. If this is a problem for you for some reason, please report it to our bug tracker and we'll figure something out.
The old
attr
namespace isn't going anywhere and its defaults are not changing โ this is a purely additive measure. Please check out the linked issue for more details.These new APIs have been added provisionally as part of #666 so you can try them out today and provide feedback. Learn more in the
API docs <https://www.attrs.org/en/stable/api.html#provisional-apis>
.#408 <https://github.com/python-attrs/attrs/issues/408>
๐ Changes ^
- โ Added
attr.resolve_types()
. It ensures that all forward-references and types in string form are resolved into concrete types.
You need this only if you need concrete types at runtime. That means that if you only use types for static type checking, you do not need this function.
#288 <https://github.com/python-attrs/attrs/issues/288>
,#302 <https://github.com/python-attrs/attrs/issues/302>
- Added
@attr.s(collect_by_mro=False)
argument that if set toTrue
fixes the collection of attributes from base classes.
It's only necessary for certain cases of multiple-inheritance but is kept off for now for backward-compatibility reasons. It will be turned on by default in the future.
As a side-effect,
attr.Attribute
now always has aninherited
attribute indicating whether an attribute on a class was directly defined or inherited.#428 <https://github.com/python-attrs/attrs/issues/428>
,#635 <https://github.com/python-attrs/attrs/issues/635>
- ๐ On Python 3, all generated methods now have a docstring explaining that they have been created by
attrs
.#506 <https://github.com/python-attrs/attrs/issues/506>
_ - It is now possible to prevent
attrs
from auto-generating the__setstate__
and__getstate__
methods that are required for pickling of slotted classes.
Either pass
@attr.s(getstate_setstate=False)
or pass@attr.s(auto_detect=True)
and implement them yourself: ifattrs
finds either of the two methods directly on the decorated class, it assumes implicitlygetstate_setstate=False
(and implements neither).This option works with dict classes but should never be necessary.
#512 <https://github.com/python-attrs/attrs/issues/512>
,#513 <https://github.com/python-attrs/attrs/issues/513>
,#642 <https://github.com/python-attrs/attrs/issues/642>
_- ๐ Fixed a
ValueError: Cell is empty
bug that could happen in some rare edge cases.#590 <https://github.com/python-attrs/attrs/issues/590>
_ attrs
can now automatically detect your own implementations and inferinit=False
,repr=False
,eq=False
,order=False
, andhash=False
if you set@attr.s(auto_detect=True)
.attrs
will ignore inherited methods. If the argument implies more than one method (e.g.eq=True
creates both__eq__
and__ne__
), it's enough for one of them to exist andattrs
will create neither.
This feature requires Python 3.
#607 <https://github.com/python-attrs/attrs/issues/607>
_- โ Added
attr.converters.pipe()
. The feature allows combining multiple conversion callbacks into one by piping the value through all of them, and retuning the last result.
As part of this feature, we had to relax the type information for converter callables.
#618 <https://github.com/python-attrs/attrs/issues/618>
_- ๐ Fixed serialization behavior of non-slots classes with
cache_hash=True
. The hash cache will be cleared on operations which make "deep copies" of instances of classes with hash caching, though the cache will not be cleared with shallow copies like those made bycopy.copy()
.
Previously,
copy.deepcopy()
or serialization and deserialization withpickle
would result in an un-initialized object.This change also allows the creation of
cache_hash=True
classes with a custom__setstate__
, which was previously forbidden (#494 <https://github.com/python-attrs/attrs/issues/494>
).#620 <https://github.com/python-attrs/attrs/issues/620>
- It is now possible to specify hooks that are called whenever an attribute is set after a class has been instantiated.
You can pass
on_setattr
both to@attr.s()
to set the default for all attributes on a class, and to@attr.ib()
to overwrite it for individual attributes.attrs
also comes with a new moduleattr.setters
that brings helpers that run validators, converters, or allow to freeze a subset of attributes.#645 <https://github.com/python-attrs/attrs/issues/645>
,#660 <https://github.com/python-attrs/attrs/issues/660>
- Provisional APIs called
attr.define()
,attr.mutable()
, andattr.frozen()
have been added.
They are only available on Python 3.6 and later, and call
attr.s()
with different default values.If nothing comes up, they will become the official way for creating classes in 20.2.0 (see above).
Please note that it may take some time until mypy โ and other tools that have dedicated support for
attrs
โ recognize these new APIs. Please do not open issues on our bug tracker, there is nothing we can do about it.#666 <https://github.com/python-attrs/attrs/issues/666>
_- We have also provisionally added
attr.field()
that supplantsattr.ib()
. It also requires at least Python 3.6 and is keyword-only. Other than that, it only dropped a few arguments, but changed no defaults.
As with
attr.s()
:attr.ib()
is not going anywhere.#669 <https://github.com/python-attrs/attrs/issues/669>
_
-
v19.3.0 Changes
October 15, 2019๐ Changes ^
- ๐ Fixed
auto_attribs
usage when default values cannot be compared directly with==
, such asnumpy
arrays.#585 <https://github.com/python-attrs/attrs/issues/585>
_
- ๐ Fixed
-
v19.2.0 Changes
October 01, 2019Backward-incompatible Changes
- โ Removed deprecated
Attribute
attributeconvert
per scheduled removal on 2019/1. This planned deprecation is tracked in issue#307 <https://github.com/python-attrs/attrs/issues/307>
.#504 <https://github.com/python-attrs/attrs/issues/504>
__lt__
,__le__
,__gt__
, and__ge__
do not consider subclasses comparable anymore.
This has been deprecated since 18.2.0 and was raising a
DeprecationWarning
for over a year.#570 <https://github.com/python-attrs/attrs/issues/570>
_๐ Deprecations ^
- ๐ The
cmp
argument toattr.s()
andattr.ib()
is now deprecated.
Please use
eq
to add equality methods (__eq__
and__ne__
) andorder
to add ordering methods (__lt__
,__le__
,__gt__
, and__ge__
) instead โ just like withdataclasses <https://docs.python.org/3/library/dataclasses.html>
_.Both are effectively
True
by default but it's enough to seteq=False
to disable both at once. Passingeq=False, order=True
explicitly will raise aValueError
though.Since this is arguably a deeper backward-compatibility break, it will have an extended deprecation period until 2021-06-01. After that day, the
cmp
argument will be removed.attr.Attribute
also isn't orderable anymore.#574 <https://github.com/python-attrs/attrs/issues/574>
_๐ Changes ^
- Updated
attr.validators.__all__
to include new validators added in#425
.#517 <https://github.com/python-attrs/attrs/issues/517>
- Slotted classes now use a pure Python mechanism to rewrite the
__class__
cell when rebuilding the class, sosuper()
works even on environments wherectypes
is not installed.#522 <https://github.com/python-attrs/attrs/issues/522>
_ - 0๏ธโฃ When collecting attributes using
@attr.s(auto_attribs=True)
, attributes with a default ofNone
are now deleted too.#523 <https://github.com/python-attrs/attrs/issues/523>
,#556 <https://github.com/python-attrs/attrs/issues/556>
- Fixed
attr.validators.deep_iterable()
andattr.validators.deep_mapping()
type stubs.#533 <https://github.com/python-attrs/attrs/issues/533>
_ - ๐ป
attr.validators.is_callable()
validator now raises an exceptionattr.exceptions.NotCallableError
, a subclass ofTypeError
, informing the received value.#536 <https://github.com/python-attrs/attrs/issues/536>
_ - ๐
@attr.s(auto_exc=True)
now generates classes that are hashable by ID, as the documentation always claimed it would.#543 <https://github.com/python-attrs/attrs/issues/543>
,#563 <https://github.com/python-attrs/attrs/issues/563>
- โ Added
attr.validators.matches_re()
that checks string attributes whether they match a regular expression.#552 <https://github.com/python-attrs/attrs/issues/552>
_ - Keyword-only attributes (
kw_only=True
) and attributes that are excluded from theattrs
's__init__
(init=False
) now can appear before mandatory attributes.#559 <https://github.com/python-attrs/attrs/issues/559>
_ - The fake filename for generated methods is now more stable.
It won't change when you restart the process.
#560 <https://github.com/python-attrs/attrs/issues/560>
_ - The value passed to
@attr.ib(repr=โฆ)
can now be either a boolean (as before) or a callable. That callable must return a string and is then used for formatting the attribute by the generated__repr__()
method.#568 <https://github.com/python-attrs/attrs/issues/568>
_ - ๐ Added
attr.__version_info__
that can be used to reliably check the version ofattrs
and write forward- and backward-compatible code. Please check out thesection on deprecated APIs <https://www.attrs.org/en/stable/api.html#deprecated-apis>
_ on how to use it.#580 <https://github.com/python-attrs/attrs/issues/580>
_
.. _
#425
: https://github.com/python-attrs/attrs/issues/425
- โ Removed deprecated