floraachy
/
pytest2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improve documentation of get_verbosity() and configuraiton

This commit is contained in:
Patrick Lannigan 2023-11-13 08:07:52 -05:00
parent 91bfcab9dd
commit 5d2183daf0
No known key found for this signature in database
GPG Key ID: BBF5D9DED1E4AAF9
2 changed files with 17 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/en/reference/reference.rst
View File

@ -1826,13 +1826,13 @@ passed multiple times. The expected format is ``name=value``. For example::
Set a verbosity level specifically for assertion related output, overriding the application wide level. Set a verbosity level specifically for assertion related output, overriding the application wide level.
.. code-block:: ini .. code-block:: ini
[pytest] [pytest]
verbosity_assertions = 2 verbosity_assertions = 2
Defaults to application wide verbosity level (via the ``-v`` command-line option). Defaults to application wide verbosity level (via the ``-v`` command-line option). A special value of
"auto" can be used to explicitly use the global verbosity level.
.. confval:: xfail_strict .. confval:: xfail_strict

17
src/_pytest/config/__init__.py
View File

@ -1651,13 +1651,26 @@ class Config:
"""Deprecated, use getoption(skip=True) instead.""" """Deprecated, use getoption(skip=True) instead."""
return self.getoption(name, skip=True) return self.getoption(name, skip=True)
#: Verbosity for failed assertions (see :confval:`verbosity_assertions`). #: Verbosity type for failed assertions (see :confval:`verbosity_assertions`).
VERBOSITY_ASSERTIONS: Final = "assertions" VERBOSITY_ASSERTIONS: Final = "assertions"
_KNOWN_VERBOSITY_TYPES: Final = {VERBOSITY_ASSERTIONS} _KNOWN_VERBOSITY_TYPES: Final = {VERBOSITY_ASSERTIONS}
_VERBOSITY_INI_DEFAULT = "auto" _VERBOSITY_INI_DEFAULT = "auto"
def get_verbosity(self, verbosity_type: Optional[str] = None) -> int: def get_verbosity(self, verbosity_type: Optional[str] = None) -> int:
r"""Access to fine-grained verbosity levels. r"""Retrieve the verbosity level for a fine-grained verbosity type.
:param verbosity_type: Verbosity type to get level for. If a level is
configured for the given type, that value will be returned. If the
given type is not a known verbosity type, the global verbosity
level will be returned. If the given type is None (default), the
global verbosity level will be returned.
To configure a level for a fine-grained verbosity type, the
configuration file should have a setting for the configuration name
and a numeric value for the verbosity level. A special value of "auto"
can be used to explicitly use the global verbosity level.
Example:
.. code-block:: ini .. code-block:: ini