Справочник по API¶

pytest.__version__¶

Текущая версия pytest, в виде строки:

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

pytest.version_tuple¶

Текущая версия pytest, в виде кортежа:

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

Для предварительных версий последним компонентом будет строка с версией предварительной версии:

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

pytest.approx¶

approx(expected, rel=None, abs=None, nan_ok=False)[исходный код]¶

Утверждение, что два числа (или две упорядоченные последовательности чисел) равны друг другу в пределах некоторого допуска.

Из-за Floating Point Arithmetic: Issues and Limitations числа, которые мы интуитивно считаем равными, не всегда таковыми являются:

>>> 0.1 + 0.2 == 0.3
False

Эта проблема часто встречается при написании тестов, например, при проверке того, что значения с плавающей точкой являются тем, что вы ожидаете. Один из способов решения этой проблемы - утверждать, что два числа с плавающей точкой равны в пределах некоторого соответствующего допуска:

>>> abs((0.1 + 0.2) - 0.3) < 1e-6
True

Однако подобные сравнения утомительны для написания и сложны для понимания. Более того, абсолютные сравнения, подобные приведенному выше, обычно не рекомендуются, потому что не существует допуска, который хорошо подходит для всех ситуаций. 1e-6 хорошо подходит для чисел около 1, но слишком мал для очень больших чисел и слишком велик для очень маленьких. Лучше выразить допуск в виде доли от ожидаемого значения, но такие относительные сравнения еще сложнее написать правильно и кратко.

Класс approx выполняет сравнение с плавающей точкой, используя максимально интуитивно понятный синтаксис:

>>> from pytest import approx
>>> 0.1 + 0.2 == approx(0.3)
True

Этот же синтаксис работает и для упорядоченных последовательностей чисел:

>>> (0.1 + 0.2, 0.2 + 0.4) == approx((0.3, 0.6))
True

numpy массивы:

>>> import numpy as np                                                          
>>> np.array([0.1, 0.2]) + np.array([0.2, 0.4]) == approx(np.array([0.3, 0.6])) 
True

И для массива numpy против скаляра:

>>> import numpy as np                                         
>>> np.array([0.1, 0.2]) + np.array([0.2, 0.1]) == approx(0.3) 
True

Поддерживаются только упорядоченные последовательности, так как approx должен выводить относительное положение последовательностей без двусмысленности. Это означает, что sets и другие неупорядоченные последовательности не поддерживаются.

Наконец, словарные значения также можно сравнивать:

>>> {'a': 0.1 + 0.2, 'b': 0.2 + 0.4} == approx({'a': 0.3, 'b': 0.6})
True

Сравнение будет истинным, если оба отображения имеют одинаковые ключи и их соответствующие значения соответствуют ожидаемым допускам.

Допуски

По умолчанию approx считает равными числа в пределах относительного допуска 1e-6 (т.е. одна часть на миллион) от ожидаемого значения. Такое обращение привело бы к удивительным результатам, если бы ожидаемое значение было 0.0, поскольку ничто, кроме самого 0.0, не является относительно близким к 0.0. Чтобы справиться с этим случаем менее неожиданно, approx также считает равными числа в пределах абсолютного допуска 1e-12 от его ожидаемого значения. Бесконечность и NaN являются особыми случаями. Бесконечность считается равной только самой себе, независимо от относительного допуска. NaN по умолчанию не считается равным ничему, но вы можете сделать его равным самому себе, установив аргумент nan_ok в True. (Это сделано для облегчения сравнения массивов, в которых NaN означает «нет данных»).

Относительные и абсолютные допуски могут быть изменены путем передачи аргументов в конструктор approx:

>>> 1.0001 == approx(1)
False
>>> 1.0001 == approx(1, rel=1e-3)
True
>>> 1.0001 == approx(1, abs=1e-3)
True

Если указать abs, но не rel, сравнение вообще не будет учитывать относительный допуск. Другими словами, два числа, которые находятся в пределах относительного допуска по умолчанию 1e-6, будут считаться неравными, если они превышают указанный абсолютный допуск. Если вы укажете и abs, и rel, то числа будут считаться равными при соблюдении любого из допусков:

>>> 1 + 1e-8 == approx(1)
True
>>> 1 + 1e-8 == approx(1, abs=1e-12)
False
>>> 1 + 1e-8 == approx(1, rel=1e-6, abs=1e-12)
True

Вы также можете использовать approx для сравнения нечисловых типов или массивов и последовательностей, содержащих нечисловые типы, в этом случае он возвращается к строгому равенству. Это может быть полезно для сравнения массивов и последовательностей, которые могут содержать необязательные значения:

>>> {"required": 1.0000005, "optional": None} == approx({"required": 1, "optional": None})
True
>>> [None, 1.0000005] == approx([None,1])
True
>>> ["foo", 1.0000005] == approx([None,1])
False

Если вы думаете об использовании approx, то, возможно, вам захочется узнать, как он сопоставляется с другими хорошими способами сравнения чисел с плавающей точкой. Все эти алгоритмы основаны на относительных и абсолютных допусках и по большей части должны совпадать, но у них есть и существенные различия:

• math.isclose(a, b, rel_tol=1e-9, abs_tol=0.0): Истинно, если относительный допуск соблюдается по отношению к a или b или если соблюдается абсолютный допуск. Поскольку относительный допуск рассчитывается относительно a и b, этот тест является симметричным (т.е. ни a, ни b не являются «опорным значением»). Вы должны указать абсолютный допуск, если хотите сравнить с 0.0, так как по умолчанию допуск отсутствует. Дополнительная информация: math.isclose().

• numpy.isclose(a, b, rtol=1e-5, atol=1e-8): Истинно, если разница между a и b меньше суммы относительного допуска по отношению к b и абсолютного допуска. Поскольку относительный допуск вычисляется только по отношению к b, этот тест является асимметричным, и вы можете считать b эталонным значением. Поддержка сравнения последовательностей обеспечивается numpy.allclose(). Дополнительная информация: numpy.isclose.

• unittest.TestCase.assertAlmostEqual(a, b): True, если a и b находятся в пределах абсолютного допуска 1e-7. Относительный допуск не учитывается, поэтому эта функция не подходит для очень больших или очень маленьких чисел. Кроме того, она доступна только в подклассах unittest.TestCase и является уродливой, поскольку не соответствует PEP8. Дополнительная информация: unittest.TestCase.assertAlmostEqual().

• a == pytest.approx(b, rel=1e-6, abs=1e-12): Истинно, если относительный допуск соблюдается по отношению к b или если соблюдается абсолютный допуск. Поскольку относительный допуск рассчитывается только относительно b, этот тест является асимметричным, и вы можете считать b эталонным значением. В особом случае, когда вы явно указываете абсолютный допуск, но не относительный допуск, учитывается только абсолютный допуск.

Примечание

approx может работать с массивами numpy, но мы рекомендуем специализированные помощники тестирования в Test Support (numpy.testing), если вам нужна поддержка сравнений, NaNs или допусков на основе ULP.

Для сопоставления строк с помощью regex можно использовать Matches из re_assert package.

Предупреждение

Изменено в версии 3.2.

Чтобы избежать непоследовательного поведения, для сравнений TypeError, >, >= и < выдается :py``<=``. Приведенный ниже пример иллюстрирует проблему:

assert approx(0.1) > 0.1 + 1e-10  # calls approx(0.1).__gt__(0.1 + 1e-10)
assert 0.1 + 1e-10 > approx(0.1)  # calls approx(0.1).__lt__(0.1 + 1e-10)

Во втором примере ожидается вызов approx(0.1).__le__(0.1 + 1e-10). Но вместо этого для сравнения используется approx(0.1).__lt__(0.1 + 1e-10). Это происходит потому, что иерархия вызовов богатых сравнений следует фиксированному поведению. Дополнительная информация: object.__ge__().

Изменено в версии 3.7.1: approx выдает TypeError, когда встречает значение dict или элемент последовательности нечислового типа.

Изменено в версии 6.1.0: approx возвращается к строгому равенству для нечисловых типов вместо того, чтобы поднять TypeError.

pytest.fail¶

Учебник: Как использовать skip и xfail для работы с тестами, которые не могут быть успешными

fail(reason[, pytrace=True, msg=None])[исходный код]¶

Явный отказ выполняющегося теста с заданным сообщением.

Parameters:

• reason (str) – Сообщение, которое должно быть показано пользователю в качестве причины сбоя.

