Scheduled monthly dependency update for March #112

pyup-bot · 2024-03-01T18:25:09Z

Update tox from 3.24.5 to 4.13.0.

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://data.safetycli.com/changelogs/tox/

Update wheel from 0.37.1 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 watchdog[watchmedo] from 2.1.6 to 4.0.0.

Changelog

4.0.0

- Drop support for Python 3.7.
- Add support for Python 3.12.
- [snapshot] Add typing to `dirsnapshot` (1012)
- [snapshot] Added `DirectorySnapshotDiff.ContextManager` (1011)
- [events] `FileSystemEvent`, and subclasses, are now `dataclass`es, and their `repr()` has changed
- [windows] `WinAPINativeEvent` is now a `dataclass`, and its `repr()` has changed
- [events] Log `FileOpenedEvent`, and `FileClosedEvent`, events in `LoggingEventHandler`
- [tests] Improve `FileSystemEvent` coverage
- [watchmedo] Log all events in `LoggerTrick``
- [windows] The `observers.read_directory_changes.WATCHDOG_TRAVERSE_MOVED_DIR_DELAY` hack was removed. The constant will be kept to prevent breaking other softwares.
- Thanks to our beloved contributors: BoboTiG, msabramo

3.0.0

- Drop support for Python 3.6.
- `watchdog` is now PEP 561 compatible, and tested with `mypy`
- Fix missing `&gt;` in `FileSystemEvent.__repr__()` (980)
- [ci] Lots of improvements
- [inotify] Return from `InotifyEmitter.queue_events()` if not launched when thread is inactive (963)
- [tests] Stability improvements
- [utils] Remove handling of `threading.Event.isSet` spelling (962)
- [watchmedo] Fixed tricks YAML generation (965)

:heart_decoration:  Thanks to our beloved contributors: kurtmckee, altendky, agroszer, BoboTiG

2.3.1

- Run `black` on the entire source code
- Bundle the `requirements-tests.txt` file in the source distribution (939)
- [watchmedo] Exclude `FileOpenedEvent` events from `AutoRestartTrick`, and `ShellCommandTrick`, to restore watchdog &lt; 2.3.0 behavior. A better solution should be found in the future. (949)
- [watchmedo] Log `FileOpenedEvent`, and `FileClosedEvent`, events in `LoggerTrick`

:heart_decoration:  Thanks to our beloved contributors: BoboTiG

2.3.0

- [inotify] Add support for `IN_OPEN` events: a `FileOpenedEvent` event will be fired (941)
- [watchmedo] Add optional event debouncing for `auto-restart`, only restarting once if many events happen in quick succession (`--debounce-interval`) (940)
- [watchmedo] Add option to not auto-restart the command after it exits (`--no-restart-on-command-exit`) (946)
- [watchmedo] Exit gracefully on `KeyboardInterrupt` exception (Ctrl+C) (945)

:heart_decoration:  Thanks to our beloved contributors: BoboTiG, dstaple, taleinat, cernekj

2.2.1

- Enable mypy to discover type hints as specified in PEP 561 (933)
- [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)

:heart_decoration:  Thanks to our beloved contributors: BoboTiG, simon04, piotrpdev

2.2.0

- [build] Wheels are now available for Python 3.11 (932)
- [documentation] HTML documentation builds are now tested for errors (902)
- [documentation] Fix typos here, and there (910)
- [fsevents2] The `fsevents2` observer is now deprecated (909)
- [tests] The error message returned by musl libc for error code `-1` is now allowed (923)
- [utils] Remove unnecessary code in `dirsnapshot.py` (930)
- [watchmedo] Handle shutdown events from `SIGHUP` (912)

:heart_decoration:  Thanks to our beloved contributors: kurtmckee, babymastodon, QuantumEnergyE, timgates42, BoboTiG

2.1.9

- [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
- [watchmedo] Make `auto-restart` restart the sub-process if it terminates. 896
- [watchmedo] Avoid zombie sub-processes when running `shell-command` without `--wait`. 405

:heart_decoration: Thanks to our beloved contributors: samschott, taleinat, altendky, BoboTiG

2.1.8

- Fix adding failed emitters on observer schedule. (872)
- [inotify] Fix hang when unscheduling watch on a path in an unmounted filesystem. (869)
- [watchmedo] Fix broken parsing of `--kill-after` argument for the auto-restart command. (870)
- [watchmedo] Fix broken parsing of boolean arguments. (887)
- [watchmedo] Fix broken parsing of commands from auto-restart, and shell-command. (888)
- [watchmedo] Support setting verbosity level via `-q/--quiet` and `-v/--verbose` arguments. (889)

:heart_decoration: Thanks to our beloved contributors: taleinat, kianmeng, palfrey, IlayRosenberg, BoboTiG

2.1.7

- Eliminate timeout in waiting on event queue. (861)
- [inotify] Fix `not` equality implementation for `InotifyEvent`. (848)
- [watchmedo] Fix calling commands from within a Python script. (879)
- [watchmedo] `PyYAML` is loaded only when strictly necessary. Simple usages of `watchmedo` are possible without the module being installed. (847)

:heart_decoration: Thanks to our beloved contributors: sattlerc, JanzenLiu, BoboTiG

Links

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

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 twine from 3.8.0 to 5.0.0.

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

Links

PyPI: https://pypi.org/project/twine
Docs: https://twine.readthedocs.io/

Update pytest from 7.0.1 to 8.0.2.

Changelog

8.0.2

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

Bug Fixes
---------

- `11895 &lt;https://github.com/pytest-dev/pytest/issues/11895&gt;`_: Fix collection on Windows where initial paths contain the short version of a path (for example ``c:\PROGRA~1\tests``).


