python.external_config.scripts.external_runner module

exception EngineStartupError[source]

Bases: exceptions.Exception

Indicates that bootstrapping into the engine failed.

cache_commands(engine, entity_type, entity_id, cache_path)[source]

Caches registered commands for the given engine. If the engine is None, an empty list of actions is cached.

Parameters:
  • entity_type (str) – Entity type
  • entity_id (str) – Entity id
  • engine – Engine instance or None
  • cache_path (str) – Path to write cached data to
main()[source]

Main method, executed from inside a QT event loop.

start_engine(configuration_uri, pipeline_config_id, plugin_id, engine_name, entity_type, entity_id, bundle_cache_fallback_paths, pre_cache)[source]

Bootstraps into an engine.

Parameters:
  • configuration_uri (str) – URI to bootstrap (for when pipeline config id is unknown).
  • pipeline_config_id (int) – Associated pipeline config id
  • plugin_id (str) – Plugin id to use for bootstrap
  • engine_name (str) – Engine name to launch
  • entity_type (str) – Entity type to launch
  • entity_id (str) – Entity id to launch
  • bundle_cache_fallback_paths (list) – List of bundle cache paths to include.
  • pre_cache (bool) – If set to True, starting up the command will also include a full caching of all necessary dependencies for all contexts and engines.