Skip to content

Scheduled weekly dependency update for week 45 #632

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
pyup-bot wants to merge 12 commits into from
Closed

Scheduled weekly dependency update for week 45 #632

pyup-bot wants to merge 12 commits into from
+12 −12

Conversation

@pyup-bot
Copy link
Collaborator

@pyup-bot pyup-bot commented Nov 10, 2025

Update sphinx from 7.3.7 to 8.3.0.

Changelog

8.3.0

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

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

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

Deprecated
----------

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

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

Testing
-------
Links

Update furo from 2024.5.6 to 2025.9.25.

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

Links

Update sphinx-autobuild from 2024.4.16 to 2025.8.25.

Changelog

2025.08.25

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

* Drop support for Python 3.9-3.10 to match Sphinx.
* Declare support for Python 3.14.
* Add an optional ``--post-build`` flag to run additional commands
after building the documentation.
* Add support for the ``SPHINX_AUTOBUILD_DEBUG`` environment variable
to help with debugging.

2024.10.03

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

* Improve error handling for failures in pre-build commands.

2024.10.02

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

* Show the changed paths that triggered the rebuild.

2024.09.19

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

* Fix path filtering on Windows by normalising path separators.
* Filter various directories by default (``.git``, ``venv``, etc).
* Serve the correct directory when using make mode (``-M``).

2024.09.18

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

* Run Sphinx through the Python entry point rather than the binary on PATH.

2024.09.17

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

* Relax checks for paths that aren't required to exist.

2024.09.03

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

* Fix support for Python 3.9.
* Fix running ``sphinx-autobuild`` via entry point scripts.
* Run ``sphinx-build`` in a subprocess to mitigate autdoc issues.
* Support the ``-M`` 'make mode' option for ``sphinx-build``.
Links

Update sphinx-sitemap from 2.6.0 to 2.9.0.

Changelog

2.9.0

-----

- |:sparkles:| NEW: Add :confval:`sitemap_indent` configuration value to control XML indentation
`112 <https://github.com/jdillard/sphinx-sitemap/pull/112>`_

2.8.0

-----

- |:sparkles:| NEW: Add support for wildcard patterns to :confval:`sitemap_excludes`
`113 <https://github.com/jdillard/sphinx-sitemap/pull/113>`_

2.7.2

-----

*Release date: 2025-06-26*

- |:bug:| FIX: Change :confval:`sitemap_show_lastmod` to default of ``False``

2.7.1

-----

*Release date: 2025-06-20*

- Remove support for Python 3.8

2.7.0

-----

*Release date: 2025-06-20*

* |:sparkles:| NEW: Add support for ``lastmod`` using `sphinx-last-updated-by-git`_
`95 <https://github.com/jdillard/sphinx-sitemap/pull/95>`_
Links

Update sphinx-click from 5.0.1 to 6.1.0.

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

Links

Update sphinx-autodoc-typehints from 2.3.0 to 3.5.2.

Changelog

3.5.2

<!-- Release notes generated using configuration in .github/release.yml at main -->

What's Changed
* Preserve type information from docstrings if no type annotation is present and parameter has default value. by christianaguilera-foundry in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/576

New Contributors
* christianaguilera-foundry made their first contribution in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/576

**Full Changelog**: https://github.com/tox-dev/sphinx-autodoc-typehints/compare/3.5.1...3.5.2

3.5.1

<!-- Release notes generated using configuration in .github/release.yml at main -->

What's Changed
* Declare 3.14 support by gaborbernat in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/571


**Full Changelog**: https://github.com/tox-dev/sphinx-autodoc-typehints/compare/3.5.0...3.5.1

3.5.0

<!-- Release notes generated using configuration in .github/release.yml at main -->

What's Changed
* Support Union type on its own by gaborbernat in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/570


**Full Changelog**: https://github.com/tox-dev/sphinx-autodoc-typehints/compare/3.4.0...3.5.0

3.4.0

<!-- Release notes generated using configuration in .github/release.yml at main -->

What's Changed
* Python 3.14 support by gaborbernat in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/569


**Full Changelog**: https://github.com/tox-dev/sphinx-autodoc-typehints/compare/3.3.0...3.4.0

3.3.0

<!-- Release notes generated using configuration in .github/release.yml at main -->

What's Changed

* Warning types and subtypes by fajpunk in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/562

New Contributors
* fajpunk made their first contribution in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/562

**Full Changelog**: https://github.com/tox-dev/sphinx-autodoc-typehints/compare/3.2.0...3.3.0

3.2.0

<!-- Release notes generated using configuration in .github/release.yml at main -->

What's Changed
* Fixed broken changelog link by agronholm in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/530
* Fix issue 481 by nineteendo in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/533
* Don't add :rtype: None by grayjk in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/538
* Place rtype after directive by grayjk in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/537

New Contributors
* agronholm made their first contribution in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/530
* nineteendo made their first contribution in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/533
* grayjk made their first contribution in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/538

**Full Changelog**: https://github.com/tox-dev/sphinx-autodoc-typehints/compare/3.1.0...3.2.0

3.1.0

<!-- Release notes generated using configuration in .github/release.yml at main -->

What's Changed
* Support Sphinx 8.2.0 - drop 3.10 support because Sphinx does by b-kamphorst in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/525

New Contributors
* b-kamphorst made their first contribution in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/525

**Full Changelog**: https://github.com/tox-dev/sphinx-autodoc-typehints/compare/3.0.1...3.1.0

3.0.1

<!-- Release notes generated using configuration in .github/release.yml at main -->

What's Changed
* Fix roles for `types` module by flying-sheep in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/516
* Update Ruff to 0.9.1 by flying-sheep in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/517


**Full Changelog**: https://github.com/tox-dev/sphinx-autodoc-typehints/compare/3.0.0...3.0.1

3.0.0

<!-- Release notes generated using configuration in .github/release.yml at main -->

What's Changed
* 🐛 Replace docutils private API use w/ public by webknjaz in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/507
* Drop support for nptyping by gaborbernat in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/514

New Contributors
* webknjaz made their first contribution in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/507

**Full Changelog**: https://github.com/tox-dev/sphinx-autodoc-typehints/compare/2.5.0...3.0.0

2.5.0

<!-- Release notes generated using configuration in .github/release.yml at main -->

What's Changed
* Fix the type checker by gaborbernat in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/493
* Apply typehints_formatter to signature by Priyansh121096 in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/494

New Contributors
* Priyansh121096 made their first contribution in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/494

**Full Changelog**: https://github.com/tox-dev/sphinx-autodoc-typehints/compare/2.4.4...2.5.0

2.4.4

<!-- Release notes generated using configuration in .github/release.yml at main -->



**Full Changelog**: https://github.com/tox-dev/sphinx-autodoc-typehints/compare/2.4.3...2.4.4

2.4.3

<!-- Release notes generated using configuration in .github/release.yml at main -->



**Full Changelog**: https://github.com/tox-dev/sphinx-autodoc-typehints/compare/2.4.2...2.4.3

2.4.2

<!-- Release notes generated using configuration in .github/release.yml at main -->

What's Changed
* Improve the CI by gaborbernat in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/485