• pytrace (bool) – Если False, msg представляет полную информацию о сбое, и отслеживание python не будет сообщено.

• msg (Optional[str]) – То же самое, что и reason, но устаревшее. Будет удалено в будущей версии, вместо него используйте reason.

pytest.skip¶

skip(reason[, allow_module_level=False, msg=None])[исходный код]¶

Пропустить выполняющийся тест с заданным сообщением.

Эта функция должна вызываться только во время тестирования (установки, вызова или разрыва) или во время сбора с помощью флага allow_module_level. Эта функция может быть вызвана и в доктестах.

Parameters:

• reason (str) – Сообщение, которое должно быть показано пользователю в качестве причины пропуска.

• allow_module_level (bool) – Позволяет вызывать эту функцию на уровне модуля, пропуская остальную часть модуля. По умолчанию имеет значение False.

• msg (Optional[str]) – То же самое, что и reason, но устаревшее. Будет удалено в будущей версии, вместо него используйте reason.

Примечание

Лучше использовать маркер pytest.mark.skipif, когда это возможно, чтобы объявить, что тест должен быть пропущен при определенных условиях, таких как несоответствие платформ или зависимостей. Аналогично, используйте директиву # doctest: +SKIP (см. doctest.SKIP), чтобы пропустить доктест статически.

pytest.importorskip¶

importorskip(modname, minversion=None, reason=None)[исходный код]¶

Импортировать и вернуть запрошенный модуль modname, или пропустить текущий тест, если модуль не может быть импортирован.

Parameters:

• modname (str) – Имя модуля для импорта.

• minversion (Optional[str]) – Если задано, то атрибут __version__ импортируемого модуля должен быть не ниже этой минимальной версии, иначе тест будет пропущен.

• reason (Optional[str]) – Если эта причина указана, она будет показана в сообщении, когда модуль не может быть импортирован.

Result:

Импортируемый модуль. Ему должно быть присвоено его каноническое имя.

Result type:

Any

Пример:

docutils = pytest.importorskip("docutils")

pytest.xfail¶

xfail(reason='')[исходный код]¶

Императивный xfail выполняющегося теста или установочной функции с указанной причиной.

Эта функция должна вызываться только во время тестирования (установки, вызова или разрыва).

Parameters:

reason (str) – Сообщение, которое должно быть показано пользователю в качестве причины отказа xfail.

Примечание

Лучше использовать маркер pytest.mark.xfail, когда это возможно, чтобы объявить тест как xfailed при определенных условиях, таких как известные ошибки или отсутствующие функции.

pytest.exit¶

exit(reason[, returncode=False, msg=None])[исходный код]¶

Процесс выходного тестирования.

Parameters:

• reason (str) – Сообщение, которое будет показано в качестве причины выхода из pytest. reason имеет значение по умолчанию только потому, что msg устарело.

• returncode (Optional[int]) – Код возврата, который будет использоваться при выходе из pytest.

• msg (Optional[str]) – То же самое, что и reason, но устаревшее. Будет удалено в будущей версии, вместо него используйте reason.

pytest.main¶

main(args=None, plugins=None)[исходный код]¶

Выполните пробный запуск в процессе работы.

Parameters:

• args (Optional[Union[List[str], PathLike[str]]]) – Список аргументов командной строки.

• plugins (Optional[Sequence[Union[str, object]]]) – Список объектов плагина, подлежащих авторегистрации во время инициализации.

Result:

Код выхода.

Result type:

Union[int, ExitCode]

pytest.param¶

param(*values[, id][, marks])[исходный код]¶

Укажите параметр в вызовах pytest.mark.parametrize или parametrized fixtures.

@pytest.mark.parametrize(
    "test_input,expected",
    [
        ("3+5", 8),
        pytest.param("6*9", 42, marks=pytest.mark.xfail),
    ],
)
def test_eval(test_input, expected):
    assert eval(test_input) == expected

Parameters:

• values (object) – Переменные args значений набора параметров, по порядку.

• marks (Union[MarkDecorator, Collection[Union[MarkDecorator, Mark]]]) – Одна метка или список меток, которые будут применены к данному набору параметров.

• id (Optional[str]) – Идентификатор, приписываемый этому набору параметров.

pytest.raises¶

Учебник: Утверждения об ожидаемых исключениях

with raises(expected_exception: Exception[, *, match]) as excinfo[исходный код]¶

Утверждение, что блок кода/вызов функции вызывает исключение.

Parameters:

• expected_exception (Type[E] | Tuple[Type[E], ...]) – Исключаемый тип исключения, или кортеж, если исключается один из нескольких возможных типов исключений.

• match (str | Pattern[str] | None) – Если указано, строка, содержащая регулярное выражение или объект регулярного выражения, которое проверяется на соответствие строковому представлению исключения с помощью re.search(). Для соответствия литеральной строке, которая может содержать special characters, шаблон может быть сначала экранирован с помощью re.escape(). (Это используется только тогда, когда pytest.raises() используется в качестве менеджера контекста, и передается в функцию в противном случае. При использовании pytest.raises() в качестве функции, вы можете использовать: pytest.raises(Exc, func, match="passed on").match("my pattern").)

Используйте pytest.raises в качестве менеджера контекста, который будет перехватывать исключение заданного типа:

>>> import pytest
>>> with pytest.raises(ZeroDivisionError):
...    1/0

Если блок кода не вызывает ожидаемого исключения (ZeroDivisionError в примере выше) или вообще не вызывает исключения, проверка завершится неудачно.

Вы также можете использовать ключевой аргумент match для утверждения, что исключение соответствует тексту или regex:

>>> with pytest.raises(ValueError, match='must be 0 or None'):
...     raise ValueError("value must be 0 or None")

>>> with pytest.raises(ValueError, match=r'must be \d+$'):
...     raise ValueError("value must be 42")

Менеджер контекста создает объект ExceptionInfo, который можно использовать для просмотра деталей перехваченного исключения:

>>> with pytest.raises(ValueError) as exc_info:
...     raise ValueError("value must be 42")
>>> assert exc_info.type is ValueError
>>> assert exc_info.value.args[0] == "value must be 42"

Примечание

При использовании pytest.raises в качестве контекстного менеджера, стоит отметить, что применяются обычные правила контекстного менеджера и что вызванное исключение должно быть последней строкой в области действия контекстного менеджера. Строки кода после этого, находящиеся в области действия контекстного менеджера, не будут выполнены. Например:

>>> value = 15
>>> with pytest.raises(ValueError) as exc_info:
...     if value > 10:
...         raise ValueError("value must be <= 10")
...     assert exc_info.type is ValueError  # this will not execute

Вместо этого необходимо использовать следующий подход (обратите внимание на разницу в сфере применения):

>>> with pytest.raises(ValueError) as exc_info:
...     if value > 10:
...         raise ValueError("value must be <= 10")
...
>>> assert exc_info.type is ValueError

Использование с pytest.mark.parametrize.

При использовании pytest.mark.parametrize можно параметризовать тесты таким образом, что некоторые из них будут вызывать исключение, а другие - нет.

Смотрите пример Параметризация условного повышения.

Легальная форма

Можно указать вызываемый объект, передав ему вызывающую лямбду:

>>> raises(ZeroDivisionError, lambda: 1/0)
<ExceptionInfo ...>

или вы можете указать произвольный вызываемый объект с аргументами:

>>> def f(x): return 1/x
...
>>> raises(ZeroDivisionError, f, 0)
<ExceptionInfo ...>
>>> raises(ZeroDivisionError, f, x=0)
<ExceptionInfo ...>

Приведенная выше форма полностью поддерживается, но не рекомендуется для нового кода, поскольку форма контекстного менеджера считается более читабельной и менее подверженной ошибкам.

Примечание

Подобно объектам пойманных исключений в Python, явная очистка локальных ссылок на возвращаемые объекты ExceptionInfo может помочь интерпретатору Python ускорить сборку мусора.

Очистка этих ссылок нарушает цикл ссылок (ExceptionInfo –> пойманное исключение –> стек кадра, поднимающий исключение –> стек текущего кадра –> локальные переменные –> ExceptionInfo), что заставляет Python сохранять все объекты, на которые ссылался этот цикл (включая все локальные переменные в текущем кадре), до следующего цикла сборки мусора. Более подробную информацию можно найти в официальной документации Python для the try statement.

pytest.deprecated_call¶