- `11953 &lt;https://github.com/pytest-dev/pytest/issues/11953&gt;`_: Fix an ``IndexError`` crash raising from ``getstatementrange_ast``.


- `12021 &lt;https://github.com/pytest-dev/pytest/issues/12021&gt;`_: Reverted a fix to `--maxfail` handling in pytest 8.0.0 because it caused a regression in pytest-xdist whereby session fixture teardowns may get executed multiple times when the max-fails is reached.

8.0.1

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

Bug Fixes
---------

- `11875 &lt;https://github.com/pytest-dev/pytest/issues/11875&gt;`_: Correctly handle errors from :func:`getpass.getuser` in Python 3.13.


- `11879 &lt;https://github.com/pytest-dev/pytest/issues/11879&gt;`_: Fix an edge case where ``ExceptionInfo._stringify_exception`` could crash :func:`pytest.raises`.


- `11906 &lt;https://github.com/pytest-dev/pytest/issues/11906&gt;`_: Fix regression with :func:`pytest.warns` using custom warning subclasses which have more than one parameter in their `__init__`.


- `11907 &lt;https://github.com/pytest-dev/pytest/issues/11907&gt;`_: Fix a regression in pytest 8.0.0 whereby calling :func:`pytest.skip` and similar control-flow exceptions within a :func:`pytest.warns()` block would get suppressed instead of propagating.


- `11929 &lt;https://github.com/pytest-dev/pytest/issues/11929&gt;`_: Fix a regression in pytest 8.0.0 whereby autouse fixtures defined in a module get ignored by the doctests in the module.


- `11937 &lt;https://github.com/pytest-dev/pytest/issues/11937&gt;`_: Fix a regression in pytest 8.0.0 whereby items would be collected in reverse order in some circumstances.

8.0.0

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

Bug Fixes
---------

- `11842 &lt;https://github.com/pytest-dev/pytest/issues/11842&gt;`_: Properly escape the ``reason`` of a :ref:`skip &lt;pytest.mark.skip ref&gt;` mark when writing JUnit XML files.


- `11861 &lt;https://github.com/pytest-dev/pytest/issues/11861&gt;`_: Avoid microsecond exceeds ``1_000_000`` when using ``log-date-format`` with ``%f`` specifier, which might cause the test suite to crash.