**Full Changelog**: https://github.com/tox-dev/sphinx-autodoc-typehints/compare/2.4.1...2.4.2

2.4.1

<!-- Release notes generated using configuration in .github/release.yml at main -->

What's Changed
* Fix placement of return type when there is a doctest by hoodmane in https://github.com/tox-dev/sphinx-autodoc-typehints/pull/482


**Full Changelog**: https://github.com/tox-dev/sphinx-autodoc-typehints/compare/2.4.0...2.4.1

2.4.0

<!-- Release notes generated using configuration in .github/release.yml at main -->

- Drop 3.9 support
- Add 3.13 support
- Bump dependencies

**Full Changelog**: https://github.com/tox-dev/sphinx-autodoc-typehints/compare/2.3.0...2.4.0
Links

Update pytest from 8.3.5 to 9.0.0.

Changelog

9.0.0

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

New features
------------


- `1367 <https://github.com/pytest-dev/pytest/issues/1367>`_: **Support for subtests** has been added.

:ref:`subtests <subtests>` are an alternative to parametrization, useful in situations where the parametrization values are not all known at collection time.

Example:

.. code-block:: python

   def contains_docstring(p: Path) -> bool:
       """Return True if the given Python file contains a top-level docstring."""
       ...


   def test_py_files_contain_docstring(subtests: pytest.Subtests) -> None:
       for path in Path.cwd().glob("*.py"):
           with subtests.test(path=str(path)):
               assert contains_docstring(path)


Each assert failure or error is caught by the context manager and reported individually, giving a clear picture of all files that are missing a docstring.

In addition, :meth:`unittest.TestCase.subTest` is now also supported.

This feature was originally implemented as a separate plugin in `pytest-subtests <https://github.com/pytest-dev/pytest-subtests>`__, but since then has been merged into the core.

.. note::

   This feature is experimental and will likely evolve in future releases. By that we mean that we might change how subtests are reported on failure, but the functionality and how to use it are stable.


- `13743 <https://github.com/pytest-dev/pytest/issues/13743>`_: Added support for **native TOML configuration files**.

While pytest, since version 6, supports configuration in ``pyproject.toml`` files under ``[tool.pytest.ini_options]``,
it does so in an "INI compatibility mode", where all configuration values are treated as strings or list of strings.
Now, pytest supports the native TOML data model.

In ``pyproject.toml``, the native TOML configuration is under the ``[tool.pytest]`` table.

.. code-block:: toml

    pyproject.toml
   [tool.pytest]
   minversion = "9.0"
   addopts = ["-ra", "-q"]
   testpaths = [
       "tests",
       "integration",
   ]

The ``[tool.pytest.ini_options]`` table remains supported, but both tables cannot be used at the same time.

If you prefer to use a separate configuration file, or don't use ``pyproject.toml``, you can use ``pytest.toml`` or ``.pytest.toml``:

.. code-block:: toml

    pytest.toml or .pytest.toml
   [pytest]
   minversion = "9.0"
   addopts = ["-ra", "-q"]
   testpaths = [
       "tests",
       "integration",
   ]

The documentation now (sometimes) shows configuration snippets in both TOML and INI formats, in a tabbed interface.

See :ref:`config file formats` for full details.


- `13823 <https://github.com/pytest-dev/pytest/issues/13823>`_: Added a **"strict mode"** enabled by the :confval:`strict` configuration option.

When set to ``true``, the :confval:`strict` option currently enables

* :confval:`strict_config`
* :confval:`strict_markers`
* :confval:`strict_parametrization_ids`
* :confval:`strict_xfail`

The individual strictness options can be explicitly set to override the global :confval:`strict` setting.

The previously-deprecated ``--strict`` command-line flag now enables strict mode.

If pytest adds new strictness options in the future, they will also be enabled in strict mode.
Therefore, you should only enable strict mode if you use a pinned/locked version of pytest,
or if you want to proactively adopt new strictness options as they are added.

See :ref:`strict mode` for more details.


- `13737 <https://github.com/pytest-dev/pytest/issues/13737>`_: Added the :confval:`strict_parametrization_ids` configuration option.

When set, pytest emits an error if it detects non-unique parameter set IDs,
rather than automatically making the IDs unique by adding `0`, `1`, ... to them.
This can be particularly useful for catching unintended duplicates.


- `13072 <https://github.com/pytest-dev/pytest/issues/13072>`_: Added support for displaying test session **progress in the terminal tab** using the `OSC 9;4; <https://conemu.github.io/en/AnsiEscapeCodes.html#ConEmu_specific_OSC>`_ ANSI sequence.
When pytest runs in a supported terminal emulator like ConEmu, Gnome Terminal, Ptyxis, Windows Terminal, Kitty or Ghostty,
you'll see the progress in the terminal tab or window,
allowing you to monitor pytest's progress at a glance.

This feature is automatically enabled when running in a TTY. It is implemented as an internal plugin. If needed, it can be disabled as follows:
- On a user level, using ``-p no:terminalprogress`` on the command line or via an environment variable ``PYTEST_ADDOPTS='-p no:terminalprogress'``.
- On a project configuration level, using ``addopts = "-p no:terminalprogress"``.


- `478 <https://github.com/pytest-dev/pytest/issues/478>`_: Support PEP420 (implicit namespace packages) as `--pyargs` target when :confval:`consider_namespace_packages` is `true` in the config.

Previously, this option only impacted package imports, now it also impacts tests discovery.


- `13678 <https://github.com/pytest-dev/pytest/issues/13678>`_: Added a new :confval:`faulthandler_exit_on_timeout` configuration option set to "false" by default to let `faulthandler` interrupt the `pytest` process after a timeout in case of deadlock.

Previously, a `faulthandler` timeout would only dump the traceback of all threads to stderr, but would not interrupt the `pytest` process.

-- by :user:`ogrisel`.


- `13829 <https://github.com/pytest-dev/pytest/issues/13829>`_: Added support for configuration option aliases via the ``aliases`` parameter in :meth:`Parser.addini() <pytest.Parser.addini>`.

Plugins can now register alternative names for configuration options,
allowing for more flexibility in configuration naming and supporting backward compatibility when renaming options.
The canonical name always takes precedence if both the canonical name and an alias are specified in the configuration file.



Improvements in existing functionality
--------------------------------------

- `13330 <https://github.com/pytest-dev/pytest/issues/13330>`_: Having pytest configuration spread over more than one file (for example having both a ``pytest.ini`` file and ``pyproject.toml`` with a ``[tool.pytest.ini_options]`` table) will now print a warning to make it clearer to the user that only one of them is actually used.

-- by :user:`sgaist`


- `13574 <https://github.com/pytest-dev/pytest/issues/13574>`_: The single argument ``--version`` no longer loads the entire plugin infrastructure, making it faster and more reliable when displaying only the pytest version.

Passing ``--version`` twice (e.g., ``pytest --version --version``) retains the original behavior, showing both the pytest version and plugin information.

.. note::

   Since ``--version`` is now processed early, it only takes effect when passed directly via the command line. It will not work if set through other mechanisms, such as :envvar:`PYTEST_ADDOPTS` or :confval:`addopts`.


