pyt

class FilterNamespace(value: Any, *, when: str | dict[str, str] | None = None, expect: int | str | None = None, result: str | None = None, action: str | None = None, **kwargs: Any)

Bases: object

enabled(testname: str | None = None, on_options: list[str] | None = None, parameters: dict[str, Any] | None = None) → bool

class PYTTestGenerator(root: str, path: str | None = None)

Bases: AbstractTestGenerator

file_patterns: ClassVar[tuple[str, ...]] = ('*.pyt', 'canary_*.py')

describe(on_options: list[str] | None = None) → str

Return a description of the test

info() → dict[str, Any]

lock(on_options: list[str] | None = None) → list[UnresolvedSpec]

Expand parameters and instantiate concrete test cases

Parameters:

on_options – User specified options used to filter tests. Test cases not matching on_options should be masked.

Notes

For further discussion on filtering tests see Filtering tests.

property filter_warnings: bool

property skipif_reason: str | None

keywords(testname: str | None = None, parameters: dict[str, Any] | None = None, raw: bool = False) → list[str]

xstatus(testname: str | None = None, on_options: list[str] | None = None, parameters: dict[str, Any] | None = None) → int

preload(testname: str | None = None, on_options: list[str] | None = None, parameters: dict[str, Any] | None = None) → str | None

modules(testname: str | None = None, on_options: list[str] | None = None, parameters: dict[str, Any] | None = None) → list[tuple[str, str | None]]

rcfiles(testname: str | None = None, on_options: list[str] | None = None, parameters: dict[str, Any] | None = None) → list[str]

artifacts(testname: str | None = None, on_options: list[str] | None = None, parameters: dict[str, Any] | None = None) → list[Artifact]

exclusive(testname: str | None = None, on_options: list[str] | None = None, parameters: dict[str, Any] | None = None) → bool

paramsets(testname: str | None = None, on_options: list[str] | None = None) → list[ParameterSet]

attributes(testname: str | None = None, on_options: list[str] | None = None, parameters: dict[str, Any] | None = None) → dict[str, Any]

names() → list[str]

generate_composite_base_case(testname: str | None = None, on_options: list[str] | None = None) → FilterNamespace | None

timeout(testname: str | None = None, on_options: list[str] | None = None, parameters: dict[str, Any] | None = None) → float | None

enable(testname: str | None = None, on_options: list[str] | None = None, parameters: dict[str, Any] | None = None) → tuple[bool, str | None]

baseline(testname: str | None = None, on_options: list[str] | None = None, parameters: dict[str, Any] | None = None) → list[str | tuple[str, str]]

file_resources(testname: str | None = None, on_options: list[str] | None = None, parameters: dict[str, Any] | None = None) → dict[Literal['copy', 'link', 'none'], list[tuple[str, str | None]]]

depends_on(testname: str | None = None, on_options: list[str] | None = None, parameters: dict[str, Any] | None = None) → list[str | DependencyPatterns]

static safe_substitute(string: str, **kwds) → str

m_keywords(*args: str, when: str | dict[str, str] | None = None) → None

m_xfail(*, code: int = -1, when: str | dict[str, str] | None = None) → None

m_xdiff(*, when: str | dict[str, str] | None = None) → None

m_owners(*args: str) → None

m_depends_on(arg: str | list[str], when: str | dict[str, str] | None = None, result: str | None = None, expect: int | str | None = None) → None

m_preload(arg: str, when: str | dict[str, str] | None = None) → None

m_module(arg: str, when: str | dict[str, str] | None = None, use: str | None = None) → None

m_rcfile(arg: str, when: str | dict[str, str] | None = None) → None

m_artifact(file: str, when: str | dict[str, str] | None = None, upon: str = 'always') → None

m_exclusive(when: str | dict[str, str] | None = None) → None

m_parameterize(argnames: str | Sequence[str], argvalues: list[Sequence[Any] | Any], when: str | dict[str, str] | None = None, type: enums | None = None, samples: int = 10, random_seed: float = 1234.0) → None

m_set_attribute(when: str | dict[str, str] | None = None, **kwargs: Any) → None

add_sources(action: str, *files: str, src: str | None = None, dst: str | None = None, when: str | dict[str, str] | None = None) → None

m_copy(*files: str, src: str | None = None, dst: str | None = None, when: str | dict[str, str] | None = None) → None

m_link(*files: str, src: str | None = None, dst: str | None = None, when: str | dict[str, str] | None = None) → None

m_sources(*files: str, when: str | dict[str, str] | None = None) → None

m_generate_composite_base_case(*, flag: str | None = None, script: str | None = None, when: str | dict[str, str] | None = None, requires: str = 'success') → None

m_name(arg: str) → None

m_timeout(arg: str | float | int, when: str | dict[str, str] | None = None) → None

testname parameter parameters platform platforms option options

m_filter_warnings(arg: bool) → None

m_skipif(arg: bool, *, reason: str) → None

m_stages(*args: str) → None

m_enable(arg: bool, when: str | dict[str, str] | None = None) → None

m_baseline(src: str | None = None, dst: str | None = None, when: str | dict[str, str] | None = None, flag: str | None = None) → None

load()

f_generate_composite_base_case(*, when: str | dict[str, str] | None = None, flag: str | None = None, script: str | None = None, requires: str = 'success')

f_analyze(*, when: str | dict[str, str] | None = None, flag: str | None = None, script: str | None = None, requires: str = 'success')

f_copy(*args: str, src: str | None = None, dst: str | None = None, when: str | dict[str, str] | None = None)

f_depends_on(*args: str, when: str | dict[str, str] | None = None, expect: int | str | None = None, result: str | None = None)

f_enable(*args: bool, when: str | dict[str, str] | None = None)

f_keywords(*args: str, when: str | dict[str, str] | None = None) → None

f_link(*args: str, src: str | None = None, dst: str | None = None, when: str | dict[str, str] | None = None)

f_owners(*args: str)

f_owner(arg: str)

f_parameterize(names: str | Sequence[str], values: list[Sequence[Any] | Any], *, when: str | dict[str, str] | None = None, type: enums = enums.list_parameter_space, samples: int = 10) → None

f_preload(arg: str, *, when: str | dict[str, str] | None = None) → None

f_load_module(arg: str, *, when: str | dict[str, str] | None = None, use: str | None = None) → None

f_source(arg: str, *, when: str | dict[str, str] | None = None)

f_stages(*args: str) → None

f_artifact(file: str, *, when: str | dict[str, str] | None = None, upon: str = 'always') → None

f_exclusive(*, when: str | dict[str, str] | None = None) → None

f_set_attribute(*, when: str | dict[str, str] | None = None, **attributes: Any) → None

f_filter_warnings(arg: bool) → None

f_skipif(arg: bool, *, reason: str) → None

f_sources(*args: str, when: str | dict[str, str] | None = None)

f_testname(arg: str) → None

f_name(arg: str) → None

f_timeout(arg: str | float | int, *, when: str | dict[str, str] | None = None)

f_xdiff(*, when: str | dict[str, str] | None = None)

f_xfail(*, code: int = -1, when: str | dict[str, str] | None = None)

f_baseline(src: str | None = None, dst: str | None = None, when: str | dict[str, str] | None = None, flag: str | None = None) → None

canary_collectstart(collector) → None