8.0.0rc2

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


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

- `11233 &lt;https://github.com/pytest-dev/pytest/issues/11233&gt;`_: Improvements to ``-r`` for xfailures and xpasses:

* Report tracebacks for xfailures when ``-rx`` is set.
* Report captured output for xpasses when ``-rX`` is set.
* For xpasses, add ``-`` in summary between test name and reason, to match how xfail is displayed.

- `11825 &lt;https://github.com/pytest-dev/pytest/issues/11825&gt;`_: The :hook:`pytest_plugin_registered` hook has a new ``plugin_name`` parameter containing the name by which ``plugin`` is registered.


Bug Fixes
---------

- `11706 &lt;https://github.com/pytest-dev/pytest/issues/11706&gt;`_: Fix reporting of teardown errors in higher-scoped fixtures when using `--maxfail` or `--stepwise`.

NOTE: This change was reverted in pytest 8.0.2 to fix a `regression &lt;https://github.com/pytest-dev/pytest-xdist/issues/1024&gt;`_ it caused in pytest-xdist.


- `11758 &lt;https://github.com/pytest-dev/pytest/issues/11758&gt;`_: Fixed ``IndexError: string index out of range`` crash in ``if highlighted[-1] == &quot;\n&quot; and source[-1] != &quot;\n&quot;``.
This bug was introduced in pytest 8.0.0rc1.


- `9765 &lt;https://github.com/pytest-dev/pytest/issues/9765&gt;`_, `#11816 &lt;https://github.com/pytest-dev/pytest/issues/11816&gt;`_: Fixed a frustrating bug that afflicted some users with the only error being ``assert mod not in mods``. The issue was caused by the fact that ``str(Path(mod))`` and ``mod.__file__`` don&#x27;t necessarily produce the same string, and was being erroneously used interchangably in some places in the code.

This fix also broke the internal API of ``PytestPluginManager.consider_conftest`` by introducing a new parameter -- we mention this in case it is being used by external code, even if marked as *private*.

8.0.0rc1

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

Breaking Changes
----------------

Old Deprecations Are Now Errors
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

- `7363 &lt;https://github.com/pytest-dev/pytest/issues/7363&gt;`_: **PytestRemovedIn8Warning deprecation warnings are now errors by default.**

Following our plan to remove deprecated features with as little disruption as
possible, all warnings of type ``PytestRemovedIn8Warning`` now generate errors
instead of warning messages by default.

**The affected features will be effectively removed in pytest 8.1**, so please consult the
:ref:`deprecations` section in the docs for directions on how to update existing code.

In the pytest ``8.0.X`` series, it is possible to change the errors back into warnings as a
stopgap measure by adding this to your ``pytest.ini`` file:

.. code-block:: ini

   [pytest]
   filterwarnings =
       ignore::pytest.PytestRemovedIn8Warning

But this will stop working when pytest ``8.1`` is released.

**If you have concerns** about the removal of a specific feature, please add a
comment to :issue:`7363`.


Version Compatibility
^^^^^^^^^^^^^^^^^^^^^

- `11151 &lt;https://github.com/pytest-dev/pytest/issues/11151&gt;`_: Dropped support for Python 3.7, which `reached end-of-life on 2023-06-27 &lt;https://devguide.python.org/versions/&gt;`__.


- ``pluggy&gt;=1.3.0`` is now required.


Collection Changes
^^^^^^^^^^^^^^^^^^

In this version we&#x27;ve made several breaking changes to pytest&#x27;s collection phase,
particularly around how filesystem directories and Python packages are collected,
fixing deficiencies and allowing for cleanups and improvements to pytest&#x27;s internals.
A deprecation period for these changes was not possible.


- `7777 &lt;https://github.com/pytest-dev/pytest/issues/7777&gt;`_: Files and directories are now collected in alphabetical order jointly, unless changed by a plugin.
Previously, files were collected before directories.
See below for an example.