- `13823 <https://github.com/pytest-dev/pytest/issues/13823>`_: Added :confval:`strict_xfail` as an alias to the ``xfail_strict`` option,
:confval:`strict_config` as an alias to the ``--strict-config`` flag,
and :confval:`strict_markers` as an alias to the ``--strict-markers`` flag.
This makes all strictness options consistently have configuration options with the prefix ``strict_``.

- `13700 <https://github.com/pytest-dev/pytest/issues/13700>`_: `--junitxml`  no longer prints the `generated xml file` summary at the end of the pytest session when `--quiet` is given.


- `13732 <https://github.com/pytest-dev/pytest/issues/13732>`_: Previously, when filtering warnings, pytest would fail if the filter referenced a class that could not be imported. Now, this only outputs a message indicating the problem.


- `13859 <https://github.com/pytest-dev/pytest/issues/13859>`_: Clarify the error message for `pytest.raises()` when a regex `match` fails.


- `13861 <https://github.com/pytest-dev/pytest/issues/13861>`_: Better sentence structure in a test's expected error message. Previously, the error message would be "expected exception must be <expected>, but got <actual>". Now, it is "Expected <expected>, but got <actual>".


Removals and backward incompatible breaking changes
---------------------------------------------------

- `12083 <https://github.com/pytest-dev/pytest/issues/12083>`_: Fixed a bug where an invocation such as `pytest a/ a/b` would cause only tests from `a/b` to run, and not other tests under `a/`.

The fix entails a few breaking changes to how such overlapping arguments and duplicates are handled:

1. `pytest a/b a/` or `pytest a/ a/b` are equivalent to `pytest a`; if an argument overlaps another arguments, only the prefix remains.

2. `pytest x.py x.py` is equivalent to `pytest x.py`; previously such an invocation was taken as an explicit request to run the tests from the file twice.

If you rely on these behaviors, consider using :ref:`--keep-duplicates <duplicate-paths>`, which retains its existing behavior (including the bug).


- `13719 <https://github.com/pytest-dev/pytest/issues/13719>`_: Support for Python 3.9 is dropped following its end of life.


- `13766 <https://github.com/pytest-dev/pytest/issues/13766>`_: Previously, pytest would assume it was running in a CI/CD environment if either of the environment variables `$CI` or `$BUILD_NUMBER` was defined;
now, CI mode is only activated if at least one of those variables is defined and set to a *non-empty* value.


- `13779 <https://github.com/pytest-dev/pytest/issues/13779>`_: **PytestRemovedIn9Warning deprecation warnings are now errors by default.**

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

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

In the pytest ``9.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.PytestRemovedIn9Warning

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

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



Deprecations (removal in next major release)
--------------------------------------------

- `13807 <https://github.com/pytest-dev/pytest/issues/13807>`_: :meth:`monkeypatch.syspath_prepend() <pytest.MonkeyPatch.syspath_prepend>` now issues a deprecation warning when the prepended path contains legacy namespace packages (those using ``pkg_resources.declare_namespace()``).
Users should migrate to native namespace packages (:pep:`420`).
See :ref:`monkeypatch-fixup-namespace-packages` for details.


Bug fixes
---------

- `13445 <https://github.com/pytest-dev/pytest/issues/13445>`_: Made the type annotations of :func:`pytest.skip` and friends more spec-complaint to have them work across more type checkers.


- `13537 <https://github.com/pytest-dev/pytest/issues/13537>`_: Fixed a bug in which :class:`ExceptionGroup` with only ``Skipped`` exceptions in teardown was not handled correctly and showed as error.


- `13598 <https://github.com/pytest-dev/pytest/issues/13598>`_: Fixed possible collection confusion on Windows when short paths and symlinks are involved.


- `13716 <https://github.com/pytest-dev/pytest/issues/13716>`_: Fixed a bug where a nonsensical invocation like ``pytest x.py[a]`` (a file cannot be parametrized) was silently treated as ``pytest x.py``. This is now a usage error.


- `13722 <https://github.com/pytest-dev/pytest/issues/13722>`_: Fixed a misleading assertion failure message when using :func:`pytest.approx` on mappings with differing lengths.


- `13773 <https://github.com/pytest-dev/pytest/issues/13773>`_: Fixed the static fixture closure calculation to properly consider transitive dependencies requested by overridden fixtures.


- `13816 <https://github.com/pytest-dev/pytest/issues/13816>`_: Fixed :func:`pytest.approx` which now returns a clearer error message when comparing mappings with different keys.


- `13849 <https://github.com/pytest-dev/pytest/issues/13849>`_: Hidden ``.pytest.ini`` files are now picked up as the config file even if empty.
This was an inconsistency with non-hidden ``pytest.ini``.


- `13865 <https://github.com/pytest-dev/pytest/issues/13865>`_: Fixed `--show-capture` with `--tb=line`.


- `13522 <https://github.com/pytest-dev/pytest/issues/13522>`_: Fixed :fixture:`pytester` in subprocess mode ignored all :attr`pytester.plugins <pytest.Pytester.plugins>` except the first.

Fixed :fixture:`pytester` in subprocess mode silently ignored non-str :attr:`pytester.plugins <pytest.Pytester.plugins>`.
Now it errors instead.
If you are affected by this, specify the plugin by name, or switch the affected tests to use :func:`pytester.runpytest_inprocess <pytest.Pytester.runpytest_inprocess>` explicitly instead.



Packaging updates and notes for downstreams
-------------------------------------------

- `13791 <https://github.com/pytest-dev/pytest/issues/13791>`_: Minimum requirements on ``iniconfig`` and ``packaging`` were bumped to ``1.0.1`` and ``22.0.0``, respectively.



Contributor-facing changes
--------------------------

- `12244 <https://github.com/pytest-dev/pytest/issues/12244>`_: Fixed self-test failures when `TERM=dumb`.


- `12474 <https://github.com/pytest-dev/pytest/issues/12474>`_: Added scheduled GitHub Action Workflow to run Sphinx linkchecks in repo documentation.


- `13621 <https://github.com/pytest-dev/pytest/issues/13621>`_: pytest's own testsuite now handles the ``lsof`` command hanging (e.g. due to unreachable network filesystems), with the affected selftests being skipped after 10 seconds.


- `13638 <https://github.com/pytest-dev/pytest/issues/13638>`_: Fixed deprecated :command:`gh pr new` command in :file:`scripts/prepare-release-pr.py`.
The script now uses :command:`gh pr create` which is compatible with GitHub CLI v2.0+.


- `13695 <https://github.com/pytest-dev/pytest/issues/13695>`_: Flush `stdout` and `stderr` in `Pytester.run` to avoid truncated outputs in `test_faulthandler.py::test_timeout` on CI -- by :user:`ogrisel`.


- `13771 <https://github.com/pytest-dev/pytest/issues/13771>`_: Skip `test_do_not_collect_symlink_siblings` on Windows environments without symlink support to avoid false negatives.


- `13841 <https://github.com/pytest-dev/pytest/issues/13841>`_: ``tox>=4`` is now required when contributing to pytest.

