tor-browser

The Tor Browser
git clone https://git.dasho.dev/tor-browser.git
Log | Files | Refs | README | LICENSE

CHANGELOG.md (60607B)


Changelog

Versions follow CalVer with a strict backwards-compatibility policy.

The first number of the version is the year. The second number is incremented with each release, starting at 1 for each year. The third number is when we need to start branches for older releases (only for emergencies).

You can find out backwards-compatibility policy here.

Changes for the upcoming release can be found in the "changelog.d" directory in our repository.

<!-- towncrier release notes start -->

[23.2.0](https://github.com/python-attrs/attrs/tree/23.2.0) - 2023-12-31

Changes

#1141

#1158

#1165

This allows you to subclass it along with another Protocol. #1172

This allows you to, for example, pass arguments to super().__init__(). #1187

#1200

It is, for example, now possible to attach methods. #1203

[23.1.0](https://github.com/python-attrs/attrs/tree/23.1.0) - 2023-04-16

Backwards-incompatible Changes

#993

Deprecations

The presence of a C-based package in our developement dependencies has caused headaches and we're not under the impression it's used a lot.

Let us know if you're using it and we might publish it as a separate package. #1120

Changes

#1068

#1079

#1081

#1084

#1085

#1090

#1092

#1099

#1105

Please note that type checkers ignore type metadata passed into make_class(), but it can be useful if you're wrapping attrs. #1107

Passing the instance using the inst keyword argument is now deprecated and will be removed in, or after, April 2024. #1117

#1122

[22.2.0](https://github.com/python-attrs/attrs/tree/22.2.0) - 2022-12-21

Backwards-incompatible Changes

#988

Deprecations

#1017

Changes

Get __init__ signatures matching any taste, peculiar or plain! The PEP 681 compatible alias option can be use to override private attribute name mangling, or add other arbitrary field argument name overrides. #950

#983

#987

#991

You can expect an improvement of about 5% -- even for very simple classes. #995

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

#999

This improves the detection of abstractness. #1001

That is safer and more robust across different versions of a class. #1009

#1010

#1027

#1065

[22.1.0](https://github.com/python-attrs/attrs/tree/22.1.0) - 2022-07-28

Backwards-incompatible Changes

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

This does not affect the cmp argument to attr.s that can be used as a shortcut to set eq and order at the same time. #939

Changes

#898

#909

#916

#925

#931

#949

#951

#969

[21.4.0](https://github.com/python-attrs/attrs/tree/21.4.0) - 2021-12-29

Changes

#892

#895, #896

[21.3.0](https://github.com/python-attrs/attrs/tree/21.3.0) - 2021-12-28

Backward-incompatible Changes

I.e. the new default is on_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, #886

As of this release, you can finally import attrs using its proper name.

Not all names from the attr namespace have been transferred; most notably attr.s and attr.ib are missing. See attrs.define and attrs.field if you haven't seen our next-generation APIs yet. A more elaborate explanation can be found On The Core API Names

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

Changes

#646, #888

Structural Pattern Matching. This can be controlled by the match_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

#817

#819

#824

#828

#830

#842 #843

#845

#857

They deprecate attrs.(set|get)_run_validators(). All functions are interoperable and modify the same internal state. They are not – and never were – thread-safe, though. #859

#877


[21.2.0](https://github.com/python-attrs/attrs/tree/21.2.0) - 2021-05-07

Backward-incompatible Changes

#806

To ensure that 3.4 users can keep installing attrs easily, we will yank 21.1.0 from PyPI. This has no consequences if you pin attrs to 21.1.0. #807

[21.1.0](https://github.com/python-attrs/attrs/tree/21.1.0) - 2021-05-06

Deprecations

Since the NG APIs have now been proclaimed stable, the next release of attrs will allow you to actually import 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

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 on attr.Attribute remains deprecated and will be removed later this year. #773

Changes

#435, #627

They are also officially supported by Mypy as of their 0.800 release.

We hope the next release will already contain an (additional) importable package called attrs. #668, #786

If an attr.converters.pipe is used, the first one's is used. #710

#718

This enables users to do "pre-init" work in their __init__() (such as super().__init__()).

__init__() can then delegate constructor argument processing to self.__attrs_init__(*args, **kwargs). #731

#732

#747

#750

#752

#759

#763

#774

#782

See the new docs on comparison for more details. #787

Both the pyright specification and attrs implementation may change in future versions of both projects.

Your constructive feedback is welcome in both attrs#795 and pyright#1782. #796

[20.3.0](https://github.com/python-attrs/attrs/tree/20.3.0) - 2020-11-05

Backward-incompatible Changes

This release does not 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 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

Changes

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

#700

#703, #712

#704

#711


[20.2.0](https://github.com/python-attrs/attrs/tree/20.2.0) - 2020-09-05

Backward-incompatible Changes

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 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

Changes

#671

#675

#681

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 of attr.Attribute. #684

#685

you don't have to set on_setattr=None anymore. #687


[20.1.0](https://github.com/python-attrs/attrs/tree/20.1.0) - 2020-08-20

Backward-incompatible Changes

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

Deprecations

That means that you'll finally be able to run import 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. #408

Changes

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, #302

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 an inherited attribute indicating whether an attribute on a class was directly defined or inherited. #428, #635

#506

Either pass @attr.s(getstate_setstate=False) or pass @attr.s(auto_detect=True) and implement them yourself: if attrs finds either of the two methods directly on the decorated class, it assumes implicitly getstate_setstate=False (and implements neither).

This option works with dict classes but should never be necessary. #512, #513, #642

#590

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 and attrs will create neither.

This feature requires Python 3. #607

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

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 by copy.copy().

Previously, copy.deepcopy() or serialization and deserialization with pickle 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). #620

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 module attr.setters that brings helpers that run validators, converters, or allow to freeze a subset of attributes. #645, #660

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

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


[19.3.0](https://github.com/python-attrs/attrs/tree/19.3.0) - 2019-10-15

Changes

#585


[19.2.0](https://github.com/python-attrs/attrs/tree/19.2.0) - 2019-10-01

Backward-incompatible Changes

This planned deprecation is tracked in issue #307. #504

This has been deprecated since 18.2.0 and was raising a DeprecationWarning for over a year. #570

Deprecations

Please use eq to add equality methods (__eq__ and __ne__) and order to add ordering methods (__lt__, __le__, __gt__, and __ge__) instead – just like with dataclasses.

Both are effectively True by default but it's enough to set eq=False to disable both at once. Passing eq=False, order=True explicitly will raise a ValueError 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

Changes

#517

#522

#523, #556

#533

#536

#543, #563

#552

#559

It won't change when you restart the process. #560

That callable must return a string and is then used for formatting the attribute by the generated __repr__() method. #568

Please check out the section on deprecated APIs on how to use it. #580

>


[19.1.0](https://github.com/python-attrs/attrs/tree/19.1.0) - 2019-03-03

Backward-incompatible Changes

This change breaks classes with cache_hash=True when a custom __setstate__ is present. An exception will be thrown when applying the attrs annotation to such a class. This limitation is tracked in issue #494. #482

Changes

- is_callable: validates that a value is callable - deep_iterable: Allows recursion down into an iterable, applying another validator to every member in the iterable as well as applying an optional validator to the iterable itself. - deep_mapping: Allows recursion down into the items in a mapping object, applying a key validator and a value validator to the key and value in every item. Also applies an optional validator to the mapping object itself.

You can find them in the attr.validators package. [#425]

#443

#450

If you define a class using @attr.s(auto_exc=True) and subclass an exception, the class will behave like a well-behaved exception class including an appropriate __str__ method, and all attributes additionally available in an args attribute. #500

#503


[18.2.0](https://github.com/python-attrs/attrs/tree/18.2.0) - 2018-09-01

Deprecations

The docs always claimed that instances are only compared if the types are identical, so this is a first step to conform to the docs.

Equality operators (== and !=) were always strict in this regard. #394

Changes

Together with mypy's attrs plugin, you've got all you need for writing statically typed code in both Python 2 and 3!

At that occasion, we've also added narrative docs about type annotations in attrs. #238

This change makes it possible to have a generated __init__ with keyword-only arguments on Python 3, relaxing the required ordering of default and non-default valued attributes. #281, #411

#364, #396

#383

#395

For example attr.ib(converter=default_if_none("")) replaces None by empty strings. #400, #414

#407

#420

#426

#430

#431


[18.1.0](https://github.com/python-attrs/attrs/tree/18.1.0) - 2018-05-03

Changes

#95

#178, #356

#290, #349

Before, the order was always determined by the order in which the attributes have been defined which may not be desirable when creating classes programmatically.

#300, #339, #343

#311, #326

This fixes attrs on Jython.

We cannot make any guarantees regarding Jython though, because our test suite cannot run due to dependency incompatibilities.

#321, #334

#322, #323

#331, #332

#336

#363

Instead of putting everything into the examples page, we have started to extract narrative chapters.

So far, we've added chapters on initialization and hashing.

Expect more to come!

#369, #370


[17.4.0](https://github.com/python-attrs/attrs/tree/17.4.0) - 2017-12-30

Backward-incompatible Changes

If you defined a class C that subclasses A and B like C(A, B), attrs would have collected the attributes from B before those of A.

This is now fixed and means that in classes that employ multiple inheritance, the output of __repr__ and the order of positional arguments in __init__ changes. Because of the nature of this bug, a proper deprecation cycle was unfortunately impossible.

Generally speaking, it's advisable to prefer kwargs-based initialization anyways – especially if you employ multiple inheritance and diamond-shaped hierarchies.

#298, #299, #304

This can break code that relied on repr(attr_cls_instance) raising AttributeError to check if any attrs-specified members were unset.

If you were using this, you can implement a custom method for checking this:

` def hasunsetmembers(self): for field in attr.fields(type(self)): try: getattr(self, field.name) except AttributeError: return True return False `

#308

Deprecations

This is done to achieve consistency with other noun-based arguments like validator.

convert will keep working until at least January 2019 while raising a DeprecationWarning.

#307

Changes

Until now the hashes of two classes with the same values were identical which was a bug.

The generated method is also much faster now.

#261, #295, #296

The singleton empty dict is still enforced.

#280

This should only happen in special environments like Google App Engine.

#284, #286

In that case, the definition that is closer to the base of the class hierarchy wins.

#285, #287

#291, #292

#306

#309


[17.3.0](https://github.com/python-attrs/attrs/tree/17.3.0) - 2017-11-08

Backward-incompatible Changes

This means that if you define a class C with an attribute x, the class will not have an attribute x for introspection. Instead of C.x, use attr.fields(C).x or look at C.__attrs_attrs__. The old behavior has been deprecated since version 16.1. (#253)

Changes

(#102, #226, #269, #270, #272)

This change paves the way for automatic type checking and serialization (though as of this release attrs does not make use of it). In Python 3.6 or higher, the value of attr.Attribute.type can alternately be set using variable type annotations (see PEP 526). (#151, #214, #215, #239)

(#198)

(#204)

That means that you can -- for example -- change the default value for an attribute by redefining it. (#221, #229)

Setting a field to an attr.ib() is still possible to supply options like validators. Setting it to any other value is treated like it was passed as attr.ib(default=value) -- passing an instance of attr.Factory also works as expected. (#262, #277)

(#282)


[17.2.0](https://github.com/python-attrs/attrs/tree/17.2.0) - 2017-05-24

Changes:

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


[17.1.0](https://github.com/python-attrs/attrs/tree/17.1.0) - 2017-05-16

To encourage more participation, the project has also been moved into a dedicated GitHub organization and everyone is most welcome to join!

attrs also has a logo now!

:alt: attrs logo

Backward-incompatible Changes:

The way hashes were handled before was in conflict with Python's specification. This may break some software although this breakage is most likely just surfacing of latent bugs. You can always make attrs create the __hash__() method using @attr.s(hash=True). See [#136] for the rationale of this change.

:::{warning} Please do not upgrade blindly and do test your software! Especially if you use instances as dict keys or put them into sets! :::

Deprecations:

Changes:

Now hash mirrors the value of cmp and classes are unhashable by default. [#136] #142

evolve() replaces assoc(), which is now deprecated. evolve() is significantly faster than assoc(), and requires the class have an initializer that can take the field values as keyword arguments (like attrs itself can generate). #116 #124 #135

#118

#128

#130

This can be used to check constants, enums, mappings, etc. #181

#161

#138

#161

Check out the validator examples to see it in action! #143

In other words you can define attribute defaults based on other attributes. [#165] #189

They are always passed the partially initialized instance. [#165]

#105 #173

#152

#155


[16.3.0](https://github.com/python-attrs/attrs/tree/16.3.0) - 2016-11-24

Changes:

#96

#111

This is mainly useful with Exceptions 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 attrs with Exceptions and were puzzled by the tracebacks: this option is for you.

#99


[16.2.0](https://github.com/python-attrs/attrs/tree/16.2.0) - 2016-09-17

Changes:

#77

#76

#80

#81

#84

Yes, we've subclassed tuple so you don't have to! Therefore attr.fields(C).x is equivalent to the deprecated C.x and works with slotted classes. #88


[16.1.0](https://github.com/python-attrs/attrs/tree/16.1.0) - 2016-08-30

Backward-incompatible Changes:

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:

If you need introspection please use the __attrs_attrs__ attribute or the attr.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.s has 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 straightforward AttributeError. In other words: decorated classes will work more like plain Python classes which was always attrs's goal.

They will be purged from documentation immediately but there are no plans to actually remove them.

Changes:

#45

#48 #51

#60

If True, it does not convert attributes of type tuple or set to list. #69


[16.0.0](https://github.com/python-attrs/attrs/tree/16.0.0) - 2016-05-23

Backward-incompatible Changes:

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 is no longer supported by the CPython core team. 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:

Classes now can automatically be slotted-style (and save your precious memory) just by passing slots=True. #35

This allows for clean initializer parameter lists while being able to initialize attributes to default values. #32

#40


[15.2.0](https://github.com/python-attrs/attrs/tree/15.2.0) - 2015-12-08

Changes:

This allows for simple type conversions, e.g. with attr.ib(convert=int). #26

#28


[15.1.0](https://github.com/python-attrs/attrs/tree/15.1.0) - 2015-08-20

Changes:

#16

#24

#20


[15.0.0](https://github.com/python-attrs/attrs/tree/15.0.0) - 2015-04-15

Changes:

Initial release.

[#136]: https://github.com/python-attrs/attrs/issues/136 [#165]: https://github.com/python-attrs/attrs/issues/165 [#425]: https://github.com/python-attrs/attrs/issues/425