python.external_config.configuration_state module¶

class ConfigurationState(bg_task_manager, parent)[source]¶

Bases: sphinx.ext.autodoc.importer._MockObject

Represents the state in Shotgun which may affect configurations and ultimately registered commands.

Looks at the following items:

As an example, changing a software entity may affect the list of registered commands.

Signals

Signal state_changed():
	Indicates that the state has changed since it was last checked.

get_configuration_hash()[source]¶

Returns a hash representing the global state of Shotgun.

Returns:	Hash string or `None` if not yet defined.

get_software_hash()[source]¶

Returns a hash representing the state of the software entity in Shotgun.

Returns:	Hash string or `None` if not yet defined.

refresh()[source]¶: Trigger an asynchronous background check of the Shotgun site configuration state. If a change is detected, indicating that configurations should be recomputed, a state_changed signal is emitted.