nuketesting.runner.configuration¶

Runner configuration module.

This is used to load test runners from the configuration file. Runner configuration is expected to be in the format:

>>> {
...  "runner_name": {
...    "exe": "path/to/nuke/executable",
...    "args": ["list of arguments for nuke"],
...    "run_in_terminal_mode": True,
...    "pytest_args": ["list of arguments to pass to pytest"]
...   }
... }

Functions¶

`find_configuration`(→ pathlib.Path \| None)	Find a configuration file that is part of the current test.
`load_runners`(→ dict[str, nuketesting.runner.runner.Runner])	Load all runners specified in the config file.

Module Contents¶

find_configuration(start_path: pathlib.Path) → pathlib.Path | None¶

Find a configuration file that is part of the current test.

This will return the first configuration that is found. It will traverse the directories up to find a “runners.json”.

Parameters:: start_path – the starting directory/file where the search begins.
Returns:: The found “runners.json” or None.

load_runners(filepath: pathlib.Path) → dict[str, nuketesting.runner.runner.Runner]¶

Load all runners specified in the config file.

Parameters:: filepath – the config filepath.
Returns:: dictionary of runner name and loaded runner.