nuketesting.runner.configuration
================================

.. py:module:: nuketesting.runner.configuration

.. autoapi-nested-parse::

   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
---------

.. autoapisummary::

   nuketesting.runner.configuration.find_configuration
   nuketesting.runner.configuration.load_runners


Module Contents
---------------

.. py:function:: 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".

   :param start_path: the starting directory/file where the search begins.

   :returns: The found "runners.json" or None.


.. py:function:: load_runners(filepath: pathlib.Path) -> dict[str, nuketesting.runner.runner.Runner]

   Load all runners specified in the config file.

   :param filepath: the config filepath.

   :returns: dictionary of runner name and loaded runner.