Scheduled monthly dependency update for February #57

pyup-bot · 2023-02-01T18:34:16Z

Update pip from 22.0.2 to 23.0.

Changelog

22.3.1

===================

Bug Fixes
---------

- Fix entry point generation of ``pip.X``, ``pipX.Y``, and ``easy_install-X.Y``
to correctly account for multi-digit Python version segments (e.g. the &quot;11&quot;
part of 3.11). (`11547 &lt;https://github.com/pypa/pip/issues/11547&gt;`_)

22.3

=================

Deprecations and Removals
-------------------------

- Deprecate ``--install-options`` which forces pip to use the deprecated ``install``
command of ``setuptools``. (`11358 &lt;https://github.com/pypa/pip/issues/11358&gt;`_)
- Deprecate installation with &#x27;setup.py install&#x27; when no-binary is enabled for
source distributions without &#x27;pyproject.toml&#x27;. (`11452 &lt;https://github.com/pypa/pip/issues/11452&gt;`_)
- Deprecate --no-binary`` disabling the wheel cache. (`11454 &lt;https://github.com/pypa/pip/issues/11454&gt;`_)
- Remove ``--use-feature=2020-resolver`` opt-in flag. This was supposed to be removed in 21.0, but missed during that release cycle. (`11493 &lt;https://github.com/pypa/pip/issues/11493&gt;`_)
- Deprecate installation with &#x27;setup.py install&#x27; when the &#x27;wheel&#x27; package is absent for
source distributions without &#x27;pyproject.toml&#x27;. (`8559 &lt;https://github.com/pypa/pip/issues/8559&gt;`_)
- Remove the ability to use ``pip list --outdated`` in combination with ``--format=freeze``. (`9789 &lt;https://github.com/pypa/pip/issues/9789&gt;`_)

Features
--------

- Use ``shell=True`` for opening the editor with ``pip config edit``. (`10716 &lt;https://github.com/pypa/pip/issues/10716&gt;`_)
- Use the ``data-dist-info-metadata`` attribute from :pep:`658` to resolve distribution metadata without downloading the dist yet. (`11111 &lt;https://github.com/pypa/pip/issues/11111&gt;`_)
- Add an option to run the test suite with pip built as a zipapp. (`11250 &lt;https://github.com/pypa/pip/issues/11250&gt;`_)
- Add a ``--python`` option to allow pip to manage Python environments other
than the one pip is installed in. (`11320 &lt;https://github.com/pypa/pip/issues/11320&gt;`_)
- Document the new (experimental) zipapp distribution of pip. (`11459 &lt;https://github.com/pypa/pip/issues/11459&gt;`_)
- Use the much faster &#x27;bzr co --lightweight&#x27; to obtain a copy of a Bazaar tree. (`5444 &lt;https://github.com/pypa/pip/issues/5444&gt;`_)

Bug Fixes
---------

- Fix ``--no-index`` when ``--index-url`` or ``--extra-index-url`` is specified
inside a requirements file. (`11276 &lt;https://github.com/pypa/pip/issues/11276&gt;`_)
- Ensure that the candidate ``pip`` executable exists, when checking for a new version of pip. (`11309 &lt;https://github.com/pypa/pip/issues/11309&gt;`_)
- Ignore distributions with invalid ``Name`` in metadata instead of crashing, when
using the ``importlib.metadata`` backend. (`11352 &lt;https://github.com/pypa/pip/issues/11352&gt;`_)
- Raise RequirementsFileParseError when parsing malformed requirements options that can&#x27;t be sucessfully parsed by shlex. (`11491 &lt;https://github.com/pypa/pip/issues/11491&gt;`_)
- Fix build environment isolation on some system Pythons. (`6264 &lt;https://github.com/pypa/pip/issues/6264&gt;`_)

Vendored Libraries
------------------

- Upgrade certifi to 2022.9.24
- Upgrade distlib to 0.3.6
- Upgrade idna to 3.4
- Upgrade pep517 to 0.13.0
- Upgrade pygments to 2.13.0
- Upgrade tenacity to 8.1.0
- Upgrade typing_extensions to 4.4.0
- Upgrade urllib3 to 1.26.12

Improved Documentation
----------------------

- Mention that --quiet must be used when writing the installation report to stdout. (`11357 &lt;https://github.com/pypa/pip/issues/11357&gt;`_)

22.2.2

===================

Bug Fixes
---------

- Avoid  ``AttributeError`` when removing the setuptools-provided ``_distutils_hack`` and it is missing its implementation. (`11314 &lt;https://github.com/pypa/pip/issues/11314&gt;`_)
- Fix import error when reinstalling pip in user site. (`11319 &lt;https://github.com/pypa/pip/issues/11319&gt;`_)
- Show pip deprecation warnings by default. (`11330 &lt;https://github.com/pypa/pip/issues/11330&gt;`_)

22.2.1

===================

Bug Fixes
---------

- Send the pip upgrade prompt to stderr. (`11282 &lt;https://github.com/pypa/pip/issues/11282&gt;`_)
- Ensure that things work correctly in environments where setuptools-injected
``distutils`` is available by default. This is done by cooperating with
setuptools&#x27; injection logic to ensure that pip uses the ``distutils`` from the
Python standard library instead. (`11298 &lt;https://github.com/pypa/pip/issues/11298&gt;`_)
- Clarify that ``pip cache``&#x27;s wheels-related output is about locally built wheels only. (`11300 &lt;https://github.com/pypa/pip/issues/11300&gt;`_)

22.2

=================

Deprecations and Removals
-------------------------

- Remove the ``html5lib`` deprecated feature flag. (`10825 &lt;https://github.com/pypa/pip/issues/10825&gt;`_)
- Remove ``--use-deprecated=backtrack-on-build-failures``. (`11241 &lt;https://github.com/pypa/pip/issues/11241&gt;`_)

Features
--------

- Add support to use `truststore &lt;https://pypi.org/project/truststore/&gt;`_ as an
alternative SSL certificate verification backend. The backend can be enabled on Python
3.10 and later by installing ``truststore`` into the environment, and adding the
``--use-feature=truststore`` flag to various pip commands.

``truststore`` differs from the current default verification backend (provided by
``certifi``) in it uses the operating system’s trust store, which can be better
controlled and augmented to better support non-standard certificates. Depending on
feedback, pip may switch to this as the default certificate verification backend in
the future. (`11082 &lt;https://github.com/pypa/pip/issues/11082&gt;`_)
- Add ``--dry-run`` option to ``pip install``, to let it print what it would install but
not actually change anything in the target environment. (`11096 &lt;https://github.com/pypa/pip/issues/11096&gt;`_)
- Record in wheel cache entries the URL of the original artifact that was downloaded
to build the cached wheels. The record is named ``origin.json`` and uses the PEP 610
Direct URL format. (`11137 &lt;https://github.com/pypa/pip/issues/11137&gt;`_)
- Support `PEP 691 &lt;https://peps.python.org/pep-0691/&gt;`_. (`#11158 &lt;https://github.com/pypa/pip/issues/11158&gt;`_)
- pip&#x27;s deprecation warnings now subclass the built-in ``DeprecationWarning``, and
can be suppressed by running the Python interpreter with
``-W ignore::DeprecationWarning``. (`11225 &lt;https://github.com/pypa/pip/issues/11225&gt;`_)
- Add ``pip inspect`` command to obtain the list of installed distributions and other
information about the Python environment, in JSON format. (`11245 &lt;https://github.com/pypa/pip/issues/11245&gt;`_)
- Significantly speed up isolated environment creation, by using the same
sources for pip instead of creating a standalone installation for each
environment. (`11257 &lt;https://github.com/pypa/pip/issues/11257&gt;`_)
- Add an experimental ``--report`` option to the install command to generate a JSON report
of what was installed. In combination with ``--dry-run`` and ``--ignore-installed`` it
can be used to resolve the requirements. (`53 &lt;https://github.com/pypa/pip/issues/53&gt;`_)

Bug Fixes
---------

- Fix ``pip install --pre`` for packages with pre-release build dependencies defined
both in ``pyproject.toml``&#x27;s ``build-system.requires`` and ``setup.py``&#x27;s
``setup_requires``. (`10222 &lt;https://github.com/pypa/pip/issues/10222&gt;`_)
- When pip rewrites the shebang line in a script during wheel installation,
update the hash and size in the corresponding ``RECORD`` file entry. (`10744 &lt;https://github.com/pypa/pip/issues/10744&gt;`_)
- Do not consider a ``.dist-info`` directory found inside a wheel-like zip file
as metadata for an installed distribution. A package in a wheel is (by
definition) not installed, and is not guaranteed to work due to how a wheel is
structured. (`11217 &lt;https://github.com/pypa/pip/issues/11217&gt;`_)
- Use ``importlib.resources`` to read the ``vendor.txt`` file in ``pip debug``.
This makes the command safe for use from a zipapp. (`11248 &lt;https://github.com/pypa/pip/issues/11248&gt;`_)
- Make the ``--use-pep517`` option of the ``download`` command apply not just
to the requirements specified on the command line, but to their dependencies,
as well. (`9523 &lt;https://github.com/pypa/pip/issues/9523&gt;`_)