- `8976 &lt;https://github.com/pytest-dev/pytest/issues/8976&gt;`_: Running `pytest pkg/__init__.py` now collects the `pkg/__init__.py` file (module) only.
Previously, it collected the entire `pkg` package, including other test files in the directory, but excluding tests in the `__init__.py` file itself
(unless :confval:`python_files` was changed to allow `__init__.py` file).

To collect the entire package, specify just the directory: `pytest pkg`.


- `11137 &lt;https://github.com/pytest-dev/pytest/issues/11137&gt;`_: :class:`pytest.Package` is no longer a :class:`pytest.Module` or :class:`pytest.File`.

The ``Package`` collector node designates a Python package, that is, a directory with an `__init__.py` file.
Previously ``Package`` was a subtype of ``pytest.Module`` (which represents a single Python module),
the module being the `__init__.py` file.
This has been deemed a design mistake (see :issue:`11137` and :issue:`7777` for details).

The ``path`` property of ``Package`` nodes now points to the package directory instead of the ``__init__.py`` file.

Note that a ``Module`` node for ``__init__.py`` (which is not a ``Package``) may still exist,
if it is picked up during collection (e.g. if you configured :confval:`python_files` to include ``__init__.py`` files).


- `7777 &lt;https://github.com/pytest-dev/pytest/issues/7777&gt;`_: Added a new :class:`pytest.Directory` base collection node, which all collector nodes for filesystem directories are expected to subclass.
This is analogous to the existing :class:`pytest.File` for file nodes.

Changed :class:`pytest.Package` to be a subclass of :class:`pytest.Directory`.
A ``Package`` represents a filesystem directory which is a Python package,
i.e. contains an ``__init__.py`` file.

:class:`pytest.Package` now only collects files in its own directory; previously it collected recursively.
Sub-directories are collected as their own collector nodes, which then collect themselves, thus creating a collection tree which mirrors the filesystem hierarchy.

Added a new :class:`pytest.Dir` concrete collection node, a subclass of :class:`pytest.Directory`.
This node represents a filesystem directory, which is not a :class:`pytest.Package`,
that is, does not contain an ``__init__.py`` file.
Similarly to ``Package``, it only collects the files in its own directory.

:class:`pytest.Session` now only collects the initial arguments, without recursing into directories.
This work is now done by the :func:`recursive expansion process &lt;pytest.Collector.collect&gt;` of directory collector nodes.

:attr:`session.name &lt;pytest.Session.name&gt;` is now ``&quot;&quot;``; previously it was the rootdir directory name.
This matches :attr:`session.nodeid &lt;_pytest.nodes.Node.nodeid&gt;` which has always been `&quot;&quot;`.

The collection tree now contains directories/packages up to the :ref:`rootdir &lt;rootdir&gt;`,
for initial arguments that are found within the rootdir.
For files outside the rootdir, only the immediate directory/package is collected --
note however that collecting from outside the rootdir is discouraged.

As an example, given the following filesystem tree::

   myroot/
       pytest.ini
       top/
       ├── aaa
       │   └── test_aaa.py
       ├── test_a.py
       ├── test_b
       │   ├── __init__.py
       │   └── test_b.py
       ├── test_c.py
       └── zzz
           ├── __init__.py
           └── test_zzz.py

the collection tree, as shown by `pytest --collect-only top/` but with the otherwise-hidden :class:`~pytest.Session` node added for clarity,
is now the following::

   &lt;Session&gt;
     &lt;Dir myroot&gt;
       &lt;Dir top&gt;
         &lt;Dir aaa&gt;
           &lt;Module test_aaa.py&gt;
             &lt;Function test_it&gt;
         &lt;Module test_a.py&gt;
           &lt;Function test_it&gt;
         &lt;Package test_b&gt;
           &lt;Module test_b.py&gt;
             &lt;Function test_it&gt;
         &lt;Module test_c.py&gt;
           &lt;Function test_it&gt;
         &lt;Package zzz&gt;
           &lt;Module test_zzz.py&gt;
             &lt;Function test_it&gt;