- `13625 <https://github.com/pytest-dev/pytest/issues/13625>`_: Added missing docstrings to ``pytest_addoption()``, ``pytest_configure()``, and ``cacheshow()`` functions in ``cacheprovider.py``.



Miscellaneous internal changes
------------------------------

- `13830 <https://github.com/pytest-dev/pytest/issues/13830>`_: Configuration overrides (``-o``/``--override-ini``) are now processed during startup rather than during :func:`config.getini() <pytest.Config.getini>`.

8.4.2

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

Bug fixes
---------

- `13478 <https://github.com/pytest-dev/pytest/issues/13478>`_: Fixed a crash when using :confval:`console_output_style` with ``times`` and a module is skipped.


- `13530 <https://github.com/pytest-dev/pytest/issues/13530>`_: Fixed a crash when using :func:`pytest.approx` and :class:`decimal.Decimal` instances with the :class:`decimal.FloatOperation` trap set.


- `13549 <https://github.com/pytest-dev/pytest/issues/13549>`_: No longer evaluate type annotations in Python ``3.14`` when inspecting function signatures.

This prevents crashes during module collection when modules do not explicitly use ``from __future__ import annotations`` and import types for annotations within a ``if TYPE_CHECKING:`` block.


- `13559 <https://github.com/pytest-dev/pytest/issues/13559>`_: Added missing `int` and `float` variants to the `Literal` type annotation of the `type` parameter in :meth:`pytest.Parser.addini`.


- `13563 <https://github.com/pytest-dev/pytest/issues/13563>`_: :func:`pytest.approx` now only imports ``numpy`` if NumPy is already in ``sys.modules``. This fixes unconditional import behavior introduced in `8.4.0`.



Improved documentation
----------------------

- `13577 <https://github.com/pytest-dev/pytest/issues/13577>`_: Clarify that ``pytest_generate_tests`` is discovered in test modules/classes; other hooks must be in ``conftest.py`` or plugins.



Contributor-facing changes
--------------------------

- `13480 <https://github.com/pytest-dev/pytest/issues/13480>`_: Self-testing: fixed a few test failures when run with ``-Wdefault`` or a similar override.


- `13547 <https://github.com/pytest-dev/pytest/issues/13547>`_: Self-testing: corrected expected message for ``test_doctest_unexpected_exception`` in Python ``3.14``.


- `13684 <https://github.com/pytest-dev/pytest/issues/13684>`_: Make pytest's own testsuite insensitive to the presence of the ``CI`` environment variable -- by :user:`ogrisel`.

8.4.1

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

Bug fixes
---------

- `13461 <https://github.com/pytest-dev/pytest/issues/13461>`_: Corrected ``_pytest.terminal.TerminalReporter.isatty`` to support
being called as a method. Before it was just a boolean which could
break correct code when using ``-o log_cli=true``).


- `13477 <https://github.com/pytest-dev/pytest/issues/13477>`_: Reintroduced :class:`pytest.PytestReturnNotNoneWarning` which was removed by accident in pytest `8.4`.

This warning is raised when a test functions returns a value other than ``None``, which is often a mistake made by beginners.

See :ref:`return-not-none` for more information.


- `13497 <https://github.com/pytest-dev/pytest/issues/13497>`_: Fixed compatibility with ``Twisted 25+``.



Improved documentation
----------------------

- `13492 <https://github.com/pytest-dev/pytest/issues/13492>`_: Fixed outdated warning about ``faulthandler`` not working on Windows.

8.4.0

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

Removals and backward incompatible breaking changes
---------------------------------------------------

- `11372 <https://github.com/pytest-dev/pytest/issues/11372>`_: Async tests will now fail, instead of warning+skipping, if you don't have any suitable plugin installed.


- `12346 <https://github.com/pytest-dev/pytest/issues/12346>`_: Tests will now fail, instead of raising a warning, if they return any value other than None.


- `12874 <https://github.com/pytest-dev/pytest/issues/12874>`_: We dropped support for Python 3.8 following its end of life (2024-10-07).


- `12960 <https://github.com/pytest-dev/pytest/issues/12960>`_: Test functions containing a yield now cause an explicit error. They have not been run since pytest 4.0, and were previously marked as an expected failure and deprecation warning.

See :ref:`the docs <yield tests deprecated>` for more information.



Deprecations (removal in next major release)
--------------------------------------------

- `10839 <https://github.com/pytest-dev/pytest/issues/10839>`_: Requesting an asynchronous fixture without a `pytest_fixture_setup` hook that resolves it will now give a DeprecationWarning. This most commonly happens if a sync test requests an async fixture. This should have no effect on a majority of users with async tests or fixtures using async pytest plugins, but may affect non-standard hook setups or ``autouse=True``. For guidance on how to work around this warning see :ref:`sync-test-async-fixture`.



New features
------------

- `11538 <https://github.com/pytest-dev/pytest/issues/11538>`_: Added :class:`pytest.RaisesGroup` as an equivalent to :func:`pytest.raises` for expecting :exc:`ExceptionGroup`. Also adds :class:`pytest.RaisesExc` which is now the logic behind :func:`pytest.raises` and used as parameter to :class:`pytest.RaisesGroup`. ``RaisesGroup`` includes the ability to specify multiple different expected exceptions, the structure of nested exception groups, and flags for emulating :ref:`except* <except_star>`. See :ref:`assert-matching-exception-groups` and docstrings for more information.


- `12081 <https://github.com/pytest-dev/pytest/issues/12081>`_: Added :fixture:`capteesys` to capture AND pass output to next handler set by ``--capture=``.


- `12504 <https://github.com/pytest-dev/pytest/issues/12504>`_: :func:`pytest.mark.xfail` now accepts :class:`pytest.RaisesGroup` for the ``raises`` parameter when you expect an exception group. You can also pass a :class:`pytest.RaisesExc` if you e.g. want to make use of the ``check`` parameter.


- `12713 <https://github.com/pytest-dev/pytest/issues/12713>`_: New `--force-short-summary` option to force condensed summary output regardless of verbosity level.

This lets users still see condensed summary output of failures for quick reference in log files from job outputs, being especially useful if non-condensed output is very verbose.


- `12749 <https://github.com/pytest-dev/pytest/issues/12749>`_: pytest traditionally collects classes/functions in the test module namespace even if they are imported from another file.

For example:

.. code-block:: python

    contents of src/domain.py
   class Testament: ...


    contents of tests/test_testament.py
   from domain import Testament


   def test_testament(): ...

In this scenario with the default options, pytest will collect the class `Testament` from `tests/test_testament.py` because it starts with `Test`, even though in this case it is a production class being imported in the test module namespace.

This behavior can now be prevented by setting the new :confval:`collect_imported_tests` configuration option to ``false``, which will make pytest collect classes/functions from test files **only** if they are defined in that file.

-- by :user:`FreerGit`


- `12765 <https://github.com/pytest-dev/pytest/issues/12765>`_: Thresholds to trigger snippet truncation can now be set with :confval:`truncation_limit_lines` and :confval:`truncation_limit_chars`.

See :ref:`truncation-params` for more information.