Process
-------

- Remove reliance on the stdlib cgi module, which is deprecated in Python 3.11.

Vendored Libraries
------------------

- Remove html5lib.
- Upgrade certifi to 2022.6.15
- Upgrade chardet to 5.0.0
- Upgrade colorama to 0.4.5
- Upgrade distlib to 0.3.5
- Upgrade msgpack to 1.0.4
- Upgrade pygments to 2.12.0
- Upgrade pyparsing to 3.0.9
- Upgrade requests to 2.28.1
- Upgrade rich to 12.5.1
- Upgrade typing_extensions to 4.3.0
- Upgrade urllib3 to 1.26.10

22.1.2

===================

Bug Fixes
---------

- Revert `10979 &lt;https://github.com/pypa/pip/issues/10979&gt;`_ since it introduced a regression in certain edge cases. (`#10979 &lt;https://github.com/pypa/pip/issues/10979&gt;`_)
- Fix an incorrect assertion in the logging logic, that prevented the upgrade prompt from being presented. (`11136 &lt;https://github.com/pypa/pip/issues/11136&gt;`_)

22.1.1

===================

Bug Fixes
---------

- Properly filter out optional dependencies (i.e. extras) when checking build environment distributions. (`11112 &lt;https://github.com/pypa/pip/issues/11112&gt;`_)
- Change the build environment dependency checking to be opt-in. (`11116 &lt;https://github.com/pypa/pip/issues/11116&gt;`_)
- Allow using a pre-release version to satisfy a build requirement. This helps
manually populated build environments to more accurately detect build-time
requirement conflicts. (`11123 &lt;https://github.com/pypa/pip/issues/11123&gt;`_)

22.1

=================

Process
-------

- Enable the ``importlib.metadata`` metadata implementation by default on
Python 3.11 (or later). The environment variable ``_PIP_USE_IMPORTLIB_METADATA``
can still be used to enable the implementation on 3.10 and earlier, or disable
it on 3.11 (by setting it to ``0`` or ``false``).

Bug Fixes
---------

- Revert `9243 &lt;https://github.com/pypa/pip/issues/9243&gt;`_ since it introduced a regression in certain edge cases. (`#10962 &lt;https://github.com/pypa/pip/issues/10962&gt;`_)
- Fix missing ``REQUESTED`` metadata when using URL constraints. (`11079 &lt;https://github.com/pypa/pip/issues/11079&gt;`_)
- ``pip config`` now normalizes names by converting underscores into dashes. (`9330 &lt;https://github.com/pypa/pip/issues/9330&gt;`_)

22.1b1

===================

Process
-------

- Start migration of distribution metadata implementation from ``pkg_resources``
to ``importlib.metadata``. The new implementation is currently not exposed in
any user-facing way, but included in the code base for easier development.

Deprecations and Removals
-------------------------

- Drop ``--use-deprecated=out-of-tree-build``, according to deprecation message. (`11001 &lt;https://github.com/pypa/pip/issues/11001&gt;`_)

Features
--------

- Add option to install and uninstall commands to opt-out from running-as-root warning. (`10556 &lt;https://github.com/pypa/pip/issues/10556&gt;`_)
- Include Project-URLs in ``pip show`` output. (`10799 &lt;https://github.com/pypa/pip/issues/10799&gt;`_)
- Improve error message when ``pip config edit`` is provided an editor that
doesn&#x27;t exist. (`10812 &lt;https://github.com/pypa/pip/issues/10812&gt;`_)
- Add a user interface for supplying config settings to build backends. (`11059 &lt;https://github.com/pypa/pip/issues/11059&gt;`_)
- Add support for Powershell autocompletion. (`9024 &lt;https://github.com/pypa/pip/issues/9024&gt;`_)
- Explains why specified version cannot be retrieved when *Requires-Python* is not satisfied. (`9615 &lt;https://github.com/pypa/pip/issues/9615&gt;`_)
- Validate build dependencies when using ``--no-build-isolation``. (`9794 &lt;https://github.com/pypa/pip/issues/9794&gt;`_)

Bug Fixes
---------

- Fix conditional checks to prevent ``pip.exe`` from trying to modify itself, on Windows. (`10560 &lt;https://github.com/pypa/pip/issues/10560&gt;`_)
- Fix uninstall editable from Windows junction link. (`10696 &lt;https://github.com/pypa/pip/issues/10696&gt;`_)
- Fallback to pyproject.toml-based builds if ``setup.py`` is present in a project, but ``setuptools`` cannot be imported. (`10717 &lt;https://github.com/pypa/pip/issues/10717&gt;`_)
- When checking for conflicts in the build environment, correctly skip requirements
containing markers that do not match the current environment. (`10883 &lt;https://github.com/pypa/pip/issues/10883&gt;`_)
- Disable brotli import in vendored urllib3 so brotli could be uninstalled/upgraded by pip. (`10950 &lt;https://github.com/pypa/pip/issues/10950&gt;`_)
- Prioritize URL credentials over netrc. (`10979 &lt;https://github.com/pypa/pip/issues/10979&gt;`_)
- Filter available distributions using hash declarations from constraints files. (`9243 &lt;https://github.com/pypa/pip/issues/9243&gt;`_)
- Fix an error when trying to uninstall packages installed as editable from a network drive. (`9452 &lt;https://github.com/pypa/pip/issues/9452&gt;`_)
- Fix pip install issues using a proxy due to an inconsistency in how Requests is currently handling variable precedence in session. (`9691 &lt;https://github.com/pypa/pip/issues/9691&gt;`_)

Vendored Libraries
------------------

- Upgrade CacheControl to 0.12.11
- Upgrade distro to 1.7.0
- Upgrade platformdirs to 2.5.2
- Remove ``progress`` from vendored dependencies.
- Upgrade ``pyparsing`` to 3.0.8 for startup performance improvements.
- Upgrade rich to 12.2.0
- Upgrade tomli to 2.0.1
- Upgrade typing_extensions to 4.2.0

Improved Documentation
----------------------

- Add more dedicated topic and reference pages to the documentation. (`10899 &lt;https://github.com/pypa/pip/issues/10899&gt;`_)
- Capitalise Y as the default for &quot;Proceed (y/n)?&quot; when uninstalling. (`10936 &lt;https://github.com/pypa/pip/issues/10936&gt;`_)
- Add ``scheme://`` requirement to ``--proxy`` option&#x27;s description (`10951 &lt;https://github.com/pypa/pip/issues/10951&gt;`_)
- The wheel command now references the build interface section instead of stating the legacy
setuptools behavior as the default. (`10972 &lt;https://github.com/pypa/pip/issues/10972&gt;`_)
- Improved usefulness of ``pip config --help`` output. (`11074 &lt;https://github.com/pypa/pip/issues/11074&gt;`_)

22.0.4

===================

Deprecations and Removals
-------------------------

- Drop the doctype check, that presented a warning for index pages that use non-compliant HTML 5. (`10903 &lt;https://github.com/pypa/pip/issues/10903&gt;`_)

Vendored Libraries
------------------

- Downgrade distlib to 0.3.3.

22.0.3

===================

Features
--------

- Print the exception via ``rich.traceback``, when running with ``--debug``. (`10791 &lt;https://github.com/pypa/pip/issues/10791&gt;`_)

Bug Fixes
---------

- Only calculate topological installation order, for packages that are going to be installed/upgraded.

This fixes an `AssertionError` that occurred when determining installation order, for a very specific combination of upgrading-already-installed-package + change of dependencies + fetching some packages from a package index. This combination was especially common in Read the Docs&#x27; builds. (`10851 &lt;https://github.com/pypa/pip/issues/10851&gt;`_)
- Use ``html.parser`` by default, instead of falling back to ``html5lib`` when ``--use-deprecated=html5lib`` is not passed. (`10869 &lt;https://github.com/pypa/pip/issues/10869&gt;`_)

Improved Documentation
----------------------

- Clarify that using per-requirement overrides disables the usage of wheels. (`9674 &lt;https://github.com/pypa/pip/issues/9674&gt;`_)

Links

PyPI: https://pypi.org/project/pip
Changelog: https://pyup.io/changelogs/pip/
Homepage: https://pip.pypa.io/

