python.external_config.external_command_utils module

enabled_on_current_os(properties)[source]

Checks toolkit command properties to determine if a command is enabled on the current OS or not.

Parameters:properties (dict) – Properties dictionary as returned by the Engine.commands dictionary property.
Returns:True if enabled, False if not.
serialize_command(engine_name, entity_type, command_name, properties)[source]

Generates a data chunk given a set of standard Toolkit command data, as obtained from engine.commands.

This can be passed to create() in order to construct a ExternalCommand instance.

Parameters:
  • engine_name (str) – Name of engine command is associated with.
  • entity_type (str) – Shotgun entity type that the command is associated with.
  • command_name (str) – Command name (the key name for an entry in engine.commands)
  • properties (dict) – Properties dictionary as returned by the Engine.commands dictionary property.
Returns:

dictionary suitable to pass to create().