- `13125 <https://github.com/pytest-dev/pytest/issues/13125>`_: :confval:`console_output_style` now supports ``times`` to show execution time of each test.


- `13192 <https://github.com/pytest-dev/pytest/issues/13192>`_: :func:`pytest.raises` will now raise a warning when passing an empty string to ``match``, as this will match against any value. Use ``match="^$"`` if you want to check that an exception has no message.


- `13192 <https://github.com/pytest-dev/pytest/issues/13192>`_: :func:`pytest.raises` will now print a helpful string diff if matching fails and the match parameter has ``^`` and ``$`` and is otherwise escaped.


- `13192 <https://github.com/pytest-dev/pytest/issues/13192>`_: You can now pass :func:`with pytest.raises(check=fn): <pytest.raises>`, where ``fn`` is a function which takes a raised exception and returns a boolean. The ``raises`` fails if no exception was raised (as usual), passes if an exception is raised and ``fn`` returns ``True`` (as well as ``match`` and the type matching, if specified, which are checked before), and propagates the exception if ``fn`` returns ``False`` (which likely also fails the test).


- `13228 <https://github.com/pytest-dev/pytest/issues/13228>`_: :ref:`hidden-param` can now be used in ``id`` of :func:`pytest.param` or in
``ids`` of :py:func:`Metafunc.parametrize <pytest.Metafunc.parametrize>`.
It hides the parameter set from the test name.


- `13253 <https://github.com/pytest-dev/pytest/issues/13253>`_: New flag: :ref:`--disable-plugin-autoload <disable_plugin_autoload>` which works as an alternative to :envvar:`PYTEST_DISABLE_PLUGIN_AUTOLOAD` when setting environment variables is inconvenient; and allows setting it in config files with :confval:`addopts`.



Improvements in existing functionality
--------------------------------------

- `10224 <https://github.com/pytest-dev/pytest/issues/10224>`_: pytest's ``short`` and ``long`` traceback styles (:ref:`how-to-modifying-python-tb-printing`)
now have partial :pep:`657` support and will show specific code segments in the
traceback.

.. code-block:: pytest

   ================================= FAILURES =================================
   _______________________ test_gets_correct_tracebacks _______________________

   test_tracebacks.py:12: in test_gets_correct_tracebacks
       assert manhattan_distance(p1, p2) == 1
              ^^^^^^^^^^^^^^^^^^^^^^^^^^
   test_tracebacks.py:6: in manhattan_distance
       return abs(point_1.x - point_2.x) + abs(point_1.y - point_2.y)
                              ^^^^^^^^^
   E   AttributeError: 'NoneType' object has no attribute 'x'

-- by :user:`ammaraskar`


- `11118 <https://github.com/pytest-dev/pytest/issues/11118>`_: Now :confval:`pythonpath` configures `$PYTHONPATH` earlier than before during the initialization process, which now also affects plugins loaded via the `-p` command-line option.

-- by :user:`millerdev`


- `11381 <https://github.com/pytest-dev/pytest/issues/11381>`_: The ``type`` parameter of the ``parser.addini`` method now accepts `"int"` and ``"float"`` parameters, facilitating the parsing of configuration values in the configuration file.

Example:

.. code-block:: python

 def pytest_addoption(parser):
     parser.addini("int_value", type="int", default=2, help="my int value")
     parser.addini("float_value", type="float", default=4.2, help="my float value")

The `pytest.ini` file:

.. code-block:: ini

 [pytest]
 int_value = 3
 float_value = 5.4


- `11525 <https://github.com/pytest-dev/pytest/issues/11525>`_: Fixtures are now clearly represented in the output as a "fixture object", not as a normal function as before, making it easy for beginners to catch mistakes such as referencing a fixture declared in the same module but not requested in the test function.

-- by :user:`the-compiler` and :user:`glyphack`


- `12426 <https://github.com/pytest-dev/pytest/issues/12426>`_: A warning is now issued when :ref:`pytest.mark.usefixtures ref` is used without specifying any fixtures. Previously, empty usefixtures markers were silently ignored.


- `12707 <https://github.com/pytest-dev/pytest/issues/12707>`_: Exception chains can be navigated when dropped into Pdb in Python 3.13+.


- `12736 <https://github.com/pytest-dev/pytest/issues/12736>`_: Added a new attribute `name` with the fixed value `"pytest tests"` to the root tag `testsuites` of the junit-xml generated by pytest.

This attribute is part of many junit-xml specifications and is even part of the `junit-10.xsd` specification that pytest's implementation is based on.


- `12943 <https://github.com/pytest-dev/pytest/issues/12943>`_: If a test fails with an exceptiongroup with a single exception, the contained exception will now be displayed in the short test summary info.


- `12958 <https://github.com/pytest-dev/pytest/issues/12958>`_: A number of :ref:`unraisable <unraisable>` enhancements:

* Set the unraisable hook as early as possible and unset it as late as possible, to collect the most possible number of unraisable exceptions.
* Call the garbage collector just before unsetting the unraisable hook, to collect any straggling exceptions.
* Collect multiple unraisable exceptions per test phase.
* Report the :mod:`tracemalloc` allocation traceback (if available).
* Avoid using a generator based hook to allow handling :class:`StopIteration` in test failures.
* Report the unraisable exception as the cause of the :class:`pytest.PytestUnraisableExceptionWarning` exception if raised.
* Compute the ``repr`` of the unraisable object in the unraisable hook so you get the latest information if available, and should help with resurrection of the object.


- `13010 <https://github.com/pytest-dev/pytest/issues/13010>`_: :func:`pytest.approx` now can compare collections that contain numbers and non-numbers mixed.


- `13016 <https://github.com/pytest-dev/pytest/issues/13016>`_: A number of :ref:`threadexception <unraisable>` enhancements:

* Set the excepthook as early as possible and unset it as late as possible, to collect the most possible number of unhandled exceptions from threads.
* Collect multiple thread exceptions per test phase.
* Report the :mod:`tracemalloc` allocation traceback (if available).
* Avoid using a generator based hook to allow handling :class:`StopIteration` in test failures.
* Report the thread exception as the cause of the :class:`pytest.PytestUnhandledThreadExceptionWarning` exception if raised.
* Extract the ``name`` of the thread object in the excepthook which should help with resurrection of the thread.


- `13031 <https://github.com/pytest-dev/pytest/issues/13031>`_: An empty parameter set as in ``pytest.mark.parametrize([], ids=idfunc)`` will no longer trigger a call to ``idfunc`` with internal objects.


- `13115 <https://github.com/pytest-dev/pytest/issues/13115>`_: Allows supplying ``ExceptionGroup[Exception]`` and ``BaseExceptionGroup[BaseException]`` to ``pytest.raises`` to keep full typing on :class:`ExceptionInfo <pytest.ExceptionInfo>`:

.. code-block:: python

   with pytest.raises(ExceptionGroup[Exception]) as exc_info:
       some_function()

Parametrizing with other exception types remains an error - we do not check the types of child exceptions and thus do not permit code that might look like we do.


- `13122 <https://github.com/pytest-dev/pytest/issues/13122>`_: The ``--stepwise`` mode received a number of improvements:

* It no longer forgets the last failed test in case pytest is executed later without the flag.

 This enables the following workflow:

 1. Execute pytest with ``--stepwise``, pytest then stops at the first failing test;
 2. Iteratively update the code and run the test in isolation, without the ``--stepwise`` flag (for example in an IDE), until it is fixed.
 3. Execute pytest with ``--stepwise`` again and pytest will continue from the previously failed test, and if it passes, continue on to the next tests.

 Previously, at step 3, pytest would start from the beginning, forgetting the previously failed test.

 This change however might cause issues if the ``--stepwise`` mode is used far apart in time, as the state might get stale, so the internal state will be reset automatically in case the test suite changes (for now only the number of tests are considered for this, we might change/improve this on the future).

* New ``--stepwise-reset``/``--sw-reset`` flag, allowing the user to explicitly reset the stepwise state and restart the workflow from the beginning.


- `13308 <https://github.com/pytest-dev/pytest/issues/13308>`_: Added official support for Python 3.14.


- `13380 <https://github.com/pytest-dev/pytest/issues/13380>`_: Fix :class:`ExceptionGroup` traceback filtering to exclude pytest internals.


- `13415 <https://github.com/pytest-dev/pytest/issues/13415>`_: The author metadata of the BibTex example is now correctly formatted with last names following first names.
An example of BibLaTex has been added.
BibTex and BibLaTex examples now clearly indicate that what is cited is software.

-- by :user:`willynilly`


- `13420 <https://github.com/pytest-dev/pytest/issues/13420>`_: Improved test collection performance by optimizing path resolution used in ``FSCollector``.


- `13457 <https://github.com/pytest-dev/pytest/issues/13457>`_: The error message about duplicate parametrization no longer displays an internal stack trace.


- `4112 <https://github.com/pytest-dev/pytest/issues/4112>`_: Using :ref:`pytest.mark.usefixtures <pytest.mark.usefixtures ref>` on :func:`pytest.param` now produces an error instead of silently doing nothing.


- `5473 <https://github.com/pytest-dev/pytest/issues/5473>`_: Replace `:` with `;` in the assertion rewrite warning message so it can be filtered using standard Python warning filters before calling :func:`pytest.main`.


- `6985 <https://github.com/pytest-dev/pytest/issues/6985>`_: Improved :func:`pytest.approx` to enhance the readability of value ranges and tolerances between 0.001 and 1000.
 * The `repr` method now provides clearer output for values within those ranges, making it easier to interpret the results.
 * Previously, the output for those ranges of values and tolerances was displayed in scientific notation (e.g., `42 ± 1.0e+00`). The updated method now presents the tolerance as a decimal for better readability (e.g., `42 ± 1`).

   Example:

   **Previous Output:**

   .. code-block:: console

       >>> pytest.approx(42, abs=1)
       42 ± 1.0e+00

   **Current Output:**

   .. code-block:: console

       >>> pytest.approx(42, abs=1)
       42 ± 1

 -- by :user:`fazeelghafoor`


- `7683 <https://github.com/pytest-dev/pytest/issues/7683>`_: The formerly optional ``pygments`` dependency is now required, causing output always to be source-highlighted (unless disabled via the ``--code-highlight=no`` CLI option).



Bug fixes
---------

- `10404 <https://github.com/pytest-dev/pytest/issues/10404>`_: Apply filterwarnings from config/cli as soon as possible, and revert them as late as possible
so that warnings as errors are collected throughout the pytest run and before the
unraisable and threadexcept hooks are removed.

This allows very late warnings and unraisable/threadexcept exceptions to fail the test suite.

This also changes the warning that the lsof plugin issues from PytestWarning to the new warning PytestFDWarning so it can be more easily filtered.


- `11067 <https://github.com/pytest-dev/pytest/issues/11067>`_: The test report is now consistent regardless if the test xfailed via :ref:`pytest.mark.xfail <pytest.mark.xfail ref>` or :func:`pytest.fail`.

Previously, *xfailed* tests via the marker would have the string ``"reason: "`` prefixed to the message, while those *xfailed* via the function did not. The prefix has been removed.


- `12008 <https://github.com/pytest-dev/pytest/issues/12008>`_: In :pr:`11220`, an unintended change in reordering was introduced by changing the way indices were assigned to direct params. More specifically, before that change, the indices of direct params to metafunc's callspecs were assigned after all parametrizations took place. Now, that change is reverted.


- `12863 <https://github.com/pytest-dev/pytest/issues/12863>`_: Fix applying markers, including :ref:`pytest.mark.parametrize <pytest.mark.parametrize ref>` when placed above `staticmethod` or `classmethod`.


- `12929 <https://github.com/pytest-dev/pytest/issues/12929>`_: Handle StopIteration from test cases, setup and teardown correctly.


- `12938 <https://github.com/pytest-dev/pytest/issues/12938>`_: Fixed ``--durations-min`` argument not respected if ``-vv`` is used.


- `12946 <https://github.com/pytest-dev/pytest/issues/12946>`_: Fixed missing help for :mod:`pdb` commands wrapped by pytest -- by :user:`adamchainz`.


- `12981 <https://github.com/pytest-dev/pytest/issues/12981>`_: Prevent exceptions in :func:`pytest.Config.add_cleanup` callbacks preventing further cleanups.


- `13047 <https://github.com/pytest-dev/pytest/issues/13047>`_: Restore :func:`pytest.approx` handling of equality checks between `bool` and `numpy.bool_` types.

Comparing `bool` and `numpy.bool_` using :func:`pytest.approx` accidentally changed in version `8.3.4` and `8.3.5` to no longer match:

.. code-block:: pycon

   >>> import numpy as np
   >>> from pytest import approx
   >>> [np.True_, np.True_] == pytest.approx([True, True])
   False

This has now been fixed:

.. code-block:: pycon

   >>> [np.True_, np.True_] == pytest.approx([True, True])
   True


- `13119 <https://github.com/pytest-dev/pytest/issues/13119>`_: Improved handling of invalid regex patterns for filter warnings by providing a clear error message.


- `13175 <https://github.com/pytest-dev/pytest/issues/13175>`_: The diff is now also highlighted correctly when comparing two strings.


- `13248 <https://github.com/pytest-dev/pytest/issues/13248>`_: Fixed an issue where passing a ``scope`` in :py:func:`Metafunc.parametrize <pytest.Metafunc.parametrize>` with ``indirect=True``
could result in other fixtures being unable to depend on the parametrized fixture.


- `13291 <https://github.com/pytest-dev/pytest/issues/13291>`_: Fixed ``repr`` of ``attrs`` objects in assertion failure messages when using ``attrs>=25.2``.


- `13312 <https://github.com/pytest-dev/pytest/issues/13312>`_: Fixed a possible ``KeyError`` crash on PyPy during collection of tests involving higher-scoped parameters.


- `13345 <https://github.com/pytest-dev/pytest/issues/13345>`_: Fix type hints for :attr:`pytest.TestReport.when` and :attr:`pytest.TestReport.location`.


- `13377 <https://github.com/pytest-dev/pytest/issues/13377>`_: Fixed handling of test methods with positional-only parameter syntax.