Учебник: Обеспечение срабатывания предупреждения об устаревании кода

with deprecated_call([match])[исходный код]¶

Убедитесь, что код выдает DeprecationWarning или PendingDeprecationWarning.

Эта функция может быть использована в качестве менеджера контекста:

>>> import warnings
>>> def api_call_v2():
...     warnings.warn('use v3 of this api', DeprecationWarning)
...     return 200

>>> import pytest
>>> with pytest.deprecated_call():
...    assert api_call_v2() == 200

Его также можно использовать, передавая функции и *args и **kwargs, в этом случае он обеспечит вызов func(*args, **kwargs), выдающий одно из предупреждений, указанных выше. Возвращаемое значение - это возвращаемое значение функции.

В форме контекстного менеджера вы можете использовать аргумент ключевого слова match, чтобы утверждать, что предупреждение соответствует тексту или regex.

Менеджер контекста создает список объектов warnings.WarningMessage, по одному на каждое поднятое предупреждение.

pytest.register_assert_rewrite¶

Учебник: Переписывание утверждений

register_assert_rewrite(*names)[исходный код]¶

Зарегистрируйте одно или несколько имен модулей, которые будут переписаны при импорте.

Эта функция гарантирует, что этот модуль или все модули внутри пакета получат свои утверждения assert переписанными. Таким образом, вы должны убедиться, что эта функция будет вызвана до того, как модуль будет импортирован, обычно в вашем __init__.py, если вы являетесь плагином, использующим пакет.

Parameters:

names (str) – Имена модулей для регистрации.

pytest.warns¶

Учебник: Утверждение предупреждений с помощью функции warns

with warns(expected_warning: Exception[, match])[исходный код]¶

Утверждение, что код вызывает определенный класс предупреждений.

В частности, параметром expected_warning может быть класс предупреждений или последовательность классов предупреждений, а код внутри блока with должен выдать хотя бы одно предупреждение этого класса или классов.

Этот помощник создает список объектов warnings.WarningMessage, по одному на каждое выданное предупреждение (независимо от того, является ли оно expected_warning или нет).

Эта функция может быть использована в качестве менеджера контекста, который будет фиксировать все поднятые предупреждения внутри нее:

>>> import pytest
>>> with pytest.warns(RuntimeWarning):
...    warnings.warn("my warning", RuntimeWarning)

В форме контекстного менеджера вы можете использовать аргумент ключевого слова match, чтобы утверждать, что предупреждение соответствует тексту или regex:

>>> with pytest.warns(UserWarning, match='must be 0 or None'):
...     warnings.warn("value must be 0 or None", UserWarning)

>>> with pytest.warns(UserWarning, match=r'must be \d+$'):
...     warnings.warn("value must be 42", UserWarning)

>>> with pytest.warns(UserWarning, match=r'must be \d+$'):
...     warnings.warn("this is not here", UserWarning)
Traceback (most recent call last):
  ...
Failed: DID NOT WARN. No warnings of type ...UserWarning... were emitted...

Использование с pytest.mark.parametrize.

При использовании pytest.mark.parametrize можно параметризовать тесты таким образом, что некоторые прогоны будут вызывать предупреждение, а другие - нет.

Этого можно добиться так же, как и с исключениями, см. пример Параметризация условного повышения.

pytest.freeze_includes¶

Учебник: Замораживание pytest

freeze_includes()[исходный код]¶

Возвращает список имен модулей, используемых pytest, которые должны быть включены cx_freeze.

pytest.mark.filterwarnings¶

Учебник: @pytest.mark.filterwarnings

Добавьте фильтры предупреждений к отмеченным элементам теста.

pytest.mark.filterwarnings(filter)¶

Parameters:

filter (str) – Строка спецификации предупреждения, которая состоит из содержимого кортежа (action, message, category, module, lineno), как указано в разделе The Warnings Filter документации Python, разделенного ":". Необязательные поля могут быть опущены. Имена модулей, передаваемые для фильтрации, не подвергаются regex-эскейпу. Например: … code-block:: python @pytest.mark.filterwarnings(«ignore:.*usage will be deprecated.*:DeprecationWarning») def test_foo(): …

pytest.mark.parametrize¶

Учебник: Как параметризировать приспособления и тестовые функции

Этот знак имеет ту же сигнатуру, что и pytest.Metafunc.parametrize(); см. там.

pytest.mark.skip¶

Учебник: Пропуск тестовых функций

Безусловный пропуск тестовой функции.

pytest.mark.skip(reason=None)¶

Parameters:

reason (str) – Причина, по которой функция проверки пропускается.

pytest.mark.skipif¶

Учебник: Пропуск тестовых функций

Пропустить функцию проверки, если условие равно True.

pytest.mark.skipif(condition, *, reason=None)¶

Parameters:

• condition (bool or str) – True/False, если условие должно быть пропущено, или condition string.

• reason (str) – Причина, по которой функция проверки пропускается.

pytest.mark.usefixtures¶

Учебник: Используйте фиксаторы в классах и модулях с помощью usefixtures.

Пометить тестовую функцию как использующую заданные имена приспособлений.

pytest.mark.usefixtures(*names)¶

Parameters:

args – Имена приспособлений для использования, в виде строк.

pytest.mark.xfail¶

Учебник: XFail: пометить функции теста как ожидаемые для отказа

Помечает функцию тестирования как ожидаемую неудачу.

pytest.mark.xfail(condition=None, *, reason=None, raises=None, run=True, strict=False)¶

Parameters:

• condition (bool or str) – Условие для пометки тестовой функции как xfail (True/False или a condition string). Если bool, то необходимо также указать reason (см. condition string).

• reason (str) – Причина, по которой тестовая функция помечена как xfail.

• raises (Type[Exception]) – Подкласс исключения (или кортеж подклассов), который, как ожидается, будет вызван функцией проверки; другие исключения не пройдут проверку.

• run (bool) – Если тестовая функция действительно должна быть выполнена. Если False, функция всегда будет xfail и не будет выполняться (полезно, если функция работает с ошибками).

• strict (bool) –

  • Если False (по умолчанию), функция будет показана в выводе терминала как xfailed в случае неудачи и как xpass в случае успеха. В обоих случаях это не приведет к сбою тестового набора в целом. Это особенно полезно для пометки слабых тестов (тестов, которые отказывают в случайном порядке), чтобы заняться ими позже.

  • Если True, функция будет показана в выводе терминала как xfailed в случае неудачи, но если она неожиданно пройдет, то она провалит набор тестов. Это особенно полезно для пометки функций, которые постоянно терпят неудачу, и должно быть четкое указание, если они неожиданно начинают проходить (например, в новом выпуске библиотеки исправлена известная ошибка).

Пользовательские метки¶

Марки создаются динамически с помощью объекта-фабрики pytest.mark и применяются как декоратор.

Например:

@pytest.mark.timeout(10, "slow", method="thread")
def test_function():
    ...

Создает и присоединяет объект Mark к собранному Item, к которому затем можно получить доступ с помощью фикстур или хуков Node.iter_markers. Объект mark будет иметь следующие атрибуты:

mark.args == (10, "slow")
mark.kwargs == {"method": "thread"}

Пример использования нескольких пользовательских маркеров:

@pytest.mark.timeout(10, "slow", method="thread")
@pytest.mark.slow
def test_function():
    ...

Когда Node.iter_markers или Node.iter_markers_with_node используется с несколькими маркерами, первым будет итерироваться маркер, ближайший к функции. В приведенном выше примере будет получен @pytest.mark.slow, а затем @pytest.mark.timeout(...).

@pytest.fixture¶

@fixture(fixture_function=None, *, scope='function', params=None, autouse=False, ids=None, name=None)[исходный код]¶

Декоратор для обозначения функции фабрики приспособлений.

Этот декоратор можно использовать с параметрами или без них для определения функции приспособления.

На имя функции приспособления можно впоследствии ссылаться, чтобы вызвать ее вызов перед запуском тестов: тестовые модули или классы могут использовать маркер pytest.mark.usefixtures(fixturename).

Тестовые функции могут напрямую использовать имена приспособлений в качестве входных аргументов, в этом случае будет инжектирован экземпляр приспособления, возвращаемый функцией приспособления.

Фикстуры могут предоставлять свои значения тестовым функциям с помощью операторов return или yield. При использовании оператора yield блок кода после оператора yield выполняется как код разрыва, независимо от результата теста, и должен выйти ровно один раз.

Parameters:

