Scheduled monthly dependency update for January #76

pyup-bot · 2024-01-01T18:29:06Z

Update pip from 23.0.1 to 23.3.2.

Changelog

23.3.2

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

Bug Fixes
---------

- Fix a bug in extras handling for link requirements (`12372 &lt;https://github.com/pypa/pip/issues/12372&gt;`_)
- Fix mercurial revision &quot;parse error&quot;: use ``--rev={ref}`` instead of ``-r={ref}`` (`12373 &lt;https://github.com/pypa/pip/issues/12373&gt;`_)

23.3.1

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

Bug Fixes
---------

- Handle a timezone indicator of Z when parsing dates in the self check. (`12338 &lt;https://github.com/pypa/pip/issues/12338&gt;`_)
- Fix bug where installing the same package at the same time with multiple pip processes could fail. (`12361 &lt;https://github.com/pypa/pip/issues/12361&gt;`_)

23.3

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

Process
-------

- Added reference to `vulnerability reporting guidelines &lt;https://www.python.org/dev/security/&gt;`_ to pip&#x27;s security policy.

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

- Drop a fallback to using SecureTransport on macOS. It was useful when pip detected OpenSSL older than 1.0.1, but the current pip does not support any Python version supporting such old OpenSSL versions. (`12175 &lt;https://github.com/pypa/pip/issues/12175&gt;`_)

Features
--------

- Improve extras resolution for multiple constraints on same base package. (`11924 &lt;https://github.com/pypa/pip/issues/11924&gt;`_)
- Improve use of datastructures to make candidate selection 1.6x faster. (`12204 &lt;https://github.com/pypa/pip/issues/12204&gt;`_)
- Allow ``pip install --dry-run`` to use platform and ABI overriding options. (`12215 &lt;https://github.com/pypa/pip/issues/12215&gt;`_)
- Add ``is_yanked`` boolean entry to the installation report (``--report``) to indicate whether the requirement was yanked from the index, but was still selected by pip conform to :pep:`592`. (`12224 &lt;https://github.com/pypa/pip/issues/12224&gt;`_)

Bug Fixes
---------

- Ignore errors in temporary directory cleanup (show a warning instead). (`11394 &lt;https://github.com/pypa/pip/issues/11394&gt;`_)
- Normalize extras according to :pep:`685` from package metadata in the resolver
for comparison. This ensures extras are correctly compared and merged as long
as the package providing the extra(s) is built with values normalized according
to the standard. Note, however, that this *does not* solve cases where the
package itself contains unnormalized extra values in the metadata. (`11649 &lt;https://github.com/pypa/pip/issues/11649&gt;`_)
- Prevent downloading sdists twice when :pep:`658` metadata is present. (`11847 &lt;https://github.com/pypa/pip/issues/11847&gt;`_)
- Include all requested extras in the install report (``--report``). (`11924 &lt;https://github.com/pypa/pip/issues/11924&gt;`_)
- Removed uses of ``datetime.datetime.utcnow`` from non-vendored code. (`12005 &lt;https://github.com/pypa/pip/issues/12005&gt;`_)
- Consistently report whether a dependency comes from an extra. (`12095 &lt;https://github.com/pypa/pip/issues/12095&gt;`_)
- Fix completion script for zsh (`12166 &lt;https://github.com/pypa/pip/issues/12166&gt;`_)
- Fix improper handling of the new onexc argument of ``shutil.rmtree()`` in Python 3.12. (`12187 &lt;https://github.com/pypa/pip/issues/12187&gt;`_)
- Filter out yanked links from the available versions error message: &quot;(from versions: 1.0, 2.0, 3.0)&quot; will not contain yanked versions conform PEP 592. The yanked versions (if any) will be mentioned in a separate error message. (`12225 &lt;https://github.com/pypa/pip/issues/12225&gt;`_)
- Fix crash when the git version number contains something else than digits and dots. (`12280 &lt;https://github.com/pypa/pip/issues/12280&gt;`_)
- Use ``-r=...`` instead of ``-r ...`` to specify references with Mercurial. (`12306 &lt;https://github.com/pypa/pip/issues/12306&gt;`_)
- Redact password from URLs in some additional places. (`12350 &lt;https://github.com/pypa/pip/issues/12350&gt;`_)
- pip uses less memory when caching large packages. As a result, there is a new on-disk cache format stored in a new directory ($PIP_CACHE_DIR/http-v2). (`2984 &lt;https://github.com/pypa/pip/issues/2984&gt;`_)

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

- Upgrade certifi to 2023.7.22
- Add truststore 0.8.0
- Upgrade urllib3 to 1.26.17

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

- Document that ``pip search`` support has been removed from PyPI (`12059 &lt;https://github.com/pypa/pip/issues/12059&gt;`_)
- Clarify --prefer-binary in CLI and docs (`12122 &lt;https://github.com/pypa/pip/issues/12122&gt;`_)
- Document that using OS-provided Python can cause pip&#x27;s test suite to report false failures. (`12334 &lt;https://github.com/pypa/pip/issues/12334&gt;`_)

23.2.1

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

Bug Fixes
---------

- Disable :pep:`658` metadata fetching with the legacy resolver. (`12156 &lt;https://github.com/pypa/pip/issues/12156&gt;`_)

23.2

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

Process
-------

- Deprecate support for eggs for Python 3.11 or later, when the new ``importlib.metadata`` backend is used to load distribution metadata. This only affects the egg *distribution format* (with the ``.egg`` extension); distributions using the ``.egg-info`` *metadata format* (but are not actually eggs) are not affected. For more information about eggs, see `relevant section in the setuptools documentation &lt;https://setuptools.pypa.io/en/stable/deprecated/python_eggs.html&gt;`__.

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

- Deprecate legacy version and version specifiers that don&#x27;t conform to `PEP 440
&lt;https://peps.python.org/pep-0440/&gt;`_ (`#12063 &lt;https://github.com/pypa/pip/issues/12063&gt;`_)
- ``freeze`` no longer excludes the ``setuptools``, ``distribute``, and ``wheel``
from the output when running on Python 3.12 or later, where they are not
included in a virtual environment by default. Use ``--exclude`` if you wish to
exclude any of these packages. (`4256 &lt;https://github.com/pypa/pip/issues/4256&gt;`_)

Features
--------

- make rejection messages slightly different between 1 and 8, so the user can make the difference. (`12040 &lt;https://github.com/pypa/pip/issues/12040&gt;`_)

Bug Fixes
---------

- Fix ``pip completion --zsh``. (`11417 &lt;https://github.com/pypa/pip/issues/11417&gt;`_)
- Prevent downloading files twice when :pep:`658` metadata is present (`11847 &lt;https://github.com/pypa/pip/issues/11847&gt;`_)
- Add permission check before configuration (`11920 &lt;https://github.com/pypa/pip/issues/11920&gt;`_)
- Fix deprecation warnings in Python 3.12 for usage of shutil.rmtree (`11957 &lt;https://github.com/pypa/pip/issues/11957&gt;`_)
- Ignore invalid or unreadable ``origin.json`` files in the cache of locally built wheels. (`11985 &lt;https://github.com/pypa/pip/issues/11985&gt;`_)
- Fix installation of packages with :pep:`658` metadata using non-canonicalized names (`12038 &lt;https://github.com/pypa/pip/issues/12038&gt;`_)
- Correctly parse ``dist-info-metadata`` values from JSON-format index data. (`12042 &lt;https://github.com/pypa/pip/issues/12042&gt;`_)
- Fail with an error if the ``--python`` option is specified after the subcommand name. (`12067 &lt;https://github.com/pypa/pip/issues/12067&gt;`_)
- Fix slowness when using ``importlib.metadata`` (the default way for pip to read metadata in Python 3.11+) and there is a large overlap between already installed and to-be-installed packages. (`12079 &lt;https://github.com/pypa/pip/issues/12079&gt;`_)
- Pass the ``-r`` flag to mercurial to be explicit that a revision is passed and protect
against ``hg`` options injection as part of VCS URLs. Users that do not have control on
VCS URLs passed to pip are advised to upgrade. (`12119 &lt;https://github.com/pypa/pip/issues/12119&gt;`_)

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