Now, methods are supported that formally define ``self`` as positional-only
and/or fixture parameters as keyword-only, e.g.:

.. code-block:: python

   class TestClass:

       def test_method(self, /, *, fixture): ...

Before, this caused an internal error in pytest.


- `13384 <https://github.com/pytest-dev/pytest/issues/13384>`_: Fixed an issue where pytest could report negative durations.


- `13420 <https://github.com/pytest-dev/pytest/issues/13420>`_: Added ``lru_cache`` to ``nodes._check_initialpaths_for_relpath``.


- `9037 <https://github.com/pytest-dev/pytest/issues/9037>`_: Honor :confval:`disable_test_id_escaping_and_forfeit_all_rights_to_community_support` when escaping ids in parametrized tests.



Improved documentation
----------------------

- `12535 <https://github.com/pytest-dev/pytest/issues/12535>`_: `This
example`<https://docs.pytest.org/en/latest/example/simple.html#making-test-result-information-available-in-fixtures>
showed ``print`` statements that do not exactly reflect what the
different branches actually do.  The fix makes the example more precise.


- `13218 <https://github.com/pytest-dev/pytest/issues/13218>`_: Pointed out in the :func:`pytest.approx` documentation that it considers booleans unequal to numeric zero or one.


- `13221 <https://github.com/pytest-dev/pytest/issues/13221>`_: Improved grouping of CLI options in the ``--help`` output.


- `6649 <https://github.com/pytest-dev/pytest/issues/6649>`_: Added :class:`~pytest.TerminalReporter` to the :ref:`api-reference` documentation page.


- `8612 <https://github.com/pytest-dev/pytest/issues/8612>`_: Add a recipe for handling abstract test classes in the documentation.

A new example has been added to the documentation to demonstrate how to use a mixin class to handle abstract
test classes without manually setting the ``__test__`` attribute for subclasses.
This ensures that subclasses of abstract test classes are automatically collected by pytest.



Packaging updates and notes for downstreams
-------------------------------------------

- `13317 <https://github.com/pytest-dev/pytest/issues/13317>`_: Specified minimum allowed versions of ``colorama``, ``iniconfig``,
and ``packaging``; and bumped the minimum allowed version
of ``exceptiongroup`` for ``python_version<'3.11'`` from a release
candidate to a full release.



Contributor-facing changes
--------------------------

- `12017 <https://github.com/pytest-dev/pytest/issues/12017>`_: Mixed internal improvements:

* Migrate formatting to f-strings in some tests.
* Use type-safe constructs in JUnitXML tests.
* Moved`` MockTiming`` into ``_pytest.timing``.

-- by :user:`RonnyPfannschmidt`


- `12647 <https://github.com/pytest-dev/pytest/issues/12647>`_: Fixed running the test suite with the ``hypothesis`` pytest plugin.



Miscellaneous internal changes
------------------------------

- `6649 <https://github.com/pytest-dev/pytest/issues/6649>`_: Added :class:`~pytest.TerminalReporter` to the public pytest API, as it is part of the signature of the :hook:`pytest_terminal_summary` hook.
Links

Update pytest-env from 1.1.5 to 1.2.0.

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

Links

Update pytest-mock from 3.14.0 to 3.15.1.

Changelog

3.15.1

------

*2025-09-16*

* `529 <https://github.com/pytest-dev/pytest-mock/issues/529>`_: Fixed ``itertools._tee object has no attribute error`` -- now ``duplicate_iterators=True`` must be passed to ``mocker.spy`` to duplicate iterators.

3.15.0

------

*2025-09-04*

* Python 3.8 (EOL) is no longer supported.
* `524 <https://github.com/pytest-dev/pytest-mock/pull/524>`_: Added ``spy_return_iter`` to ``mocker.spy``, which contains a duplicate of the return value of the spied method if it is an ``Iterator``.

3.14.1

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

* `503 <https://github.com/pytest-dev/pytest-mock/pull/503>`_: Python 3.14 is now officially supported.
Links

Update fiftyone from 1.5.2 to 1.10.0.

Changelog

1.10.0