Previously, it was::

   &lt;Session&gt;
     &lt;Module top/test_a.py&gt;
       &lt;Function test_it&gt;
     &lt;Module top/test_c.py&gt;
       &lt;Function test_it&gt;
     &lt;Module top/aaa/test_aaa.py&gt;
       &lt;Function test_it&gt;
     &lt;Package test_b&gt;
       &lt;Module test_b.py&gt;
         &lt;Function test_it&gt;
     &lt;Package zzz&gt;
       &lt;Module test_zzz.py&gt;
         &lt;Function test_it&gt;

Code/plugins which rely on a specific shape of the collection tree might need to update.


- `11676 &lt;https://github.com/pytest-dev/pytest/issues/11676&gt;`_: The classes :class:`~_pytest.nodes.Node`, :class:`~pytest.Collector`, :class:`~pytest.Item`, :class:`~pytest.File`, :class:`~_pytest.nodes.FSCollector` are now marked abstract (see :mod:`abc`).

We do not expect this change to affect users and plugin authors, it will only cause errors when the code is already wrong or problematic.


Other breaking changes
^^^^^^^^^^^^^^^^^^^^^^

These are breaking changes where deprecation was not possible.


- `11282 &lt;https://github.com/pytest-dev/pytest/issues/11282&gt;`_: Sanitized the handling of the ``default`` parameter when defining configuration options.

Previously if ``default`` was not supplied for :meth:`parser.addini &lt;pytest.Parser.addini&gt;` and the configuration option value was not defined in a test session, then calls to :func:`config.getini &lt;pytest.Config.getini&gt;` returned an *empty list* or an *empty string* depending on whether ``type`` was supplied or not respectively, which is clearly incorrect. Also, ``None`` was not honored even if ``default=None`` was used explicitly while defining the option.

Now the behavior of :meth:`parser.addini &lt;pytest.Parser.addini&gt;` is as follows:

* If ``default`` is NOT passed but ``type`` is provided, then a type-specific default will be returned. For example ``type=bool`` will return ``False``, ``type=str`` will return ``&quot;&quot;``, etc.
* If ``default=None`` is passed and the option is not defined in a test session, then ``None`` will be returned, regardless of the ``type``.
* If neither ``default`` nor ``type`` are provided, assume ``type=str`` and return ``&quot;&quot;`` as default (this is as per previous behavior).

The team decided to not introduce a deprecation period for this change, as doing so would be complicated both in terms of communicating this to the community as well as implementing it, and also because the team believes this change should not break existing plugins except in rare cases.


- `11667 &lt;https://github.com/pytest-dev/pytest/issues/11667&gt;`_: pytest&#x27;s ``setup.py`` file is removed.
If you relied on this file, e.g. to install pytest using ``setup.py install``,
please see `Why you shouldn&#x27;t invoke setup.py directly &lt;https://blog.ganssle.io/articles/2021/10/setup-py-deprecated.html#summary&gt;`_ for alternatives.


- `9288 &lt;https://github.com/pytest-dev/pytest/issues/9288&gt;`_: :func:`~pytest.warns` now re-emits unmatched warnings when the context
closes -- previously it would consume all warnings, hiding those that were not
matched by the function.

While this is a new feature, we announce it as a breaking change
because many test suites are configured to error-out on warnings, and will
therefore fail on the newly-re-emitted warnings.


- The internal ``FixtureManager.getfixtureclosure`` method has changed. Plugins which use this method or
which subclass ``FixtureManager`` and overwrite that method will need to adapt to the change.



Deprecations
------------

- `10465 &lt;https://github.com/pytest-dev/pytest/issues/10465&gt;`_: Test functions returning a value other than ``None`` will now issue a :class:`pytest.PytestWarning` instead of ``pytest.PytestRemovedIn8Warning``, meaning this will stay a warning instead of becoming an error in the future.