- Upgrade certifi to 2023.5.7
- Upgrade platformdirs to 3.8.1
- Upgrade pygments to 2.15.1
- Upgrade pyparsing to 3.1.0
- Upgrade Requests to 2.31.0
- Upgrade rich to 13.4.2
- Upgrade setuptools to 68.0.0
- Updated typing_extensions to 4.6.0
- Upgrade typing_extensions to 4.7.1
- Upgrade urllib3 to 1.26.16

23.1.2

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

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

- Upgrade setuptools to 67.7.2

23.1.1

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

Bug Fixes
---------

- Revert `11487 &lt;https://github.com/pypa/pip/pull/11487&gt;`_, as it causes issues with virtualenvs created by the Windows Store distribution of Python. (`#11987 &lt;https://github.com/pypa/pip/issues/11987&gt;`_)

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

- Revert pkg_resources (via setuptools) back to 65.6.3

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

- Update documentation to reflect the new behavior of using the cache of locally
built wheels in hash-checking mode. (`11967 &lt;https://github.com/pypa/pip/issues/11967&gt;`_)

23.1

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

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

- Remove support for the deprecated ``--install-options``. (`11358 &lt;https://github.com/pypa/pip/issues/11358&gt;`_)
- ``--no-binary`` does not imply ``setup.py install`` anymore. Instead a wheel will be
built locally and installed. (`11451 &lt;https://github.com/pypa/pip/issues/11451&gt;`_)
- ``--no-binary`` does not disable the cache of locally built wheels anymore. It only
means &quot;don&#x27;t download wheels&quot;. (`11453 &lt;https://github.com/pypa/pip/issues/11453&gt;`_)
- Deprecate ``--build-option`` and ``--global-option``. Users are invited to switch to
``--config-settings``. (`11859 &lt;https://github.com/pypa/pip/issues/11859&gt;`_)
- Using ``--config-settings`` with projects that don&#x27;t have a ``pyproject.toml`` now prints
a deprecation warning. In the future the presence of config settings will automatically
enable the default build backend for legacy projects and pass the settings to it. (`11915 &lt;https://github.com/pypa/pip/issues/11915&gt;`_)
- Remove ``setup.py install`` fallback when building a wheel failed for projects without
``pyproject.toml``. (`8368 &lt;https://github.com/pypa/pip/issues/8368&gt;`_)
- When the ``wheel`` package is not installed, pip now uses the default build backend
instead of ``setup.py install`` and ``setup.py develop`` for project without
``pyproject.toml``. (`8559 &lt;https://github.com/pypa/pip/issues/8559&gt;`_)

Features
--------

- Specify egg-link location in assertion message when it does not match installed location to provide better error message for debugging. (`10476 &lt;https://github.com/pypa/pip/issues/10476&gt;`_)
- Present conflict information during installation after each choice that is rejected (pass ``-vv`` to ``pip install`` to show it) (`10937 &lt;https://github.com/pypa/pip/issues/10937&gt;`_)
- Display dependency chain on each Collecting/Processing log line. (`11169 &lt;https://github.com/pypa/pip/issues/11169&gt;`_)
- Support a per-requirement ``--config-settings`` option in requirements files. (`11325 &lt;https://github.com/pypa/pip/issues/11325&gt;`_)
- The ``--config-settings``/``-C`` option now supports using the same key multiple
times. When the same key is specified multiple times, all values are passed to
the build backend as a list, as opposed to the previous behavior, where pip would
only pass the last value if the same key was used multiple times. (`11681 &lt;https://github.com/pypa/pip/issues/11681&gt;`_)
- Add ``-C`` as a short version of the ``--config-settings`` option. (`11786 &lt;https://github.com/pypa/pip/issues/11786&gt;`_)
- Reduce the number of resolver rounds, since backjumping makes the resolver more efficient in finding solutions. This also makes pathological cases fail quicker. (`11908 &lt;https://github.com/pypa/pip/issues/11908&gt;`_)
- Warn if ``--hash`` is used on a line without requirement in a requirements file. (`11935 &lt;https://github.com/pypa/pip/issues/11935&gt;`_)
- Stop propagating CLI ``--config-settings`` to the build dependencies. They already did
not propagate to requirements provided in requirement files. To pass the same config
settings to several requirements, users should provide the requirements as CLI
arguments. (`11941 &lt;https://github.com/pypa/pip/issues/11941&gt;`_)
- Support wheel cache when using ``--require-hashes``. (`5037 &lt;https://github.com/pypa/pip/issues/5037&gt;`_)
- Add ``--keyring-provider`` flag. See the Authentication page in the documentation for more info. (`8719 &lt;https://github.com/pypa/pip/issues/8719&gt;`_)
- In the case of virtual environments, configuration files are now also included from the base installation. (`9752 &lt;https://github.com/pypa/pip/issues/9752&gt;`_)

Bug Fixes
---------

- Fix grammar by changing &quot;A new release of pip available:&quot; to &quot;A new release of pip is available:&quot; in the notice used for indicating that. (`11529 &lt;https://github.com/pypa/pip/issues/11529&gt;`_)
- Normalize paths before checking if installed scripts are on PATH. (`11719 &lt;https://github.com/pypa/pip/issues/11719&gt;`_)
- Correct the way to decide if keyring is available. (`11774 &lt;https://github.com/pypa/pip/issues/11774&gt;`_)
- More consistent resolution backtracking by removing legacy hack related to setuptools resolution (`11837 &lt;https://github.com/pypa/pip/issues/11837&gt;`_)
- Include ``AUTHORS.txt`` in pip&#x27;s wheels. (`11882 &lt;https://github.com/pypa/pip/issues/11882&gt;`_)
- The ``uninstall`` and ``install --force-reinstall`` commands no longer call
``normalize_path()`` repeatedly on the same paths. Instead, these results are
cached for the duration of an uninstall operation, resulting in improved
performance, particularly on Windows. (`11889 &lt;https://github.com/pypa/pip/issues/11889&gt;`_)
- Fix and improve the parsing of hashes embedded in URL fragments. (`11936 &lt;https://github.com/pypa/pip/issues/11936&gt;`_)
- When package A depends on package B provided as a direct URL dependency including a hash
embedded in the link, the ``--require-hashes`` option did not warn when user supplied hashes
were missing for package B. (`11938 &lt;https://github.com/pypa/pip/issues/11938&gt;`_)
- Correctly report ``requested_extras`` in the installation report when extras are
specified for a local directory installation. (`11946 &lt;https://github.com/pypa/pip/issues/11946&gt;`_)
- When installing an archive from a direct URL or local file, populate
``download_info.info.hashes`` in the installation report, in addition to the legacy
``download_info.info.hash`` key. (`11948 &lt;https://github.com/pypa/pip/issues/11948&gt;`_)

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

- Upgrade msgpack to 1.0.5
- Patch pkg_resources to remove dependency on ``jaraco.text``.
- Upgrade platformdirs to 3.2.0
- Upgrade pygments to 2.14.0
- Upgrade resolvelib to 1.0.1
- Upgrade rich to 13.3.3
- Upgrade setuptools to 67.6.1
- Upgrade tenacity to 8.2.2
- Upgrade typing_extensions to 4.5.0
- Upgrade urllib3 to 1.26.15

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