• scope (Union[_ScopeName, Callable[[str, Config], _ScopeName]]) – Область видимости, для которой это приспособление является общим; одно из "function" (по умолчанию), "class", "module", "package" или "session". Этот параметр также может быть вызываемой переменной, которая принимает (fixture_name, config) в качестве параметров и должна возвращать str с одним из значений, указанных выше. Дополнительную информацию см. в документации Динамическая область применения.

• params (Optional[Iterable[object]]) – Необязательный список параметров, который вызовет несколько вызовов функции приспособления и всех использующих ее тестов. Текущий параметр доступен в request.param.

• autouse (bool) – Если True, функция приспособления активируется для всех тестов, которые могут ее видеть. Если False (по умолчанию), то для активации фикстуры требуется явная ссылка.

• ids (Optional[Union[Sequence[Optional[object]], Callable[[Any], Optional[object]]]]) – Последовательность идентификаторов, каждый из которых соответствует параметрам так, чтобы они были частью идентификатора теста. Если идентификаторы не указаны, они будут сгенерированы автоматически из параметров.

• name (Optional[str]) – Имя приспособления. По умолчанию это имя равно имени декорируемой функции. Если приспособление используется в том же модуле, в котором оно определено, имя функции приспособления будет затенено функцией arg, запрашивающей приспособление; один из способов решения этой проблемы - назвать декорированную функцию fixture_<fixturename>, а затем использовать @pytest.fixture(name='<fixturename>').

capfd¶

Учебник: Как перехватить вывод stdout/stderr

capfd()[исходный код]¶

Включите захват текста при записи в файловые дескрипторы 1 и 2.

Захваченный вывод доступен через вызовы методов capfd.readouterr(), которые возвращают именованный кортеж (out, err). out и err будут объектами text.

Возвращает экземпляр CaptureFixture[str].

Пример:

def test_system_echo(capfd):
    os.system('echo "hello"')
    captured = capfd.readouterr()
    assert captured.out == "hello\n"

capfdbinary¶

Учебник: Как перехватить вывод stdout/stderr

capfdbinary()[исходный код]¶

Включите перехват байтов при записи в файловые дескрипторы 1 и 2.

Захваченный вывод доступен через вызовы методов capfd.readouterr(), которые возвращают именованный кортеж (out, err). out и err будут объектами byte.

Возвращает экземпляр CaptureFixture[bytes].

Пример:

def test_system_echo(capfdbinary):
    os.system('echo "hello"')
    captured = capfdbinary.readouterr()
    assert captured.out == b"hello\n"

каплог¶

Учебник: Как управлять лесозаготовками

caplog()[исходный код]¶

Запись журнала доступа и контроля.

Захваченные журналы доступны через следующие свойства/методы:

* caplog.messages        -> list of format-interpolated log messages
* caplog.text            -> string containing formatted log output
* caplog.records         -> list of logging.LogRecord instances
* caplog.record_tuples   -> list of (logger_name, level, message) tuples
* caplog.clear()         -> clear captured records and formatted log output string

Возвращает экземпляр pytest.LogCaptureFixture.

final class LogCaptureFixture[исходный код]¶

Обеспечивает доступ и управление захватом журналов.

property handler: LogCaptureHandler¶

Получение обработчика протоколирования, используемого приспособлением.

get_records(when)[исходный код]¶

Получите записи журнала для одной из возможных фаз тестирования.

Parameters:

when (Literal['setup', 'call', 'teardown']) – Из какой фазы тестирования следует получить записи. Допустимыми значениями являются: «установка», «вызов» и «снятие».

Result:

Список захваченных записей на данном этапе.

Result type:

List[LogRecord]

Добавлено в версии 3.4.

property text: str¶

Форматированный текст журнала.

property records: List[LogRecord]¶

Список записей журнала.

property record_tuples: List[Tuple[str, int, str]]¶

Список сокращенной версии записей журнала, предназначенный для использования при сравнении утверждений.

Формат кортежа следующий:

(имя_журнала, уровень_журнала, сообщение)

property messages: List[str]¶

Список интерполированных по формату сообщений журнала.

В отличие от „records“, который содержит строку формата и параметры для интерполяции, сообщения журнала в этом списке все интерполируются.

В отличие от „text“, который содержит вывод обработчика, сообщения журнала в этом списке не украшены уровнями, временными метками и т.д., что делает точные сравнения более надежными.

Обратите внимание, что информация о трассировке или стеке (из logging.exception() или аргументов exc_info или stack_info функций логирования) не включается, так как она добавляется форматором в обработчике.

Добавлено в версии 3.7.

clear()[исходный код]¶

Сброс списка записей журнала и захваченного текста журнала.

set_level(level, logger=None)[исходный код]¶

Установите уровень регистратора на время проведения теста.

Изменено в версии 3.4: Уровни регистраторов, измененные этой функцией, будут восстановлены до исходных значений по окончании теста.

Parameters:

• level (Union[int, str]) – Уровень.

• logger (Optional[str]) – Регистратор для обновления. Если не указан, то корневой регистратор.

with at_level(level, logger=None)[исходный код]¶

Контекстный менеджер, устанавливающий уровень для перехвата журналов. После окончания оператора „with“ уровень восстанавливается до исходного значения.

Parameters:

• level (Union[int, str]) – Уровень.

• logger (Optional[str]) – Регистратор для обновления. Если не указан, то корневой регистратор.

capsys¶

Учебник: Как перехватить вывод stdout/stderr

capsys()[исходный код]¶

Включите захват текста при записи в sys.stdout и sys.stderr.

Захваченный вывод доступен через вызовы методов capsys.readouterr(), которые возвращают именованный кортеж (out, err). out и err будут объектами text.

Возвращает экземпляр CaptureFixture[str].

Пример:

def test_output(capsys):
    print("hello")
    captured = capsys.readouterr()
    assert captured.out == "hello\n"

class CaptureFixture[исходный код]¶

Объект, возвращаемый фиксаторами capsys, capsysbinary, capfd и capfdbinary.

readouterr()[исходный код]¶

Прочитать и вернуть захваченный выход, сбросив внутренний буфер.

Result:

Захваченное содержимое в виде именованного кортежа со строковыми атрибутами out и err.

Result type:

CaptureResult

with disabled()[исходный код]¶

Временно отключить захват внутри блока with.

capsysbinary¶

Учебник: Как перехватить вывод stdout/stderr

capsysbinary()[исходный код]¶

Включите перехват байтов при записи в sys.stdout и sys.stderr.

Захваченный вывод доступен через вызовы методов capsysbinary.readouterr(), которые возвращают именованный кортеж (out, err). out и err будут объектами bytes.

Возвращает экземпляр CaptureFixture[bytes].

Пример:

def test_output(capsysbinary):
    print("hello")
    captured = capsysbinary.readouterr()
    assert captured.out == b"hello\n"

config.cache¶

Учебник: Как повторно запускать неудачные тесты и сохранять состояние между запусками тестов

Объект config.cache позволяет другим плагинам и фикстурам хранить и извлекать значения во время выполнения тестов. Для доступа к нему из фикстуры запросите pytestconfig в вашей фикстуре и получите его с помощью pytestconfig.cache.

Под капотом плагин кэша использует простой dumps/loads API модуля json stdlib.

config.cache является экземпляром pytest.Cache:

final class Cache[исходный код]¶

mkdir(name)[исходный код]¶

Возвращает объект пути к каталогу с заданным именем.

Если каталог еще не существует, он будет создан. Вы можете использовать его для управления файлами, например, для хранения/получения дампов баз данных во время тестовых сессий.

Добавлено в версии 7.0.

Parameters:

name (str) – Должно быть строкой, не содержащей разделителя /. Убедитесь, что имя содержит идентификаторы вашего плагина или приложения, чтобы избежать столкновений с другими пользователями кэша.

get(key, default)[исходный код]¶

Возвращает кэшированное значение для заданного ключа.

Если значение еще не было кэшировано или значение не может быть прочитано, возвращается указанное значение по умолчанию.

Parameters:

• key (str) – Должно быть разделенным значением /. Обычно первым именем является имя вашего плагина или вашего приложения.

• default – Значение, возвращаемое в случае cache-miss или недопустимого значения кэша.

set(key, value)[исходный код]¶

Сохранить значение для заданного ключа.

Parameters:

• key (str) – Должно быть разделенным значением /. Обычно первым именем является имя вашего плагина или вашего приложения.