- `3664 &lt;https://github.com/pytest-dev/pytest/issues/3664&gt;`_: Applying a mark to a fixture function now issues a warning: marks in fixtures never had any effect, but it is a common user error to apply a mark to a fixture (for example ``usefixtures``) and expect it to work.

This will become an error in pytest 9.0.



Features and Improvements
-------------------------

Improved Diffs
^^^^^^^^^^^^^^

These changes improve the diffs that pytest prints when an assertion fails.
Note that syntax highlighting requires the ``pygments`` package.


- `11520 &lt;https://github.com/pytest-dev/pytest/issues/11520&gt;`_: The very verbose (``-vv``) diff output is now colored as a diff instead of a big chunk of red.

Python code in error reports is now syntax-highlighted as Python.

The sections in the error reports are now better separated.


- `1531 &lt;https://github.com/pytest-dev/pytest/issues/1531&gt;`_: The very verbose diff (``-vv``) for every standard library container type is improved. The indentation is now consistent and the markers are on their own separate lines, which should reduce the diffs shown to users.

Previously, the standard Python pretty printer was used to generate the output, which puts opening and closing
markers on the same line as the first/last entry, in addition to not having consistent indentation.


- `10617 &lt;https://github.com/pytest-dev/pytest/issues/10617&gt;`_: Added more comprehensive set assertion rewrites for comparisons other than equality ``==``, with
the following operations now providing better failure messages: ``!=``, ``&lt;=``, ``&gt;=``, ``&lt;``, and ``&gt;``.


Separate Control For Assertion Verbosity
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

- `11387 &lt;https://github.com/pytest-dev/pytest/issues/11387&gt;`_: Added the new :confval:`verbosity_assertions` configuration option for fine-grained control of failed assertions verbosity.

If you&#x27;ve ever wished that pytest always show you full diffs, but without making everything else verbose, this is for you.

See :ref:`Fine-grained verbosity &lt;pytest.fine_grained_verbosity&gt;` for more details.

For plugin authors, :attr:`config.get_verbosity &lt;pytest.Config.get_verbosity&gt;` can be used to retrieve the verbosity level for a specific verbosity type.


Additional Support For Exception Groups and ``__notes__``
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

These changes improve pytest&#x27;s support for exception groups.


- `10441 &lt;https://github.com/pytest-dev/pytest/issues/10441&gt;`_: Added :func:`ExceptionInfo.group_contains() &lt;pytest.ExceptionInfo.group_contains&gt;`, an assertion helper that tests if an :class:`ExceptionGroup` contains a matching exception.

See :ref:`assert-matching-exception-groups` for an example.


- `11227 &lt;https://github.com/pytest-dev/pytest/issues/11227&gt;`_: Allow :func:`pytest.raises` ``match`` argument to match against `PEP-678 &lt;https://peps.python.org/pep-0678/&gt;` ``__notes__``.


Custom Directory collectors
^^^^^^^^^^^^^^^^^^^^^^^^^^^

- `7777 &lt;https://github.com/pytest-dev/pytest/issues/7777&gt;`_: Added a new hook :hook:`pytest_collect_directory`,
which is called by filesystem-traversing collector nodes,
such as :class:`pytest.Session`, :class:`pytest.Dir` and :class:`pytest.Package`,
to create a collector node for a sub-directory.
It is expected to return a subclass of :class:`pytest.Directory`.
This hook allows plugins to :ref:`customize the collection of directories &lt;custom directory collectors&gt;`.


&quot;New-style&quot; Hook Wrappers
^^^^^^^^^^^^^^^^^^^^^^^^^

- `11122 &lt;https://github.com/pytest-dev/pytest/issues/11122&gt;`_: pytest now uses &quot;new-style&quot; hook wrappers internally, available since pluggy 1.2.0.
See `pluggy&#x27;s 1.2.0 changelog &lt;https://pluggy.readthedocs.io/en/latest/changelog.html#pluggy-1-2-0-2023-06-21&gt;`_ and the :ref:`updated docs &lt;hookwrapper&gt;` for details.