Update wheel from 0.37.1 to 0.38.4.

Changelog

0.38.4

- Fixed ``PKG-INFO`` conversion in ``bdist_wheel`` mangling UTF-8 header values in
``METADATA`` (PR by Anderson Bravalheri)

0.38.3

- Fixed install failure when used with ``--no-binary``, reported on Ubuntu 20.04, by
removing ``setup_requires`` from ``setup.cfg``

0.38.2

- Fixed regression introduced in v0.38.1 which broke parsing of wheel file names with
multiple platform tags

0.38.1

- Removed install dependency on setuptools
- The future-proof fix in 0.36.0 for converting PyPy&#x27;s SOABI into a abi tag was
faulty. Fixed so that future changes in the SOABI will not change the tag.

0.38.0

- Dropped support for Python &lt; 3.7
- Updated vendored ``packaging`` to 21.3
- Replaced all uses of ``distutils`` with ``setuptools``
- The handling of ``license_files`` (including glob patterns and default
values) is now delegated to ``setuptools&gt;=57.0.0`` (466).
The package dependencies were updated to reflect this change.
- Fixed potential DoS attack via the ``WHEEL_INFO_RE`` regular expression
- Fixed ``ValueError: ZIP does not support timestamps before 1980`` when using
``SOURCE_DATE_EPOCH=0`` or when on-disk timestamps are earlier than 1980-01-01. Such
timestamps are now changed to the minimum value before packaging.

Links

PyPI: https://pypi.org/project/wheel
Changelog: https://pyup.io/changelogs/wheel/
Repo: https://github.com/pypa/wheel

Update watchdog[watchmedo] from 2.1.6 to 2.2.1.

Changelog

2.2.1

~~~~~

2023-01-01 • `full history &lt;https://github.com/gorakhargosh/watchdog/compare/v2.2.0...v2.2.1&gt;`__

- Enable ``mypy`` to discover type hints as specified in PEP 561 (`933 &lt;https://github.com/gorakhargosh/watchdog/pull/933&gt;`__)
- [ci] Set the expected Python version when building release files
- [ci] Update actions versions in use
- [watchmedo] [regression] Fix usage of missing ``signal.SIGHUP`` attribute on non-Unix OSes (`935 &lt;https://github.com/gorakhargosh/watchdog/pull/935&gt;`__)
- Thanks to our beloved contributors: BoboTiG, simon04, piotrpdev

2.2.0

~~~~~

2022-12-05 • `full history &lt;https://github.com/gorakhargosh/watchdog/compare/v2.1.9...v2.2.0&gt;`__

- [build] Wheels are now available for Python 3.11 (`932 &lt;https://github.com/gorakhargosh/watchdog/pull/932&gt;`__)
- [documentation] HTML documentation builds are now tested for errors (`902 &lt;https://github.com/gorakhargosh/watchdog/pull/902&gt;`__)
- [documentation] Fix typos here, and there (`910 &lt;https://github.com/gorakhargosh/watchdog/pull/910&gt;`__)
- [fsevents2] The ``fsevents2`` observer is now deprecated (`909 &lt;https://github.com/gorakhargosh/watchdog/pull/909&gt;`__)
- [tests] The error message returned by musl libc for error code ``-1`` is now allowed (`923 &lt;https://github.com/gorakhargosh/watchdog/pull/923&gt;`__)
- [utils] Remove unnecessary code in ``dirsnapshot.py`` (`930 &lt;https://github.com/gorakhargosh/watchdog/pull/930&gt;`__)
- [watchmedo] Handle shutdown events from ``SIGHUP`` (`912 &lt;https://github.com/gorakhargosh/watchdog/pull/912&gt;`__)
- Thanks to our beloved contributors: kurtmckee, babymastodon, QuantumEnergyE, timgates42, BoboTiG

2.1.9

~~~~~

2022-06-10 • `full history &lt;https://github.com/gorakhargosh/watchdog/compare/v2.1.8...v2.1.9&gt;`__

- [fsevents] Fix flakey test to assert that there are no errors when stopping the emitter.
- [inotify] Suppress occasional ``OSError: [Errno 9] Bad file descriptor`` at shutdown. (`805 &lt;https://github.com/gorakhargosh/watchdog/issues/805&gt;`__)
- [watchmedo] Make ``auto-restart`` restart the sub-process if it terminates. (`896 &lt;https://github.com/gorakhargosh/watchdog/pull/896&gt;`__)
- [watchmedo] Avoid zombie sub-processes when running ``shell-command`` without ``--wait``. (`405 &lt;https://github.com/gorakhargosh/watchdog/issues/405&gt;`__)
- Thanks to our beloved contributors: samschott, taleinat, altendky, BoboTiG

2.1.8

~~~~~

2022-05-15 • `full history &lt;https://github.com/gorakhargosh/watchdog/compare/v2.1.7...v2.1.8&gt;`__

- Fix adding failed emitters on observer schedule. (`872 &lt;https://github.com/gorakhargosh/watchdog/issues/872&gt;`__)
- [inotify] Fix hang when unscheduling watch on a path in an unmounted filesystem. (`869 &lt;https://github.com/gorakhargosh/watchdog/pull/869&gt;`__)
- [watchmedo] Fix broken parsing of ``--kill-after`` argument for the ``auto-restart`` command. (`870 &lt;https://github.com/gorakhargosh/watchdog/issues/870&gt;`__)
- [watchmedo] Fix broken parsing of boolean arguments. (`887 &lt;https://github.com/gorakhargosh/watchdog/issues/887&gt;`__)
- [watchmedo] Fix broken parsing of commands from ``auto-restart``, and ``shell-command``. (`888 &lt;https://github.com/gorakhargosh/watchdog/issues/888&gt;`__)
- [watchmedo] Support setting verbosity level via ``-q/--quiet`` and ``-v/--verbose`` arguments. (`889 &lt;https://github.com/gorakhargosh/watchdog/pull/889&gt;`__)
- Thanks to our beloved contributors: taleinat, kianmeng, palfrey, IlayRosenberg, BoboTiG

2.1.7

~~~~~

2022-03-25 • `full history &lt;https://github.com/gorakhargosh/watchdog/compare/v2.1.6...v2.1.7&gt;`__

- Eliminate timeout in waiting on event queue. (`861 &lt;https://github.com/gorakhargosh/watchdog/pull/861&gt;`__)
- [inotify] Fix ``not`` equality implementation for ``InotifyEvent``. (`848 &lt;https://github.com/gorakhargosh/watchdog/pull/848&gt;`__)
- [watchmedo] Fix calling commands from within a Python script. (`879 &lt;https://github.com/gorakhargosh/watchdog/pull/879&gt;`__)
- [watchmedo] ``PyYAML`` is loaded only when strictly necessary. Simple usages of ``watchmedo`` are possible without the module being installed. (`847 &lt;https://github.com/gorakhargosh/watchdog/pull/847&gt;`__)
- Thanks to our beloved contributors: sattlerc, JanzenLiu, BoboTiG

Links

PyPI: https://pypi.org/project/watchdog
Changelog: https://pyup.io/changelogs/watchdog/
Repo: https://github.com/gorakhargosh/watchdog
Docs: https://pythonhosted.org/watchdog/

Update flake8 from 4.0.1 to 6.0.0.

The bot wasn't able to find a changelog for this release. Got an idea?

Links

PyPI: https://pypi.org/project/flake8
Repo: https://github.com/pycqa/flake8

Update pylint from 2.12.2 to 2.16.0.

The bot wasn't able to find a changelog for this release. Got an idea?

Links

PyPI: https://pypi.org/project/pylint
Changelog: https://pyup.io/changelogs/pylint/

Update tox from 3.24.5 to 4.4.4.

Changelog

3.28.0

--------------------

Features
^^^^^^^^

- Support provision of tox 4 with the ``min_version`` option - by :user:`hroncok`
`2661 &lt;https://github.com/tox-dev/tox/issues/2661&gt;`_

3.27.1

--------------------

Bugfixes
^^^^^^^^

- Replaced deprecated ``license_file`` key with ``license_files`` in ``setup.cfg`` -- by :user:`mgorny`.
`2521 &lt;https://github.com/tox-dev/tox/issues/2521&gt;`_
- Add env cleanup to envreport - fix PYTHONPATH leak into &quot;envreport&quot; -- by :user:`f3flight`.
`2528 &lt;https://github.com/tox-dev/tox/issues/2528&gt;`_

3.27.0

--------------------

Bugfixes
^^^^^^^^