• value (object) – Должен состоять из любой комбинации основных типов python, включая вложенные типы, такие как списки словарей.

doctest_namespace¶

Учебник: Как выполнять доктесты

doctest_namespace()[исходный код]¶

Приспособление, возвращающее dict, которое будет внедрено в пространство имен doctests.

Обычно это приспособление используется в сочетании с другим приспособлением autouse:

@pytest.fixture(autouse=True)
def add_np(doctest_namespace):
    doctest_namespace["np"] = numpy

Подробнее: приспособление „doctest_namespace“.

обезьянник¶

Учебник: Как использовать модули и окружения monkeypatch/mock

monkeypatch()[исходный код]¶

Удобное приспособление для крепления обезьян.

Приспособление предоставляет эти методы для модификации объектов, словарей или os.environ:

• monkeypatch.setattr(obj, name, value, raising=True)

• monkeypatch.delattr(obj, name, raising=True)

• monkeypatch.setitem(mapping, name, value)

• monkeypatch.delitem(obj, name, raising=True)

• monkeypatch.setenv(name, value, prepend=None)

• monkeypatch.delenv(name, raising=True)

• monkeypatch.syspath_prepend(path)

• monkeypatch.chdir(path)

• monkeypatch.context()

Все изменения будут отменены после завершения работы запрашивающей тестовой функции или приспособления. Параметр raising определяет, будет ли выдан сигнал KeyError или AttributeError, если операция установки/удаления не имеет указанной цели.

Чтобы отменить изменения, сделанные приспособлением в содержащейся области видимости, используйте context().

Возвращает экземпляр MonkeyPatch.

final class MonkeyPatch[исходный код]¶

Помощник для удобного использования атрибутов monkeypatch/элементов/переменных окружения/syspath.

Возвращается приспособлением monkeypatch.

Изменено в версии 6.2: Теперь может также использоваться непосредственно как pytest.MonkeyPatch(), когда приспособление недоступно. В этом случае используйте with MonkeyPatch.context() as mp: или не забудьте явно вызвать undo().

classmethod with context()[исходный код]¶

Контекстный менеджер, возвращающий новый объект MonkeyPatch, который отменяет любое исправление, сделанное внутри блока with при выходе.

Пример:

import functools


def test_partial(monkeypatch):
    with monkeypatch.context() as m:
        m.setattr(functools, "partial", 3)