Plugins which want to use new-style wrappers can do so if they require ``pytest&gt;=8``.


Other Improvements
^^^^^^^^^^^^^^^^^^

- `11216 &lt;https://github.com/pytest-dev/pytest/issues/11216&gt;`_: If a test is skipped from inside an :ref:`xunit setup fixture &lt;classic xunit&gt;`, the test summary now shows the test location instead of the fixture location.


- `11314 &lt;https://github.com/pytest-dev/pytest/issues/11314&gt;`_: Logging to a file using the ``--log-file`` option will use ``--log-level``, ``--log-format`` and ``--log-date-format`` as fallback
if ``--log-file-level``, ``--log-file-format`` and ``--log-file-date-format`` are not provided respectively.


- `11610 &lt;https://github.com/pytest-dev/pytest/issues/11610&gt;`_: Added the :func:`LogCaptureFixture.filtering() &lt;pytest.LogCaptureFixture.filtering&gt;` context manager which
adds a given :class:`logging.Filter` object to the :fixture:`caplog` fixture.


- `11447 &lt;https://github.com/pytest-dev/pytest/issues/11447&gt;`_: :func:`pytest.deprecated_call` now also considers warnings of type :class:`FutureWarning`.


- `11600 &lt;https://github.com/pytest-dev/pytest/issues/11600&gt;`_: Improved the documentation and type signature for :func:`pytest.mark.xfail &lt;pytest.mark.xfail&gt;`&#x27;s ``condition`` param to use ``False`` as the default value.


- `7469 &lt;https://github.com/pytest-dev/pytest/issues/7469&gt;`_: :class:`~pytest.FixtureDef` is now exported as ``pytest.FixtureDef`` for typing purposes.


- `11353 &lt;https://github.com/pytest-dev/pytest/issues/11353&gt;`_: Added typing to :class:`~pytest.PytestPluginManager`.


Bug Fixes
---------

- `10701 &lt;https://github.com/pytest-dev/pytest/issues/10701&gt;`_: :meth:`pytest.WarningsRecorder.pop` will return the most-closely-matched warning in the list,
rather than the first warning which is an instance of the requested type.


- `11255 &lt;https://github.com/pytest-dev/pytest/issues/11255&gt;`_: Fixed crash on `parametrize(..., scope=&quot;package&quot;)` without a package present.


- `11277 &lt;https://github.com/pytest-dev/pytest/issues/11277&gt;`_: Fixed a bug that when there are multiple fixtures for an indirect parameter,
the scope of the highest-scope fixture is picked for the parameter set, instead of that of the one with the narrowest scope.


- `11456 &lt;https://github.com/pytest-dev/pytest/issues/11456&gt;`_: Parametrized tests now *really do* ensure that the ids given to each input are unique - for
example, ``a, a, a0`` now results in ``a1, a2, a0`` instead of the previous (buggy) ``a0, a1, a0``.
This necessarily means changing nodeids where these were previously colliding, and for
readability adds an underscore when non-unique ids end in a number.


- `11563 &lt;https://github.com/pytest-dev/pytest/issues/11563&gt;`_: Fixed a crash when using an empty string for the same parametrized value more than once.


- `11712 &lt;https://github.com/pytest-dev/pytest/issues/11712&gt;`_: Fixed handling ``NO_COLOR`` and ``FORCE_COLOR`` to ignore an empty value.


- `9036 &lt;https://github.com/pytest-dev/pytest/issues/9036&gt;`_: ``pytest.warns`` and similar functions now capture warnings when an exception is raised inside a ``with`` block.



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

- `11011 &lt;https://github.com/pytest-dev/pytest/issues/11011&gt;`_: Added a warning about modifying the root logger during tests when using ``caplog``.


- `11065 &lt;https://github.com/pytest-dev/pytest/issues/11065&gt;`_: Use ``pytestconfig`` instead of ``request.config`` in cache example to be consistent with the API documentation.


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