- Dropped ``--build-option`` in isolated builds, an alternative fix for the ``SetuptoolsDeprecationWarning`` about using ``--global-option`` -- by :user:`adamchainz`
`2497 &lt;https://github.com/tox-dev/tox/issues/2497&gt;`_
- Remove read-only files in ``ensure_empty_dir``.
`2498 &lt;https://github.com/tox-dev/tox/issues/2498&gt;`_
- Multiple tox instances no longer clobber the ``.tox`` directory when
``provision_tox_env`` is used. - by :user:`masenf`
`2515 &lt;https://github.com/tox-dev/tox/issues/2515&gt;`_


Documentation
^^^^^^^^^^^^^

- Clarify that ``install_command`` only takes one command - by :user:`jugmac00`
`2433 &lt;https://github.com/tox-dev/tox/issues/2433&gt;`_
- Documented problems with plugin and provision env - by :user:`ziima`.
`2469 &lt;https://github.com/tox-dev/tox/issues/2469&gt;`_

3.26.0

--------------------

Bugfixes
^^^^^^^^

- Fix fallback to ``python`` environment when ``isolated_build = true`` is set -- by :user:`Unrud`
`2474 &lt;https://github.com/tox-dev/tox/issues/2474&gt;`_
- Fixed ``SetuptoolsDeprecationWarning`` about using ``--global-option`` -- by :user:`adamchainz`
`2478 &lt;https://github.com/tox-dev/tox/issues/2478&gt;`_


Features
^^^^^^^^

- Use ``tomllib`` on Python 3.11 or later and ``tomli`` instead of ``toml`` library on lower versions - by :user:`hroncok`.
`2463 &lt;https://github.com/tox-dev/tox/issues/2463&gt;`_

3.25.1

--------------------

Bugfixes
^^^^^^^^

- ``sitepackages = true`` will add user&#x27;s site-package to the python path on Windows as expected -- by :user:`niander`
`2402 &lt;https://github.com/tox-dev/tox/issues/2402&gt;`_
- Avoid importing ``pipes`` on Python 3.3+ to avoid ``DeprecationWarning`` on Python 3.11 -- by :user:`adamchainz`
`2417 &lt;https://github.com/tox-dev/tox/issues/2417&gt;`_
- Fix ``isolated_build`` when the build process produces stderr at exit.
`2449 &lt;https://github.com/tox-dev/tox/issues/2449&gt;`_


Documentation
^^^^^^^^^^^^^

- Explain advantages of ``PIP_CONSTRAINT`` environment variable over ``--constraint`` argument.
`2423 &lt;https://github.com/tox-dev/tox/issues/2423&gt;`_

3.25.0

--------------------

Bugfixes
^^^^^^^^

- Fixed failing isolated_build because setuptools warning was captured
in ``build_requires``. -- by :user:`zariiii9003`
`2332 &lt;https://github.com/tox-dev/tox/issues/2332&gt;`_
- Avoid potential 30s delay caused by socket.getfqdn(). -- by :user:`ssbarnea`
`2375 &lt;https://github.com/tox-dev/tox/issues/2375&gt;`_


Features
^^^^^^^^

- Ignore missing commands if they are prefixed by ``-``
-- by :user:`cdown`.
`2315 &lt;https://github.com/tox-dev/tox/issues/2315&gt;`_
- Add default environment variables (such as http_proxy) regardless of their case to passenv on UNIX -- by :user:`poggenhans`.
`2372 &lt;https://github.com/tox-dev/tox/issues/2372&gt;`_
- On Windows ``PROGRAMFILES``, ``PROGRAMFILES(X86)``, and ``PROGRAMDATA`` environment variables are now passed through, unmasking system values necessary to locate resources such as a C compiler.
`2382 &lt;https://github.com/tox-dev/tox/issues/2382&gt;`_


Documentation
^^^^^^^^^^^^^

- Deleted the tox mailing list -- by :user:`jugmac00`
`2364 &lt;https://github.com/tox-dev/tox/issues/2364&gt;`_

Links

PyPI: https://pypi.org/project/tox
Changelog: https://pyup.io/changelogs/tox/

Update coverage from 6.3 to 7.1.0.

Changelog

7.0.5

--------------------------

- Fix: On Python 3.7, a file with type annotations but no ``from __future__
import annotations`` would be missing statements in the coverage report. This
is now fixed, closing `issue 1524`_.

.. _issue 1524: https://github.com/nedbat/coveragepy/issues/1524


.. _changes_7-0-4:

7.0.4

--------------------------

- Performance: an internal cache of file names was accidentally disabled,
resulting in sometimes drastic reductions in performance.  This is now fixed,
closing `issue 1527`_.   Thanks to Ivan Ciuvalschii for the reproducible test
case.

.. _issue 1527: https://github.com/nedbat/coveragepy/issues/1527


.. _changes_7-0-3:

7.0.3

--------------------------

- Fix: when using pytest-cov or pytest-xdist, or perhaps both, the combining
step could fail with ``assert row is not None`` using 7.0.2.  This was due to
a race condition that has always been possible and is still possible. In
7.0.1 and before, the error was silently swallowed by the combining code.
Now it will produce a message &quot;Couldn&#x27;t combine data file&quot; and ignore the
data file as it used to do before 7.0.2.  Closes `issue 1522`_.

.. _issue 1522: https://github.com/nedbat/coveragepy/issues/1522


.. _changes_7-0-2:

7.0.2

--------------------------

- Fix: when using the ``[run] relative_files = True`` setting, a relative
``[paths]`` pattern was still being made absolute.  This is now fixed,
closing `issue 1519`_.

- Fix: if Python doesn&#x27;t provide tomllib, then TOML configuration files can
only be read if coverage.py is installed with the ``[toml]`` extra.
Coverage.py will raise an error if TOML support is not installed when it sees
your settings are in a .toml file. But it didn&#x27;t understand that
``[tools.coverage]`` was a valid section header, so the error wasn&#x27;t reported
if you used that header, and settings were silently ignored.  This is now
fixed, closing `issue 1516`_.

- Fix: adjusted how decorators are traced on PyPy 7.3.10, fixing `issue 1515`_.

- Fix: the ``coverage lcov`` report did not properly implement the
``--fail-under=MIN`` option.  This has been fixed.

- Refactor: added many type annotations, including a number of refactorings.
This should not affect outward behavior, but they were a bit invasive in some
places, so keep your eyes peeled for oddities.

- Refactor: removed the vestigial and long untested support for Jython and
IronPython.

.. _issue 1515: https://github.com/nedbat/coveragepy/issues/1515
.. _issue 1516: https://github.com/nedbat/coveragepy/issues/1516
.. _issue 1519: https://github.com/nedbat/coveragepy/issues/1519


.. _changes_7-0-1:

7.0.1

--------------------------

- When checking if a file mapping resolved to a file that exists, we weren&#x27;t
considering files in .whl files.  This is now fixed, closing `issue 1511`_.

- File pattern rules were too strict, forbidding plus signs and curly braces in
directory and file names.  This is now fixed, closing `issue 1513`_.

- Unusual Unicode or control characters in source files could prevent
reporting.  This is now fixed, closing `issue 1512`_.

- The PyPy wheel now installs on PyPy 3.7, 3.8, and 3.9, closing `issue 1510`_.

.. _issue 1510: https://github.com/nedbat/coveragepy/issues/1510
.. _issue 1511: https://github.com/nedbat/coveragepy/issues/1511
.. _issue 1512: https://github.com/nedbat/coveragepy/issues/1512
.. _issue 1513: https://github.com/nedbat/coveragepy/issues/1513


.. _changes_7-0-0:

7.0.0

--------------------------

Nothing new beyond 7.0.0b1.


.. _changes_7-0-0b1:

7.0.0b1