- Cross-reference the ``--python`` flag from the ``--prefix`` flag,
and mention limitations of ``--prefix`` regarding script installation. (`11775 &lt;https://github.com/pypa/pip/issues/11775&gt;`_)
- Add SECURITY.md to make the policy offical. (`11809 &lt;https://github.com/pypa/pip/issues/11809&gt;`_)
- Add username to Git over SSH example. (`11838 &lt;https://github.com/pypa/pip/issues/11838&gt;`_)
- Quote extras in the pip install docs to guard shells with default glob
qualifiers, like zsh. (`11842 &lt;https://github.com/pypa/pip/issues/11842&gt;`_)
- Make it clear that requirements/constraints file can be a URL (`11954 &lt;https://github.com/pypa/pip/issues/11954&gt;`_)

Links

PyPI: https://pypi.org/project/pip
Changelog: https://data.safetycli.com/changelogs/pip/
Homepage: https://pip.pypa.io/

Update wheel from 0.40.0 to 0.42.0.

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

Links

PyPI: https://pypi.org/project/wheel

Update pylint from 2.17.2 to 3.0.3.

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

Links

PyPI: https://pypi.org/project/pylint
Changelog: https://data.safetycli.com/changelogs/pylint/

Update tox from 4.4.11 to 4.11.4.

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

Links

PyPI: https://pypi.org/project/tox
Changelog: https://data.safetycli.com/changelogs/tox/

Update coverage from 7.2.3 to 7.4.0.

Changelog

7.4.0

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