- `11208 &lt;https://github.com/pytest-dev/pytest/issues/11208&gt;`_: The (internal) ``FixtureDef.cached_result`` type has changed.
Now the third item ``cached_result[2]``, when set, is an exception instance instead of an exception triplet.


- `11218 &lt;https://github.com/pytest-dev/pytest/issues/11218&gt;`_: (This entry is meant to assist plugins which access private pytest internals to instantiate ``FixtureRequest`` objects.)

:class:`~pytest.FixtureRequest` is now an abstract class which can&#x27;t be instantiated directly.
A new concrete ``TopRequest`` subclass of ``FixtureRequest`` has been added for the ``request`` fixture in test functions,
as counterpart to the existing ``SubRequest`` subclass for the ``request`` fixture in fixture functions.


- `11315 &lt;https://github.com/pytest-dev/pytest/issues/11315&gt;`_: The :fixture:`pytester` fixture now uses the :fixture:`monkeypatch` fixture to manage the current working directory.
If you use ``pytester`` in combination with :func:`monkeypatch.undo() &lt;pytest.MonkeyPatch.undo&gt;`, the CWD might get restored.
Use :func:`monkeypatch.context() &lt;pytest.MonkeyPatch.context&gt;` instead.


- `11333 &lt;https://github.com/pytest-dev/pytest/issues/11333&gt;`_: Corrected the spelling of ``Config.ArgsSource.INVOCATION_DIR``.
The previous spelling ``INCOVATION_DIR`` remains as an alias.


- `11638 &lt;https://github.com/pytest-dev/pytest/issues/11638&gt;`_: Fixed the selftests to pass correctly if ``FORCE_COLOR``, ``NO_COLOR`` or ``PY_COLORS`` is set in the calling environment.

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

pyup-bot · 2024-04-01T18:23:13Z

Closing this in favor of #113

pyup-bot added 10 commits March 1, 2024 13:25

Update tox from 3.24.5 to 4.13.0

c6940c9

Update wheel from 0.37.1 to 0.42.0

aa1a7a9

Update watchdog from 2.1.6 to 4.0.0

2198ebc

Update sphinx from 5.3.0 to 7.2.6

71d48e0

Update twine from 3.8.0 to 5.0.0

1b4f405

Update pytest from 7.0.1 to 8.0.2

5e3b57b

Update pytest-cov from 3.0.0 to 4.1.0

e68401e

Update dataclasses-json from 0.5.6 to 0.6.4

8b372ff

Update jsons from 1.6.1 to 1.6.3

07c51fa

Update sphinx-issues from 3.0.1 to 4.0.0

de1ffcb

pyup-bot added the update label Mar 1, 2024

pyup-bot assigned rnag Mar 1, 2024

pyup-bot mentioned this pull request Mar 1, 2024

Scheduled monthly dependency update for February #110

Closed

pyup-bot closed this Apr 1, 2024

rnag deleted the pyup/scheduled-update-2024-03-01 branch April 1, 2024 18:23

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Scheduled monthly dependency update for March #112

Scheduled monthly dependency update for March #112

pyup-bot commented Mar 1, 2024

pyup-bot commented Apr 1, 2024

Scheduled monthly dependency update for March #112

Scheduled monthly dependency update for March #112

Conversation

pyup-bot commented Mar 1, 2024

Update tox from 3.24.5 to 4.13.0.

3.28.0

3.27.1

3.27.0

3.26.0

3.25.1

3.25.0

Update wheel from 0.37.1 to 0.42.0.

Update watchdog[watchmedo] from 2.1.6 to 4.0.0.

4.0.0

3.0.0

2.3.1

2.3.0

2.2.1

2.2.0

2.1.9

2.1.8

2.1.7

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 twine from 3.8.0 to 5.0.0.

Update pytest from 7.0.1 to 8.0.2.

8.0.2

8.0.1

8.0.0

8.0.0rc2

8.0.0rc1

7.4.4

7.4.3

7.4.2

7.4.1

7.4.0

pyup-bot commented Apr 1, 2024