&lt;changes_7-0-0b1_&gt;`_.)

- Changes to file pattern matching, which might require updating your
configuration:

- Previously, ``*`` would incorrectly match directory separators, making
 precise matching difficult.  This is now fixed, closing `issue 1407`_.

- Now ``**`` matches any number of nested directories, including none.

- Improvements to combining data files when using the
:ref:`config_run_relative_files` setting:

- During ``coverage combine``, relative file paths are implicitly combined
 without needing a ``[paths]`` configuration setting.  This also fixed
 `issue 991`_.

- A ``[paths]`` setting like ``*/foo`` will now match ``foo/bar.py`` so that
 relative file paths can be combined more easily.

- The setting is properly interpreted in more places, fixing `issue 1280`_.

- Fixed environment variable expansion in pyproject.toml files.  It was overly
broad, causing errors outside of coverage.py settings, as described in `issue
1481`_ and `issue 1345`_.  This is now fixed, but in rare cases will require
changing your pyproject.toml to quote non-string values that use environment
substitution.

- Fixed internal logic that prevented coverage.py from running on
implementations other than CPython or PyPy (`issue 1474`_).

.. _issue 991: https://github.com/nedbat/coveragepy/issues/991
.. _issue 1280: https://github.com/nedbat/coveragepy/issues/1280
.. _issue 1345: https://github.com/nedbat/coveragepy/issues/1345
.. _issue 1407: https://github.com/nedbat/coveragepy/issues/1407
.. _issue 1474: https://github.com/nedbat/coveragepy/issues/1474
.. _issue 1481: https://github.com/nedbat/coveragepy/issues/1481


.. _changes_6-5-0:

6.6.0

- Changes to file pattern matching, which might require updating your
configuration:

- Previously, ``*`` would incorrectly match directory separators, making
 precise matching difficult.  This is now fixed, closing `issue 1407`_.

- Now ``**`` matches any number of nested directories, including none.

- Improvements to combining data files when using the
:ref:`config_run_relative_files` setting, which might require updating your
configuration:

- During ``coverage combine``, relative file paths are implicitly combined
 without needing a ``[paths]`` configuration setting.  This also fixed
 `issue 991`_.

- A ``[paths]`` setting like ``*/foo`` will now match ``foo/bar.py`` so that
 relative file paths can be combined more easily.

- The :ref:`config_run_relative_files` setting is properly interpreted in
 more places, fixing `issue 1280`_.

- When remapping file paths with ``[paths]``, a path will be remapped only if
the resulting path exists.  The documentation has long said the prefix had to
exist, but it was never enforced.  This fixes `issue 608`_, improves `issue
649`_, and closes `issue 757`_.

- Reporting operations now implicitly use the ``[paths]`` setting to remap file
paths within a single data file.  Combining multiple files still requires the
``coverage combine`` step, but this simplifies some single-file situations.
Closes `issue 1212`_ and `issue 713`_.

- The ``coverage report`` command now has a ``--format=`` option.  The original
style is now ``--format=text``, and is the default.

- Using ``--format=markdown`` will write the table in Markdown format, thanks
 to `Steve Oswald &lt;pull 1479_&gt;`_, closing `issue 1418`_.

- Using ``--format=total`` will write a single total number to the
 output.  This can be useful for making badges or writing status updates.

- Combining data files with ``coverage combine`` now hashes the data files to
skip files that add no new information.  This can reduce the time needed.
Many details affect the speed-up, but for coverage.py&#x27;s own test suite,
combining is about 40% faster. Closes `issue 1483`_.

- When searching for completely un-executed files, coverage.py uses the
presence of ``__init__.py`` files to determine which directories have source
that could have been imported.  However, `implicit namespace packages`_ don&#x27;t
require ``__init__.py``.  A new setting ``[report]
include_namespace_packages`` tells coverage.py to consider these directories
during reporting.  Thanks to `Felix Horvat &lt;pull 1387_&gt;`_ for the
contribution.  Closes `issue 1383`_ and `issue 1024`_.

- Fixed environment variable expansion in pyproject.toml files.  It was overly
broad, causing errors outside of coverage.py settings, as described in `issue
1481`_ and `issue 1345`_.  This is now fixed, but in rare cases will require
changing your pyproject.toml to quote non-string values that use environment
substitution.

- An empty file has a coverage total of 100%, but used to fail with
``--fail-under``.  This has been fixed, closing `issue 1470`_.

- The text report table no longer writes out two separator lines if there are
no files listed in the table.  One is plenty.

- Fixed a mis-measurement of a strange use of wildcard alternatives in
match/case statements, closing `issue 1421`_.

- Fixed internal logic that prevented coverage.py from running on
implementations other than CPython or PyPy (`issue 1474`_).

- The deprecated ``[run] note`` setting has been completely removed.

.. _implicit namespace packages: https://peps.python.org/pep-0420/
.. _issue 608: https://github.com/nedbat/coveragepy/issues/608
.. _issue 649: https://github.com/nedbat/coveragepy/issues/649
.. _issue 713: https://github.com/nedbat/coveragepy/issues/713
.. _issue 757: https://github.com/nedbat/coveragepy/issues/757
.. _issue 991: https://github.com/nedbat/coveragepy/issues/991
.. _issue 1024: https://github.com/nedbat/coveragepy/issues/1024
.. _issue 1212: https://github.com/nedbat/coveragepy/issues/1212
.. _issue 1280: https://github.com/nedbat/coveragepy/issues/1280
.. _issue 1345: https://github.com/nedbat/coveragepy/issues/1345
.. _issue 1383: https://github.com/nedbat/coveragepy/issues/1383
.. _issue 1407: https://github.com/nedbat/coveragepy/issues/1407
.. _issue 1418: https://github.com/nedbat/coveragepy/issues/1418
.. _issue 1421: https://github.com/nedbat/coveragepy/issues/1421
.. _issue 1470: https://github.com/nedbat/coveragepy/issues/1470
.. _issue 1474: https://github.com/nedbat/coveragepy/issues/1474
.. _issue 1481: https://github.com/nedbat/coveragepy/issues/1481
.. _issue 1483: https://github.com/nedbat/coveragepy/issues/1483
.. _pull 1387: https://github.com/nedbat/coveragepy/pull/1387
.. _pull 1479: https://github.com/nedbat/coveragepy/pull/1479



.. _changes_6-6-0b1:

6.6.0b1

----------------------------

6.5.0

--------------------------

- The JSON report now includes details of which branches were taken, and which
are missing for each file. Thanks, `Christoph Blessing &lt;pull 1438_&gt;`_. Closes
`issue 1425`_.

- Starting with coverage.py 6.2, ``class`` statements were marked as a branch.
This wasn&#x27;t right, and has been reverted, fixing `issue 1449`_. Note this
will very slightly reduce your coverage total if you are measuring branch
coverage.

- Packaging is now compliant with `PEP 517`_, closing `issue 1395`_.

- A new debug option ``--debug=pathmap`` shows details of the remapping of
paths that happens during combine due to the ``[paths]`` setting.

- Fix an internal problem with caching of invalid Python parsing. Found by
OSS-Fuzz, fixing their `bug 50381`_.

.. _bug 50381: https://bugs.chromium.org/p/oss-fuzz/issues/detail?id=50381
.. _PEP 517: https://peps.python.org/pep-0517/
.. _issue 1395: https://github.com/nedbat/coveragepy/issues/1395
.. _issue 1425: https://github.com/nedbat/coveragepy/issues/1425
.. _issue 1449: https://github.com/nedbat/coveragepy/issues/1449
.. _pull 1438: https://github.com/nedbat/coveragepy/pull/1438


.. _changes_6-4-4:

6.4.4

--------------------------

- Wheels are now provided for Python 3.11.


.. _changes_6-4-3:

6.4.3

--------------------------

- Fix a failure when combining data files if the file names contained glob-like
patterns.  Thanks, `Michael Krebs and Benjamin Schubert &lt;pull 1405_&gt;`_.

- Fix a messaging failure when combining Windows data files on a different
drive than the current directory, closing `issue 1428`_.  Thanks, `Lorenzo
Micò &lt;pull 1430_&gt;`_.

- Fix path calculations when running in the root directory, as you might do in
a Docker container. Thanks `Arthur Rio &lt;pull 1403_&gt;`_.

- Filtering in the HTML report wouldn&#x27;t work when reloading the index page.
This is now fixed.  Thanks, `Marc Legendre &lt;pull 1413_&gt;`_.

- Fix a problem with Cython code measurement, closing `issue 972`_.  Thanks,
`Matus Valo &lt;pull 1347_&gt;`_.

.. _issue 972: https://github.com/nedbat/coveragepy/issues/972
.. _issue 1428: https://github.com/nedbat/coveragepy/issues/1428
.. _pull 1347: https://github.com/nedbat/coveragepy/pull/1347
.. _pull 1403: https://github.com/nedbat/coveragepy/issues/1403
.. _pull 1405: https://github.com/nedbat/coveragepy/issues/1405
.. _pull 1413: https://github.com/nedbat/coveragepy/issues/1413
.. _pull 1430: https://github.com/nedbat/coveragepy/pull/1430


.. _changes_6-4-2:

6.4.2

--------------------------

- Updated for a small change in Python 3.11.0 beta 4: modules now start with a
line with line number 0, which is ignored.  This line cannot be executed, so
coverage totals were thrown off.  This line is now ignored by coverage.py,
but this also means that truly empty modules (like ``__init__.py``) have no
lines in them, rather than one phantom line.  Fixes `issue 1419`_.

- Internal debugging data added to sys.modules is now an actual module, to
avoid confusing code that examines everything in sys.modules.  Thanks,
`Yilei Yang &lt;pull 1399_&gt;`_.

.. _issue 1419: https://github.com/nedbat/coveragepy/issues/1419
.. _pull 1399: https://github.com/nedbat/coveragepy/pull/1399


.. _changes_6-4-1:

6.4.1

--------------------------

- Greatly improved performance on PyPy, and other environments that need the
pure Python trace function.  Thanks, Carl Friedrich Bolz-Tereick (`pull
1381`_ and `pull 1388`_).  Slightly improved performance when using the C
trace function, as most environments do.  Closes `issue 1339`_.

- The conditions for using tomllib from the standard library have been made
more precise, so that 3.11 alphas will continue to work. Closes `issue
1390`_.

.. _issue 1339: https://github.com/nedbat/coveragepy/issues/1339
.. _pull 1381: https://github.com/nedbat/coveragepy/pull/1381
.. _pull 1388: https://github.com/nedbat/coveragepy/pull/1388
.. _issue 1390: https://github.com/nedbat/coveragepy/issues/1390


.. _changes_64:

6.4

------------------------

- A new setting, :ref:`config_run_sigterm`, controls whether a SIGTERM signal
handler is used.  In 6.3, the signal handler was always installed, to capture
data at unusual process ends.  Unfortunately, this introduced other problems
(see `issue 1310`_).  Now the signal handler is only used if you opt-in by
setting ``[run] sigterm = true``.

- Small changes to the HTML report:

- Added links to next and previous file, and more keyboard shortcuts: ``[``
 and ``]`` for next file and previous file; ``u`` for up to the index; and
 ``?`` to open/close the help panel.  Thanks, `J. M. F. Tsang
 &lt;pull 1364_&gt;`_.

- The time stamp and version are displayed at the top of the report.  Thanks,
 `Ammar Askar &lt;pull 1354_&gt;`_. Closes `issue 1351`_.

- A new debug option ``debug=sqldata`` adds more detail to ``debug=sql``,
logging all the data being written to the database.

- Previously, running ``coverage report`` (or any of the reporting commands) in
an empty directory would create a .coverage data file.  Now they do not,
fixing `issue 1328`_.

- On Python 3.11, the ``[toml]`` extra no longer installs tomli, instead using
tomllib from the standard library.  Thanks `Shantanu &lt;pull 1359_&gt;`_.

- In-memory CoverageData objects now properly update(), closing `issue 1323`_.

.. _issue 1310: https://github.com/nedbat/coveragepy/issues/1310
.. _issue 1323: https://github.com/nedbat/coveragepy/issues/1323
.. _issue 1328: https://github.com/nedbat/coveragepy/issues/1328
.. _issue 1351: https://github.com/nedbat/coveragepy/issues/1351
.. _pull 1354: https://github.com/nedbat/coveragepy/pull/1354
.. _pull 1359: https://github.com/nedbat/coveragepy/pull/1359
.. _pull 1364: https://github.com/nedbat/coveragepy/pull/1364


.. _changes_633:

6.3.3

--------------------------

- Fix: Coverage.py now builds successfully on CPython 3.11 (3.11.0b1) again.
Closes `issue 1367`_.  Some results for generators may have changed.

.. _issue 1367: https://github.com/nedbat/coveragepy/issues/1367


.. _changes_632:

6.3.2

--------------------------

- Fix: adapt to pypy3.9&#x27;s decorator tracing behavior.  It now traces function
decorators like CPython 3.8: both the -line and the def-line are traced.
Fixes `issue 1326`_.

- Debug: added ``pybehave`` to the list of :ref:`coverage debug &lt;cmd_debug&gt;`
and :ref:`cmd_run_debug` options.

- Fix: show an intelligible error message if ``--concurrency=multiprocessing``
is used without a configuration file.  Closes `issue 1320`_.

.. _issue 1320: https://github.com/nedbat/coveragepy/issues/1320
.. _issue 1326: https://github.com/nedbat/coveragepy/issues/1326


.. _changes_631:

6.3.1

--------------------------

- Fix: deadlocks could occur when terminating processes.  Some of these
deadlocks (described in `issue 1310`_) are now fixed.

- Fix: a signal handler was being set from multiple threads, causing an error:
&quot;ValueError: signal only works in main thread&quot;.  This is now fixed, closing
`issue 1312`_.

- Fix: ``--precision`` on the command-line was being ignored while considering
``--fail-under``.  This is now fixed, thanks to
`Marcelo Trylesinski &lt;pull 1317_&gt;`_.

- Fix: releases no longer provide 3.11.0-alpha wheels. Coverage.py uses CPython
internal fields which are moving during the alpha phase. Fixes `issue 1316`_.

.. _issue 1310: https://github.com/nedbat/coveragepy/issues/1310
.. _issue 1312: https://github.com/nedbat/coveragepy/issues/1312
.. _issue 1316: https://github.com/nedbat/coveragepy/issues/1316
.. _pull 1317: https://github.com/nedbat/coveragepy/pull/1317


.. _changes_63:

Links

PyPI: https://pypi.org/project/coverage
Changelog: https://pyup.io/changelogs/coverage/
Repo: https://github.com/nedbat/coveragepy

Update Sphinx from 4.3.2 to 6.1.3.

Changelog

6.1.3

=====================================

Bugs fixed
----------

* 11116: Reverted to previous Sphinx 5 node copying method
* 11117: Reverted changes to parallel image processing from Sphinx 6.1.0
* 11119: Supress ``ValueError`` in the ``linkcheck`` builder

6.1.2

=====================================

Bugs fixed
----------

* 11101: LaTeX: ``div.topic_padding`` key of sphinxsetup documented at 5.1.0 was
implemented with name ``topic_padding``
* 11099: LaTeX: ``shadowrule`` key of sphinxsetup causes PDF build to crash
since Sphinx 5.1.0
* 11096: LaTeX: ``shadowsize`` key of sphinxsetup causes PDF build to crash
since Sphinx 5.1.0
* 11095: LaTeX: shadow of :dudir:`topic` and contents_ boxes not in page
margin since Sphinx 5.1.0

.. _contents: https://docutils.sourceforge.io/docs/ref/rst/directives.html#table-of-contents
* 11100: Fix copying images when running under parallel mode.

6.1.1

=====================================

Bugs fixed
----------

* 11091: Fix ``util.nodes.apply_source_workaround`` for ``literal_block`` nodes
with no source information in the node or the node&#x27;s parents.

6.1.0

=====================================

Dependencies
------------

* Adopted the `Ruff`_ code linter.

.. _Ruff: https://github.com/charliermarsh/ruff

Incompatible changes
--------------------

* 10979: gettext: Removed support for pluralisation in ``get_translation``.
This was unused and complicated other changes to ``sphinx.locale``.

Deprecated
----------

* ``sphinx.util`` functions:

* Renamed ``sphinx.util.typing.stringify()``
  to ``sphinx.util.typing.stringify_annotation()``
* Moved ``sphinx.util.xmlname_checker()``
  to ``sphinx.builders.epub3._XML_NAME_PATTERN``

Moved to ``sphinx.util.display``:

* ``sphinx.util.status_iterator``
* ``sphinx.util.display_chunk``
* ``sphinx.util.SkipProgressMessage``
* ``sphinx.util.progress_message``

Moved to ``sphinx.util.http_date``:

* ``sphinx.util.epoch_to_rfc1123``
* ``sphinx.util.rfc1123_to_epoch``

Moved to ``sphinx.util.exceptions``:

* ``sphinx.util.save_traceback``
* ``sphinx.util.format_exception_cut_frames``

Features added
--------------

* Cache doctrees in the build environment during the writing phase.
* Make all writing phase tasks support parallel execution.
* 11072: Use PEP 604 (``X | Y``) display conventions for ``typing.Optional``
and ``typing.Optional`` types within the Python domain and autodoc.
* 10700: autodoc: Document ``typing.NewType()`` types as classes rather than
&#x27;data&#x27;.
* Cache doctrees between the reading and writing phases.

Bugs fixed
----------

* 10962: HTML: Fix the multi-word key name lookup table.
* Fixed support for Python 3.12 alpha 3 (changes in the ``enum`` module).
* 11069: HTML Theme: Removed outdated &quot;shortcut&quot; link relation keyword.
* 10952: Properly terminate parallel processes on programme interuption.
* 10988: Speed up ``TocTree.resolve()`` through more efficient copying.
* 6744: LaTeX: support for seealso directive should be via an environment
to allow styling.
* 11074: LaTeX: Can&#x27;t change sphinxnote to use sphinxheavybox starting with
5.1.0

6.0.1

=====================================

Dependencies
------------

* Require Pygments 2.13 or later.

Bugs fixed
----------

* 10944: imgmath:  Fix resolving image paths for files in nested folders.

6.0.0

=====================================

Dependencies
------------

* 10468: Drop Python 3.6 support
* 10470: Drop Python 3.7, Docutils 0.14, Docutils 0.15, Docutils 0.16, and
Docutils 0.17 support. Patch by Adam Turner

Incompatible changes
--------------------

* 7405: Removed the jQuery and underscore.js JavaScript frameworks.

These frameworks are no longer be automatically injected into themes from
Sphinx 6.0. If you develop a theme or extension that uses the
``jQuery``, ``$``, or ``$u`` global objects, you need to update your
JavaScript to modern standards, or use the mitigation below.

The first option is to use the sphinxcontrib.jquery_ extension, which has been
developed by the Sphinx team and contributors. To use this, add
``sphinxcontrib.jquery`` to the ``extensions`` list in ``conf.py``, or call
``app.setup_extension(&quot;sphinxcontrib.jquery&quot;)`` if you develop a Sphinx theme
or extension.

The second option is to manually ensure that the frameworks are present.
To re-add jQuery and underscore.js, you will need to copy ``jquery.js`` and
``underscore.js`` from `the Sphinx repository`_ to your ``static`` directory,
and add the following to your ``layout.html``:

.. code-block:: html+jinja

  {%- block scripts %}
      &lt;script src=&quot;{{ pathto(&#x27;_static/jquery.js&#x27;, resource=True) }}&quot;&gt;&lt;/script&gt;
      &lt;script src=&quot;{{ pathto(&#x27;_static/underscore.js&#x27;, resource=True) }}&quot;&gt;&lt;/script&gt;
      {{ super() }}
  {%- endblock %}

.. _sphinxcontrib.jquery: https://github.com/sphinx-contrib/jquery/

Patch by Adam Turner.
* 10471, 10565: Removed deprecated APIs scheduled for removal in Sphinx 6.0. See
:ref:`dev-deprecated-apis` for details. Patch by Adam Turner.
* 10901: C Domain: Remove support for parsing pre-v3 style type directives and
roles. Also remove associated configuration variables ``c_allow_pre_v3`` and
``c_warn_on_allowed_pre_v3``. Patch by Adam Turner.

Features added
--------------

* 10924: LaTeX: adopt better looking defaults for tables and code-blocks.
See :confval:`latex_table_style` and the ``pre_border-radius`` and
``pre_background-TeXcolor`` :ref:`additionalcss` for the former defaults
and how to re-enact them if desired.

Bugs fixed
----------

* 10984: LaTeX: Document :confval:`latex_additional_files` behavior for files
with ``.tex`` extension.

5.3.0

=====================================

* 10759: LaTeX: add :confval:`latex_table_style` and support the
``&#x27;booktabs&#x27;``, ``&#x27;borderless&#x27;``, and ``&#x27;colorrows&#x27;`` styles.
(thanks to Stefan Wiehler for initial pull requests 6666, 6671)
* 10840: One can cross-reference including an option value like ``:option:`--module=foobar,
``:option:`--module[=foobar] or ``:option:`--module foobar.
Patch by Martin Liska.
* 10881: autosectionlabel: Record the generated section label to the debug log.
* 10268: Correctly URI-escape image filenames.
* 10887: domains: Allow sections in all the content of all object description
directives (e.g. :rst:dir:`py:function`). Patch by Adam Turner

