tk-framework-shotgunutils
v5.6.1
Changelog
How To
Shotgun Model
Shotgun Hierarchy Model
Shotgun Asynchronous Data Retriever
Background Task Processing
Shotgun Toolkit Qt Settings Wrapper
Shotgun Globals Access
External Configuration Management
Reference
API
tk-framework-shotgunutils
Docs
»
Index
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
K
|
L
|
M
|
N
|
P
|
Q
|
R
|
S
|
T
|
U
|
W
A
accessibleDescription() (ShotgunStandardItem method)
accessibleText() (ShotgunStandardItem method)
add_item() (ShotgunDataHandlerCache method)
add_pass_through_task() (BackgroundTaskManager method)
add_task() (BackgroundTaskManager method)
ADDED (ShotgunDataHandler attribute)
append_upstream_result() (BackgroundTask method)
async_item_from_entity() (ShotgunHierarchyModel method)
async_item_from_paths() (ShotgunHierarchyModel method)
async_item_retrieval_completed (ShotgunHierarchyModel attribute)
async_refresh() (ShotgunEntityModel method)
B
BackgroundTask (class in python.task_manager.background_task)
BackgroundTaskManager (class in python.task_manager.background_task_manager)
base_config_uri (ExternalConfigurationLoader attribute)
C
CACHE_BY_UID (ShotgunDataHandlerCache attribute)
CACHE_CHILDREN (ShotgunDataHandlerCache attribute)
cache_commands() (in module python.external_config.scripts.external_runner)
cache_loaded (ShotgunQueryModel attribute)
CachedShotgunSchema (class in python.shotgun_globals.cached_schema)
CacheReadVersionMismatch
canFetchMore() (ShotgunQueryModel method)
clear() (ShotgunDataRetriever method)
(ShotgunQueryModel method)
clear_cached_data() (python.shotgun_globals.cached_schema.CachedShotgunSchema class method)
color_mix() (in module python.utils.color)
commands_load_failed (ExternalConfiguration attribute)
commands_loaded (ExternalConfiguration attribute)
compare_shotgun_data() (in module python.shotgun_model.util)
CONFIGURATION_INACCESSIBLE (ExternalConfiguration attribute)
CONFIGURATION_READY (ExternalConfiguration attribute)
configurations_changed (ExternalConfigurationLoader attribute)
configurations_loaded (ExternalConfigurationLoader attribute)
ConfigurationState (class in python.external_config.configuration_state)
create() (python.external_config.external_command.ExternalCommand class method)
create_fallback_configuration() (in module python.external_config.config.factory)
create_from_pipeline_configuration_data() (in module python.external_config.config.factory)
create_human_readable_date() (in module python.shotgun_globals.date_time)
create_human_readable_timestamp() (in module python.shotgun_globals.date_time)
create_parameter_file() (in module python.external_config.util)
D
data() (ShotgunStandardItem method)
DATA_HANDLER_CLASS (ShotgunModel attribute)
data_refresh_fail (ShotgunQueryModel attribute)
data_refreshed (ShotgunQueryModel attribute)
data_refreshing (ShotgunQueryModel attribute)
delete_cache() (in module python.external_config.file_cache)
DELETED (ShotgunDataHandler attribute)
descriptor_uri (ExternalConfiguration attribute)
deserialize() (in module python.external_config.config.factory)
(python.external_config.external_command.ExternalCommand class method)
destroy() (ShotgunEntityModel method)
(ShotgunQueryModel method)
destroy_framework() (ShotgunUtilsFramework method)
display_name (ExternalCommand attribute)
download_thumbnail() (ShotgunDataRetriever static method)
download_thumbnail_source() (ShotgunDataRetriever static method)
E
emit_completed() (ResultsDispatcher method)
emit_failure() (ResultsDispatcher method)
enabled_on_current_os() (in module python.external_config.external_command_utils)
engine_name (ExternalCommand attribute)
(ExternalConfiguration attribute)
(ExternalConfigurationLoader attribute)
EngineStartupError
ensure_data_is_loaded() (ShotgunModel method)
entity_ids (ShotgunModel attribute)
entity_type() (ShotgunHierarchyItem method)
excluded_permission_groups_hint (ExternalCommand attribute)
execute() (ExternalCommand method)
execute_create() (ShotgunDataRetriever method)
execute_delete() (ShotgunDataRetriever method)
execute_find() (ShotgunDataRetriever method)
execute_find_one() (ShotgunDataRetriever method)
execute_method() (ShotgunDataRetriever method)
execute_nav_expand() (ShotgunDataRetriever method)
execute_nav_search_entity() (ShotgunDataRetriever method)
execute_nav_search_string() (ShotgunDataRetriever method)
execute_on_multiple_entities() (ExternalCommand method)
execute_text_search() (ShotgunDataRetriever method)
execute_update() (ShotgunDataRetriever method)
ExternalCommand (class in python.external_config.external_command)
ExternalConfigParseError
ExternalConfiguration (class in python.external_config.config.config_base)
ExternalConfigurationLoader (class in python.external_config.external_config_loader)
F
FallbackExternalConfiguration (class in python.external_config.config.config_fallback)
fetchMore() (ShotgunHierarchyModel method)
(ShotgunQueryModel method)
FIELD (ShotgunDataHandlerCache attribute)
field (ShotgunItemData attribute)
field_is_editable() (python.shotgun_globals.cached_schema.CachedShotgunSchema class method)
field_is_visible() (python.shotgun_globals.cached_schema.CachedShotgunSchema class method)
FIRST_COLUMN_HEADER (ShotgunModel attribute)
FORMAT_VERSION (ShotgunDataHandler attribute)
framework (module)
G
generate_child_nodes() (ShotgunDataHandler method)
generate_data_request() (ShotgunDataHandler method)
(ShotgunFindDataHandler method)
(ShotgunNavDataHandler method)
get_additional_column_fields() (ShotgunModel method)
get_all_items() (ShotgunDataHandlerCache method)
get_cache_path() (in module python.external_config.file_cache)
get_child_uids() (ShotgunDataHandlerCache method)
get_children() (ShotgunDataHandlerCache method)
get_configuration_hash() (ConfigurationState method)
get_data_item_from_uid() (ShotgunDataHandler method)
get_data_type() (python.shotgun_globals.cached_schema.CachedShotgunSchema class method)
get_empty_phrase() (python.shotgun_globals.cached_schema.CachedShotgunSchema class method)
get_entities() (ShotgunEntityModel method)
get_entity() (ShotgunEntityModel method)
get_entity_fields() (python.shotgun_globals.cached_schema.CachedShotgunSchema class method)
get_entity_icon() (ShotgunEntityModel method)
get_entity_ids() (ShotgunFindDataHandler method)
get_entity_type() (ShotgunModel method)
get_entity_type_icon() (in module python.shotgun_globals.icon)
get_entity_type_icon_url() (in module python.shotgun_globals.icon)
get_entry_by_uid() (ShotgunDataHandlerCache method)
get_field_display_name() (python.shotgun_globals.cached_schema.CachedShotgunSchema class method)
get_filters() (ShotgunModel method)
get_ordered_status_list() (python.shotgun_globals.cached_schema.CachedShotgunSchema class method)
get_sanitized_data() (in module python.shotgun_model.util)
get_schema() (ShotgunDataRetriever method)
get_sg_data() (in module python.shotgun_model.util)
(ShotgunStandardItem method)
get_shotgun_data() (ShotgunDataHandlerCache method)
get_software_hash() (ConfigurationState method)
get_status_color() (python.shotgun_globals.cached_schema.CachedShotgunSchema class method)
get_status_display_name() (python.shotgun_globals.cached_schema.CachedShotgunSchema class method)
get_type_display_name() (python.shotgun_globals.cached_schema.CachedShotgunSchema class method)
get_uid_from_entity_id() (ShotgunFindDataHandler method)
get_valid_types() (python.shotgun_globals.cached_schema.CachedShotgunSchema class method)
get_valid_values() (python.shotgun_globals.cached_schema.CachedShotgunSchema class method)
group (BackgroundTask attribute)
(ExternalCommand attribute)
H
hard_refresh() (ShotgunQueryModel method)
has_children() (ShotgunHierarchyItem method)
hasChildren() (ShotgunQueryModel method)
I
icon (ExternalCommand attribute)
index_from_entity() (ShotgunModel method)
init_framework() (ShotgunUtilsFramework method)
interpreter (ExternalConfiguration attribute)
(ExternalConfigurationLoader attribute)
InvalidExternalConfiguration (class in python.external_config.config.config_invalid)
is_cache_available() (ShotgunDataHandler method)
is_cache_loaded() (ShotgunDataHandler method)
is_compatible() (python.external_config.external_command.ExternalCommand class method)
is_data_cached() (ShotgunQueryModel method)
is_entity_related() (ShotgunHierarchyItem method)
is_group_default (ExternalCommand attribute)
IS_LEAF (ShotgunDataHandlerCache attribute)
is_leaf() (ShotgunItemData method)
is_primary (ExternalConfiguration attribute)
IS_SG_MODEL_ROLE (ShotgunQueryModel attribute)
is_valid (ExternalConfiguration attribute)
(InvalidExternalConfiguration attribute)
item_exists() (ShotgunDataHandlerCache method)
item_from_entity() (ShotgunModel method)
item_from_path() (ShotgunHierarchyModel method)
K
kind() (ShotgunHierarchyItem method)
L
LiveExternalConfiguration (class in python.external_config.config.config_live)
load_cache() (in module python.external_config.file_cache)
(ShotgunDataHandler method)
load_cache_file() (in module python.external_config.file_cache)
load_data() (SimpleShotgunHierarchyModel method)
(SimpleShotgunModel method)
M
main() (in module python.external_config.scripts.external_runner)
N
next_group_id() (BackgroundTaskManager method)
P
PARENT (ShotgunDataHandlerCache attribute)
parent (ShotgunItemData attribute)
path (LiveExternalConfiguration attribute)
path() (ShotgunHierarchyItem method)
pause_processing() (BackgroundTaskManager method)
pipeline_configuration_id (ExternalConfiguration attribute)
(InvalidExternalConfiguration attribute)
(LiveExternalConfiguration attribute)
(RemoteExternalConfiguration attribute)
pipeline_configuration_name (ExternalCommand attribute)
(ExternalConfiguration attribute)
(LiveExternalConfiguration attribute)
(RemoteExternalConfiguration attribute)
plugin_id (ExternalConfiguration attribute)
(ExternalConfigurationLoader attribute)
priority (BackgroundTask attribute)
python (module)
python.external_config (module)
python.external_config.config (module)
python.external_config.config.config_base (module)
python.external_config.config.config_fallback (module)
python.external_config.config.config_invalid (module)
python.external_config.config.config_live (module)
python.external_config.config.config_remote (module)
python.external_config.config.factory (module)
python.external_config.configuration_state (module)
python.external_config.errors (module)
python.external_config.external_command (module)
python.external_config.external_command_utils (module)
python.external_config.external_config_loader (module)
python.external_config.file_cache (module)
python.external_config.scripts (module)
python.external_config.scripts.external_runner (module)
python.external_config.util (module)
python.settings (module)
python.settings.user_settings (module)
python.shotgun_data (module)
python.shotgun_data.shotgun_data_retriever (module)
python.shotgun_globals (module)
python.shotgun_globals.cached_schema (module)
python.shotgun_globals.date_time (module)
python.shotgun_globals.icon (module)
python.shotgun_globals.ui (module)
python.shotgun_globals.ui.resources_rc (module)
python.shotgun_model (module)
python.shotgun_model.data_handler (module)
python.shotgun_model.data_handler_cache (module)
python.shotgun_model.data_handler_find (module)
python.shotgun_model.data_handler_nav (module)
python.shotgun_model.data_item (module)
python.shotgun_model.errors (module)
python.shotgun_model.shotgun_entity_model (module)
python.shotgun_model.shotgun_hierarchy_item (module)
python.shotgun_model.shotgun_hierarchy_model (module)
python.shotgun_model.shotgun_model (module)
python.shotgun_model.shotgun_query_model (module)
python.shotgun_model.shotgun_standard_item (module)
python.shotgun_model.simple_shotgun_hierarchy_model (module)
python.shotgun_model.simple_shotgun_model (module)
python.shotgun_model.util (module)
python.task_manager (module)
python.task_manager.background_task (module)
python.task_manager.background_task_manager (module)
python.task_manager.results_poller (module)
python.task_manager.worker_thread (module)
python.utils (module)
python.utils.color (module)
python.utils.qt (module)
Q
qCleanupResources() (in module python.shotgun_globals.ui.resources_rc)
qInitResources() (in module python.shotgun_globals.ui.resources_rc)
query_changed (ShotgunQueryModel attribute)
R
raw_data (ShotgunDataHandlerCache attribute)
refresh() (ConfigurationState method)
refresh_shotgun_global_state() (ExternalConfigurationLoader method)
register_bg_task_manager() (python.shotgun_globals.cached_schema.CachedShotgunSchema class method)
RemoteExternalConfiguration (class in python.external_config.config.config_remote)
remove_cache() (ShotgunDataHandler method)
request_attachment() (ShotgunDataRetriever method)
request_commands() (ExternalConfiguration method)
(InvalidExternalConfiguration method)
request_configurations() (ExternalConfigurationLoader method)
request_thumbnail() (ShotgunDataRetriever method)
request_thumbnail_source() (ShotgunDataRetriever method)
reset() (ShotgunQueryModel method)
ResultsDispatcher (class in python.task_manager.results_poller)
retrieve() (UserSettings method)
run() (BackgroundTask method)
(ResultsDispatcher method)
(WorkerThread method)
run_on_schema_loaded() (python.shotgun_globals.cached_schema.CachedShotgunSchema class method)
run_task() (WorkerThread method)
S
safe_delete_later() (in module python.utils.qt)
sanitize_for_qt_model() (in module python.shotgun_model.util)
sanitize_qt() (in module python.shotgun_model.util)
save_cache() (ShotgunDataHandler method)
schema_loaded (CachedShotgunSchema attribute)
SCOPE_CONFIG (UserSettings attribute)
SCOPE_ENGINE (UserSettings attribute)
SCOPE_GLOBAL (UserSettings attribute)
SCOPE_INSTANCE (UserSettings attribute)
SCOPE_PROJECT (UserSettings attribute)
SCOPE_SITE (UserSettings attribute)
serialize() (ExternalCommand method)
(in module python.external_config.config.factory)
serialize_command() (in module python.external_config.external_command_utils)
SG_ASSOCIATED_FIELD_ROLE (ShotgunModel attribute)
SG_DATA (ShotgunDataHandlerCache attribute)
SG_DATA_ROLE (ShotgunQueryModel attribute)
SG_PATH_FIELD (ShotgunHierarchyItem attribute)
shotgun_data (ShotgunItemData attribute)
ShotgunDataHandler (class in python.shotgun_model.data_handler)
ShotgunDataHandlerCache (class in python.shotgun_model.data_handler_cache)
ShotgunDataRetriever (class in python.shotgun_data.shotgun_data_retriever)
ShotgunEntityModel (class in python.shotgun_model.shotgun_entity_model)
ShotgunFindDataHandler (class in python.shotgun_model.data_handler_find)
ShotgunHierarchyItem (class in python.shotgun_model.shotgun_hierarchy_item)
ShotgunHierarchyModel (class in python.shotgun_model.shotgun_hierarchy_model)
ShotgunItemData (class in python.shotgun_model.data_item)
ShotgunModel (class in python.shotgun_model.shotgun_model)
ShotgunModelDataError
ShotgunModelError
ShotgunNavDataHandler (class in python.shotgun_model.data_handler_nav)
ShotgunQueryModel (class in python.shotgun_model.shotgun_query_model)
ShotgunStandardItem (class in python.shotgun_model.shotgun_standard_item)
ShotgunUtilsFramework (class in framework)
shut_down() (BackgroundTaskManager method)
(ConfigurationState method)
(ExternalConfigurationLoader method)
(ResultsDispatcher method)
(WorkerThread method)
SimpleShotgunHierarchyModel (class in python.shotgun_model.simple_shotgun_hierarchy_model)
SimpleShotgunModel (class in python.shotgun_model.simple_shotgun_model)
size (ShotgunDataHandlerCache attribute)
software_hash (ExternalConfiguration attribute)
(ExternalConfigurationLoader attribute)
start() (ShotgunDataRetriever method)
start_engine() (in module python.external_config.scripts.external_runner)
start_processing() (BackgroundTaskManager method)
state_changed (ConfigurationState attribute)
status (ExternalConfiguration attribute)
status_loaded (CachedShotgunSchema attribute)
statusTip() (ShotgunStandardItem method)
stop() (ShotgunDataRetriever method)
stop_all_tasks() (BackgroundTaskManager method)
stop_task() (BackgroundTaskManager method)
stop_task_group() (BackgroundTaskManager method)
stop_work() (ShotgunDataRetriever method)
store() (UserSettings method)
support_shotgun_multiple_selection (ExternalCommand attribute)
system_name (ExternalCommand attribute)
T
take_item() (ShotgunDataHandlerCache method)
target_entities() (ShotgunHierarchyItem method)
task_completed (BackgroundTaskManager attribute)
(ResultsDispatcher attribute)
task_failed (BackgroundTaskManager attribute)
(ResultsDispatcher attribute)
TASK_GROUP (ExternalConfiguration attribute)
(ExternalConfigurationLoader attribute)
task_group_finished (BackgroundTaskManager attribute)
text() (ShotgunStandardItem method)
tooltip (ExternalCommand attribute)
toolTip() (ShotgunStandardItem method)
tracking_latest (ExternalConfiguration attribute)
(FallbackExternalConfiguration attribute)
(RemoteExternalConfiguration attribute)
U
uid (BackgroundTask attribute)
UID (ShotgunDataHandlerCache attribute)
uids (ShotgunDataHandlerCache attribute)
unique_id (ShotgunItemData attribute)
unload_cache() (ShotgunDataHandler method)
unregister_bg_task_manager() (python.shotgun_globals.cached_schema.CachedShotgunSchema class method)
update_data() (ShotgunDataHandler method)
(ShotgunFindDataHandler method)
(ShotgunNavDataHandler method)
UPDATED (ShotgunDataHandler attribute)
UserSettings (class in python.settings.user_settings)
W
whatsThis() (ShotgunStandardItem method)
work_completed (ShotgunDataRetriever attribute)
work_failure (ShotgunDataRetriever attribute)
WorkerThread (class in python.task_manager.worker_thread)
write_cache() (in module python.external_config.file_cache)
write_cache_file() (in module python.external_config.file_cache)