Changelog¶
Versions follow CalVer with a strict backwards compatibility policy. The third digit is only for regressions.
16.3.0 (2016-11-24)¶
Changes:¶
Attributes now can have user-defined metadata which greatly improves
attrs‘s extensibility. #96Allow for a
__attrs_post_init__method that – if defined – will get called at the end of theattrs-generated__init__method. #111Add
@attr.s(str=True)that will optionally create a__str__method that is identical to__repr__. This is mainly useful withExceptions and other classes that rely on a useful__str__implementation but overwrite the default one through a poor own one. Default Python class behavior is to use__repr__as__str__anyways.If you tried using
attrswithExceptions and were puzzled by the tracebacks: this option is for you.Don’t overwrite
__name__with__qualname__forattr.s(slots=True)classes. #99
16.2.0 (2016-09-17)¶
Changes:¶
- Add
attr.astuple()that – similarly toattr.asdict()– returns the instance as a tuple. #77 - Converts now work with frozen classes. #76
- Instantiation of
attrsclasses with converters is now significantly faster. #80 - Pickling now works with
__slots__classes. #81 attr.assoc()now works with__slots__classes. #84- The tuple returned by
attr.fields()now also allows to access theAttributeinstances by name. Yes, we’ve subclassedtupleso you don’t have to! Thereforeattr.fields(C).xis equivalent to the deprecatedC.xand works with__slots__classes. #88
16.1.0 (2016-08-30)¶
Backward-incompatible changes:¶
- All instances where function arguments were called
clhave been changed to the more Pythoniccls. Since it was always the first argument, it’s doubtful anyone ever called those function with in the keyword form. If so, sorry for any breakage but there’s no practical deprecation path to solve this ugly wart.
Deprecations:¶
Accessing
Attributeinstances on class objects is now deprecated and will stop working in 2017. If you need introspection please use the__attrs_attrs__attribute or theattr.fields()function that carry them too. In the future, the attributes that are defined on the class body and are usually overwritten in your__init__method are simply removed after@attr.shas been applied.This will remove the confusing error message if you write your own
__init__and forget to initialize some attribute. Instead you will get a straightforwardAttributeError. In other words: decorated classes will work more like plain Python classes which was alwaysattrs‘s goal.The serious business aliases
attr.attributesandattr.attrhave been deprecated in favor ofattr.attrsandattr.attribwhich are much more consistent and frankly obvious in hindsight. They will be purged from documentation immediately but there are no plans to actually remove them.
Changes:¶
attr.asdict()‘sdict_factoryarguments is now propagated on recursion. #45attr.asdict(),attr.has()andattr.fields()are significantly faster. #48 #51- Add
attr.attrsandattr.attribas a more consistent aliases forattr.sandattr.ib. - Add
frozenoption toattr.sthat will make instances best-effort immutable. #60 attr.asdict()now takesretain_collection_typesas an argument. IfTrue, it does not convert attributes of typetupleorsettolist. #69
16.0.0 (2016-05-23)¶
Backward-incompatible changes:¶
Python 3.3 and 2.6 aren’t supported anymore. They may work by chance but any effort to keep them working has ceased.
The last Python 2.6 release was on October 29, 2013 and isn’t supported by the CPython core team anymore. Major Python packages like Django and Twisted dropped Python 2.6 a while ago already.
Python 3.3 never had a significant user base and wasn’t part of any distribution’s LTS release.
Changes:¶
__slots__have arrived! Classes now can automatically be slots-style (and save your precious memory) just by passingslots=True. #35- Allow the case of initializing attributes that are set to
init=False. This allows for clean initializer parameter lists while being able to initialize attributes to default values. #32 attr.asdict()can now produce arbitrary mappings instead of Pythondicts when provided with adict_factoryargument. #40- Multiple performance improvements.