Skip to content

Commit

Permalink
Add pytest.version_tuple
Browse files Browse the repository at this point in the history
This adds `pytest.version_tuple`, which makes it simpler for users to do something depending on the pytest version (such as declaring plugins which are introduced in later versions) more easily than parsing the version themselves.

This feature was added originally in pypa/setuptools_scm#475.

Followup to #7605.
  • Loading branch information
nicoddemus committed Jun 14, 2021
1 parent 6447ca5 commit ed2fd1b
Show file tree
Hide file tree
Showing 4 changed files with 39 additions and 2 deletions.
28 changes: 28 additions & 0 deletions doc/en/reference/reference.rst
Expand Up @@ -226,6 +226,34 @@ Marks a test function as *expected to fail*.
a new release of a library fixes a known bug).


pytest.__version__
~~~~~~~~~~~~~~~~~~

The current pytest version, as a string::

>>> import pytest
>>> pytest.__version__
'7.0.0'

pytest.version_tuple
~~~~~~~~~~~~~~~~~~~~

.. versionadded:: 7.0

The current pytest version, as a tuple::

>>> import pytest
>>> pytest.version_tuple
(7, 0, 0)

For pre-releases, the last component will be a string with the prerelease version::

>>> import pytest
>>> pytest.version_tuple
(7, 0, '0rc1')



Custom marks
~~~~~~~~~~~~

Expand Down
5 changes: 3 additions & 2 deletions src/_pytest/__init__.py
@@ -1,8 +1,9 @@
__all__ = ["__version__"]
__all__ = ["__version__", "version_tuple"]

try:
from ._version import version as __version__
from ._version import version as __version__, version_tuple
except ImportError:
# broken installation, we don't even try
# unknown only works because we do poor mans version compare
__version__ = "unknown"
version_tuple = (0, 0, "unknown") # type:ignore[assignment]
2 changes: 2 additions & 0 deletions src/pytest/__init__.py
Expand Up @@ -2,6 +2,7 @@
"""pytest: unit and functional testing with Python."""
from . import collect
from _pytest import __version__
from _pytest import version_tuple
from _pytest._code import ExceptionInfo
from _pytest.assertion import register_assert_rewrite
from _pytest.cacheprovider import Cache
Expand Down Expand Up @@ -130,6 +131,7 @@
"Session",
"set_trace",
"skip",
"version_tuple",
"TempPathFactory",
"Testdir",
"TempdirFactory",
Expand Down
6 changes: 6 additions & 0 deletions testing/test_helpconfig.py
Expand Up @@ -19,6 +19,12 @@ def test_version_less_verbose(pytester: Pytester, pytestconfig, monkeypatch) ->
result.stderr.fnmatch_lines([f"pytest {pytest.__version__}"])


def test_versions():
"""Regression check for the public version attributes in pytest."""
assert isinstance(pytest.__version__, str)
assert isinstance(pytest.version_tuple, tuple)


def test_help(pytester: Pytester) -> None:
result = pytester.runpytest("--help")
assert result.ret == 0
Expand Down

0 comments on commit ed2fd1b

Please sign in to comment.