5.2.3

=====================================

* 10878: Fix base64 image embedding in ``sphinx.ext.imgmath``
* 10886: Add ``:nocontentsentry:`` flag and global domain table of contents
entry control option. Patch by Adam Turner

5.2.2

=====================================

* 10872: Restore link targets for autodoc modules to the top of content.
Patch by Dominic Davis-Foster.

5.2.1

=====================================

Bugs fixed
----------

* 10861: Always normalise the ``pycon3`` lexer to ``pycon``.
* Fix using ``sphinx.ext.autosummary`` with modules containing titles in the
module-level docstring.

5.2.0.post0

===========================================

* Recreated source tarballs for Debian maintainers.

5.2.0

=====================================

Dependencies
------------

* 10356: Sphinx now uses declarative metadata with ``pyproject.toml`` to
create packages, using PyPA&#x27;s ``flit`` project as a build backend. Patch by
Adam Turner.

Deprecated
----------

* 10843: Support for HTML 4 output. Patch by Adam Turner.

Features added
--------------

* 10738: napoleon: Add support for docstring types using &#x27;of&#x27;, like
``type of type``. Example: ``tuple of int``.
* 10286: C++, support requires clauses not just between the template
parameter lists and the declaration.
* 10755: linkcheck: Check the source URL of raw directives that use the ``url``
option.
* 10781: Allow :rst:role:`ref` role to be used with definitions and fields.
* 10717: HTML Search: Increase priority for full title and
subtitle matches in search results
* 10718: HTML Search: Save search result score to the HTML element for debugging
* 10673: Make toctree accept &#x27;genindex&#x27;, &#x27;modindex&#x27; and &#x27;search&#x27; docnames
* 6316, 10804: Add domain objects to the table of contents. Patch by Adam Turner
* 6692: HTML Search: Include explicit :rst:dir:`index` directive index entries
in the search index and search results. Patch by Adam Turner
* 10816: imgmath: Allow embedding images in HTML as base64
* 10854: HTML Search: Use browser localstorage for highlight control, stop
storing highlight parameters in URL query strings. Patch by Adam Turner.