- In Python 3.12 and above, you can try an experimental core based on the new
:mod:`sys.monitoring &lt;python:sys.monitoring&gt;` module by defining a
``COVERAGE_CORE=sysmon`` environment variable.  This should be faster, though
plugins and dynamic contexts are not yet supported with it.  I am very
interested to hear how it works (or doesn&#x27;t!) for you.


.. _changes_7-3-4:

7.3.4

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

- Fix: the change for multi-line signature exclusions in 7.3.3 broke other
forms of nested clauses being excluded properly.  This is now fixed, closing
`issue 1713`_.

- Fix: in the HTML report, selecting code for copying won&#x27;t select the line
numbers also. Thanks, `Robert Harris &lt;pull 1717_&gt;`_.

.. _issue 1713: https://github.com/nedbat/coveragepy/issues/1713
.. _pull 1717: https://github.com/nedbat/coveragepy/pull/1717


.. _changes_7-3-3:

7.3.3

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

- Fix: function definitions with multi-line signatures can now be excluded by
matching any of the lines, closing `issue 684`_.  Thanks, `Jan Rusak,
Maciej Kowalczyk and Joanna Ejzel &lt;pull 1705_&gt;`_.

- Fix: XML reports could fail with a TypeError if files had numeric components
that were duplicates except for leading zeroes, like ``file1.py`` and
``file001.py``.  Fixes `issue 1709`_.

- The ``coverage annotate`` command used to announce that it would be removed
in a future version. Enough people got in touch to say that they use it, so
it will stay.  Don&#x27;t expect it to keep up with other new features though.

- Added new :ref:`debug options &lt;cmd_run_debug&gt;`:

- ``pytest`` writes the pytest test name into the debug output.

- ``dataop2`` writes the full data being added to CoverageData objects.

.. _issue 684: https://github.com/nedbat/coveragepy/issues/684
.. _pull 1705: https://github.com/nedbat/coveragepy/pull/1705
.. _issue 1709: https://github.com/nedbat/coveragepy/issues/1709


.. _changes_7-3-2:

7.3.2

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

- The ``coverage lcov`` command ignored the ``[report] exclude_lines`` and
``[report] exclude_also`` settings (`issue 1684`_).  This is now fixed,
thanks `Jacqueline Lee &lt;pull 1685_&gt;`_.

- Sometimes SQLite will create journal files alongside the coverage.py database
files.  These are ephemeral, but could be mistakenly included when combining
data files.  Now they are always ignored, fixing `issue 1605`_. Thanks to
Brad Smith for suggesting fixes and providing detailed debugging.

- On Python 3.12+, we now disable SQLite writing journal files, which should be
a little faster.

- The new 3.12 soft keyword ``type`` is properly bolded in HTML reports.

- Removed the &quot;fullcoverage&quot; feature used by CPython to measure the coverage of
early-imported standard library modules.  CPython `stopped using it
&lt;88054_&gt;`_ in 2021, and it stopped working completely in Python 3.13.

.. _issue 1605: https://github.com/nedbat/coveragepy/issues/1605
.. _issue 1684: https://github.com/nedbat/coveragepy/issues/1684
.. _pull 1685: https://github.com/nedbat/coveragepy/pull/1685
.. _88054: https://github.com/python/cpython/issues/88054


.. _changes_7-3-1:

7.3.1

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

- The semantics of stars in file patterns has been clarified in the docs.  A
leading or trailing star matches any number of path components, like a double
star would.  This is different than the behavior of a star in the middle of a
pattern.  This discrepancy was `identified by Sviatoslav Sydorenko
&lt;starbad_&gt;`_, who `provided patient detailed diagnosis &lt;pull 1650_&gt;`_ and
graciously agreed to a pragmatic resolution.

- The API docs were missing from the last version. They are now `restored
&lt;apidocs_&gt;`_.

.. _apidocs: https://coverage.readthedocs.io/en/latest/api_coverage.html
.. _starbad: https://github.com/nedbat/coveragepy/issues/1407#issuecomment-1631085209
.. _pull 1650: https://github.com/nedbat/coveragepy/pull/1650

.. _changes_7-3-0:

7.3.0

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

- Added a :meth:`.Coverage.collect` context manager to start and stop coverage
data collection.

- Dropped support for Python 3.7.

- Fix: in unusual circumstances, SQLite cannot be set to asynchronous mode.
Coverage.py would fail with the error ``Safety level may not be changed
inside a transaction.`` This is now avoided, closing `issue 1646`_.  Thanks
to Michael Bell for the detailed bug report.

- Docs: examples of configuration files now include separate examples for the
different syntaxes: .coveragerc, pyproject.toml, setup.cfg, and tox.ini.

- Fix: added ``nosemgrep`` comments to our JavaScript code so that
semgrep-based SAST security checks won&#x27;t raise false alarms about security
problems that aren&#x27;t problems.

- Added a CITATION.cff file, thanks to `Ken Schackart &lt;pull 1641_&gt;`_.

.. _pull 1641: https://github.com/nedbat/coveragepy/pull/1641
.. _issue 1646: https://github.com/nedbat/coveragepy/issues/1646


.. _changes_7-2-7:

7.2.7

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

- Fix: reverted a `change from 6.4.3 &lt;pull 1347b_&gt;`_ that helped Cython, but
also increased the size of data files when using dynamic contexts, as
described in the now-fixed `issue 1586`_. The problem is now avoided due to a
recent change (`issue 1538 &lt;issue 1538b_&gt;`_).  Thanks to `Anders Kaseorg
&lt;pull 1629_&gt;`_ and David Szotten for persisting with problem reports and
detailed diagnoses.

- Wheels are now provided for CPython 3.12.

.. _pull 1347b: https://github.com/nedbat/coveragepy/pull/1347
.. _issue 1538b: https://github.com/nedbat/coveragepy/issues/1538
.. _issue 1586: https://github.com/nedbat/coveragepy/issues/1586
.. _pull 1629: https://github.com/nedbat/coveragepy/pull/1629


.. _changes_7-2-6:

7.2.6

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

- Fix: the ``lcov`` command could raise an IndexError exception if a file is
translated to Python but then executed under its own name.  Jinja2 does this
when rendering templates.  Fixes `issue 1553`_.

- Python 3.12 beta 1 now inlines comprehensions.  Previously they were compiled
as invisible functions and coverage.py would warn you if they weren&#x27;t
completely executed.  This no longer happens under Python 3.12.

- Fix: the ``coverage debug sys`` command includes some environment variables
in its output.  This could have included sensitive data.  Those values are
now hidden with asterisks, closing `issue 1628`_.

.. _issue 1553: https://github.com/nedbat/coveragepy/issues/1553
.. _issue 1628: https://github.com/nedbat/coveragepy/issues/1628


.. _changes_7-2-5:

7.2.5

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

- Fix: ``html_report()`` could fail with an AttributeError on ``isatty`` if run
in an unusual environment where sys.stdout had been replaced.  This is now
fixed.


.. _changes_7-2-4:

7.2.4

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

PyCon 2023 sprint fixes!

- Fix: with ``relative_files = true``, specifying a specific file to include or
omit wouldn&#x27;t work correctly (`issue 1604`_).  This is now fixed, with
testing help by `Marc Gibbons &lt;pull 1608_&gt;`_.

- Fix: the XML report would have an incorrect ``&lt;source&gt;`` element when using
relative files and the source option ended with a slash (`issue 1541`_).
This is now fixed, thanks to `Kevin Brown-Silva &lt;pull 1608_&gt;`_.

- When the HTML report location is printed to the terminal, it&#x27;s now a
terminal-compatible URL, so that you can click the location to open the HTML
file in your browser.  Finishes `issue 1523`_ thanks to `Ricardo Newbery
&lt;pull 1613_&gt;`_.

- Docs: a new :ref:`Migrating page &lt;migrating&gt;` with details about how to
migrate between major versions of coverage.py.  It currently covers the
wildcard changes in 7.x.  Thanks, `Brian Grohe &lt;pull 1610_&gt;`_.

.. _issue 1523: https://github.com/nedbat/coveragepy/issues/1523
.. _issue 1541: https://github.com/nedbat/coveragepy/issues/1541
.. _issue 1604: https://github.com/nedbat/coveragepy/issues/1604
.. _pull 1608: https://github.com/nedbat/coveragepy/pull/1608
.. _pull 1609: https://github.com/nedbat/coveragepy/pull/1609
.. _pull 1610: https://github.com/nedbat/coveragepy/pull/1610
.. _pull 1613: https://github.com/nedbat/coveragepy/pull/1613


.. _changes_7-2-3:

Links

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

Update Sphinx from 5.3.0 to 7.2.6.

Changelog

7.2.6

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

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

* 11679: Add the :envvar:`!SPHINX_AUTODOC_RELOAD_MODULES` environment variable,
which if set reloads modules when using autodoc with ``TYPE_CHECKING = True``.
Patch by Matt Wozniski and Adam Turner.
* 11679: Use :py:func:`importlib.reload` to reload modules in autodoc.
Patch by Matt Wozniski and Adam Turner.

7.2.5

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

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

* 11645: Fix a regression preventing autodoc from importing modules within
packages that make use of ``if typing.TYPE_CHECKING:`` to guard circular
imports needed by type checkers.
Patch by Matt Wozniski.
* 11634: Fixed inheritance diagram relative link resolution
for sibling files in a subdirectory.
Patch by Albert Shih.
* 11659: Allow ``?config=...`` in :confval:`mathjax_path`.
* 11654: autodoc: Fail with a more descriptive error message
when an object claims to be an instance of ``type``,
but is not a class.
Patch by James Braza.
* 11620: Cease emitting :event:`source-read` events for files read via
the :dudir:`include` directive.
* 11620: Add a new :event:`include-read` for observing and transforming
the content of included files via the :dudir:`include` directive.
* 11627: Restore support for copyright lines of the form ``YYYY``
when ``SOURCE_DATE_EPOCH`` is set.

7.2.4

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

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

* 11618: Fix a regression in the MoveModuleTargets transform,
introduced in 10478 (9662).
* 11649: linkcheck: Resolve hanging tests for timezones west of London
and incorrect conversion from UTC to offsets from the UNIX epoch.
Patch by Dmitry Shachnev and Adam Turner.

7.2.3

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

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

* 11576: Require sphinxcontrib-serializinghtml 1.1.9.

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

* Fix regression in ``autodoc.Documenter.parse_name()``.
* Fix regression in JSON serialisation.
* 11543: autodoc: Support positional-only parameters in ``classmethod`` methods
when ``autodoc_preserve_defaults`` is ``True``.
* Restore support string methods on path objects.
This is deprecated and will be removed in Sphinx 8.
Use :py:func:`os.fspath` to convert :py:class:`~pathlib.Path` objects to strings,
or :py:class:`~pathlib.Path`&#x27;s methods to work with path objects.

7.2.2

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

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

* Fix the signature of the ``StateMachine.insert_input()`` patch,
for when calling with keyword arguments.
* Fixed membership testing (``in``) for the :py:class:`str` interface
of the asset classes (``_CascadingStyleSheet`` and ``_JavaScript``),
which several extensions relied upon.
* Fixed a type error in ``SingleFileHTMLBuilder._get_local_toctree``,
``includehidden`` may be passed as a string or a boolean.
* Fix ``:noindex:`` for ``PyModule`` and ``JSModule``.

7.2.1

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

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

* Restored the the :py:class:`str` interface of the asset classes
(``_CascadingStyleSheet`` and ``_JavaScript``), which several extensions relied upon.
This will be removed in Sphinx 9.
* Restored calls to ``Builder.add_{css,js}_file()``,
which several extensions relied upon.
* Restored the private API ``TocTree.get_toctree_ancestors()``,
which several extensions relied upon.

7.2.0

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

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

* 11511: Drop Python 3.8 support.
* 11576: Require Pygments 2.14 or later.

Deprecated
----------

* 11512: Deprecate ``sphinx.util.md5`` and ``sphinx.util.sha1``.
Use ``hashlib`` instead.
* 11526: Deprecate ``sphinx.testing.path``.
Use ``os.path`` or ``pathlib`` instead.
* 11528: Deprecate ``sphinx.util.split_index_msg`` and ``sphinx.util.split_into``.
Use ``sphinx.util.index_entries.split_index_msg`` instead.
* Deprecate ``sphinx.builders.html.Stylesheet``
and ``sphinx.builders.html.Javascript``.
Use ``sphinx.application.Sphinx.add_css_file()``
and ``sphinx.application.Sphinx.add_js_file()`` instead.
* 11582: Deprecate ``sphinx.builders.html.StandaloneHTMLBuilder.css_files`` and
``sphinx.builders.html.StandaloneHTMLBuilder.script_files``.
Use ``sphinx.application.Sphinx.add_css_file()``
and ``sphinx.application.Sphinx.add_js_file()`` instead.
* 11459: Deprecate ``sphinx.ext.autodoc.preserve_defaults.get_function_def()``.
Patch by Bénédikt Tran.

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

* 11526: Support ``os.PathLike`` types and ``pathlib.Path`` objects
in many more places.
* 5474: coverage: Print summary statistics tables.
Patch by Jorge Leitao.
* 6319: viewcode: Add :confval:`viewcode_line_numbers` to control
whether line numbers are added to rendered source code.
Patch by Ben Krikler.
* 9662: Add the ``:no-typesetting:`` option to suppress textual output
and only create a linkable anchor.
Patch by Latosha Maltba.
* 11221: C++: Support domain objects in the table of contents.
Patch by Rouslan Korneychuk.
* 10938: doctest: Add :confval:`doctest_show_successes` option.
Patch by Trey Hunner.
* 11533: Add ``:no-index:``, ``:no-index-entry:``, and ``:no-contents-entry:``.
* 11572: Improve ``debug`` logging of reasons why files are detected as out of
date.
Patch by Eric Larson.
* 10678: Emit :event:`source-read` events for files read via
the :dudir:`include` directive.
Patch by Halldor Fannar.
* 11570: Use short names when using :pep:`585` built-in generics.
Patch by Riccardo Mori.
* 11300: Improve ``SigElementFallbackTransform`` fallback logic and signature
text elements nodes. See :doc:`the documentation &lt;/extdev/nodes&gt;` for more
details.
Patch by Bénédikt Tran.
* Allow running Sphinx with ``python -m sphinx build ...``.

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

* 11077: graphviz: Fix relative links from within the graph.
Patch by Ralf Grubenmann.
* 11529: Line Block in LaTeX builder outputs spurious empty token.
Patch by Adrian Vollmer.
* 11196: autosummary: Summary line extraction failed with &quot;e.g.&quot;
* 10614: Fixed a number of bugs in inheritance diagrams that resulted in
missing or broken links.
Patch by Albert Shih.
* 9428: Exclude substitution definitions when running the ``gettext`` builder.
Patch by Alvin Wong.
* 10795: Raise a descriptive error if ``graphviz_dot`` is falsy.
* 11546: Translated nodes identical to their original text are now marked
with the ``translated=True`` attribute.
* 10049: html: Change &quot;Permalink&quot; to &quot;Link&quot; for title text in link anchors.
* 4225: Relax Pygments parsing on lexing failures.
* 11246: Allow inline links in the first line of a docstring and one-line
type comments ``: :meta ...:`` when using :mod:`sphinx.ext.napoleon`.
Patch by Bénédikt Tran.
* 10930: Highlight all search terms on the search results page.
Patch by Dmitry Shachnev.
* 11473: Type annotations containing :py:data:`~typing.Literal` enumeration
values now render correctly.
Patch by Bénédikt Tran.
* 11591: Fix support for C coverage in ``sphinx.ext.coverage`` extension.
Patch by Stephen Finucane.
* 11594: HTML Theme: Enhancements to horizontal scrolling on smaller
devices in the ``agogo`` theme.
Patch by Lukas Engelter.
* 11459: Fix support for async and lambda functions in
``sphinx.ext.autodoc.preserve_defaults``.
Patch by Bénédikt Tran.

Testing
-------

* 11577: pytest: Fail tests on &quot;XPASS&quot;.
* 11577: pytest: Use &quot;importlib&quot; import mode.
* 11577: pytest: Set PYTHONWARNINGS=error.
* 11577: pytest: Set strict config and strict markers.

7.1.2

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

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

* 11542: linkcheck: Properly respect :confval:`linkcheck_anchors`
and do not spuriously report failures to validate anchors.
Patch by James Addison.

7.1.1

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

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

* 11514: Fix ``SOURCE_DATE_EPOCH`` in multi-line copyright footer.
Patch by Bénédikt Tran.

7.1.0

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

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

* Releases are no longer signed, given the `change in PyPI policy`_.

.. _change in PyPI policy: https://blog.pypi.org/posts/2023-05-23-removing-pgp/

Deprecated
----------

* 11412: Emit warnings on using a deprecated Python-specific index entry type
(namely, ``module``, ``keyword``, ``operator``, ``object``, ``exception``,
``statement``, and ``builtin``) in the :rst:dir:`index` directive, and
set the removal version to Sphinx 9. Patch by Adam Turner.

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

* 11415: Add a checksum to JavaScript and CSS asset URIs included within
generated HTML, using the CRC32 algorithm.
* :meth:`~sphinx.application.Sphinx.require_sphinx` now allows the version
requirement to be specified as ``(major, minor)``.
* 11011: Allow configuring a line-length limit for object signatures, via
:confval:`maximum_signature_line_length` and the domain-specific variants.
If the length of the signature (in characters) is greater than the configured
limit, each parameter in the signature will be split to its own logical line.
This behaviour may also be controlled by options on object description
directives, for example :rst:dir:`py:function:single-line-parameter-list`.
Patch by Thomas Louf, Adam Turner, and Jean-François B.
* 10983: Support for multiline copyright statements in the footer block.
Patch by Stefanie Molin
* ``sphinx.util.display.status_iterator`` now clears the current line
with ANSI control codes, rather than overprinting with space characters.
* 11431: linkcheck: Treat SSL failures as broken links.
Patch by James Addison.
* 11157: Keep the ``translated`` attribute on translated nodes.
* 11451: Improve the traceback displayed when using :option:`sphinx-build -T`
in parallel builds. Patch by Bénédikt Tran
* 11324: linkcheck: Use session-basd HTTP requests.
* 11438: Add support for the :rst:dir:`py:class` and :rst:dir:`py:function`
directives for PEP 695 (generic classes and functions declarations) and
PEP 696 (default type parameters).  Multi-line support (11011) is enabled
for type parameters list and can be locally controlled on object description
directives, e.g., :rst:dir:`py:function:single-line-type-parameter-list`.
Patch by Bénédikt Tran.
* 11484: linkcheck: Allow HTML anchors to be ignored on a per-URL basis
via :confval:`linkcheck_anchors_ignore_for_url` while
still checking the validity of the page itself.
Patch by Bénédikt Tran
* 1246: Add translation progress statistics and inspection support,
via a new substitution (``|translation progress|``) and a new
configuration variable (:confval:`translation_progress_classes`).
These enable determining the percentage of translated elements within
a document, and the remaining translated and untranslated elements.

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

* Restored the ``footnote-reference`` class that has been removed in
the latest (unreleased) version of Docutils.
* 11486: Use :rfc:`8081` font file MIME types in the EPUB builder.
Using the correct MIME type will prevent warnings from ``epubcheck``
and will generate a valid EPUB.
* 11435: Use microsecond-resolution timestamps for outdated file detection
in ``BuildEnvironment.get_outdated_files``.
* 11437: Top-level headings starting with a reStructuredText role
now render properly when :confval:`rst_prolog` is set.
Previously, a file starting with the below would have
improperly rendered due to where the prologue text
was inserted into the document.

.. code:: rst

  :mod:`lobster` -- The lobster module
  ====================================

  ...

Patch by Bénédikt Tran.
* 11337: Fix a ``MemoryError`` in ``sphinx.ext.intersphinx`` when using ``None``
or ``typing.*`` as inline type references. Patch by Bénédikt Tran (picnixz)

Testing
-------

* 11345: Always delete ``docutils.conf`` in test directories when running
``SphinxTestApp.cleanup()``.

7.0.1

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

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

* 11411: Support `Docutils 0.20`_. Patch by Adam Turner.

.. _Docutils 0.20: https://docutils.sourceforge.io/RELEASE-NOTES.html#release-0-20-2023-05-04

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

* 11418: Clean up remaining references to ``sphinx.setup_command``
following the removal of support for setuptools.
Patch by Willem Mulder.

7.0.0

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

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

* 11359: Remove long-deprecated aliases for ``MecabSplitter`` and
``DefaultSplitter`` in ``sphinx.search.ja``.
* 11360: Remove deprecated ``make_old_id`` functions in domain object
description classes.
* 11363: Remove the Setuptools integration (``build_sphinx`` hook in
``setup.py``).
* 11364: Remove deprecated ``sphinx.ext.napoleon.iterators`` module.
* 11365: Remove support for the ``jsdump`` format in ``sphinx.search``.
* 11366: Make ``locale`` a required argument to
``sphinx.util.i18n.format_date()``.
* 11370: Remove deprecated ``sphinx.util.stemmer`` module.
* 11371: Remove deprecated ``sphinx.pycode.ast.parse()`` function.
* 11372: Remove deprecated ``sphinx.io.read_doc()`` function.
* 11373: Removed deprecated ``sphinx.util.get_matching_files()`` function.
* 11378: Remove deprecated ``sphinx.util.docutils.is_html5_writer_available()``
function.
* 11379: Make the ``env`` argument to ``Builder`` subclasses required.
* 11380: autosummary: Always emit grouped import exceptions.
* 11381: Remove deprecated ``style`` key for HTML templates.
* 11382: Remove deprecated ``sphinx.writers.latex.LaTeXTranslator.docclasses``
attribute.
* 11383: Remove deprecated ``sphinx.builders.html.html5_ready`` and
``sphinx.builders.html.HTMLTranslator`` attributes.
* 11385: Remove support for HTML 4 output.

6.2.1

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

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

* 11355: Revert the default type of :confval:`nitpick_ignore` and
:confval:`nitpick_ignore_regex` to ``list``.

6.2.0

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

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

* Require Docutils 0.18.1 or greater.

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

* LaTeX: removal of some internal TeX ``\dimen`` registers (not previously
publicly documented) as per 5.1.0 code comments in ``sphinx.sty``:
``\sphinxverbatimsep``, ``\sphinxverbatimborder``, ``\sphinxshadowsep``,
``\sphinxshadowsize``, and ``\sphinxshadowrule``. (refs: 11105)
* Remove ``.egg`` support from pycode ``ModuleAnalyser``; Python eggs are a
now-obsolete binary distribution format
* 11089: Remove deprecated code in ``sphinx.builders.linkcheck``.
Patch by Daniel Eades
* Remove internal-only ``sphinx.locale.setlocale``

Deprecated
----------

* 11247: Deprecate the legacy ``intersphinx_mapping`` format
* ``sphinx.util.osutil.cd`` is deprecated in favour of ``contextlib.chdir``.

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

* 11277: :rst:dir:`autoproperty` allows the return type to be specified as
a type comment (e.g., `` type: () -&gt; int``). Patch by Bénédikt Tran
* 10811: Autosummary: extend ``__all__`` to imported members for template rendering
when option ``autosummary_ignore_module_all`` is set to ``False``. Patch by
Clement Pinard
* 11147: Add a ``content_offset`` parameter to ``nested_parse_with_titles()``,
allowing for correct line numbers during nested parsing.
Patch by Jeremy Maitin-Shepard
* Update to Unicode CLDR 42
* Add a ``--jobs`` synonym for ``-j``. Patch by Hugo van Kemenade
* LaTeX: a command ``\sphinxbox`` for styling text elements with a (possibly
rounded) box, optional background color and shadow, has been added.
See :ref:`sphinxbox`. (refs: 11224)
* LaTeX: add ``\sphinxstylenotetitle``, ..., ``\sphinxstylewarningtitle``, ...,
for an extra layer of mark-up freeing up ``\sphinxstrong`` for other uses.
See :ref:`latex-macros`. (refs: 11267)
* LaTeX: :dudir:`note`, :dudir:`hint`, :dudir:`important` and :dudir:`tip` can
now each be styled as the other admonitions, i.e. possibly with a background
color, individual border widths and paddings, possibly rounded corners, and
optional shadow.  See :ref:`additionalcss`. (refs: 11234)
* LaTeX: admonitions and :dudir:`topic` (and
:dudir:`contents &lt;table-of-contents&gt;`) directives, and not only
:rst:dir:`code-block`, support ``box-decoration-break=slice``.
* LaTeX: let rounded boxes support up to 4 distinct border-widths (refs: 11243)
* LaTeX: new options ``noteTextColor``, ``noteTeXextras`` et al.
See :ref:`additionalcss`.
* LaTeX: support elliptical corners in rounded boxes. (refs: 11254)
* 11150: Include source location in highlighting warnings, when lexing fails.
Patch by Jeremy Maitin-Shepard
* 11281: Support for :confval:`imgmath_latex` ``= &#x27;tectonic&#x27;`` or
``= &#x27;xelatex&#x27;``.  Patch by Dimitar Dimitrov
* 11109, 9643: Add :confval:`python_display_short_literal_types` option for
condensed rendering of ``Literal`` types.

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

* 11079: LaTeX: figures with align attribute may disappear and strangely impact
following lists
* 11093: LaTeX: fix &quot;multiply-defined references&quot; PDF build warnings when one or
more reST labels directly precede an :rst:dir:`py:module` or :rst:dir:`automodule`
directive. Patch by Bénédikt Tran (picnixz)
* 11110: LaTeX: Figures go missing from latex pdf if their files have the same
base name and they use a post transform.  Patch by aaron-cooper
* LaTeX: fix potential color leak from shadow to border of rounded boxes, if
shadow color is set but border color is not
* LaTeX: fix unintended 1pt upwards vertical shift of code blocks frames
respective to contents (when using rounded corners)
* 11235: LaTeX: added ``\color`` in topic (or admonition) contents may cause color
leak to the shadow and border at a page break
* 11264: LaTeX: missing space before colon after &quot;Voir aussi&quot; for :rst:dir:`seealso`
directive in French
* 11268: LaTeX: longtable with left alignment breaks out of current list
indentation context in PDF.  Thanks to picnixz.
* 11274: LaTeX: external links are not properly escaped for ``\sphinxupquote``
compatibility
* 11147: Fix source file/line number info in object description content and in
other uses of ``nested_parse_with_titles``.  Patch by Jeremy Maitin-Shepard.
* 11192: Restore correct parallel search index building.
Patch by Jeremy Maitin-Shepard
* Use the new Transifex ``tx`` client

Testing
-------

* Fail testing when any Python warnings are emitted
* Migrate remaining ``unittest.TestCase`` style test functions to pytest style
* Remove tests that rely on setuptools

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 :dudir:`contents &lt;table-of-contents&gt;`
boxes not in page margin since Sphinx 5.1.0
* 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.

Links

PyPI: https://pypi.org/project/sphinx
Changelog: https://data.safetycli.com/changelogs/sphinx/

Update pytest from 7.2.2 to 7.4.4.

Changelog

7.4.4

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

Bug Fixes
---------

- `11140 &lt;https://github.com/pytest-dev/pytest/issues/11140&gt;`_: Fix non-string constants at the top of file being detected as docstrings on Python&gt;=3.8.


- `11572 &lt;https://github.com/pytest-dev/pytest/issues/11572&gt;`_: Handle an edge case where :data:`sys.stderr` and :data:`sys.__stderr__` might already be closed when :ref:`faulthandler` is tearing down.


- `11710 &lt;https://github.com/pytest-dev/pytest/issues/11710&gt;`_: Fixed tracebacks from collection errors not getting pruned.


- `7966 &lt;https://github.com/pytest-dev/pytest/issues/7966&gt;`_: Removed unhelpful error message from assertion rewrite mechanism when exceptions are raised in ``__iter__`` methods. Now they are treated un-iterable instead.



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

- `11091 &lt;https://github.com/pytest-dev/pytest/issues/11091&gt;`_: Updated documentation to refer to hyphenated options: replaced ``--junitxml`` with ``--junit-xml`` and ``--collectonly`` with ``--collect-only``.

7.4.3

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

Bug Fixes
---------

- `10447 &lt;https://github.com/pytest-dev/pytest/issues/10447&gt;`_: Markers are now considered in the reverse mro order to ensure base  class markers are considered first -- this resolves a regression.


- `11239 &lt;https://github.com/pytest-dev/pytest/issues/11239&gt;`_: Fixed ``:=`` in asserts impacting unrelated test cases.


- `11439 &lt;https://github.com/pytest-dev/pytest/issues/11439&gt;`_: Handled an edge case where :data:`sys.stderr` might already be closed when :ref:`faulthandler` is tearing down.

7.4.2

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

Bug Fixes
---------

- `11237 &lt;https://github.com/pytest-dev/pytest/issues/11237&gt;`_: Fix doctest collection of `functools.cached_property` objects.


- `11306 &lt;https://github.com/pytest-dev/pytest/issues/11306&gt;`_: Fixed bug using ``--importmode=importlib`` which would cause package ``__init__.py`` files to be imported more than once in some cases.


- `11367 &lt;https://github.com/pytest-dev/pytest/issues/11367&gt;`_: Fixed bug where `user_properties` where not being saved in the JUnit XML file if a fixture failed during teardown.


- `11394 &lt;https://github.com/pytest-dev/pytest/issues/11394&gt;`_: Fixed crash when parsing long command line arguments that might be interpreted as files.



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

- `11391 &lt;https://github.com/pytest-dev/pytest/issues/11391&gt;`_: Improved disclaimer on pytest plugin reference page to better indicate this is an automated, non-curated listing.

7.4.1

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

Bug Fixes
---------

- `10337 &lt;https://github.com/pytest-dev/pytest/issues/10337&gt;`_: Fixed bug where fake intermediate modules generated by ``--import-mode=importlib`` would not include the
child modules as attributes of the parent modules.


- `10702 &lt;https://github.com/pytest-dev/pytest/issues/10702&gt;`_: Fixed error assertion handling in :func:`pytest.approx` when ``None`` is an expected or received value when comparing dictionaries.


- `10811 &lt;https://github.com/pytest-dev/pytest/issues/10811&gt;`_: Fixed issue when using ``--import-mode=importlib`` together with ``--doctest-modules`` that caused modules
to be imported more than once, causing problems with modules that have import side effects.

7.4.0

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

Features
--------

- `10901 &lt;https://github.com/pytest-dev/pytest/issues/10901&gt;`_: Added :func:`ExceptionInfo.from_exception() &lt;pytest.ExceptionInfo.from_exception&gt;`, a simpler way to create an :class:`~pytest.ExceptionInfo` from an exception.
This can replace :func:`ExceptionInfo.from_exc_info() &lt;pytest.ExceptionInfo.from_exc_info()&gt;` for most uses.



Improvements
------------

- `10872 &lt;https://github.com/pytest-dev/pytest/issues/10872&gt;`_: Update test log report annotation to named tuple and fixed inconsistency in docs for :hook:`pytest_report_teststatus` hook.


- `10907 &lt;https://github.com/pytest-dev/pytest/issues/10907&gt;`_: When an exception traceback to be displayed is completely filtered out (by mechanisms such as ``__tracebackhide__``, internal frames, and similar), now only the exception string and the following message are shown:

&quot;All traceback entries are hidden. Pass `--full-trace` to see hidden and internal frames.&quot;.

Previously, the last frame of the traceback was shown, even though it was hidden.


- `10940 &lt;https://github.com/pytest-dev/pytest/issues/10940&gt;`_: Improved verbose output (``-vv``) of ``skip`` and ``xfail`` reasons by performing text wrapping while leaving a clear margin for progress output.

Added ``TerminalReporter.wrap_write()`` as a helper for that.


- `10991 &lt;https://github.com/pytest-dev/pytest/issues/10991&gt;`_: Added handling of ``%f`` directive to print microseconds in log format options, such as ``log-date-format``.


- `11005 &lt;https://github.com/pytest-dev/pytest/issues/11005&gt;`_: Added the underlying exception to the cache provider&#x27;s path creation and write warning messages.


- `11013 &lt;https://github.com/pytest-dev/pytest/issues/11013&gt;`_: Added warning when :confval:`testpaths` is set, but paths are not found by glob. In this case, pytest will fall back to searching from the current directory.


- `11043 &lt;https://github.com/pytest-dev/pytest/issues/11043&gt;`_: When `--confcutdir` is not specified, and there is no config file present, the conftest cutoff directory (`--confcutdir`) is now set to the :ref:`rootdir &lt;rootdir&gt;`.
Previously in such cases, `conftest.py` files would be probed all the way to the root directory of the filesystem.
If you are badly affected by this change, consider adding an empty config file to your desired cutoff directory, or explicitly set `--confcutdir`.


- `11081 &lt;https://github.com/pytest-dev/pytest/issues/11081&gt;`_: The :confval:`norecursedirs` check is now performed in a :hook:`pytest_ignore_collect` implementation, so plugins can affect it.

If after updating to this version you see that your `norecursedirs` setting is not being respected,
it means that a conftest or a plugin you use has a bad `pytest_ignore_collect` implementation.
Most likely, your hook returns `False` for paths it does not want to ignore,
which ends the processing and doesn&#x27;t allow other plugins, including pytest itself, to ignore the path.
The fix is to return `None` instead of `False` for paths your hook doesn&#x27;t want to ignore.


- `8711 &lt;https://github.com/pytest-dev/pytest/issues/8711&gt;`_: :func:`caplog.set_level() &lt;pytest.LogCaptureFixture.set_level&gt;` and :func:`caplog.at_level() &lt;pytest.LogCaptureFixture.at_level&gt;`
will temporarily enable the requested ``level`` if ``level`` was disabled globally via
``logging.disable(LEVEL)``.



Bug Fixes
---------

- `10831 &lt;https://github.com/pytest-dev/pytest/issues/10831&gt;`_: Terminal Reporting: Fixed bug when running in ``--tb=line`` mode where ``pytest.fail(pytrace=False)`` tests report ``None``.


- `11068 &lt;https://github.com/pytest-dev/pytest/issues/11068&gt;`_: Fixed the ``--last-failed`` whole-file skipping functionality (&quot;skipped N files&quot;) for :ref:`non-python test files &lt;non-python tests&gt;`.


- `11104 &lt;https://github.com/pytest-dev/pytest/issues/11104&gt;`_: Fixed a regression in pytest 7.3.2 which caused to :confval:`testpaths` to be considered for loading initial conftests,
even when it was not utilized (e.g. when explicit paths were given on the command line).
Now the ``testpaths`` are only considered when they are in use.


- `1904 &lt;https://github.com/pytest-dev/pytest/issues/1904&gt;`_: Fixed traceback entries hidden with ``__tracebackhide__ = True`` still being shown for chained exceptions (parts after &quot;... the above exception ...&quot; message).


- `7781 &lt;https://github.com/pytest-dev/pytest/issues/7781&gt;`_: Fix writing non-encodable text to log file when using ``--debug``.



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

- `9146 &lt;https://github.com/pytest-dev/pytest/issues/9146&gt;`_: Improved documentation for :func:`caplog.set_level() &lt;pytest.LogCaptureFixture.set_level&gt;`.



Trivial/Internal Changes
------------------------

- `11031 &lt;https://github.com/pytest-dev/pytest/issues/11031&gt;`_: Enhanced the CLI flag for ``-c`` to now include ``--config-file`` to make it clear that this flag applies to the usage of a custom config file.

7.3.2

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

Bug Fixes
---------

- `10169 &lt;https://github.com/pytest-dev/pytest/issues/10169&gt;`_: Fix bug where very long option names could cause pytest to break with ``OSError: [Errno 36] File name too long`` on some systems.


- `10894 &lt;https://github.com/pytest-dev/pytest/issues/10894&gt;`_: Support for Python 3.12 (beta at the time of writing).


- `10987 &lt;https://github.com/pytest-dev/pytest/issues/10987&gt;`_: :confval:`testpaths` is now honored to load root ``conftests``.


- `10999 &lt;https://github.com/pytest-dev/pytest/issues/10999&gt;`_: The `monkeypatch` `setitem`/`delitem` type annotations now allow `TypedDict` arguments.


- `11028 &lt;https://github.com/pytest-dev/pytest/issues/11028&gt;`_: Fixed bug in assertion rewriting where a variable assigned with the walrus operator could not be used later in a function call.


- `11054 &lt;https://github.com/pytest-dev/pytest/issues/11054&gt;`_: Fixed ``--last-failed``&#x27;s &quot;(skipped N files)&quot; functionality for files inside of packages (directories with `__init__.py` files).

7.3.1

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

Improvements
------------

- `10875 &lt;https://github.com/pytest-dev/pytest/issues/10875&gt;`_: Python 3.12 support: fixed ``RuntimeError: TestResult has no addDuration method`` when running ``unittest`` tests.


- `10890 &lt;https://github.com/pytest-dev/pytest/issues/10890&gt;`_: Python 3.12 support: fixed ``shutil.rmtree(onerror=...)`` deprecation warning when using :fixture:`tmp_path`.



Bug Fixes
---------

- `10896 &lt;https://github.com/pytest-dev/pytest/issues/10896&gt;`_: Fixed performance regression related to :fixture:`tmp_path` and the new :confval:`tmp_path_retention_policy` option.


- `10903 &lt;https://github.com/pytest-dev/pytest/issues/10903&gt;`_: Fix crash ``INTERNALERROR IndexError: list index out of range`` which happens when displaying an exception where all entries are hidden.
This reverts the change &quot;Correctly handle ``__tracebackhide__`` for chained exceptions.&quot; introduced in version 7.3.0.

7.3.0

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

Features
--------

- `10525 &lt;https://github.com/pytest-dev/pytest/issues/10525&gt;`_: Test methods decorated with ``classmethod`` can now be discovered as tests, following the same rules as normal methods. This fills the gap that static methods were discoverable as tests but not class methods.


- `10755 &lt;https://github.com/pytest-dev/pytest/issues/10755&gt;`_: :confval:`console_output_style` now supports ``progress-even-when-capture-no`` to force the use of the progress output even when capture is disabled. This is useful in large test suites where capture may have significant performance impact.


- `7431 &lt;https://github.com/pytest-dev/pytest/issues/7431&gt;`_: ``--log-disable`` CLI option added to disable individual loggers.


- `8141 &lt;https://github.com/pytest-dev/pytest/issues/8141&gt;`_: Added :confval:`tmp_path_retention_count` and :confval:`tmp_path_retention_policy` configuration options to control how directories created by the :fixture:`tmp_path` fixture are kept.



Improvements
------------

- `10226 &lt;https://github.com/pytest-dev/pytest/issues/10226&gt;`_: If multiple errors are raised in teardown, we now re-raise an ``ExceptionGroup`` of them instead of discarding all but the last.


- `10658 &lt;https://github.com/pytest-dev/pytest/issues/10658&gt;`_: Allow ``-p`` arguments to include spaces (eg: ``-p no:logging`` instead of
``-pno:logging``). Mostly useful in the ``addopts`` section of the configuration
file.


- `10710 &lt;https://github.com/pytest-dev/pytest/issues/10710&gt;`_: Added ``start`` and ``stop`` timestamps to ``TestReport`` objects.


- `10727 &lt;https://github.com/pytest-dev/pytest/issues/10727&gt;`_: Split the report header for ``rootdir``, ``config file`` and ``testpaths`` so each has its own line.


- `10840 &lt;https://github.com/pytest-dev/pytest/issues/10840&gt;`_: pytest should no longer crash on AST with pathological position attributes, for example testing AST produced by `Hylang &lt;https://github.com/hylang/hy&gt;__`.


- `6267 &lt;https://github.com/pytest-dev/pytest/issues/6267&gt;`_: The full output of a test is no longer truncated if the truncation message would be longer than
the hidden text. The line number shown has also been fixed.



Bug Fixes
---------

- `10743 &lt;https://github.com/pytest-dev/pytest/issues/10743&gt;`_: The assertion rewriting mechanism now works correctly when assertion expressions contain the walrus operator.


- `10765 &lt;https://github.com/pytest-dev/pytest/issues/10765&gt;`_: Fixed :fixture:`tmp_path` fixture always raising :class:`OSError` on ``emscripten`` platform due to missing :func:`os.getuid`.


- `1904 &lt;https://github.com/pytest-dev/pytest/issues/1904&gt;`_: Correctly handle ``__tracebackhide__`` for chained exceptions.
NOTE: This change was reverted in version 7.3.1.



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

- `10782 &lt;https://github.com/pytest-dev/pytest/issues/10782&gt;`_: Fixed the minimal example in :ref:`goodpractices`: ``pip install -e .`` requires a ``version`` entry

pyup-bot · 2024-02-01T18:28:10Z

Closing this in favor of #79

pyup-bot added 8 commits January 1, 2024 13:29

Update pip from 23.0.1 to 23.3.2

70e7865

Update wheel from 0.40.0 to 0.42.0

970e18b

Update pylint from 2.17.2 to 3.0.3

cfc95e5

Update tox from 4.4.11 to 4.11.4

7da48f6

Update coverage from 7.2.3 to 7.4.0

bca2274

Update sphinx from 5.3.0 to 7.2.6

052f48e

Update pytest from 7.2.2 to 7.4.4

bcc0ce6

Update pytest-mock from 3.10.0 to 3.12.0

0fc4b65

pyup-bot added the update pyup updates label Jan 1, 2024

pyup-bot assigned rnag Jan 1, 2024

pyup-bot mentioned this pull request Jan 1, 2024

Scheduled monthly dependency update for December #74

Closed

pyup-bot closed this Feb 1, 2024

rnag deleted the pyup/scheduled-update-2024-01-01 branch February 1, 2024 18:28

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Scheduled monthly dependency update for January #76

Scheduled monthly dependency update for January #76

pyup-bot commented Jan 1, 2024

pyup-bot commented Feb 1, 2024

Scheduled monthly dependency update for January #76

Scheduled monthly dependency update for January #76

Conversation

pyup-bot commented Jan 1, 2024

Update pip from 23.0.1 to 23.3.2.

23.3.2

23.3.1

23.3

23.2.1

23.2

23.1.2

23.1.1

23.1

Update wheel from 0.40.0 to 0.42.0.

Update pylint from 2.17.2 to 3.0.3.

Update tox from 4.4.11 to 4.11.4.

Update coverage from 7.2.3 to 7.4.0.

7.4.0

7.3.4

7.3.3

7.3.2

7.3.1

7.3.0

7.2.7

7.2.6

7.2.5

7.2.4

Update Sphinx from 5.3.0 to 7.2.6.

7.2.6

7.2.5

7.2.4

7.2.3

7.2.2

7.2.1

7.2.0

7.1.2

7.1.1

7.1.0

7.0.1

7.0.0

6.2.1

6.2.0

6.1.3

6.1.2

6.1.1

6.1.0

6.0.1

6.0.0

Update pytest from 7.2.2 to 7.4.4.

7.4.4

7.4.3

7.4.2

7.4.1

7.4.0

7.3.2

7.3.1

7.3.0

pyup-bot commented Feb 1, 2024