Please see the official [Voxel51 Release Notes](https://docs.voxel51.com/release-notes.html#fiftyone-1-10-0) for details.

1.9.0

Please see the official [Voxel51 Release Notes](https://docs.voxel51.com/release-notes.html#fiftyone-1-9-0) for details.

1.8.1

Please see the official [Voxel51 Release Notes](https://docs.voxel51.com/release-notes.html#fiftyone-1-8-1) for details.

1.8.0

Please see the official [Voxel51 Release Notes](https://docs.voxel51.com/release-notes.html#fiftyone-1-8-0) for details.

1.7.2

Please see the official [Voxel51 Release Notes](https://docs.voxel51.com/release-notes.html#fiftyone-1-7-2) for details.

1.7.1

Please see the official [Voxel51 Release Notes](https://docs.voxel51.com/release-notes.html#fiftyone-1-7-1) for details.

1.7.0

Please see the official [Voxel51 Release Notes](https://docs.voxel51.com/release-notes.html#fiftyone-1-7-0) for details!

1.6.0

Please see the official [Voxel51 Release Notes](https://docs.voxel51.com/release-notes.html#fiftyone-1-6-0) for details.
Links

Update datasets from 3.6.0 to 4.4.1.

Changelog

4.4.0

Added

-   [API]
 [`PartialDecoding` support](https://www.tensorflow.org/datasets/decode#only_decode_a_sub-set_of_the_features),
 to decode only a subset of the features (for performances).
-   [API] `tfds.features.LabeledImage` for semantic segmentation (like image but
 with additional `info.features['image_label'].name` label metadata).
-   [API] float32 support for `tfds.features.Image` (e.g. for depth map).
-   [API] Loading datasets from files now supports custom
 `tfds.features.FeatureConnector`.
-   [API] All FeatureConnector can now have a `None` dimension anywhere
 (previously restricted to the first position).
-   [API] `tfds.features.Tensor()` can have arbitrary number of dynamic
 dimension (`Tensor(..., shape=(None, None, 3, None)`)).
-   [API] `tfds.features.Tensor` can now be serialised as bytes, instead of
 float/int values (to allow better compression): `Tensor(...,
 encoding='zlib')`.
-   [API] Support for datasets with `None` in `tfds.as_numpy`.
-   Script to add TFDS metadata files to existing TF-record (see
 [doc](https://www.tensorflow.org/datasets/external_tfrecord)).
-   [TESTING] `tfds.testing.mock_data` now supports:
 -   non-scalar tensors with dtype `tf.string`;
 -   `builder_from_files` and path-based community datasets.
-   [Documentation] Catalog now exposes links to
 [KnowYourData visualisations](https://knowyourdata-tfds.withgoogle.com/).
-   [Documentation] Guide on
 [common implementation gotchas](https://www.tensorflow.org/datasets/common_gotchas).
-   Many new reinforcement learning datasets.  Changed
-   [API] Dataset generated with `disable_shuffling=True` are now read in
 generation order.

Fixed

-   File format automatically restored (for datasets generated with
 `tfds.builder(..., file_format=)`).
-   Dynamically set number of worker threads during extraction.
-   Update progress bar during download even if downloads are cached.
-   Misc bug fixes.

4.3.0

Added

-   [API] `dataset.info.splits['train'].num_shards` to expose the number of
 shards to the user.
-   [API] `tfds.features.Dataset` to have a field containing sub-datasets (e.g.
 used in RL datasets).
-   [API] dtype and `tf.uint16` support in `tfds.features.Video`.
-   [API] `DatasetInfo.license` field to add redistributing information.
-   [API] `.copy`, `.format` methods to GPath objects.
-   [Performances] `tfds.benchmark(ds)` (compatible with any iterator, not just
 `tf.data`, better colab representation).
-   [Performances] Faster `tfds.as_numpy()` (avoid extra `tf.Tensor` <>
 `np.array` copy).
-   [Testing] Support for custom `BuilderConfig` in `DatasetBuilderTest`.
-   [Testing] `DatasetBuilderTest` now has a `dummy_data` class property which
 can be used in `setUpClass`.
-   [Testing] `add_tfds_id` and cardinality support to `tfds.testing.mock_data`.
-   [Documentation] Better `tfds.as_dataframe` visualisation (Sequence, ragged
 tensor, semantic masks with `use_colormap`).
-   [Experimental] Community datasets support. To allow dynamically import
 datasets defined outside the TFDS repository.
-   [Experimental] Hugging-face compatibility wrapper to use Hugging-face
 datasets directly in TFDS.
-   [Experimental] Riegeli format support.
-   [Experimental] `DatasetInfo.disable_shuffling` to force examples to be read
 in generation order.
-   New datasets.

Fixed

-   Many bugs.

4.2.0

Added

-   [CLI] `tfds build` to the CLI. See
 [documentation](https://www.tensorflow.org/datasets/cli#tfds_build_download_and_prepare_a_dataset).
-   [API] `tfds.features.Dataset` to represent nested datasets.
-   [API] `tfds.ReadConfig(add_tfds_id=True)` to add a unique id to the example
 `ex['tfds_id']` (e.g. `b'train.tfrecord-00012-of-01024__123'`).
-   [API] `num_parallel_calls` option to `tfds.ReadConfig` to overwrite to
 default `AUTOTUNE` option.
-   [API] `tfds.ImageFolder` support for `tfds.decode.SkipDecoder`.
-   [API] Multichannel audio support to `tfds.features.Audio`.
-   [API] `try_gcs` to `tfds.builder(..., try_gcs=True)`
-   Better `tfds.as_dataframe` visualization (ffmpeg video if installed,
 bounding boxes,...).
-   [TESTING] Allow `max_examples_per_splits=0` in `tfds build
 --max_examples_per_splits=0` to test `_split_generators` only (without
 `_generate_examples`).
-   New datasets.

Changed

-   [API] DownloadManager now returns
 [Pathlib-like](https://docs.python.org/3/library/pathlib.html#basic-use)
 objects.
-   [API] Simpler `BuilderConfig` definition: class `VERSION` and
 `RELEASE_NOTES` are applied to all `BuilderConfig`. Config description is
 now optional.
-   [API] To guarantee better deterministic, new validations are performed on
 the keys when creating a dataset (to avoid filenames as keys
 (non-deterministic) and restrict key to `str`, `bytes` and `int`). New
 errors likely indicates an issue in the dataset implementation.
-   [API] `tfds.core.benchmark` now returns a `pd.DataFrame` (instead of a
 `dict`).
-   [API] `tfds.units` is not visible anymore from the public API.
-   Datasets updates.

Deprecated

Removed

-   Configs for all text datasets. Only plain text version is kept. For example:
 `multi_nli/plain_text` -> `multi_nli`.

Fixed

-   [API] Datasets returned by `tfds.as_numpy` are compatible with `len(ds)`.
-   Support 0-len sequence with images of dynamic shape (Fix 2616).
-   Progression bar correctly updated when copying files.
-   Better debugging and error message (e.g. human readable size,...).
-   Many bug fixes (GPath consistency with pathlib, s3 compatibility, TQDM
 visual artifacts, GCS crash on windows, re-download when checksums updated,
 ...).

4.1.0

Added

-   It is now easier to create datasets outside TFDS repository (see our updated
 [dataset creation guide](https://www.tensorflow.org/datasets/add_dataset)).
-   When generating a dataset, if download fails for any reason, it is now
 possible to manually download the data. See
 [doc](https://www.tensorflow.org/datasets/overview#manual_download_if_download_fails).
-   `tfds.core.as_path` to create pathlib.Path-like objects compatible with GCS
 (e.g. `tfds.core.as_path('gs://my-bucket/labels.csv').read_text()`).
-   `verify_ssl=` option to `tfds.download.DownloadConfig` to disable SSH
 certificate during download.
-   New datasets.  Changed
-   All dataset inherit from `tfds.core.GeneratorBasedBuilder`. Converting a
 dataset to beam now only require changing `_generate_examples` (see
 [example and doc](https://www.tensorflow.org/datasets/beam_datasets#instructions)).
-   `_split_generators` should now returns `{'split_name':
 self._generate_examples(), ...}` (but current datasets are backward
 compatible).
-   Better `pathlib.Path`, `os.PathLike` compatibility: `dl_manager.manual_dir`
 now returns a pathlib-Like object. Example: `python text =
 (dl_manager.manual_dir / 'downloaded-text.txt').read_text()` Note: Other
 `dl_manager.download`, `.extract`,... will return pathlib-like objects in
 future versions. `FeatureConnector`,... and most functions should accept
 `PathLike` objects. Let us know if some functions you need are missing.
-   `--record_checksums` now assume the new dataset-as-folder model.

Deprecated

-   `tfds.core.SplitGenerator`, `tfds.core.BeamBasedBuilder` are deprecated and
 will be removed in a future version.

Fixed

-   `BuilderConfig` are now compatible with Beam datasets 2348
-   `tfds.features.Images` can accept encoded `bytes` images directly (useful
 when used with `img_name, img_bytes =
 dl_manager.iter_archive('images.zip')`).
-   Doc API now show deprecated methods, abstract methods to overwrite are now
 documented.
-   You can generate `imagenet2012` with only a single split (e.g. only the
 validation data). Other split will be skipped if not present.

4.0.1

Fixed

-   `tfds.load` when generation code isn't present.
-   GCS compatibility.

4.0.0

Added

-   Dataset-as-folder: Dataset can now be self-contained module in a folder with
 checksums, dummy data,... This simplify implementing datasets outside the
 TFDS repository.
-   `tfds.load` can now load dataset without using the generation class. So
 `tfds.load('my_dataset:1.0.0')` can work

@pyup-bot pyup-bot mentioned this pull request Nov 10, 2025
Closed
@pyup-bot
Copy link
Collaborator Author

pyup-bot commented Nov 24, 2025

Closing this in favor of #633

@pyup-bot pyup-bot closed this Nov 24, 2025
@guysmoilov guysmoilov deleted the pyup-scheduled-update-2025-11-10 branch November 24, 2025 17:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@pyup-bot