Bugs fixed
----------

* 10723: LaTeX: 5.1.0 has made the &#x27;sphinxsetup&#x27; ``verbatimwithframe=false``
become without effect.
* 10257: C++, ensure consistent non-specialization template argument
representation.
* 10729: C++, fix parsing of certain non-type template parameter packs.
* 10715: Revert 10520: &quot;Fix&quot; use of sidebar classes in ``agogo.css_t``

5.1.1

=====================================

Bugs fixed
----------

* 10701: Fix ValueError in the new ``deque`` based ``sphinx.ext.napolean``
iterator implementation.
* 10702: Restore compatability with third-party builders.

5.1.0

=====================================

Dependencies
------------

* 10656: Support `Docutils 0.19`_. Patch by Adam Turner.

.. _Docutils 0.19: https://docutils.sourceforge.io/RELEASE-NOTES.html#release-0-19-2022-07-05

Deprecated
----------

* 10467: Deprecated ``sphinx.util.stemmer`` in favour of ``snowballstemmer``.
Patch by Adam Turner.
* 9856: Deprecated ``sphinx.ext.napoleon.iterators``.

Features added
--------------

* 10444: html theme: Allow specifying multiple CSS files through the ``stylesheet``
setting in ``theme.conf`` or by setting ``html_style`` to an iterable of strings.
* 10366: std domain: Add support for emphasising placeholders in :rst:dir:`option`
directives through a new :confval:`option_emphasise_placeholders` configuration
option.
* 10439: std domain: Use the repr of some variables when displaying warnings,
making whitespace issues easier to identify.
* 10571: quickstart: Reduce content in the generated ``conf.py`` file. Patch by
Pradyun Gedam.
* 10648: LaTeX: CSS-named-alike additional :ref:`&#x27;sphinxsetup&#x27; &lt;latexsphinxsetup&gt;`
keys allow to configure four separate border-widths, four paddings, four
corner radii, a shadow (possibly inset), colours for border, background, shadow
for each of the code-block, topic, attention, caution, danger, error and warning
directives.
* 10655: LaTeX: Explain non-standard encoding in LatinRules.xdy
* 10599: HTML Theme: Wrap consecutive footnotes in an ``&lt;aside&gt;`` element when
using Docutils 0.18 or later, to allow for easier styling. This matches the
behaviour introduced in Docutils 0.19. Patch by Adam Turner.
* 10518: config: Add ``include_patterns`` as the opposite of ``exclude_patterns``.
Patch by Adam Turner.

Bugs fixed
----------

