Changelog
### 4.4.2
```
Sylvan Mosberger (https://github.com/Infinisil) contributed a patch to
some doctests that were breaking on NixOS.
John Vandenberg (https://github.com/jayvdb) made a case for removing the usage
of `__file__`, that was breaking PyOxidizer.
Miro Hrončok (https://github.com/hroncok) contributed some fixes for the
future Python 3.9.
Hugo van Kemenade (https://github.com/hugovk) contributed some fixes for the
future Python 3.10.
```
### 4.4.1
```
Changed the description to "Decorators for Humans" are requested by
several users. Fixed a .rst bug in the description as seen in PyPI.
```
### 4.4.0
```
Fixed a regression with decorator factories breaking the case with no
arguments by going back to the syntax used in version 4.2.
Accepted a small fix from Eric Larson (https://github.com/larsoner) affecting
`isgeneratorfunction` for old Python versions.
Moved the documentation from ReadTheDocs to GitHub to simplify the
release process and replaced ReStructuredText with Markdown: it is
an inferior solution, but it works better with GitHub and it is good enough.
```
### 4.3.2
```
Accepted a patch from Sylvain Marie (https://github.com/smarie): now the
decorator module can decorate generator functions by preserving their
being generator functions. Set `python_requires='>=2.6, !=3.0.*, !=3.1.*'`
in setup.py, as suggested by https://github.com/hugovk.
```
### 4.3.1
```
Added a section "For the impatient" to the README, addressing an issue
raised by Amir Malekpour. Added support for Python 3.7. Now
the path to the decorator module appears in the tracebacks, as suggested
by an user at EuroPython 2018.
```
Links
- PyPI: https://pypi.org/project/decorator
- Changelog: https://pyup.io/changelogs/decorator/
- Repo: https://github.com/micheles/decorator
Changelog
### 3.0
```
++++++++++++++++
- Python 2 is no longer supported (the 2.x branch supports Python 2,
use "idna<3" in your requirements file if you need Python 2 support)
- Support for V2 UTS 46 test vectors.
```
### 2.10
```
+++++++++++++++++
- Update to Unicode 13.0.0.
- Throws a more specific exception if "xn--" is provided as a label.
- This is expected to be the last version that supports Python 2.
```
### 2.9
```
++++++++++++++++
- Update to Unicode 12.1.0.
- Prohibit A-labels ending with a hyphen (Thanks, Julien Bernard!)
- Future-proofing: Test on Python 3.7 and 3.8, don't immediately
fail should Python 4 come along.
- Made BSD 3-clause license clearer
```
### 2.8
```
++++++++++++++++
- Update to Unicode 11.0.0.
- Provide more specific exceptions for some malformed labels.
```
### 2.7
```
++++++++++++++++
- Update to Unicode 10.0.0.
- No longer accepts dot-prefixed domains (e.g. ".example") as valid.
This is to be more conformant with the UTS 46 spec. Users should
strip dot prefixes from domains before processing.
```
Links
- PyPI: https://pypi.org/project/idna
- Changelog: https://pyup.io/changelogs/idna/
- Repo: https://github.com/kjd/idna
Changelog
### 2.25.1
```
-------------------
**Bugfixes**
- Requests now treats `application/json` as `utf8` by default. Resolving
inconsistencies between `r.text` and `r.json` output. (5673)
**Dependencies**
- Requests now supports chardet v4.x.
```
### 2.25.0
```
------------------
**Improvements**
- Added support for NETRC environment variable. (5643)
**Dependencies**
- Requests now supports urllib3 v1.26.
**Deprecations**
- Requests v2.25.x will be the last release series with support for Python 3.5.
- The `requests[security]` extra is officially deprecated and will be removed
in Requests v2.26.0.
```
### 2.24.0
```
-------------------
**Improvements**
- pyOpenSSL TLS implementation is now only used if Python
either doesn't have an `ssl` module or doesn't support
SNI. Previously pyOpenSSL was unconditionally used if available.
This applies even if pyOpenSSL is installed via the
`requests[security]` extra (5443)
- Redirect resolution should now only occur when
`allow_redirects` is True. (5492)
- No longer perform unnecessary Content-Length calculation for
requests that won't use it. (5496)
```
### 2.23.0
```
-------------------
**Improvements**
- Remove defunct reference to `prefetch` in Session `__attrs__` (5110)
**Bugfixes**
- Requests no longer outputs password in basic auth usage warning. (5099)
**Dependencies**
- Pinning for `chardet` and `idna` now uses major version instead of minor.
This hopefully reduces the need for releases everytime a dependency is updated.
```
### 2.22.0
```
-------------------
**Dependencies**
- Requests now supports urllib3 v1.25.2.
(note: 1.25.0 and 1.25.1 are incompatible)
**Deprecations**
- Requests has officially stopped support for Python 3.4.
```
### 2.21.0
```
-------------------
**Dependencies**
- Requests now supports idna v2.8.
```
### 2.20.1
```
-------------------
**Bugfixes**
- Fixed bug with unintended Authorization header stripping for
redirects using default ports (http/80, https/443).
```
### 2.20.0
```
-------------------
**Bugfixes**
- Content-Type header parsing is now case-insensitive (e.g.
charset=utf8 v Charset=utf8).
- Fixed exception leak where certain redirect urls would raise
uncaught urllib3 exceptions.
- Requests removes Authorization header from requests redirected
from https to http on the same hostname. (CVE-2018-18074)
- `should_bypass_proxies` now handles URIs without hostnames (e.g.
files).
**Dependencies**
- Requests now supports urllib3 v1.24.
**Deprecations**
- Requests has officially stopped support for Python 2.6.
```
### 2.19.1
```
-------------------
**Bugfixes**
- Fixed issue where status\_codes.py's `init` function failed trying
to append to a `__doc__` value of `None`.
```
### 2.19.0
```
-------------------
**Improvements**
- Warn user about possible slowdown when using cryptography version
< 1.3.4
- Check for invalid host in proxy URL, before forwarding request to
adapter.
- Fragments are now properly maintained across redirects. (RFC7231
7.1.2)
- Removed use of cgi module to expedite library load time.
- Added support for SHA-256 and SHA-512 digest auth algorithms.
- Minor performance improvement to `Request.content`.
- Migrate to using collections.abc for 3.7 compatibility.
**Bugfixes**
- Parsing empty `Link` headers with `parse_header_links()` no longer
return one bogus entry.
- Fixed issue where loading the default certificate bundle from a zip
archive would raise an `IOError`.
- Fixed issue with unexpected `ImportError` on windows system which do
not support `winreg` module.
- DNS resolution in proxy bypass no longer includes the username and
password in the request. This also fixes the issue of DNS queries
failing on macOS.
- Properly normalize adapter prefixes for url comparison.
- Passing `None` as a file pointer to the `files` param no longer
raises an exception.
- Calling `copy` on a `RequestsCookieJar` will now preserve the cookie
policy correctly.
**Dependencies**
- We now support idna v2.7.
- We now support urllib3 v1.23.
```
Links
- PyPI: https://pypi.org/project/requests
- Changelog: https://pyup.io/changelogs/requests/
- Docs: https://requests.readthedocs.io
Changelog
### 1.26.2
```
-------------------
* Fixed an issue where ``wrap_socket`` and ``CERT_REQUIRED`` wouldn't
be imported properly on Python 2.7.8 and earlier (Pull 2052)
```
### 1.26.1
```
-------------------
* Fixed an issue where two ``User-Agent`` headers would be sent if a
``User-Agent`` header key is passed as ``bytes`` (Pull 2047)
```
### 1.26.0
```
-------------------
* **NOTE: urllib3 v2.0 will drop support for Python 2**.
`Read more in the v2.0 Roadmap <https://urllib3.readthedocs.io/en/latest/v2-roadmap.html>`_.
* Added support for HTTPS proxies contacting HTTPS servers (Pull 1923, Pull 1806)
* Deprecated negotiating TLSv1 and TLSv1.1 by default. Users that
still wish to use TLS earlier than 1.2 without a deprecation warning
should opt-in explicitly by setting ``ssl_version=ssl.PROTOCOL_TLSv1_1`` (Pull 2002)
**Starting in urllib3 v2.0: Connections that receive a ``DeprecationWarning`` will fail**
* Deprecated ``Retry`` options ``Retry.DEFAULT_METHOD_WHITELIST``, ``Retry.DEFAULT_REDIRECT_HEADERS_BLACKLIST``
and ``Retry(method_whitelist=...)`` in favor of ``Retry.DEFAULT_ALLOWED_METHODS``,
``Retry.DEFAULT_REMOVE_HEADERS_ON_REDIRECT``, and ``Retry(allowed_methods=...)``
(Pull 2000) **Starting in urllib3 v2.0: Deprecated options will be removed**
* Added default ``User-Agent`` header to every request (Pull 1750)
* Added ``urllib3.util.SKIP_HEADER`` for skipping ``User-Agent``, ``Accept-Encoding``,
and ``Host`` headers from being automatically emitted with requests (Pull 2018)
* Collapse ``transfer-encoding: chunked`` request data and framing into
the same ``socket.send()`` call (Pull 1906)
* Send ``http/1.1`` ALPN identifier with every TLS handshake by default (Pull 1894)
* Properly terminate SecureTransport connections when CA verification fails (Pull 1977)
* Don't emit an ``SNIMissingWarning`` when passing ``server_hostname=None``
to SecureTransport (Pull 1903)
* Disabled requesting TLSv1.2 session tickets as they weren't being used by urllib3 (Pull 1970)
* Suppress ``BrokenPipeError`` when writing request body after the server
has closed the socket (Pull 1524)
* Wrap ``ssl.SSLError`` that can be raised from reading a socket (e.g. "bad MAC")
into an ``urllib3.exceptions.SSLError`` (Pull 1939)
```
### 1.25.11
```
--------------------
* Fix retry backoff time parsed from ``Retry-After`` header when given
in the HTTP date format. The HTTP date was parsed as the local timezone
rather than accounting for the timezone in the HTTP date (typically
UTC) (Pull 1932, Pull 1935, Pull 1938, Pull 1949)
* Fix issue where an error would be raised when the ``SSLKEYLOGFILE``
environment variable was set to the empty string. Now ``SSLContext.keylog_file``
is not set in this situation (Pull 2016)
```
### 1.25.10
```
--------------------
* Added support for ``SSLKEYLOGFILE`` environment variable for
logging TLS session keys with use with programs like
Wireshark for decrypting captured web traffic (Pull 1867)
* Fixed loading of SecureTransport libraries on macOS Big Sur
due to the new dynamic linker cache (Pull 1905)
* Collapse chunked request bodies data and framing into one
call to ``send()`` to reduce the number of TCP packets by 2-4x (Pull 1906)
* Don't insert ``None`` into ``ConnectionPool`` if the pool
was empty when requesting a connection (Pull 1866)
* Avoid ``hasattr`` call in ``BrotliDecoder.decompress()`` (Pull 1858)
```
### 1.25.9
```
-------------------
* Added ``InvalidProxyConfigurationWarning`` which is raised when
erroneously specifying an HTTPS proxy URL. urllib3 doesn't currently
support connecting to HTTPS proxies but will soon be able to
and we would like users to migrate properly without much breakage.
See `this GitHub issue <https://github.com/urllib3/urllib3/issues/1850>`_
for more information on how to fix your proxy config. (Pull 1851)
* Drain connection after ``PoolManager`` redirect (Pull 1817)
* Ensure ``load_verify_locations`` raises ``SSLError`` for all backends (Pull 1812)
* Rename ``VerifiedHTTPSConnection`` to ``HTTPSConnection`` (Pull 1805)
* Allow the CA certificate data to be passed as a string (Pull 1804)
* Raise ``ValueError`` if method contains control characters (Pull 1800)
* Add ``__repr__`` to ``Timeout`` (Pull 1795)
```
### 1.25.8
```
-------------------
* Drop support for EOL Python 3.4 (Pull 1774)
* Optimize _encode_invalid_chars (Pull 1787)
```
### 1.25.7
```
-------------------
* Preserve ``chunked`` parameter on retries (Pull 1715, Pull 1734)
* Allow unset ``SERVER_SOFTWARE`` in App Engine (Pull 1704, Issue 1470)
* Fix issue where URL fragment was sent within the request target. (Pull 1732)
* Fix issue where an empty query section in a URL would fail to parse. (Pull 1732)
* Remove TLS 1.3 support in SecureTransport due to Apple removing support (Pull 1703)
```
### 1.25.6
```
-------------------
* Fix issue where tilde (``~``) characters were incorrectly
percent-encoded in the path. (Pull 1692)
```
### 1.25.5
```
-------------------
* Add mitigation for BPO-37428 affecting Python <3.7.4 and OpenSSL 1.1.1+ which
caused certificate verification to be enabled when using ``cert_reqs=CERT_NONE``.
(Issue 1682)
```
### 1.25.4
```
-------------------
* Propagate Retry-After header settings to subsequent retries. (Pull 1607)
* Fix edge case where Retry-After header was still respected even when
explicitly opted out of. (Pull 1607)
* Remove dependency on ``rfc3986`` for URL parsing.
* Fix issue where URLs containing invalid characters within ``Url.auth`` would
raise an exception instead of percent-encoding those characters.
* Add support for ``HTTPResponse.auto_close = False`` which makes HTTP responses
work well with BufferedReaders and other ``io`` module features. (Pull 1652)
* Percent-encode invalid characters in URL for ``HTTPConnectionPool.request()`` (Pull 1673)
```
### 1.25.3
```
-------------------
* Change ``HTTPSConnection`` to load system CA certificates
when ``ca_certs``, ``ca_cert_dir``, and ``ssl_context`` are
unspecified. (Pull 1608, Issue 1603)
* Upgrade bundled rfc3986 to v1.3.2. (Pull 1609, Issue 1605)
```
### 1.25.2
```
-------------------
* Change ``is_ipaddress`` to not detect IPvFuture addresses. (Pull 1583)
* Change ``parse_url`` to percent-encode invalid characters within the
path, query, and target components. (Pull 1586)
```
### 1.25.1
```
-------------------
* Add support for Google's ``Brotli`` package. (Pull 1572, Pull 1579)
* Upgrade bundled rfc3986 to v1.3.1 (Pull 1578)
```
### 1.25
```
-----------------
* Require and validate certificates by default when using HTTPS (Pull 1507)
* Upgraded ``urllib3.utils.parse_url()`` to be RFC 3986 compliant. (Pull 1487)
* Added support for ``key_password`` for ``HTTPSConnectionPool`` to use
encrypted ``key_file`` without creating your own ``SSLContext`` object. (Pull 1489)
* Add TLSv1.3 support to CPython, pyOpenSSL, and SecureTransport ``SSLContext``
implementations. (Pull 1496)
* Switched the default multipart header encoder from RFC 2231 to HTML 5 working draft. (Issue 303, Pull 1492)
* Fixed issue where OpenSSL would block if an encrypted client private key was
given and no password was given. Instead an ``SSLError`` is raised. (Pull 1489)
* Added support for Brotli content encoding. It is enabled automatically if
``brotlipy`` package is installed which can be requested with
``urllib3[brotli]`` extra. (Pull 1532)
* Drop ciphers using DSS key exchange from default TLS cipher suites.
Improve default ciphers when using SecureTransport. (Pull 1496)
* Implemented a more efficient ``HTTPResponse.__iter__()`` method. (Issue 1483)
```
### 1.24.3
```
-------------------
* Apply fix for CVE-2019-9740. (Pull 1591)
```
### 1.24.2
```
-------------------
* Don't load system certificates by default when any other ``ca_certs``, ``ca_certs_dir`` or
``ssl_context`` parameters are specified.
* Remove Authorization header regardless of case when redirecting to cross-site. (Issue 1510)
* Add support for IPv6 addresses in subjectAltName section of certificates. (Issue 1269)
```
### 1.24.1
```
-------------------
* Remove quadratic behavior within ``GzipDecoder.decompress()`` (Issue 1467)
* Restored functionality of ``ciphers`` parameter for ``create_urllib3_context()``. (Issue 1462)
```
### 1.24
```
-----------------
* Allow key_server_hostname to be specified when initializing a PoolManager to allow custom SNI to be overridden. (Pull 1449)
* Test against Python 3.7 on AppVeyor. (Pull 1453)
* Early-out ipv6 checks when running on App Engine. (Pull 1450)
* Change ambiguous description of backoff_factor (Pull 1436)
* Add ability to handle multiple Content-Encodings (Issue 1441 and Pull 1442)
* Skip DNS names that can't be idna-decoded when using pyOpenSSL (Issue 1405).
* Add a server_hostname parameter to HTTPSConnection which allows for
overriding the SNI hostname sent in the handshake. (Pull 1397)
* Drop support for EOL Python 2.6 (Pull 1429 and Pull 1430)
* Fixed bug where responses with header Content-Type: message/* erroneously
raised HeaderParsingError, resulting in a warning being logged. (Pull 1439)
* Move urllib3 to src/urllib3 (Pull 1409)
```
### 1.23
```
-----------------
* Allow providing a list of headers to strip from requests when redirecting
to a different host. Defaults to the ``Authorization`` header. Different
headers can be set via ``Retry.remove_headers_on_redirect``. (Issue 1316)
* Fix ``util.selectors._fileobj_to_fd`` to accept ``long`` (Issue 1247).
* Dropped Python 3.3 support. (Pull 1242)
* Put the connection back in the pool when calling stream() or read_chunked() on
a chunked HEAD response. (Issue 1234)
* Fixed pyOpenSSL-specific ssl client authentication issue when clients
attempted to auth via certificate + chain (Issue 1060)
* Add the port to the connectionpool connect print (Pull 1251)
* Don't use the ``uuid`` module to create multipart data boundaries. (Pull 1380)
* ``read_chunked()`` on a closed response returns no chunks. (Issue 1088)
* Add Python 2.6 support to ``contrib.securetransport`` (Pull 1359)
* Added support for auth info in url for SOCKS proxy (Pull 1363)
```
Links
- PyPI: https://pypi.org/project/urllib3
- Changelog: https://pyup.io/changelogs/urllib3/
- Docs: https://urllib3.readthedocs.io/
Changelog
### 2.4.2
```
============================
Release Date: TBA
* `FunctionDef.is_generator` properly handles `yield` nodes in `While` tests
Close PyCQA/pylint3519
* Properly construct the arguments of infered property descriptors
Close PyCQA/pylint3648
```
### 2.4.1
```
============================
Release Date: 2020-05-05
* Handle the case where the raw builder fails to retrieve the ``__all__`` attribute
Close 772
* Restructure the AST parsing heuristic to always pick the same module
Close PyCQA/pylint3540
Close 773
* Changed setup.py to work with [distlib](https://pypi.org/project/distlib)
Close 779
* Do not crash with SyntaxError when parsing namedtuples with invalid label
Close PyCQA/pylint3549
* Protect against ``infer_call_result`` failing with `InferenceError` in `Super.getattr()`
Close PyCQA/pylint3529
```
### 2.4.0
```
============================
Release Date: 2020-04-27
* Expose a ast_from_string method in AstroidManager, which will accept
source code as a string and return the corresponding astroid object
Closes PyCQA/astroid725
* ``BoundMethod.implicit_parameters`` returns a proper value for ``__new__``
Close PyCQA/pylint2335
* Allow slots added dynamically to a class to still be inferred
Close PyCQA/pylint2334
* Allow `FunctionDef.getattr` to look into both instance attrs and special attributes
Close PyCQA/pylint1078
* Infer qualified ``classmethod`` as a classmethod.
Close PyCQA/pylint3417
* Prevent a recursion error to happen when inferring the declared metaclass of a class
Close 749
* Raise ``AttributeInferenceError`` when ``getattr()`` receives an empty name
Close PyCQA/pylint2991
* Prevent a recursion error for self reference variables and `type()` calls.
Close 199
* Do not infer the first argument of a staticmethod in a metaclass as the class itself
Close PyCQA/pylint3032
* ``NodeNG.bool_value()`` gained an optional ``context`` parameter
We need to pass an inference context downstream when inferring the boolean
value of a node in order to prevent recursion errors and double inference.
This fix prevents a recursion error with dask library.
Close PyCQA/pylint2985
* Pass a context argument to ``astroid.Arguments`` to prevent recursion errors
Close PyCQA/pylint3414
* Better inference of class and static methods decorated with custom methods
Close PyCQA/pylint3209
* Reverse the order of decorators for `infer_subscript`
`path_wrapper` needs to come first, followed by `raise_if_nothing_inferred`,
otherwise we won't handle `StopIteration` correctly.
Close 762
* Prevent a recursion error when inferring self-referential variables without definition
Close PyCQA/pylint1285
* Numpy `datetime64.astype` return value is inferred as a `ndarray`.
Close PyCQA/pylint3332
* Skip non ``Assign`` and ``AnnAssign`` nodes from enum reinterpretation
Closes PyCQA/pylint3365
* Numpy ``ndarray`` attributes ``imag`` and ``real`` are now inferred as ``ndarray``.
Close PyCQA/pylint3322
* Added a call to ``register_transform`` for all functions of the ``brain_numpy_core_multiarray``
module in case the current node is an instance of ``astroid.Name``
Close 666
* Use the parent of the node when inferring aug assign nodes instead of the statement
Close PyCQA/pylint2911
Close PyCQA/pylint3214
* Added some functions to the ``brain_numpy_core_umath`` module
Close PyCQA/pylint3319
* Added some functions of the ``numpy.core.multiarray`` module
Close PyCQA/pylint3208
* All the ``numpy ufunc`` functions derived now from a common class that
implements the specific ``reduce``, ``accumulate``, ``reduceat``,
``outer`` and ``at`` methods.
Close PyCQA/pylint2885
* ``nodes.Const.itered`` returns a list of ``Const`` nodes, not strings
Close PyCQA/pylint3306
* The ``shape`` attribute of a ``numpy ndarray`` is now a ``ndarray``
Close PyCQA/pylint3139
* Don't ignore special methods when inspecting gi classes
Close 728
* Added transform for ``scipy.gaussian``
* Add suport for inferring properties.
* Added a brain for ``responses``
* Allow inferring positional only arguments.
* Retry parsing a module that has invalid type comments
It is possible for a module to use comments that might be interpreted
as type comments by the `ast` library. We do not want to completely crash on those
invalid type comments.
Close 708
* Scope the inference to the current bound node when inferring instances of classes
When inferring instances of classes from arguments, such as ``self``
in a bound method, we could use as a hint the context's ``boundnode``,
which indicates the instance from which the inference originated.
As an example, a subclass that uses a parent's method which returns
``self``, will override the ``self`` to point to it instead of pointing
to the parent class.
Close PyCQA/pylint3157
* Add support for inferring exception instances in all contexts
We were able to infer exception instances as ``ExceptionInstance``
only for a handful of cases, but not all. ``ExceptionInstance`` has
support for better inference of `.args` and other exception related
attributes that normal instances do not have.
This additional support should remove certain false positives related
to ``.args`` and other exception attributes in ``pylint``.
Close PyCQA/pylint2333
* Add more supported parameters to ``subprocess.check_output``
Close 722
* Infer args unpacking of ``self``
Certain stdlib modules use ``*args`` to encapsulate
the ``self`` parameter, which results in uninferable
instances given we rely on the presence of the ``self``
argument to figure out the instance where we should be
setting attributes.
Close PyCQA/pylint3216
* Clean up setup.py
Make pytest-runner a requirement only if running tests, similar to what was
done with McCabe.
Clean up the setup.py file, resolving a handful of minor warnings with it.
* Handle StopIteration error in infer_int.
Close PyCQA/pylint3274
* Can access per argument type comments for positional only and keyword only arguments.
The comments are accessed through through the new
``Arguments.type_comment_posonlyargs`` and
``Arguments.type_comment_kwonlyargs`` attributes respectively.
* Relax upper bound on `wrapt`
Close 755
* Properly analyze CFFI compiled extensions.
```
### 2.3.2
```
============================
Release Date: TBA
* All type comments have as parent the corresponding `astroid` node
Until now they had as parent the builtin `ast` node which meant
we were operating with primitive objects instead of our own.
Close PyCQA/pylint3174
* Pass an inference context to `metaclass()` when inferring an object type
This should prevent a bunch of recursion errors happening in pylint.
Also refactor the inference of `IfExp` nodes to use separate contexts
for each potential branch.
Close PyCQA/pylint3152
Close PyCQA/pylint3159
```
### 2.3.1
```
============================
Release Date: 2019-09-30
* A transform for the builtin `dataclasses` module was added.
This should address various `dataclasses` issues that were surfaced
even more after the release of pylint 2.4.0.
In the previous versions of `astroid`, annotated assign nodes were
allowed to be retrieved via `getattr()` but that no longer happens
with the latest `astroid` release, as those attribute are not actual
attributes, but rather virtual ones, thus an operation such as `getattr()`
does not make sense for them.
* Update attr brain to partly understand annotated attributes
Close 656
```
### 2.3.0
```
============================
Release Date: 2019-09-24
* Add a brain tip for ``subprocess.check_output``
Close 689
* Remove NodeNG.nearest method because of lack of usage in astroid and pylint.
Close 691
* Allow importing wheel files. Close 541
* Annotated AST follows PEP8 coding style when converted to string.
* Fix a bug where defining a class using type() could cause a DuplicateBasesError.
Close 644
* Dropped support for Python 3.4.
* Numpy brain support is improved.
Numpy's fundamental type ``numpy.ndarray`` has its own brain : ``brain_numpy_ndarray`` and
each numpy module that necessitates brain action has now its own numpy brain :
- ``numpy.core.numeric``
- ``numpy.core.function_base``
- ``numpy.core.multiarray``
- ``numpy.core.numeric``
- ``numpy.core.numerictypes``
- ``numpy.core.umath``
- ``numpy.random.mtrand``
Close PyCQA/pylint2865
Close PyCQA/pylint2747
Close PyCQA/pylint2721
Close PyCQA/pylint2326
Close PyCQA/pylint2021
* ``assert`` only functions are properly inferred as returning ``None``
Close 668
* Add support for Python 3.8's `NamedExpr` nodes, which is part of assignment expressions.
Close 674
* Added support for inferring `IfExp` nodes.
* Instances of exceptions are inferred as such when inferring in non-exception context
This allows special inference support for exception attributes such as `.args`.
Close PyCQA/pylint2333
* Drop a superfluous and wrong callcontext when inferring the result of a context manager
Close PyCQA/pylint2859
* ``igetattr`` raises ``InferenceError`` on re-inference of the same object
This prevents ``StopIteration`` from leaking when we encounter the same
object in the current context, which could result in various ``RuntimeErrors``
leaking in other parts of the inference.
Until we get a global context per inference, the solution is sort of a hack,
as with the suggested global context improvement, we could theoretically
reuse the same inference object.
Close 663
* Variable annotations can no longer be retrieved with `ClassDef.getattr`
Unless they have an attached value, class variable annotations can no longer
be retrieved with `ClassDef.getattr.`
* Improved builtin inference for ``tuple``, ``set``, ``frozenset``, ``list`` and ``dict``
We were properly inferring these callables *only* if they had consts as
values, but that is not the case most of the time. Instead we try to infer
the values that their arguments can be and use them instead of assuming
Const nodes all the time.
Close PyCQA/pylint2841
* The last except handler wins when inferring variables bound in an except handler.
Close PyCQA/pylint2777
* ``threading.Lock.locked()`` is properly recognized as a member of ``threading.Lock``
Close PyCQA/pylint2791
* Fix recursion error involving ``len`` and self referential attributes
Close PyCQA/pylint2736
Close PyCQA/pylint2734
Close PyCQA/pylint2740
* Can access per argument type comments through new ``Arguments.type_comment_args`` attribute.
Close 665
* Fix being unable to access class attributes on a NamedTuple.
Close PyCQA/pylint1628
* Fixed being unable to find distutils submodules by name when in a virtualenv.
Close PyCQA/pylint73
```
### 2.2.0
```
============================
Release Date: 2019-02-27
* Fix a bug concerning inference of calls to numpy function that should not return Tuple or List instances.
Close PyCQA/pylint2436
* Fix a bug where a method, which is a lambda built from a function, is not inferred as ``BoundMethod``
Close PyCQA/pylint2594
* ``typed_ast`` gets installed for Python 3.7, meaning type comments can now work on 3.7.
* Fix a bug concerning inference of unary operators on numpy types.
Close PyCQA/pylint2436 (first part)
* Fix a crash with ``typing.NamedTuple`` and empty fields. Close PyCQA/pylint2745
* Add a proper ``strerror`` inference to the ``OSError`` exceptions.
Close PyCQA/pylint2553
* Support non-const nodes as values of Enum attributes.
Close 612
* Fix a crash in the ``enum`` brain tip caused by non-assign members in class definitions.
Close PyCQA/pylint2719
* ``brain_numpy`` returns an undefined type for ``numpy`` methods to avoid ``assignment-from-no-return``
Close PyCQA/pylint2694
* Fix a bug where a call to a function that has been previously called via
functools.partial was wrongly inferred
Close PyCQA/pylint2588
* Fix a recursion error caused by inferring the ``slice`` builtin.
Close PyCQA/pylint2667
* Remove the restriction that "old style classes" cannot have a MRO.
This does not make sense any longer given that we run against Python 3
code.
Close PyCQA/pylint2701
* Added more builtin exceptions attributes. Close 580
* Add a registry for builtin exception models. Close PyCQA/pylint1432
* Add brain tips for `http.client`. Close PyCQA/pylint2687
* Prevent crashing when processing ``enums`` with mixed single and double quotes.
Close PyCQA/pylint2676
* ``typing`` types have the `__args__` property. Close PyCQA/pylint2419
* Fix a bug where an Attribute used as a base class was triggering a crash
Close 626
* Added special support for `enum.IntFlag`
Close PyCQA/pylint2534
* Extend detection of data classes defined with attr
Close 628
* Fix typo in description for brain_attrs
```
### 2.1.0
```
============================
Release Date: 2018-11-25
* ``threading.Lock.acquire`` has the ``timeout`` parameter now.
Close PyCQA/pylint2457
* Pass parameters by keyword name when inferring sequences.
Close PyCQA/pylint2526
* Correct line numbering for f-strings for complex embedded expressions
When a f-string contained a complex expression, such as an attribute access,
we weren't cloning all the subtree of the f-string expression for attaching the correct
line number. This problem is coming from the builtin AST parser which gives for the f-string
and for its underlying elements the line number 1, but this is causing all sorts of bugs and
problems in pylint, which expects correct line numbering.
Close PyCQA/pylint2449
* Add support for `argparse.Namespace`
Close PyCQA/pylint2413
* `async` functions are now inferred as `AsyncGenerator` when inferring their call result.
* Filter out ``Uninferable`` when inferring the call result result of a class with an uninferable ``__call__`` method.
Close PyCQA/pylint2434
* Make compatible with AST changes in Python 3.8.
* Subscript inference (e.g. "`a[i]`") now pays attention to multiple inferred values for value
(e.g. "`a`") and slice (e.g. "`i`")
Close 614
```
### 2.0.4
```
============================
Release Date: 2018-08-10
* Make sure that assign nodes can find ``yield`` statements in their values
Close PyCQA/pylint2400
```
### 2.0.3
```
============================
Release Date: 2018-08-08
* The environment markers for PyPy were invalid.
```
### 2.0.2
```
============================
Release Date: 2018-08-01
* Stop repeat inference attempt causing a RuntimeError in Python3.7
Close PyCQA/pylint2317
* infer_call_result can raise InferenceError so make sure to handle that for the call sites
where it is used
infer_call_result started recently to raise InferenceError for objects for which it
could not find any returns. Previously it was silently raising a StopIteration,
which was especially leaking when calling builtin methods.
Since it is after all an inference method, it is expected that it
could raise an InferenceError rather than returning nothing.
Close PyCQA/pylint2350
```
### 2.0.1
```
============================
Release Date: 2018-07-19
* Released to clear an old wheel package on PyPI
```
### 2.0
```
==========================
Release Date: 2018-07-15
* String representation of nodes takes in account precedence and associativity rules of operators.
* Fix loading files with `modutils.load_from_module` when
the path that contains it in `sys.path` is a symlink and
the file is contained in a symlinked folder.
Close 583
* Reworking of the numpy brain dealing with numerictypes
(use of inspect module to determine the class hierarchy of
numpy.core.numerictypes module)
Close PyCQA/pylint2140
* Added inference support for starred nodes in for loops
Close 146
* Support unpacking for dicts in assignments
Close 268
* Add support for inferring functools.partial
Close 125
* Inference support for `dict.fromkeys`
Close 110
* `int()` builtin is inferred as returning integers.
Close 150
* `str()` builtin is inferred as returning strings.
Close 148
* DescriptorBoundMethod has the correct number of arguments defined.
* Improvement of the numpy numeric types definition.
Close PyCQA/pylint1971
* Subclasses of *property* are now interpreted as properties
Close PyCQA/pylint1601
* AsStringRegexpPredicate has been removed.
Use transform predicates instead of it.
* Switched to using typed_ast for getting access to type comments
As a side effect of this change, some nodes gained a new `type_annotation` attribute,
which, if the type comments were correctly parsed, should contain a node object
with the corresponding objects from the type comment.
* typing.X[...] and typing.NewType are inferred as classes instead of instances.
* Module.__path__ is now a list
It used to be a string containing the path, but it doesn't reflect the situation
on Python, where it is actually a list.
* Fix a bug with namespace package's __path__ attribute.
Close 528
* Added brain tips for random.sample
Part of PyCQA/pylint811
* Add brain tip for `issubclass` builtin
Close 101.
* Fix submodule imports from six
Close PyCQA/pylint1640
* Fix missing __module__ and __qualname__ from class definition locals
Close PYCQA/pylint1753
* Fix a crash when __annotations__ access a parent's __init__ that does not have arguments
Close 473
* Fix multiple objects sharing the same InferenceContext.path causing uninferable results
Close 483
* Fix improper modification of col_offset, lineno upon inference of builtin functions
Close PyCQA/pylint1839
* Subprocess.Popen brain now knows of the args member
Close PyCQA/pylint1860
* add move_to_end method to collections.OrderedDict brain
Close PyCQA/pylint1872
* Include new hashlib classes added in python 3.6
* Fix RecursionError for augmented assign
Close 437, 447, 313, PyCQA/pylint1642, PyCQA/pylint1805, PyCQA/pylint1854, PyCQA/pylint1452
* Add missing attrs special attribute
Close PyCQA/pylint1884
* Inference now understands the 'isinstance' builtin
Close 98
* Stop duplicate nodes with the same key values
from appearing in dictionaries from dictionary unpacking.
Close PyCQA/pylint1843
* Fix ``contextlib.contextmanager`` inference for nested context managers
Close 1699
* Implement inference for len builtin
Close 112
* Add qname method to Super object preventing potential errors in upstream
pylint
Close 533
* Stop astroid from getting stuck in an infinite loop if a function shares
its name with its decorator
Close 375
* Fix issue with inherited __call__ improperly inferencing self
Close PyCQA/pylint2199
* Fix __call__ precedence for classes with custom metaclasses
Close PyCQA/pylint2159
* Limit the maximum amount of interable result in an NodeNG.infer() call to
100 by default for performance issues with variables with large amounts of
possible values.
The max inferable value can be tuned by setting the `max_inferable_values` flag on
astroid.MANAGER.
```
Links
- PyPI: https://pypi.org/project/astroid
- Changelog: https://pyup.io/changelogs/astroid/
- Repo: https://github.com/PyCQA/astroid
Changelog
### 20.3.0
```
-------------------
Backward-incompatible Changes
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
- ``attr.define()``, ``attr.frozen()``, ``attr.mutable()``, and ``attr.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/1e3844d0c99e479e716169034b5fa963file-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 all ``Attribute``\ s and returns a (modified or updated) list of ``Attribute`` 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()`` and ``attr.astuple()`` now treat ``frozenset``\ s like ``set``\ s with regards to the *retain_collection_types* argument.
`704 <https://github.com/python-attrs/attrs/issues/704>`_
- The type stubs for ``attr.s()`` and ``attr.make_class()`` are not missing the *collect_by_mro* argument anymore.
`711 <https://github.com/python-attrs/attrs/issues/711>`_
----
```
### 20.2.0
```
-------------------
Backward-incompatible Changes
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
- ``attr.define()``, ``attr.frozen()``, ``attr.mutable()``, and ``attr.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/1e3844d0c99e479e716169034b5fa963file-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 correct 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 the ``attr.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 of ``attr.Attribute``.
`684 <https://github.com/python-attrs/attrs/issues/684>`_
- ``zope.interface`` is now a "soft dependency" when running the test suite; if ``zope.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 set ``on_setattr=None`` anymore.
`687 <https://github.com/python-attrs/attrs/issues/687>`_
----
```
### 20.1.0
```
-------------------
Backward-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 an ``attrs`` namespace.
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 <https://www.attrs.org/en/stable/api.htmlprovisional-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 to ``True`` 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 an ``inherited`` 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:
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 <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 infer ``init=False``, ``repr=False``, ``eq=False``, ``order=False``, and ``hash=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 and ``attrs`` 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 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 <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 module ``attr.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()``, and ``attr.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 supplants ``attr.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>`_
----
```
### 19.3.0
```
-------------------
Changes
^^^^^^^
- Fixed ``auto_attribs`` usage when default values cannot be compared directly with ``==``, such as ``numpy`` arrays.
`585 <https://github.com/python-attrs/attrs/issues/585>`_
----
```
### 19.2.0
```
-------------------
Backward-incompatible Changes
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
- Removed deprecated ``Attribute`` attribute ``convert`` 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 to ``attr.s()`` and ``attr.ib()`` is now deprecated.
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 <https://docs.python.org/3/library/dataclasses.html>`_.
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 <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, so ``super()`` works even on environments where ``ctypes`` is not installed.
`522 <https://github.com/python-attrs/attrs/issues/522>`_
- When collecting attributes using ``attr.s(auto_attribs=True)``, attributes with a default of ``None`` 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()`` and ``attr.validators.deep_mapping()`` type stubs.
`533 <https://github.com/python-attrs/attrs/issues/533>`_
- ``attr.validators.is_callable()`` validator now raises an exception ``attr.exceptions.NotCallableError``, a subclass of ``TypeError``, 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 the ``attrs``'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 of ``attrs`` and write forward- and backward-compatible code.
Please check out the `section on deprecated APIs <http://www.attrs.org/en/stable/api.htmldeprecated-apis>`_ on how to use it.
`580 <https://github.com/python-attrs/attrs/issues/580>`_
.. _`425`: https://github.com/python-attrs/attrs/issues/425
----
```
### 19.1.0
```
-------------------
Backward-incompatible Changes
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
- Fixed a bug where deserialized objects with ``cache_hash=True`` could have incorrect hash code values.
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 <https://github.com/python-attrs/attrs/issues/494>`_.
`482 <https://github.com/python-attrs/attrs/issues/482>`_
Changes
^^^^^^^
- Add ``is_callable``, ``deep_iterable``, and ``deep_mapping`` validators.
* ``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`_
- Fixed stub files to prevent errors raised by mypy's ``disallow_any_generics = True`` option.
`443 <https://github.com/python-attrs/attrs/issues/443>`_
- Attributes with ``init=False`` now can follow after ``kw_only=True`` attributes.
`450 <https://github.com/python-attrs/attrs/issues/450>`_
- ``attrs`` now has first class support for defining exception classes.
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 <https://github.com/python-attrs/attrs/issues/500>`_
- Clarified documentation for hashing to warn that hashable objects should be deeply immutable (in their usage, even if this is not enforced).
`503 <https://github.com/python-attrs/attrs/issues/503>`_
----
```
### 18.2.0
```
-------------------
Deprecations
^^^^^^^^^^^^
- Comparing subclasses using ``<``, ``>``, ``<=``, and ``>=`` is now deprecated.
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 <https://github.com/python-attrs/attrs/issues/394>`_
Changes
^^^^^^^
- ``attrs`` now ships its own `PEP 484 <https://www.python.org/dev/peps/pep-0484/>`_ type hints.
Together with `mypy <http://mypy-lang.org>`_'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 <https://www.attrs.org/en/stable/types.html>`_ about type annotations in ``attrs``.
`238 <https://github.com/python-attrs/attrs/issues/238>`_
- Added *kw_only* arguments to ``attr.ib`` and ``attr.s``, and a corresponding *kw_only* attribute to ``attr.Attribute``.
This change makes it possible to have a generated ``__init__`` with keyword-only arguments
Update certifi from 2018.4.16 to 2020.12.5.
The bot wasn't able to find a changelog for this release. Got an idea?
Links
- PyPI: https://pypi.org/project/certifi - Docs: https://certifiio.readthedocs.io/en/latest/Update chardet from 3.0.4 to 4.0.0.
Changelog
### 4.0.0 ``` Benchmarking chardet 4.0.0 on CPython 3.7.5 (default, Sep 8 2020, 12:19:42) [Clang 11.0.3 (clang-1103.0.32.62)] -------------------------------------------------------------------------------- ....................................................................................................................................................................................................................................................................................................................................................................... Calls per second for each encoding: ```Links
- PyPI: https://pypi.org/project/chardet - Changelog: https://pyup.io/changelogs/chardet/ - Repo: https://github.com/chardet/chardetUpdate decorator from 4.3.0 to 4.4.2.
Changelog
### 4.4.2 ``` Sylvan Mosberger (https://github.com/Infinisil) contributed a patch to some doctests that were breaking on NixOS. John Vandenberg (https://github.com/jayvdb) made a case for removing the usage of `__file__`, that was breaking PyOxidizer. Miro Hrončok (https://github.com/hroncok) contributed some fixes for the future Python 3.9. Hugo van Kemenade (https://github.com/hugovk) contributed some fixes for the future Python 3.10. ``` ### 4.4.1 ``` Changed the description to "Decorators for Humans" are requested by several users. Fixed a .rst bug in the description as seen in PyPI. ``` ### 4.4.0 ``` Fixed a regression with decorator factories breaking the case with no arguments by going back to the syntax used in version 4.2. Accepted a small fix from Eric Larson (https://github.com/larsoner) affecting `isgeneratorfunction` for old Python versions. Moved the documentation from ReadTheDocs to GitHub to simplify the release process and replaced ReStructuredText with Markdown: it is an inferior solution, but it works better with GitHub and it is good enough. ``` ### 4.3.2 ``` Accepted a patch from Sylvain Marie (https://github.com/smarie): now the decorator module can decorate generator functions by preserving their being generator functions. Set `python_requires='>=2.6, !=3.0.*, !=3.1.*'` in setup.py, as suggested by https://github.com/hugovk. ``` ### 4.3.1 ``` Added a section "For the impatient" to the README, addressing an issue raised by Amir Malekpour. Added support for Python 3.7. Now the path to the decorator module appears in the tracebacks, as suggested by an user at EuroPython 2018. ```Links
- PyPI: https://pypi.org/project/decorator - Changelog: https://pyup.io/changelogs/decorator/ - Repo: https://github.com/micheles/decoratorUpdate dnspython from 1.15.0 to 2.0.0.
The bot wasn't able to find a changelog for this release. Got an idea?
Links
- PyPI: https://pypi.org/project/dnspython - Homepage: http://www.dnspython.orgUpdate idna from 2.6 to 3.0.
Changelog
### 3.0 ``` ++++++++++++++++ - Python 2 is no longer supported (the 2.x branch supports Python 2, use "idna<3" in your requirements file if you need Python 2 support) - Support for V2 UTS 46 test vectors. ``` ### 2.10 ``` +++++++++++++++++ - Update to Unicode 13.0.0. - Throws a more specific exception if "xn--" is provided as a label. - This is expected to be the last version that supports Python 2. ``` ### 2.9 ``` ++++++++++++++++ - Update to Unicode 12.1.0. - Prohibit A-labels ending with a hyphen (Thanks, Julien Bernard!) - Future-proofing: Test on Python 3.7 and 3.8, don't immediately fail should Python 4 come along. - Made BSD 3-clause license clearer ``` ### 2.8 ``` ++++++++++++++++ - Update to Unicode 11.0.0. - Provide more specific exceptions for some malformed labels. ``` ### 2.7 ``` ++++++++++++++++ - Update to Unicode 10.0.0. - No longer accepts dot-prefixed domains (e.g. ".example") as valid. This is to be more conformant with the UTS 46 spec. Users should strip dot prefixes from domains before processing. ```Links
- PyPI: https://pypi.org/project/idna - Changelog: https://pyup.io/changelogs/idna/ - Repo: https://github.com/kjd/idnaUpdate ipaddress from 1.0.22 to 1.0.23.
The bot wasn't able to find a changelog for this release. Got an idea?
Links
- PyPI: https://pypi.org/project/ipaddress - Repo: https://github.com/phihag/ipaddressUpdate requests from 2.18.4 to 2.25.1.
Changelog
### 2.25.1 ``` ------------------- **Bugfixes** - Requests now treats `application/json` as `utf8` by default. Resolving inconsistencies between `r.text` and `r.json` output. (5673) **Dependencies** - Requests now supports chardet v4.x. ``` ### 2.25.0 ``` ------------------ **Improvements** - Added support for NETRC environment variable. (5643) **Dependencies** - Requests now supports urllib3 v1.26. **Deprecations** - Requests v2.25.x will be the last release series with support for Python 3.5. - The `requests[security]` extra is officially deprecated and will be removed in Requests v2.26.0. ``` ### 2.24.0 ``` ------------------- **Improvements** - pyOpenSSL TLS implementation is now only used if Python either doesn't have an `ssl` module or doesn't support SNI. Previously pyOpenSSL was unconditionally used if available. This applies even if pyOpenSSL is installed via the `requests[security]` extra (5443) - Redirect resolution should now only occur when `allow_redirects` is True. (5492) - No longer perform unnecessary Content-Length calculation for requests that won't use it. (5496) ``` ### 2.23.0 ``` ------------------- **Improvements** - Remove defunct reference to `prefetch` in Session `__attrs__` (5110) **Bugfixes** - Requests no longer outputs password in basic auth usage warning. (5099) **Dependencies** - Pinning for `chardet` and `idna` now uses major version instead of minor. This hopefully reduces the need for releases everytime a dependency is updated. ``` ### 2.22.0 ``` ------------------- **Dependencies** - Requests now supports urllib3 v1.25.2. (note: 1.25.0 and 1.25.1 are incompatible) **Deprecations** - Requests has officially stopped support for Python 3.4. ``` ### 2.21.0 ``` ------------------- **Dependencies** - Requests now supports idna v2.8. ``` ### 2.20.1 ``` ------------------- **Bugfixes** - Fixed bug with unintended Authorization header stripping for redirects using default ports (http/80, https/443). ``` ### 2.20.0 ``` ------------------- **Bugfixes** - Content-Type header parsing is now case-insensitive (e.g. charset=utf8 v Charset=utf8). - Fixed exception leak where certain redirect urls would raise uncaught urllib3 exceptions. - Requests removes Authorization header from requests redirected from https to http on the same hostname. (CVE-2018-18074) - `should_bypass_proxies` now handles URIs without hostnames (e.g. files). **Dependencies** - Requests now supports urllib3 v1.24. **Deprecations** - Requests has officially stopped support for Python 2.6. ``` ### 2.19.1 ``` ------------------- **Bugfixes** - Fixed issue where status\_codes.py's `init` function failed trying to append to a `__doc__` value of `None`. ``` ### 2.19.0 ``` ------------------- **Improvements** - Warn user about possible slowdown when using cryptography version < 1.3.4 - Check for invalid host in proxy URL, before forwarding request to adapter. - Fragments are now properly maintained across redirects. (RFC7231 7.1.2) - Removed use of cgi module to expedite library load time. - Added support for SHA-256 and SHA-512 digest auth algorithms. - Minor performance improvement to `Request.content`. - Migrate to using collections.abc for 3.7 compatibility. **Bugfixes** - Parsing empty `Link` headers with `parse_header_links()` no longer return one bogus entry. - Fixed issue where loading the default certificate bundle from a zip archive would raise an `IOError`. - Fixed issue with unexpected `ImportError` on windows system which do not support `winreg` module. - DNS resolution in proxy bypass no longer includes the username and password in the request. This also fixes the issue of DNS queries failing on macOS. - Properly normalize adapter prefixes for url comparison. - Passing `None` as a file pointer to the `files` param no longer raises an exception. - Calling `copy` on a `RequestsCookieJar` will now preserve the cookie policy correctly. **Dependencies** - We now support idna v2.7. - We now support urllib3 v1.23. ```Links
- PyPI: https://pypi.org/project/requests - Changelog: https://pyup.io/changelogs/requests/ - Docs: https://requests.readthedocs.ioUpdate six from 1.11.0 to 1.15.0.
Changelog
### 1.15.0 ``` ------ - Pull request 331: Optimize `six.ensure_str` and `six.ensure_binary`. ``` ### 1.14.0 ``` ------ - Issue 288, pull request 289: Add `six.assertNotRegex`. - Issue 317: `six.moves._dummy_thread` now points to the `_thread` module on Python 3.9+. Python 3.7 and later requires threading and deprecated the `_dummy_thread` module. - Issue 308, pull request 314: Remove support for Python 2.6 and Python 3.2. - Issue 250, issue 165, pull request 251: `six.wraps` now ignores missing attributes. This follows the Python 3.2+ standard library behavior. ``` ### 1.13.0 ``` ------ - Issue 298, pull request 299: Add `six.moves.dbm_ndbm`. - Issue 155: Add `six.moves.collections_abc`, which aliases the `collections` module on Python 2-3.2 and the `collections.abc` on Python 3.3 and greater. - Pull request 304: Re-add distutils fallback in `setup.py`. - Pull request 305: On Python 3.7, `with_metaclass` supports classes using PEP 560 features. ``` ### 1.12.0 ``` ------ - Issue 259, pull request 260: `six.add_metaclass` now preserves `__qualname__` from the original class. - Pull request 204: Add `six.ensure_binary`, `six.ensure_text`, and `six.ensure_str`. ```Links
- PyPI: https://pypi.org/project/six - Changelog: https://pyup.io/changelogs/six/ - Repo: https://github.com/benjaminp/sixUpdate urllib3 from 1.22 to 1.26.2.
Changelog
### 1.26.2 ``` ------------------- * Fixed an issue where ``wrap_socket`` and ``CERT_REQUIRED`` wouldn't be imported properly on Python 2.7.8 and earlier (Pull 2052) ``` ### 1.26.1 ``` ------------------- * Fixed an issue where two ``User-Agent`` headers would be sent if a ``User-Agent`` header key is passed as ``bytes`` (Pull 2047) ``` ### 1.26.0 ``` ------------------- * **NOTE: urllib3 v2.0 will drop support for Python 2**. `Read more in the v2.0 Roadmap <https://urllib3.readthedocs.io/en/latest/v2-roadmap.html>`_. * Added support for HTTPS proxies contacting HTTPS servers (Pull 1923, Pull 1806) * Deprecated negotiating TLSv1 and TLSv1.1 by default. Users that still wish to use TLS earlier than 1.2 without a deprecation warning should opt-in explicitly by setting ``ssl_version=ssl.PROTOCOL_TLSv1_1`` (Pull 2002) **Starting in urllib3 v2.0: Connections that receive a ``DeprecationWarning`` will fail** * Deprecated ``Retry`` options ``Retry.DEFAULT_METHOD_WHITELIST``, ``Retry.DEFAULT_REDIRECT_HEADERS_BLACKLIST`` and ``Retry(method_whitelist=...)`` in favor of ``Retry.DEFAULT_ALLOWED_METHODS``, ``Retry.DEFAULT_REMOVE_HEADERS_ON_REDIRECT``, and ``Retry(allowed_methods=...)`` (Pull 2000) **Starting in urllib3 v2.0: Deprecated options will be removed** * Added default ``User-Agent`` header to every request (Pull 1750) * Added ``urllib3.util.SKIP_HEADER`` for skipping ``User-Agent``, ``Accept-Encoding``, and ``Host`` headers from being automatically emitted with requests (Pull 2018) * Collapse ``transfer-encoding: chunked`` request data and framing into the same ``socket.send()`` call (Pull 1906) * Send ``http/1.1`` ALPN identifier with every TLS handshake by default (Pull 1894) * Properly terminate SecureTransport connections when CA verification fails (Pull 1977) * Don't emit an ``SNIMissingWarning`` when passing ``server_hostname=None`` to SecureTransport (Pull 1903) * Disabled requesting TLSv1.2 session tickets as they weren't being used by urllib3 (Pull 1970) * Suppress ``BrokenPipeError`` when writing request body after the server has closed the socket (Pull 1524) * Wrap ``ssl.SSLError`` that can be raised from reading a socket (e.g. "bad MAC") into an ``urllib3.exceptions.SSLError`` (Pull 1939) ``` ### 1.25.11 ``` -------------------- * Fix retry backoff time parsed from ``Retry-After`` header when given in the HTTP date format. The HTTP date was parsed as the local timezone rather than accounting for the timezone in the HTTP date (typically UTC) (Pull 1932, Pull 1935, Pull 1938, Pull 1949) * Fix issue where an error would be raised when the ``SSLKEYLOGFILE`` environment variable was set to the empty string. Now ``SSLContext.keylog_file`` is not set in this situation (Pull 2016) ``` ### 1.25.10 ``` -------------------- * Added support for ``SSLKEYLOGFILE`` environment variable for logging TLS session keys with use with programs like Wireshark for decrypting captured web traffic (Pull 1867) * Fixed loading of SecureTransport libraries on macOS Big Sur due to the new dynamic linker cache (Pull 1905) * Collapse chunked request bodies data and framing into one call to ``send()`` to reduce the number of TCP packets by 2-4x (Pull 1906) * Don't insert ``None`` into ``ConnectionPool`` if the pool was empty when requesting a connection (Pull 1866) * Avoid ``hasattr`` call in ``BrotliDecoder.decompress()`` (Pull 1858) ``` ### 1.25.9 ``` ------------------- * Added ``InvalidProxyConfigurationWarning`` which is raised when erroneously specifying an HTTPS proxy URL. urllib3 doesn't currently support connecting to HTTPS proxies but will soon be able to and we would like users to migrate properly without much breakage. See `this GitHub issue <https://github.com/urllib3/urllib3/issues/1850>`_ for more information on how to fix your proxy config. (Pull 1851) * Drain connection after ``PoolManager`` redirect (Pull 1817) * Ensure ``load_verify_locations`` raises ``SSLError`` for all backends (Pull 1812) * Rename ``VerifiedHTTPSConnection`` to ``HTTPSConnection`` (Pull 1805) * Allow the CA certificate data to be passed as a string (Pull 1804) * Raise ``ValueError`` if method contains control characters (Pull 1800) * Add ``__repr__`` to ``Timeout`` (Pull 1795) ``` ### 1.25.8 ``` ------------------- * Drop support for EOL Python 3.4 (Pull 1774) * Optimize _encode_invalid_chars (Pull 1787) ``` ### 1.25.7 ``` ------------------- * Preserve ``chunked`` parameter on retries (Pull 1715, Pull 1734) * Allow unset ``SERVER_SOFTWARE`` in App Engine (Pull 1704, Issue 1470) * Fix issue where URL fragment was sent within the request target. (Pull 1732) * Fix issue where an empty query section in a URL would fail to parse. (Pull 1732) * Remove TLS 1.3 support in SecureTransport due to Apple removing support (Pull 1703) ``` ### 1.25.6 ``` ------------------- * Fix issue where tilde (``~``) characters were incorrectly percent-encoded in the path. (Pull 1692) ``` ### 1.25.5 ``` ------------------- * Add mitigation for BPO-37428 affecting Python <3.7.4 and OpenSSL 1.1.1+ which caused certificate verification to be enabled when using ``cert_reqs=CERT_NONE``. (Issue 1682) ``` ### 1.25.4 ``` ------------------- * Propagate Retry-After header settings to subsequent retries. (Pull 1607) * Fix edge case where Retry-After header was still respected even when explicitly opted out of. (Pull 1607) * Remove dependency on ``rfc3986`` for URL parsing. * Fix issue where URLs containing invalid characters within ``Url.auth`` would raise an exception instead of percent-encoding those characters. * Add support for ``HTTPResponse.auto_close = False`` which makes HTTP responses work well with BufferedReaders and other ``io`` module features. (Pull 1652) * Percent-encode invalid characters in URL for ``HTTPConnectionPool.request()`` (Pull 1673) ``` ### 1.25.3 ``` ------------------- * Change ``HTTPSConnection`` to load system CA certificates when ``ca_certs``, ``ca_cert_dir``, and ``ssl_context`` are unspecified. (Pull 1608, Issue 1603) * Upgrade bundled rfc3986 to v1.3.2. (Pull 1609, Issue 1605) ``` ### 1.25.2 ``` ------------------- * Change ``is_ipaddress`` to not detect IPvFuture addresses. (Pull 1583) * Change ``parse_url`` to percent-encode invalid characters within the path, query, and target components. (Pull 1586) ``` ### 1.25.1 ``` ------------------- * Add support for Google's ``Brotli`` package. (Pull 1572, Pull 1579) * Upgrade bundled rfc3986 to v1.3.1 (Pull 1578) ``` ### 1.25 ``` ----------------- * Require and validate certificates by default when using HTTPS (Pull 1507) * Upgraded ``urllib3.utils.parse_url()`` to be RFC 3986 compliant. (Pull 1487) * Added support for ``key_password`` for ``HTTPSConnectionPool`` to use encrypted ``key_file`` without creating your own ``SSLContext`` object. (Pull 1489) * Add TLSv1.3 support to CPython, pyOpenSSL, and SecureTransport ``SSLContext`` implementations. (Pull 1496) * Switched the default multipart header encoder from RFC 2231 to HTML 5 working draft. (Issue 303, Pull 1492) * Fixed issue where OpenSSL would block if an encrypted client private key was given and no password was given. Instead an ``SSLError`` is raised. (Pull 1489) * Added support for Brotli content encoding. It is enabled automatically if ``brotlipy`` package is installed which can be requested with ``urllib3[brotli]`` extra. (Pull 1532) * Drop ciphers using DSS key exchange from default TLS cipher suites. Improve default ciphers when using SecureTransport. (Pull 1496) * Implemented a more efficient ``HTTPResponse.__iter__()`` method. (Issue 1483) ``` ### 1.24.3 ``` ------------------- * Apply fix for CVE-2019-9740. (Pull 1591) ``` ### 1.24.2 ``` ------------------- * Don't load system certificates by default when any other ``ca_certs``, ``ca_certs_dir`` or ``ssl_context`` parameters are specified. * Remove Authorization header regardless of case when redirecting to cross-site. (Issue 1510) * Add support for IPv6 addresses in subjectAltName section of certificates. (Issue 1269) ``` ### 1.24.1 ``` ------------------- * Remove quadratic behavior within ``GzipDecoder.decompress()`` (Issue 1467) * Restored functionality of ``ciphers`` parameter for ``create_urllib3_context()``. (Issue 1462) ``` ### 1.24 ``` ----------------- * Allow key_server_hostname to be specified when initializing a PoolManager to allow custom SNI to be overridden. (Pull 1449) * Test against Python 3.7 on AppVeyor. (Pull 1453) * Early-out ipv6 checks when running on App Engine. (Pull 1450) * Change ambiguous description of backoff_factor (Pull 1436) * Add ability to handle multiple Content-Encodings (Issue 1441 and Pull 1442) * Skip DNS names that can't be idna-decoded when using pyOpenSSL (Issue 1405). * Add a server_hostname parameter to HTTPSConnection which allows for overriding the SNI hostname sent in the handshake. (Pull 1397) * Drop support for EOL Python 2.6 (Pull 1429 and Pull 1430) * Fixed bug where responses with header Content-Type: message/* erroneously raised HeaderParsingError, resulting in a warning being logged. (Pull 1439) * Move urllib3 to src/urllib3 (Pull 1409) ``` ### 1.23 ``` ----------------- * Allow providing a list of headers to strip from requests when redirecting to a different host. Defaults to the ``Authorization`` header. Different headers can be set via ``Retry.remove_headers_on_redirect``. (Issue 1316) * Fix ``util.selectors._fileobj_to_fd`` to accept ``long`` (Issue 1247). * Dropped Python 3.3 support. (Pull 1242) * Put the connection back in the pool when calling stream() or read_chunked() on a chunked HEAD response. (Issue 1234) * Fixed pyOpenSSL-specific ssl client authentication issue when clients attempted to auth via certificate + chain (Issue 1060) * Add the port to the connectionpool connect print (Pull 1251) * Don't use the ``uuid`` module to create multipart data boundaries. (Pull 1380) * ``read_chunked()`` on a closed response returns no chunks. (Issue 1088) * Add Python 2.6 support to ``contrib.securetransport`` (Pull 1359) * Added support for auth info in url for SOCKS proxy (Pull 1363) ```Links
- PyPI: https://pypi.org/project/urllib3 - Changelog: https://pyup.io/changelogs/urllib3/ - Docs: https://urllib3.readthedocs.io/Update validators from 0.12.2 to 0.18.2.
Changelog
### 0.18.2 ``` ^^^^^^^^^^^^^^^^^^^ - Implement actual validation for old style BTC addresses including checksumming (182, pull request courtesy of tpatja) - Use a regex to guesstimate validity of new segwit BTC addresses (182, pull request courtesy of tpatja) ``` ### 0.18.1 ``` ^^^^^^^^^^^^^^^^^^^ - Made uuid validator accept UUID objects (174, pull request courtesy of Letsch22) ``` ### 0.18.0 ``` ^^^^^^^^^^^^^^^^^^^ - Added bitcoin address validator (166, pull request courtesy of daveusa31) ``` ### 0.17.1 ``` ^^^^^^^^^^^^^^^^^^^ - Fixed python_requires using twine ``` ### 0.17.0 ``` ^^^^^^^^^^^^^^^^^^^ - Added python_requires='>=3.4' to setup.py (163, pull request courtesy of vphilippon) - Fixed URL validator ip_last_octet regex (145, pull request courtesy of ghost) ``` ### 0.16.0 ``` ^^^^^^^^^^^^^^^^^^^ - Added support for emojis and more IDNA URLs (161, pull request courtesy of automationator) ``` ### 0.15.0 ``` ^^^^^^^^^^^^^^^^^^^ - Added bank card validators (157, pull request courtesy of TimonPeng) ``` ### 0.14.3 ``` ^^^^^^^^^^^^^^^^^^^ - Handle None values gracefully in domain validator (144, pull request courtesy reahaas) - Local part of the email address should be less or equal than 64 bytes (147, pull request courtesy mondeja) - Removed py27 support - Removed pypy2 support ``` ### 0.14.2 ``` ^^^^^^^^^^^^^^^^^^^ - Made domain validation case-insensitive (136, pull request courtesy ehmkah) ``` ### 0.14.1 ``` ^^^^^^^^^^^^^^^^^^^ - Updated domain validator regex to not allow numeric only TLDs (133, pull request courtesy jmeridth) - Allow for idna encoded domains (133, pull request courtesy jmeridth) ``` ### 0.14.0 ``` ^^^^^^^^^^^^^^^^^^^ - Added new validators ``ipv4_cidr``, ``ipv6_cidr`` (117, pull request courtesy woodruffw) ``` ### 0.13.0 ``` ^^^^^^^^^^^^^^^^^^^ - Added new validator: ``es_doi``, ``es_nif``, ``es_cif``, ``es_nie`` (121, pull request courtesy kingbuzzman) ``` ### 0.12.6 ``` ^^^^^^^^^^^^^^^^^^^ - Fixed domain validator for single character domains (118, pull request courtesy kingbuzzman) ``` ### 0.12.5 ``` ^^^^^^^^^^^^^^^^^^^ - Fixed py37 support (113, pull request courtesy agiletechnologist) ``` ### 0.12.4 ``` ^^^^^^^^^^^^^^^^^^^ - Use inspect.getfullargspec() in py3 (110, pull request courtesy riconnon) ``` ### 0.12.3 ``` ^^^^^^^^^^^^^^^^^^^ - Added `allow_temporal_ssn` parameter to fi_ssn validator (97, pull request courtesy quantus) - Remove py33 support ```Links
- PyPI: https://pypi.org/project/validators - Changelog: https://pyup.io/changelogs/validators/ - Repo: https://github.com/kvesteri/validatorsUpdate astroid from 1.6.4 to 2.4.2.
Changelog
### 2.4.2 ``` ============================ Release Date: TBA * `FunctionDef.is_generator` properly handles `yield` nodes in `While` tests Close PyCQA/pylint3519 * Properly construct the arguments of infered property descriptors Close PyCQA/pylint3648 ``` ### 2.4.1 ``` ============================ Release Date: 2020-05-05 * Handle the case where the raw builder fails to retrieve the ``__all__`` attribute Close 772 * Restructure the AST parsing heuristic to always pick the same module Close PyCQA/pylint3540 Close 773 * Changed setup.py to work with [distlib](https://pypi.org/project/distlib) Close 779 * Do not crash with SyntaxError when parsing namedtuples with invalid label Close PyCQA/pylint3549 * Protect against ``infer_call_result`` failing with `InferenceError` in `Super.getattr()` Close PyCQA/pylint3529 ``` ### 2.4.0 ``` ============================ Release Date: 2020-04-27 * Expose a ast_from_string method in AstroidManager, which will accept source code as a string and return the corresponding astroid object Closes PyCQA/astroid725 * ``BoundMethod.implicit_parameters`` returns a proper value for ``__new__`` Close PyCQA/pylint2335 * Allow slots added dynamically to a class to still be inferred Close PyCQA/pylint2334 * Allow `FunctionDef.getattr` to look into both instance attrs and special attributes Close PyCQA/pylint1078 * Infer qualified ``classmethod`` as a classmethod. Close PyCQA/pylint3417 * Prevent a recursion error to happen when inferring the declared metaclass of a class Close 749 * Raise ``AttributeInferenceError`` when ``getattr()`` receives an empty name Close PyCQA/pylint2991 * Prevent a recursion error for self reference variables and `type()` calls. Close 199 * Do not infer the first argument of a staticmethod in a metaclass as the class itself Close PyCQA/pylint3032 * ``NodeNG.bool_value()`` gained an optional ``context`` parameter We need to pass an inference context downstream when inferring the boolean value of a node in order to prevent recursion errors and double inference. This fix prevents a recursion error with dask library. Close PyCQA/pylint2985 * Pass a context argument to ``astroid.Arguments`` to prevent recursion errors Close PyCQA/pylint3414 * Better inference of class and static methods decorated with custom methods Close PyCQA/pylint3209 * Reverse the order of decorators for `infer_subscript` `path_wrapper` needs to come first, followed by `raise_if_nothing_inferred`, otherwise we won't handle `StopIteration` correctly. Close 762 * Prevent a recursion error when inferring self-referential variables without definition Close PyCQA/pylint1285 * Numpy `datetime64.astype` return value is inferred as a `ndarray`. Close PyCQA/pylint3332 * Skip non ``Assign`` and ``AnnAssign`` nodes from enum reinterpretation Closes PyCQA/pylint3365 * Numpy ``ndarray`` attributes ``imag`` and ``real`` are now inferred as ``ndarray``. Close PyCQA/pylint3322 * Added a call to ``register_transform`` for all functions of the ``brain_numpy_core_multiarray`` module in case the current node is an instance of ``astroid.Name`` Close 666 * Use the parent of the node when inferring aug assign nodes instead of the statement Close PyCQA/pylint2911 Close PyCQA/pylint3214 * Added some functions to the ``brain_numpy_core_umath`` module Close PyCQA/pylint3319 * Added some functions of the ``numpy.core.multiarray`` module Close PyCQA/pylint3208 * All the ``numpy ufunc`` functions derived now from a common class that implements the specific ``reduce``, ``accumulate``, ``reduceat``, ``outer`` and ``at`` methods. Close PyCQA/pylint2885 * ``nodes.Const.itered`` returns a list of ``Const`` nodes, not strings Close PyCQA/pylint3306 * The ``shape`` attribute of a ``numpy ndarray`` is now a ``ndarray`` Close PyCQA/pylint3139 * Don't ignore special methods when inspecting gi classes Close 728 * Added transform for ``scipy.gaussian`` * Add suport for inferring properties. * Added a brain for ``responses`` * Allow inferring positional only arguments. * Retry parsing a module that has invalid type comments It is possible for a module to use comments that might be interpreted as type comments by the `ast` library. We do not want to completely crash on those invalid type comments. Close 708 * Scope the inference to the current bound node when inferring instances of classes When inferring instances of classes from arguments, such as ``self`` in a bound method, we could use as a hint the context's ``boundnode``, which indicates the instance from which the inference originated. As an example, a subclass that uses a parent's method which returns ``self``, will override the ``self`` to point to it instead of pointing to the parent class. Close PyCQA/pylint3157 * Add support for inferring exception instances in all contexts We were able to infer exception instances as ``ExceptionInstance`` only for a handful of cases, but not all. ``ExceptionInstance`` has support for better inference of `.args` and other exception related attributes that normal instances do not have. This additional support should remove certain false positives related to ``.args`` and other exception attributes in ``pylint``. Close PyCQA/pylint2333 * Add more supported parameters to ``subprocess.check_output`` Close 722 * Infer args unpacking of ``self`` Certain stdlib modules use ``*args`` to encapsulate the ``self`` parameter, which results in uninferable instances given we rely on the presence of the ``self`` argument to figure out the instance where we should be setting attributes. Close PyCQA/pylint3216 * Clean up setup.py Make pytest-runner a requirement only if running tests, similar to what was done with McCabe. Clean up the setup.py file, resolving a handful of minor warnings with it. * Handle StopIteration error in infer_int. Close PyCQA/pylint3274 * Can access per argument type comments for positional only and keyword only arguments. The comments are accessed through through the new ``Arguments.type_comment_posonlyargs`` and ``Arguments.type_comment_kwonlyargs`` attributes respectively. * Relax upper bound on `wrapt` Close 755 * Properly analyze CFFI compiled extensions. ``` ### 2.3.2 ``` ============================ Release Date: TBA * All type comments have as parent the corresponding `astroid` node Until now they had as parent the builtin `ast` node which meant we were operating with primitive objects instead of our own. Close PyCQA/pylint3174 * Pass an inference context to `metaclass()` when inferring an object type This should prevent a bunch of recursion errors happening in pylint. Also refactor the inference of `IfExp` nodes to use separate contexts for each potential branch. Close PyCQA/pylint3152 Close PyCQA/pylint3159 ``` ### 2.3.1 ``` ============================ Release Date: 2019-09-30 * A transform for the builtin `dataclasses` module was added. This should address various `dataclasses` issues that were surfaced even more after the release of pylint 2.4.0. In the previous versions of `astroid`, annotated assign nodes were allowed to be retrieved via `getattr()` but that no longer happens with the latest `astroid` release, as those attribute are not actual attributes, but rather virtual ones, thus an operation such as `getattr()` does not make sense for them. * Update attr brain to partly understand annotated attributes Close 656 ``` ### 2.3.0 ``` ============================ Release Date: 2019-09-24 * Add a brain tip for ``subprocess.check_output`` Close 689 * Remove NodeNG.nearest method because of lack of usage in astroid and pylint. Close 691 * Allow importing wheel files. Close 541 * Annotated AST follows PEP8 coding style when converted to string. * Fix a bug where defining a class using type() could cause a DuplicateBasesError. Close 644 * Dropped support for Python 3.4. * Numpy brain support is improved. Numpy's fundamental type ``numpy.ndarray`` has its own brain : ``brain_numpy_ndarray`` and each numpy module that necessitates brain action has now its own numpy brain : - ``numpy.core.numeric`` - ``numpy.core.function_base`` - ``numpy.core.multiarray`` - ``numpy.core.numeric`` - ``numpy.core.numerictypes`` - ``numpy.core.umath`` - ``numpy.random.mtrand`` Close PyCQA/pylint2865 Close PyCQA/pylint2747 Close PyCQA/pylint2721 Close PyCQA/pylint2326 Close PyCQA/pylint2021 * ``assert`` only functions are properly inferred as returning ``None`` Close 668 * Add support for Python 3.8's `NamedExpr` nodes, which is part of assignment expressions. Close 674 * Added support for inferring `IfExp` nodes. * Instances of exceptions are inferred as such when inferring in non-exception context This allows special inference support for exception attributes such as `.args`. Close PyCQA/pylint2333 * Drop a superfluous and wrong callcontext when inferring the result of a context manager Close PyCQA/pylint2859 * ``igetattr`` raises ``InferenceError`` on re-inference of the same object This prevents ``StopIteration`` from leaking when we encounter the same object in the current context, which could result in various ``RuntimeErrors`` leaking in other parts of the inference. Until we get a global context per inference, the solution is sort of a hack, as with the suggested global context improvement, we could theoretically reuse the same inference object. Close 663 * Variable annotations can no longer be retrieved with `ClassDef.getattr` Unless they have an attached value, class variable annotations can no longer be retrieved with `ClassDef.getattr.` * Improved builtin inference for ``tuple``, ``set``, ``frozenset``, ``list`` and ``dict`` We were properly inferring these callables *only* if they had consts as values, but that is not the case most of the time. Instead we try to infer the values that their arguments can be and use them instead of assuming Const nodes all the time. Close PyCQA/pylint2841 * The last except handler wins when inferring variables bound in an except handler. Close PyCQA/pylint2777 * ``threading.Lock.locked()`` is properly recognized as a member of ``threading.Lock`` Close PyCQA/pylint2791 * Fix recursion error involving ``len`` and self referential attributes Close PyCQA/pylint2736 Close PyCQA/pylint2734 Close PyCQA/pylint2740 * Can access per argument type comments through new ``Arguments.type_comment_args`` attribute. Close 665 * Fix being unable to access class attributes on a NamedTuple. Close PyCQA/pylint1628 * Fixed being unable to find distutils submodules by name when in a virtualenv. Close PyCQA/pylint73 ``` ### 2.2.0 ``` ============================ Release Date: 2019-02-27 * Fix a bug concerning inference of calls to numpy function that should not return Tuple or List instances. Close PyCQA/pylint2436 * Fix a bug where a method, which is a lambda built from a function, is not inferred as ``BoundMethod`` Close PyCQA/pylint2594 * ``typed_ast`` gets installed for Python 3.7, meaning type comments can now work on 3.7. * Fix a bug concerning inference of unary operators on numpy types. Close PyCQA/pylint2436 (first part) * Fix a crash with ``typing.NamedTuple`` and empty fields. Close PyCQA/pylint2745 * Add a proper ``strerror`` inference to the ``OSError`` exceptions. Close PyCQA/pylint2553 * Support non-const nodes as values of Enum attributes. Close 612 * Fix a crash in the ``enum`` brain tip caused by non-assign members in class definitions. Close PyCQA/pylint2719 * ``brain_numpy`` returns an undefined type for ``numpy`` methods to avoid ``assignment-from-no-return`` Close PyCQA/pylint2694 * Fix a bug where a call to a function that has been previously called via functools.partial was wrongly inferred Close PyCQA/pylint2588 * Fix a recursion error caused by inferring the ``slice`` builtin. Close PyCQA/pylint2667 * Remove the restriction that "old style classes" cannot have a MRO. This does not make sense any longer given that we run against Python 3 code. Close PyCQA/pylint2701 * Added more builtin exceptions attributes. Close 580 * Add a registry for builtin exception models. Close PyCQA/pylint1432 * Add brain tips for `http.client`. Close PyCQA/pylint2687 * Prevent crashing when processing ``enums`` with mixed single and double quotes. Close PyCQA/pylint2676 * ``typing`` types have the `__args__` property. Close PyCQA/pylint2419 * Fix a bug where an Attribute used as a base class was triggering a crash Close 626 * Added special support for `enum.IntFlag` Close PyCQA/pylint2534 * Extend detection of data classes defined with attr Close 628 * Fix typo in description for brain_attrs ``` ### 2.1.0 ``` ============================ Release Date: 2018-11-25 * ``threading.Lock.acquire`` has the ``timeout`` parameter now. Close PyCQA/pylint2457 * Pass parameters by keyword name when inferring sequences. Close PyCQA/pylint2526 * Correct line numbering for f-strings for complex embedded expressions When a f-string contained a complex expression, such as an attribute access, we weren't cloning all the subtree of the f-string expression for attaching the correct line number. This problem is coming from the builtin AST parser which gives for the f-string and for its underlying elements the line number 1, but this is causing all sorts of bugs and problems in pylint, which expects correct line numbering. Close PyCQA/pylint2449 * Add support for `argparse.Namespace` Close PyCQA/pylint2413 * `async` functions are now inferred as `AsyncGenerator` when inferring their call result. * Filter out ``Uninferable`` when inferring the call result result of a class with an uninferable ``__call__`` method. Close PyCQA/pylint2434 * Make compatible with AST changes in Python 3.8. * Subscript inference (e.g. "`a[i]`") now pays attention to multiple inferred values for value (e.g. "`a`") and slice (e.g. "`i`") Close 614 ``` ### 2.0.4 ``` ============================ Release Date: 2018-08-10 * Make sure that assign nodes can find ``yield`` statements in their values Close PyCQA/pylint2400 ``` ### 2.0.3 ``` ============================ Release Date: 2018-08-08 * The environment markers for PyPy were invalid. ``` ### 2.0.2 ``` ============================ Release Date: 2018-08-01 * Stop repeat inference attempt causing a RuntimeError in Python3.7 Close PyCQA/pylint2317 * infer_call_result can raise InferenceError so make sure to handle that for the call sites where it is used infer_call_result started recently to raise InferenceError for objects for which it could not find any returns. Previously it was silently raising a StopIteration, which was especially leaking when calling builtin methods. Since it is after all an inference method, it is expected that it could raise an InferenceError rather than returning nothing. Close PyCQA/pylint2350 ``` ### 2.0.1 ``` ============================ Release Date: 2018-07-19 * Released to clear an old wheel package on PyPI ``` ### 2.0 ``` ========================== Release Date: 2018-07-15 * String representation of nodes takes in account precedence and associativity rules of operators. * Fix loading files with `modutils.load_from_module` when the path that contains it in `sys.path` is a symlink and the file is contained in a symlinked folder. Close 583 * Reworking of the numpy brain dealing with numerictypes (use of inspect module to determine the class hierarchy of numpy.core.numerictypes module) Close PyCQA/pylint2140 * Added inference support for starred nodes in for loops Close 146 * Support unpacking for dicts in assignments Close 268 * Add support for inferring functools.partial Close 125 * Inference support for `dict.fromkeys` Close 110 * `int()` builtin is inferred as returning integers. Close 150 * `str()` builtin is inferred as returning strings. Close 148 * DescriptorBoundMethod has the correct number of arguments defined. * Improvement of the numpy numeric types definition. Close PyCQA/pylint1971 * Subclasses of *property* are now interpreted as properties Close PyCQA/pylint1601 * AsStringRegexpPredicate has been removed. Use transform predicates instead of it. * Switched to using typed_ast for getting access to type comments As a side effect of this change, some nodes gained a new `type_annotation` attribute, which, if the type comments were correctly parsed, should contain a node object with the corresponding objects from the type comment. * typing.X[...] and typing.NewType are inferred as classes instead of instances. * Module.__path__ is now a list It used to be a string containing the path, but it doesn't reflect the situation on Python, where it is actually a list. * Fix a bug with namespace package's __path__ attribute. Close 528 * Added brain tips for random.sample Part of PyCQA/pylint811 * Add brain tip for `issubclass` builtin Close 101. * Fix submodule imports from six Close PyCQA/pylint1640 * Fix missing __module__ and __qualname__ from class definition locals Close PYCQA/pylint1753 * Fix a crash when __annotations__ access a parent's __init__ that does not have arguments Close 473 * Fix multiple objects sharing the same InferenceContext.path causing uninferable results Close 483 * Fix improper modification of col_offset, lineno upon inference of builtin functions Close PyCQA/pylint1839 * Subprocess.Popen brain now knows of the args member Close PyCQA/pylint1860 * add move_to_end method to collections.OrderedDict brain Close PyCQA/pylint1872 * Include new hashlib classes added in python 3.6 * Fix RecursionError for augmented assign Close 437, 447, 313, PyCQA/pylint1642, PyCQA/pylint1805, PyCQA/pylint1854, PyCQA/pylint1452 * Add missing attrs special attribute Close PyCQA/pylint1884 * Inference now understands the 'isinstance' builtin Close 98 * Stop duplicate nodes with the same key values from appearing in dictionaries from dictionary unpacking. Close PyCQA/pylint1843 * Fix ``contextlib.contextmanager`` inference for nested context managers Close 1699 * Implement inference for len builtin Close 112 * Add qname method to Super object preventing potential errors in upstream pylint Close 533 * Stop astroid from getting stuck in an infinite loop if a function shares its name with its decorator Close 375 * Fix issue with inherited __call__ improperly inferencing self Close PyCQA/pylint2199 * Fix __call__ precedence for classes with custom metaclasses Close PyCQA/pylint2159 * Limit the maximum amount of interable result in an NodeNG.infer() call to 100 by default for performance issues with variables with large amounts of possible values. The max inferable value can be tuned by setting the `max_inferable_values` flag on astroid.MANAGER. ```Links
- PyPI: https://pypi.org/project/astroid - Changelog: https://pyup.io/changelogs/astroid/ - Repo: https://github.com/PyCQA/astroidUpdate attrs from 18.1.0 to 20.3.0.
Changelog
### 20.3.0 ``` ------------------- Backward-incompatible Changes ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - ``attr.define()``, ``attr.frozen()``, ``attr.mutable()``, and ``attr.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/1e3844d0c99e479e716169034b5fa963file-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 all ``Attribute``\ s and returns a (modified or updated) list of ``Attribute`` 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()`` and ``attr.astuple()`` now treat ``frozenset``\ s like ``set``\ s with regards to the *retain_collection_types* argument. `704 <https://github.com/python-attrs/attrs/issues/704>`_ - The type stubs for ``attr.s()`` and ``attr.make_class()`` are not missing the *collect_by_mro* argument anymore. `711 <https://github.com/python-attrs/attrs/issues/711>`_ ---- ``` ### 20.2.0 ``` ------------------- Backward-incompatible Changes ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - ``attr.define()``, ``attr.frozen()``, ``attr.mutable()``, and ``attr.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/1e3844d0c99e479e716169034b5fa963file-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 correct 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 the ``attr.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 of ``attr.Attribute``. `684 <https://github.com/python-attrs/attrs/issues/684>`_ - ``zope.interface`` is now a "soft dependency" when running the test suite; if ``zope.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 set ``on_setattr=None`` anymore. `687 <https://github.com/python-attrs/attrs/issues/687>`_ ---- ``` ### 20.1.0 ``` ------------------- Backward-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 an ``attrs`` namespace. 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 <https://www.attrs.org/en/stable/api.htmlprovisional-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 to ``True`` 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 an ``inherited`` 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: 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 <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 infer ``init=False``, ``repr=False``, ``eq=False``, ``order=False``, and ``hash=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 and ``attrs`` 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 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 <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 module ``attr.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()``, and ``attr.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 supplants ``attr.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>`_ ---- ``` ### 19.3.0 ``` ------------------- Changes ^^^^^^^ - Fixed ``auto_attribs`` usage when default values cannot be compared directly with ``==``, such as ``numpy`` arrays. `585 <https://github.com/python-attrs/attrs/issues/585>`_ ---- ``` ### 19.2.0 ``` ------------------- Backward-incompatible Changes ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Removed deprecated ``Attribute`` attribute ``convert`` 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 to ``attr.s()`` and ``attr.ib()`` is now deprecated. 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 <https://docs.python.org/3/library/dataclasses.html>`_. 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 <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, so ``super()`` works even on environments where ``ctypes`` is not installed. `522 <https://github.com/python-attrs/attrs/issues/522>`_ - When collecting attributes using ``attr.s(auto_attribs=True)``, attributes with a default of ``None`` 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()`` and ``attr.validators.deep_mapping()`` type stubs. `533 <https://github.com/python-attrs/attrs/issues/533>`_ - ``attr.validators.is_callable()`` validator now raises an exception ``attr.exceptions.NotCallableError``, a subclass of ``TypeError``, 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 the ``attrs``'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 of ``attrs`` and write forward- and backward-compatible code. Please check out the `section on deprecated APIs <http://www.attrs.org/en/stable/api.htmldeprecated-apis>`_ on how to use it. `580 <https://github.com/python-attrs/attrs/issues/580>`_ .. _`425`: https://github.com/python-attrs/attrs/issues/425 ---- ``` ### 19.1.0 ``` ------------------- Backward-incompatible Changes ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - Fixed a bug where deserialized objects with ``cache_hash=True`` could have incorrect hash code values. 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 <https://github.com/python-attrs/attrs/issues/494>`_. `482 <https://github.com/python-attrs/attrs/issues/482>`_ Changes ^^^^^^^ - Add ``is_callable``, ``deep_iterable``, and ``deep_mapping`` validators. * ``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`_ - Fixed stub files to prevent errors raised by mypy's ``disallow_any_generics = True`` option. `443 <https://github.com/python-attrs/attrs/issues/443>`_ - Attributes with ``init=False`` now can follow after ``kw_only=True`` attributes. `450 <https://github.com/python-attrs/attrs/issues/450>`_ - ``attrs`` now has first class support for defining exception classes. 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 <https://github.com/python-attrs/attrs/issues/500>`_ - Clarified documentation for hashing to warn that hashable objects should be deeply immutable (in their usage, even if this is not enforced). `503 <https://github.com/python-attrs/attrs/issues/503>`_ ---- ``` ### 18.2.0 ``` ------------------- Deprecations ^^^^^^^^^^^^ - Comparing subclasses using ``<``, ``>``, ``<=``, and ``>=`` is now deprecated. 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 <https://github.com/python-attrs/attrs/issues/394>`_ Changes ^^^^^^^ - ``attrs`` now ships its own `PEP 484 <https://www.python.org/dev/peps/pep-0484/>`_ type hints. Together with `mypy <http://mypy-lang.org>`_'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 <https://www.attrs.org/en/stable/types.html>`_ about type annotations in ``attrs``. `238 <https://github.com/python-attrs/attrs/issues/238>`_ - Added *kw_only* arguments to ``attr.ib`` and ``attr.s``, and a corresponding *kw_only* attribute to ``attr.Attribute``. This change makes it possible to have a generated ``__init__`` with keyword-only arguments