Полезен в ситуациях, когда необходимо отменить некоторые исправления до завершения теста, например, при высмеивании stdlib функций, которые могут сломать сам pytest при высмеивании (примеры см. в issue #3290).

setattr(target: str, name: object, value: ~_pytest.monkeypatch.Notset = <notset>, raising: bool = True) → None[исходный код]¶

setattr(target: object, name: str, value: object, raising: bool = True) → None

Установите значение атрибута на цель, запомнив старое значение.

Например:

import os

monkeypatch.setattr(os, "getcwd", lambda: "/")

Приведенный выше код заменяет функцию os.getcwd() на lambda, которая всегда возвращает "/".

Для удобства можно указать строку target, которая будет интерпретирована как точечный путь импорта, причем последняя часть будет именем атрибута:

monkeypatch.setattr("os.getcwd", lambda: "/")

Вызывает AttributeError, если атрибут не существует, если только raising не установлено значение False.

Где ставить пластырь

monkeypatch.setattr работает путем (временной) замены объекта, на который указывает имя, на другой. На любой отдельный объект может указывать множество имен, поэтому для того, чтобы исправление работало, необходимо убедиться, что вы исправляете имя, используемое тестируемой системой.

См. раздел Where to patch в документации unittest.mock для полного объяснения, которое предназначено для unittest.mock.patch(), но применимо и к monkeypatch.setattr.

delattr(target, name=<notset>, raising=True)[исходный код]¶

Удалите атрибут name из target.

Если не указано name и target является строкой, то она будет интерпретирована как точечный путь импорта, последняя часть которого является именем атрибута.

Вызывает ошибку AttributeError, если атрибут не существует, если только raising не установлено значение False.

setitem(dic, name, value)[исходный код]¶

Установите в значение словарную статью name.

delitem(dic, name, raising=True)[исходный код]¶

Удалите name из диктанта.

Вызывает KeyError, если он не существует, если только raising не установлено значение False.

setenv(name, value, prepend=None)[исходный код]¶

Установите переменную окружения name на value.

Если prepend является символом, прочитайте текущее значение переменной окружения и добавьте value, примыкающий к символу prepend.

delenv(name, raising=True)[исходный код]¶

Удалите name из среды.

Вызывает KeyError, если он не существует, если только raising не установлено значение False.

syspath_prepend(path)[исходный код]¶

Добавьте path к sys.path список мест импорта.

chdir(path)[исходный код]¶

Изменить текущий рабочий каталог на указанный путь.

Parameters:

path (Union[str, PathLike[str]]) – Путь к преображению.

undo()[исходный код]¶

Отменить предыдущие изменения.

Этот вызов расходует стек отмены. Вызов во второй раз не имеет никакого эффекта, если только после вызова отмены вы не выполните еще одно исправление обезьян.

Обычно нет необходимости вызывать undo(), так как она вызывается автоматически при завершении работы.

Примечание

Одно и то же приспособление monkeypatch используется в одном вызове тестовой функции. Если monkeypatch используется и самой тестовой функцией, и одним из тестовых приспособлений, вызов undo() отменит все изменения, сделанные в обеих функциях.

Предпочтительнее использовать context() вместо этого.

pytestconfig¶

pytestconfig()[исходный код]¶

Скопированное на сессию приспособление, которое возвращает объект pytest.Config сессии.

Пример:

def test_foo(pytestconfig):
    if pytestconfig.getoption("verbose") > 0:
        ...

pytester¶

Предоставляет экземпляр Pytester, который можно использовать для запуска и тестирования самого pytest.

Он предоставляет пустой каталог, в котором pytest может выполняться изолированно, и содержит средства для написания тестов, конфигурационных файлов и сопоставления с ожидаемым результатом.

Чтобы использовать его, включите в свой самый верхний файл conftest.py:

pytest_plugins = "pytester"

final class Pytester[исходный код]¶

Средства для написания тестов/конфигурационных файлов, выполнения pytest в изоляции и сопоставления с ожидаемым результатом, идеально подходят для тестирования «черного ящика» плагинов pytest.

Он пытается максимально изолировать выполнение теста от внешних факторов, изменяя текущий рабочий каталог на path и переменные окружения во время инициализации.

exception TimeoutExpired[исходный код]¶

plugins: List[Union[str, _PluggyPlugin]]¶

Список плагинов для использования с parseconfig() и runpytest(). Изначально это пустой список, но плагины могут быть добавлены в список. Тип элементов для добавления в список зависит от использующего их метода, так что подробности смотрите в них.

property path: Path¶

Путь к временной директории, используемой для создания файлов/запуска тестов и т.д.

make_hook_recorder(pluginmanager)[исходный код]¶

Создайте новый HookRecorder для PytestPluginManager.

chdir()[исходный код]¶

Cd во временный каталог.

Это делается автоматически при инстанцировании.

makefile(ext, *args, **kwargs)[исходный код]¶

Создайте новый текстовый файл(ы) в тестовом каталоге.

Parameters:

• ext (str) – Расширение, которое должен использовать файл(ы), включая точку, например, .py.

• args (str) – Все аргументы рассматриваются как строки и объединяются с помощью новых строк. Результат записывается как содержимое в файл. Имя файла зависит от тестовой функции, запрашивающей это приспособление.

• kwargs (str) – Каждое ключевое слово является именем файла, а его значение будет записано как содержимое файла.

Result:

Первый созданный файл.

Result type:

Path

Примеры:

pytester.makefile(".txt", "line1", "line2")

pytester.makefile(".ini", pytest="[pytest]\naddopts=-rs\n")

Для создания двоичных файлов используйте непосредственно pathlib.Path.write_bytes():

filename = pytester.path.joinpath("foo.bin")
filename.write_bytes(b"...")

makeconftest(source)[исходный код]¶

Напишите файл contest.py.

Parameters:

source (str) – Содержание.

Result:

Файл conftest.py.

Result type:

Path

makeini(source)[исходный код]¶

Напишите файл tox.ini.

Parameters:

source (str) – Содержание.

Result:

Файл tox.ini.

Result type:

Path

getinicfg(source)[исходный код]¶

Возвращает секцию pytest из конфигурационного файла tox.ini.

makepyprojecttoml(source)[исходный код]¶

Напишите файл pyproject.toml.

Parameters:

source (str) – Содержание.

Result:

Файл pyproject.ini.

Result type:

Path

Добавлено в версии 6.0.

makepyfile(*args, **kwargs)[исходный код]¶

Ярлык для .makefile() с расширением .py.

По умолчанию используется имя теста с расширением „.py“, например test_foobar.py, перезаписывая существующие файлы.

Примеры:

def test_something(pytester):
    # Initial file is created test_something.py.
    pytester.makepyfile("foobar")
    # To create multiple files, pass kwargs accordingly.
    pytester.makepyfile(custom="foobar")
    # At this point, both 'test_something.py' & 'custom.py' exist in the test directory.

maketxtfile(*args, **kwargs)[исходный код]¶

Ярлык для .makefile() с расширением .txt.

По умолчанию используется имя теста с расширением „.txt“, например test_foobar.txt, перезаписывая существующие файлы.

Примеры:

def test_something(pytester):
    # Initial file is created test_something.txt.
    pytester.maketxtfile("foobar")
    # To create multiple files, pass kwargs accordingly.
    pytester.maketxtfile(custom="foobar")
    # At this point, both 'test_something.txt' & 'custom.txt' exist in the test directory.

syspathinsert(path=None)[исходный код]¶

Добавляет каталог к sys.path, по умолчанию path.

Это отменяется автоматически, когда этот объект умирает в конце каждого теста.

Parameters:

path (Optional[Union[str, PathLike[str]]]) – Путь.

mkdir(name)[исходный код]¶

Создайте новый (под)каталог.

Parameters:

name (Union[str, PathLike[str]]) – Имя каталога, относительно пути pytester.

Result:

Созданный каталог.

Result type:

Path

mkpydir(name)[исходный код]¶

Создайте новый пакет python.

Это создаст (под)каталог с пустым файлом __init__.py, чтобы он был распознан как пакет Python.

copy_example(name=None)[исходный код]¶

Скопируйте файл из каталога проекта в testdir.

Parameters:

name (Optional[str]) – Имя файла для копирования.

Result:

Путь к скопированному каталогу (внутри self.path).

Result type:

Path

getnode(config, arg)[исходный код]¶

Получить узел коллекции файла.

Parameters:

• config (Config) – Конфигурация pytest. Для его создания смотрите parseconfig() и parseconfigure().

• arg (Union[str, PathLike[str]]) – Путь к файлу.

Result:

Узел.

Result type:

Union[Collector, Item]

getpathnode(path)[исходный код]¶

Возвращает узел коллекции файла.

Это похоже на getnode(), но использует parseconfigure() для создания (настроенного) экземпляра pytest Config.

Parameters:

path (Union[str, PathLike[str]]) – Путь к файлу.

Result:

Узел.

Result type:

Union[Collector, Item]

genitems(colitems)[исходный код]¶

Генерирует все элементы теста из узла коллекции.

Эта функция обращается к узлу коллекции и возвращает список всех элементов теста, содержащихся в нем.

Parameters:

colitems (Sequence[Union[Item, Collector]]) – Узлы коллекции.

Result:

Собранные предметы.

Result type:

List[Item]

runitem(source)[исходный код]¶

Запустите элемент «test_func».

Вызывающий экземпляр теста (класс, содержащий метод теста) должен предоставить метод .getrunner(), который должен вернуть бегунок, способный запустить протокол теста для одного элемента, например, _pytest.runner.runtestprotocol().

inline_runsource(source, *cmdlineargs)[исходный код]¶

Запустите тестовый модуль в процессе с помощью pytest.main().

Эта прога записывает «исходник» во временный файл и выполняет pytest.main() на нем, возвращая экземпляр HookRecorder для результата.

Parameters:

• source (str) – Исходный код тестового модуля.

• cmdlineargs – Любые дополнительные аргументы командной строки для использования.

inline_genitems(*args)[исходный код]¶

Запустите pytest.main(['--collectonly']) в процессе.

Запускает функцию pytest.main() для выполнения всего pytest внутри самого процесса тестирования, подобно inline_run(), но возвращает кортеж собранных элементов и экземпляр HookRecorder.

inline_run(*args, plugins=(), no_reraise_ctrlc=False)[исходный код]¶

Выполнить pytest.main() в процессе, возвращая HookRecorder.

Выполняет функцию pytest.main() для запуска всего pytest внутри самого процесса тестирования. Это означает, что она может вернуть экземпляр HookRecorder, который дает более подробные результаты этого запуска, чем можно получить путем сопоставления stdout/stderr из runpytest().

Parameters:

• args (Union[str, PathLike[str]]) – Аргументы командной строки для передачи в pytest.main().

• plugins – Дополнительные экземпляры плагинов, которые должен использовать экземпляр pytest.main().

• no_reraise_ctrlc (bool) – Обычно мы возвращаем прерывания клавиатуры из дочерней программы. Если True, перехватывается исключение KeyboardInterrupt.

runpytest_inprocess(*args, **kwargs)[исходный код]¶

Возвращает результат выполнения pytest в процессе, предоставляя интерфейс, аналогичный тому, что предоставляет self.runpytest().

runpytest(*args, **kwargs)[исходный код]¶

Запустить pytest в линию или в подпроцессе, в зависимости от опции командной строки «–runpytest» и вернуть RunResult.

parseconfig(*args)[исходный код]¶

Возвращает новый экземпляр pytest pytest.Config из заданных аргументов командной строки.

Это вызывает код загрузки pytest в _pytest.config для создания нового pytest.PytestPluginManager и вызова хука pytest_cmdline_parse для создания нового экземпляра pytest.Config.

Если plugins были заполнены, они должны быть модулями плагинов, которые должны быть зарегистрированы в менеджере плагинов.

parseconfigure(*args)[исходный код]¶

Возвращает новый экземпляр pytest configured Config.

Возвращает новый экземпляр pytest.Config, подобно parseconfig(), но также вызывает хук pytest_configure.

getitem(source, funcname='test_func')[исходный код]¶

Возвращает элемент теста для тестовой функции.

Записывает исходный текст в файл python и запускает коллекцию pytest на полученном модуле, возвращая элемент теста для запрашиваемого имени функции.

Parameters:

• source (Union[str, PathLike[str]]) – Источник модуля.

• funcname (str) – Имя тестовой функции, для которой нужно вернуть элемент теста.

Result:

Предмет испытания.

Result type:

Item

getitems(source)[исходный код]¶

Верните все тестовые предметы, собранные в модуле.

Записывает исходный текст в файл Python и запускает коллекцию pytest на полученном модуле, возвращая все содержащиеся в нем тестовые элементы.

getmodulecol(source, configargs=(), *, withinit=False)[исходный код]¶

Возвращает узел коллекции модулей для source.

Записывает source в файл, используя makepyfile(), а затем запускает на нем коллекцию pytest, возвращая узел коллекции для тестового модуля.

Parameters:

• source (Union[str, PathLike[str]]) – Исходный код модуля для сбора.

• configargs – Любые дополнительные аргументы для передачи в parseconfigure().

• withinit (bool) – Нужно ли также записывать файл __init__.py в тот же каталог, чтобы убедиться, что это пакет.

collect_by_name(modcol, name)[исходный код]¶

Возвращает узел коллекции для имени из коллекции модулей.

Выполняет поиск узла коллекции модуля в поисках узла коллекции, соответствующего заданному имени.

Parameters:

• modcol (Collector) – Узел коллекции модулей; см. getmodulecol().

• name (str) – Имя узла, который нужно вернуть.

popen(cmdargs, stdout=-1, stderr=-1, stdin=NotSetType.token, **kw)[исходный код]¶

Вызвать subprocess.Popen.

Вызывает subprocess.Popen, убедившись, что текущий рабочий каталог находится в PYTHONPATH.

Вероятно, вместо этого лучше использовать run().

run(*cmdargs, timeout=None, stdin=NotSetType.token)[исходный код]¶

Запуск команды с аргументами.

Запустите процесс с помощью subprocess.Popen с сохранением stdout и stderr.

Parameters:

• cmdargs (Union[str, PathLike[str]]) – Последовательность аргументов для передачи в subprocess.Popen, при этом объекты типа path преобразуются в str автоматически.

• timeout (Optional[float]) – Период в секундах, по истечении которого произойдет тайм-аут и возникнет ошибка Pytester.TimeoutExpired.

• stdin (Union[NotSetType, bytes, IO[Any], int]) – Необязательный стандартный ввод. - Если он имеет тип CLOSE_STDIN (По умолчанию), то этот метод вызывает subprocess.Popen с stdin=subprocess.PIPE, и стандартный ввод закрывается сразу после запуска новой команды. - Если он имеет тип bytes, то эти байты передаются на стандартный вход команды. - В противном случае они передаются в subprocess.Popen. Для получения дополнительной информации в этом случае обратитесь к документу параметра stdin в subprocess.Popen.

Result:

Результат.

Result type:

RunResult

runpython(script)[исходный код]¶

Запустите сценарий python, используя sys.executable в качестве интерпретатора.

runpython_c(command)[исходный код]¶

Выполнить python -c "command".

runpytest_subprocess(*args, timeout=None)[исходный код]¶

Запуск pytest в качестве подпроцесса с заданными аргументами.

Любые плагины, добавленные в список plugins, будут добавлены с помощью опции командной строки -p. Дополнительно --basetemp используется для помещения любых временных файлов и каталогов в пронумерованный каталог с префиксом «runpytest-», чтобы не конфликтовать с обычным пронумерованным расположением временных файлов и каталогов pytest.

Parameters:

• args (Union[str, PathLike[str]]) – Последовательность аргументов для передачи в подпроцесс pytest.

• timeout (Optional[float]) – Период в секундах, по истечении которого произойдет тайм-аут и возникнет ошибка Pytester.TimeoutExpired.

Result:

Результат.

Result type:

RunResult

spawn_pytest(string, expect_timeout=10.0)[исходный код]¶

Запустите pytest с помощью pexpect.

Это гарантирует использование правильного pytest и устанавливает местоположение временных каталогов.

Возвращается ребенок pexpect.

spawn(cmd, expect_timeout=10.0)[исходный код]¶

Выполните команду с помощью pexpect.

Возвращается ребенок pexpect.

final class RunResult[исходный код]¶

Результат выполнения команды из Pytester.

ret: Union[int, ExitCode]¶

Возвращаемое значение.

outlines¶

Список строк, захваченных из stdout.

errlines¶

Список строк, захваченных из stderr.

stdout¶

LineMatcher из stdout.

Используйте, например, str(stdout) для восстановления stdout или широко используемый метод stdout.fnmatch_lines().

stderr¶

LineMatcher из stderr.

duration¶

Продолжительность в секундах.

parseoutcomes()[исходный код]¶

Возвращает словарь итоговых существительных -> подсчет, полученный в результате разбора терминального вывода, который произвел процесс тестирования.

Возвращаемые существительные всегда будут иметь форму множественного числа:

======= 1 failed, 1 passed, 1 warning, 1 error in 0.13s ====

Возвращает {"failed": 1, "passed": 1, "warnings": 1, "errors": 1}.

classmethod parse_summary_nouns(lines)[исходный код]¶

Извлечение существительных из итоговой строки терминала pytest.

Он всегда возвращает существительное во множественном числе для согласованности:

======= 1 failed, 1 passed, 1 warning, 1 error in 0.13s ====

Возвращает {"failed": 1, "passed": 1, "warnings": 1, "errors": 1}.

assert_outcomes(passed=0, skipped=0, failed=0, errors=0, xpassed=0, xfailed=0, warnings=None, deselected=None)[исходный код]¶

Убедитесь, что указанные результаты появляются с соответствующими номерами (0 означает, что ничего не произошло) в текстовом выводе тестового запуска.

warnings и deselected проверяются, только если не None.

class LineMatcher[исходный код]¶

Гибкое согласование текста.

Это удобный класс для тестирования больших текстов, например, вывода команд.

Конструктор принимает список строк без концевых новых строк, т.е. text.splitlines().

__str__()[исходный код]¶

Верните весь оригинальный текст.

Добавлено в версии 6.2: В старых версиях можно использовать str().

fnmatch_lines_random(lines2)[исходный код]¶

Проверьте наличие строк в выводе в любом порядке (используя fnmatch.fnmatch()).

re_match_lines_random(lines2)[исходный код]¶

Проверьте наличие строк в выводе в любом порядке (используя re.match()).

get_lines_after(fnline)[исходный код]¶

Возвращает все строки, следующие за заданной строкой в тексте.

Данная строка может содержать подстановочные знаки glob.

fnmatch_lines(lines2, *, consecutive=False)[исходный код]¶

Проверьте наличие строк в выводе (используя fnmatch.fnmatch()).

Аргументом является список строк, которые должны совпадать и могут использовать подстановочные знаки glob. Если они не совпадают, вызывается pytest.fail(). Совпадения и несовпадения также отображаются в сообщении об ошибке.

Parameters:

• lines2 (Sequence[str]) – Строковые шаблоны для сопоставления.

• consecutive (bool) – Совмещать линии последовательно?

re_match_lines(lines2, *, consecutive=False)[исходный код]¶

Проверьте наличие строк в выводе (используя re.match()).

Аргументом является список строк, которые должны совпадать с помощью re.match. Если они не совпадают, вызывается pytest.fail().

Совпадения и несовпадения также отображаются как часть сообщения об ошибке.

Parameters:

• lines2 (Sequence[str]) – строковые шаблоны для сопоставления.

• consecutive (bool) – последовательное совпадение строк?

no_fnmatch_line(pat)[исходный код]¶

Убедитесь, что захваченные строки не соответствуют заданному шаблону, используя fnmatch.fnmatch.

Parameters:

pat (str) – Шаблон для сопоставления строк.

no_re_match_line(pat)[исходный код]¶

Убедитесь, что захваченные строки не соответствуют заданному шаблону, используя re.match.

Parameters:

pat (str) – Регулярное выражение для сопоставления строк.

str()[исходный код]¶

Верните весь оригинальный текст.

final class HookRecorder[исходный код]¶

Запись всех хуков, вызываемых в менеджере плагинов.

Записывающие крючки создаются с помощью Pytester.

Это обертывает все вызовы хуков в менеджере плагинов, записывая каждый вызов перед распространением обычных вызовов.

getcalls(names)[исходный код]¶

Получить все записанные звонки на крючки с заданными именами (или названием).

matchreport(inamepart='', names=('pytest_runtest_logreport', 'pytest_collectreport'), when=None)[исходный код]¶

Возвращает тест-отчет, путь к которому совпадает с пунктирным путем импорта.

final class RecordedHookCall[исходный код]¶

Записанный звонок на крючок.

Аргументы вызова крючка устанавливаются как атрибуты. Например:

calls = hook_recorder.getcalls("pytest_runtest_setup")
# Suppose pytest_runtest_setup was called once with `item=an_item`.
assert calls[0].item is an_item

свойство_записи¶

Учебник: свойство_записи

record_property()[исходный код]¶

Добавьте дополнительные свойства к вызывающему тесту.

Пользовательские свойства становятся частью отчета о тестировании и доступны для сконфигурированных журналистов, подобно JUnit XML.

Приспособление можно вызвать с помощью name, value. Значение автоматически кодируется в XML.

Пример:

def test_function(record_property):
    record_property("example_key", 1)

запись_тестуемого_свойства¶

Учебник: запись_тестуемого_свойства

record_testsuite_property()[исходный код]¶

Запишите новый тег <property> как дочерний тег корневого <testsuite>.

Это подходит для записи глобальной информации обо всем тестовом наборе и совместимо с семейством xunit2 JUnit.

Это session-скопированное приспособление, которое вызывается с помощью (name, value). Пример:

def test_foo(record_testsuite_property):
    record_testsuite_property("ARCH", "PPC")
    record_testsuite_property("STORAGE_TYPE", "CEPH")

Parameters:

• name – Имя свойства.

• value – Значение свойства. Будет преобразовано в строку.

Предупреждение

В настоящее время это приспособление не работает с плагином pytest-xdist. Подробности смотрите в issue #7767.

повторное предупреждение¶

Учебник: Утверждение предупреждений с помощью функции warns

recwarn()[исходный код]¶

Возвращает экземпляр WarningsRecorder, который записывает все предупреждения, выданные тестовыми функциями.

Информацию о категориях предупреждений см. на сайте https://docs.pytest.org/en/latest/how-to/capture-warnings.html.

class WarningsRecorder[исходный код]¶

Контекстный менеджер для записи поднятых предупреждений.

Каждое записанное предупреждение является экземпляром warnings.WarningMessage.

Адаптировано из warnings.catch_warnings.

Примечание

DeprecationWarning и PendingDeprecationWarning обрабатываются по-разному; см. Обеспечение срабатывания предупреждения об устаревании кода.

property list: List[WarningMessage]¶

Список записанных предупреждений.

pop(cls=<class 'Warning'>)[исходный код]¶

Выдавать первое записанное предупреждение, поднимать исключение, если оно не существует.

clear()[исходный код]¶

Очистить список записанных предупреждений.

запрос¶

Пример: Передавать различные значения в тестовую функцию в зависимости от опций командной строки

Приспособление request - это специальное приспособление, предоставляющее информацию о запрашивающей тестовой функции.

class FixtureRequest[исходный код]¶

Запрос на приспособление от функции испытания или приспособления.

Объект запроса предоставляет доступ к запрашивающему тестовому контексту и имеет необязательный атрибут param в случае, если приспособление параметризуется косвенно.

fixturename: Optional[str]¶

Приспособление, для которого выполняется данный запрос.

property scope: _ScopeName¶

Строка области видимости, одна из «function», «class», «module», «package», «session».

property fixturenames: List[str]¶

Имена всех активных светильников в данном запросе.

property node¶

Базовый узел коллекции (зависит от текущего диапазона запроса).

property config: Config¶

Объект конфигурации pytest, связанный с этим запросом.

property function¶

Объект тестовой функции, если запрос имеет область действия для каждой функции.

property cls¶

Класс (может быть None), в котором была собрана тестовая функция.

property instance¶

Экземпляр (может быть None), на котором была собрана тестовая функция.

property module¶

Объект модуля Python, в котором была собрана тестовая функция.

property path: Path¶

Путь, где была собрана тестовая функция.

property keywords: MutableMapping[str, Any]¶

Словарь ключевых слов/маркеров для базового узла.

property session: Session¶

Объект сессии Pytest.

addfinalizer(finalizer)[исходный код]¶

Добавьте функцию finalizer/teardown, которая будет вызываться без аргументов после завершения выполнения последнего теста в запрашивающем тестовом контексте.

applymarker(marker)[исходный код]¶

Применить маркер к одному вызову тестовой функции.

Этот метод полезен, если вы не хотите иметь ключевое слово/маркер на всех вызовах функций.

Parameters:

marker (Union[str, MarkDecorator]) – Объект, созданный вызовом pytest.mark.NAME(...).

raiseerror(msg)[исходный код]¶

Вызывает исключение FixtureLookupError.

Parameters:

msg (Optional[str]) – Необязательное пользовательское сообщение об ошибке.

getfixturevalue(argname)[исходный код]¶

Динамический запуск именованной функции приспособления.

Объявление приспособлений через аргумент функции рекомендуется там, где это возможно. Но если вы можете принять решение об использовании другого приспособления только во время настройки теста, вы можете использовать эту функцию для его получения внутри приспособления или тела тестовой функции.

Этот метод может быть использован на этапе настройки испытания или на этапе выполнения испытания, но на этапе разрушения испытания значение приспособления может быть недоступно.

Parameters:

argname (str) – Имя приспособления.

Exception:

pytest.FixtureLookupError – Если данное приспособление не удалось найти.

testdir¶

Идентичен pytester, но предоставляет экземпляр, методы которого возвращают унаследованные объекты py.path.local, когда это применимо.

В новом коде следует избегать использования testdir в пользу pytester.

final class Testdir[исходный код]

Аналогичен Pytester, но этот класс работает с объектами legacy legacy_path.

Все методы просто направляются к внутреннему экземпляру Pytester, преобразуя результаты в объекты legacy_path по мере необходимости.

exception TimeoutExpired

property tmpdir: LocalPath

Временный каталог, в котором выполняются тесты.

make_hook_recorder(pluginmanager)[исходный код]

См. Pytester.make_hook_recorder().

chdir()[исходный код]

См. Pytester.chdir().

finalize()[исходный код]

См. Pytester._finalize().

makefile(ext, *args, **kwargs)[исходный код]

См. Pytester.makefile().

makeconftest(source)[исходный код]

См. Pytester.makeconftest().

makeini(source)[исходный код]

См. Pytester.makeini().

getinicfg(source)[исходный код]

См. Pytester.getinicfg().

makepyprojecttoml(source)[исходный код]

См. Pytester.makepyprojecttoml().

makepyfile(*args, **kwargs)[исходный код]

См. Pytester.makepyfile().

maketxtfile(*args, **kwargs)[исходный код]

См. Pytester.maketxtfile().

syspathinsert(path=None)[исходный код]

См. Pytester.syspathinsert().

mkdir(name)[исходный код]

См. Pytester.mkdir().

mkpydir(name)[исходный код]

См. Pytester.mkpydir().

copy_example(name=None)[исходный код]

См. Pytester.copy_example().

getnode(config, arg)[исходный код]

См. Pytester.getnode().

getpathnode(path)[исходный код]

См. Pytester.getpathnode().

genitems(colitems)[исходный код]

См. Pytester.genitems().

runitem(source)[исходный код]

См. Pytester.runitem().

inline_runsource(source, *cmdlineargs)[исходный код]

См. Pytester.inline_runsource().

inline_genitems(*args)[исходный код]

См. Pytester.inline_genitems().

inline_run(*args, plugins=(), no_reraise_ctrlc=False)[исходный код]

См. Pytester.inline_run().

runpytest_inprocess(*args, **kwargs)[исходный код]

См. Pytester.runpytest_inprocess().

runpytest(*args, **kwargs)[исходный код]

См. Pytester.runpytest().

parseconfig(*args)[исходный код]

См. Pytester.parseconfig().

parseconfigure(*args)[исходный код]

См. Pytester.parseconfigure().

getitem(source, funcname='test_func')[исходный код]

См. Pytester.getitem().

getitems(source)[исходный код]

См. Pytester.getitems().

getmodulecol(source, configargs=(), withinit=False)[исходный код]

См. Pytester.getmodulecol().

collect_by_name(modcol, name)[исходный код]

См. Pytester.collect_by_name().

popen(cmdargs, stdout=-1, stderr=-1, stdin=NotSetType.token, **kw)[исходный код]

См. Pytester.popen().

run(*cmdargs, timeout=None, stdin=NotSetType.token)[исходный код]

См. Pytester.run().

runpython(script)[исходный код]

См. Pytester.runpython().

runpython_c(command)[исходный код]

См. Pytester.runpython_c().

runpytest_subprocess(*args, timeout=None)[исходный код]

См. Pytester.runpytest_subprocess().

spawn_pytest(string, expect_timeout=10.0)[исходный код]

См. Pytester.spawn_pytest().

spawn(cmd, expect_timeout=10.0)[исходный код]

См. Pytester.spawn().

tmp_path¶

Учебник: Как использовать временные каталоги и файлы в тестах

tmp_path()[исходный код]¶

Возвращает объект пути к временному каталогу, уникальный для каждого вызова тестовой функции, созданный как подкаталог базового временного каталога.

По умолчанию новый временный каталог базы создается каждый сеанс тестирования, а старые базы удаляются после 3 сеансов, чтобы облегчить отладку. Если используется --basetemp, то он очищается после каждой сессии. См. Базовый временный каталог по умолчанию.

Возвращаемый объект является объектом pathlib.Path.

tmp_путь_фабрики¶

Учебник: Приспособление tmp_path_factory

tmp_path_factory является экземпляром TempPathFactory:

final class TempPathFactory[исходный код]¶

Фабрика для временных каталогов под общим базовым каталогом temp.

Базовый каталог может быть настроен с помощью опции --basetemp.

mktemp(basename, numbered=True)[исходный код]¶

Создайте новый временный каталог, управляемый фабрикой.

Parameters:

• basename (str) – Имя базы каталога, должно быть относительным путем.

• numbered (bool) – Если True, убедитесь, что каталог уникален, добавив нумерованный суффикс, больший, чем любой существующий: basename="foo-" и numbered=True означает, что эта функция создаст каталоги с именами "foo-0", "foo-1", "foo-2" и так далее.

Result:

Путь к новому каталогу.

Result type:

Path

getbasetemp()[исходный код]¶

Возвращает базовый временный каталог, создавая его при необходимости.

Result:

Базовый временный каталог.

Result type:

Path