* 10594: HTML Theme: field term colons are doubled if using Docutils 0.18+
* 10596: Build failure if Docutils version is 0.18 (not 0.18.1) due
to missing ``Node.findall()``
* 10506: LaTeX: build error if highlighting inline code role in figure caption
(refs: 10251)
* 10634: Make -P (pdb) option work better with exceptions triggered from events
* 10550: py domain: Fix spurious whitespace in unparsing various operators (``+``,
``-``, ``~``, and ``**``). Patch by Adam Turner (refs: 10551).
* 10460: logging: Always show node source locations as absolute paths.
* HTML Search: HTML tags are displayed as a part of object name
* HTML Search: search snipets should not be folded
* HTML Search: Minor errors are emitted on fetching search snipets
* HTML Search: The markers for header links are shown in the search result
* 10520: HTML Theme: Fix use of sidebar classes in ``agogo.css_t``.
* 6679: HTML Theme: Fix inclusion of hidden toctrees in the agogo theme.
* 10566: HTML Theme: Fix enable_search_shortcuts does not work
* 8686: LaTeX: Text can fall out of code-block at end of page and leave artifact
on next page
* 10633: LaTeX: user injected ``\color`` commands in topic or admonition boxes may
cause color leaks in PDF due to upstream `framed.sty &lt;https://ctan.org/pkg/framed&gt;`_
bug
* 10638: LaTeX: framed coloured boxes in highlighted code (e.g. highlighted
diffs using Pygments style ``&#x27;manni&#x27;``) inherit thickness of code-block frame
* 10647: LaTeX: Only one ``\label`` is generated for ``desc_signature`` node
even if it has multiple node IDs
* 10579: i18n: UnboundLocalError is raised on translating raw directive
* 9577, 10088: py domain: Fix warning for duplicate Python references when
using ``:any:`` and autodoc.
* 10548: HTML Search: fix minor summary issues.

5.0.2

=====================================

Features added
--------------

* 10523: HTML Theme: Expose the Docutils&#x27;s version info tuple as a template
variable, ``docutils_version_info``. Patch by Adam Turner.

Bugs fixed
----------

* 10538: autodoc: Inherited class attribute having docstring is documented even
if :confval:`autodoc_inherit_docstring` is disabled
* 10509: autosummary: autosummary fails with a shared library
* 10497: py domain: Failed to resolve strings in Literal. Patch by Adam Turner.
* 10523: HTML Theme: Fix double brackets on citation references in Docutils 0.18+.
Patch by Adam Turner.
* 10534: Missing CSS for nav.contents in Docutils 0.18+. Patch by Adam Turner.

5.0.1

=====================================

Bugs fixed
----------

* 10498: gettext: TypeError is raised when sorting warning messages if a node
has no line number. Patch by Adam Turner.
* 10493: HTML Theme: :rst:dir:`topic` directive is rendered incorrectly with
Docutils 0.18. Patch by Adam Turner.
* 10495: IndexError is raised for a :rst:role:`kbd` role having a separator.
Patch by Adam Turner.

5.0.0

* 9575: autodoc: The annotation of return value should not be shown when
``autodoc_typehints=&quot;description&quot;``
* 9648: autodoc: ``*args`` and ``**kwargs`` entries are duplicated when
``autodoc_typehints=&quot;description&quot;``
* 8180: autodoc: Docstring metadata ignored for attributes
* 10443: epub: EPUB builder can&#x27;t detect the mimetype of .webp file
* 10104: gettext: Duplicated locations are shown if 3rd party extension does
not provide correct information
* 10456: py domain: ``:meta:`` fields are displayed if docstring contains two
or more meta-field
* 9096: sphinx-build: the value of progress bar for paralle build is wrong
* 10110: sphinx-build: exit code is not changed when error is raised on
builder-finished event

4.5.0

=====================================

Incompatible changes
--------------------

* 10112: extlinks: Disable hardcoded links detector by default
* 9993, 10177: std domain: Disallow to refer an inline target via
:rst:role:`ref` role

Deprecated
----------

* ``sphinx.ext.napoleon.docstring.GoogleDocstring._qualify_name()``

Features added
--------------

* 10260: Enable ``FORCE_COLOR`` and ``NO_COLOR`` for terminal colouring
* 10234: autosummary: Add &quot;autosummary&quot; CSS class to summary tables
* 10125: extlinks: Improve suggestion message for a reference having title
* 10112: extlinks: Add :confval:`extlinks_detect_hardcoded_links` to enable
hardcoded links detector feature
* 9494, 9456: html search: Add a config variable
:confval:`html_show_search_summary` to enable/disable the search summaries
* 9337: HTML theme, add option ``enable_search_shortcuts`` that enables :kbd:`/` as
a Quick search shortcut and :kbd:`Esc` shortcut that
removes search highlighting.
* 10107: i18n: Allow to suppress translation warnings by adding ``noqa``
comment to the tail of each translation message
* 10252: C++, support attributes on classes, unions, and enums.
* 10253: :rst:role:`pep` role now generates URLs based on `peps.python.org
&lt;https://peps.python.org&gt;`_

Bugs fixed
----------

* 9876: autodoc: Failed to document an imported class that is built from native
binary module
* 10133: autodoc: Crashed when mocked module is used for type annotation
* 10146: autodoc: :confval:`autodoc_default_options` does not support
``no-value`` option
* 9971: autodoc: TypeError is raised when the target object is annotated by
unhashable object
* 10205: extlinks: Failed to compile regexp on checking hardcoded links
* 10277: html search: Could not search short words (ex. &quot;use&quot;)
* 9529: LaTeX: named auto numbered footnote (ex. ``[named]``) that is referred
multiple times was rendered to a question mark
* 9924: LaTeX: multi-line :rst:dir:`cpp:function` directive has big vertical
spacing in Latexpdf
* 10158: LaTeX: excessive whitespace since v4.4.0 for undocumented
variables/structure members 
* 10175: LaTeX: named footnote reference is linked to an incorrect footnote if
the name is also used in the different document
* 10269: manpage: Failed to resolve the title of :rst:role:`ref` cross references
* 10179: i18n: suppress &quot;rST localization&quot; warning
* 10118: imgconverter: Unnecessary availablity check is called for remote URIs
* 10181: napoleon: attributes are displayed like class attributes for google
style docstrings when :confval:`napoleon_use_ivar` is enabled
* 10

pyup-bot · 2023-03-01T18:33:12Z

Closing this in favor of #58

pyup-bot added 11 commits February 1, 2023 13:34

Update pip from 22.0.2 to 23.0

ef320d2

Update wheel from 0.37.1 to 0.38.4

048aa2c

Update watchdog from 2.1.6 to 2.2.1

8f9cd58

Update flake8 from 4.0.1 to 6.0.0

d3d0f42

Update pylint from 2.12.2 to 2.16.0

a13658d

Update tox from 3.24.5 to 4.4.4

a31abc2

Update coverage from 6.3 to 7.1.0

b2629d5

Update sphinx from 4.3.2 to 6.1.3

2f0cb17

Update twine from 3.7.1 to 4.0.2

414bc6b

Update pytest from 6.2.5 to 7.2.1

3c61b7b

Update pytest-mock from 3.7.0 to 3.10.0

1c60c5b

pyup-bot added the update pyup updates label Feb 1, 2023

pyup-bot assigned rnag Feb 1, 2023

pyup-bot mentioned this pull request Feb 1, 2023

Scheduled monthly dependency update for January #56

Closed

pyup-bot closed this Mar 1, 2023

rnag deleted the pyup/scheduled-update-2023-02-01 branch March 1, 2023 18:33

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Scheduled monthly dependency update for February #57

Scheduled monthly dependency update for February #57

pyup-bot commented Feb 1, 2023

pyup-bot commented Mar 1, 2023

Scheduled monthly dependency update for February #57

Scheduled monthly dependency update for February #57

Conversation

pyup-bot commented Feb 1, 2023

Update pip from 22.0.2 to 23.0.

22.3.1

22.3

22.2.2

22.2.1

22.2

22.1.2

22.1.1

22.1

22.1b1

22.0.4

22.0.3

Update wheel from 0.37.1 to 0.38.4.

0.38.4

0.38.3

0.38.2

0.38.1

0.38.0

Update watchdog[watchmedo] from 2.1.6 to 2.2.1.

2.2.1

2.2.0

2.1.9

2.1.8

2.1.7

Update flake8 from 4.0.1 to 6.0.0.

Update pylint from 2.12.2 to 2.16.0.

Update tox from 3.24.5 to 4.4.4.

3.28.0

3.27.1

3.27.0

3.26.0

3.25.1

3.25.0

Update coverage from 6.3 to 7.1.0.

7.0.5

7.0.4

7.0.3

7.0.2

7.0.1

7.0.0

7.0.0b1

6.6.0

6.6.0b1

6.5.0

6.4.4

6.4.3

6.4.2

6.4.1

6.4

6.3.3

6.3.2

6.3.1

Update Sphinx from 4.3.2 to 6.1.3.

6.1.3

6.1.2

6.1.1

6.1.0

6.0.1

6.0.0

5.3.0

5.2.3

5.2.2

5.2.1

5.2.0.post0

5.2.0

5.1.1

5.1.0

5.0.2

5.0.1

5.0.0

4.5.0

pyup-bot commented Mar 1, 2023