Skip to content

Commit f4269b7

Browse files
Shotgun-RundeckShotgun-Rundeck
committed
Auto-updated documentation based on tag v5.10.1
1 parent 00e1885 commit f4269b7

35 files changed

+82
-69
lines changed

‎.buildinfo

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: adcab43e9ea6b1781e1b0e107b69fc52
3+
config: 13fb4f37a93b73c59f5ec1585c3cc13c
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎.doctrees/environment.pickle

601 Bytes
Binary file not shown.

‎.doctrees/external_config.doctree

0 Bytes
Binary file not shown.

‎.doctrees/index.doctree

0 Bytes
Binary file not shown.

‎.doctrees/settings.doctree

0 Bytes
Binary file not shown.

‎.doctrees/shotgun_data.doctree

0 Bytes
Binary file not shown.

‎.doctrees/shotgun_globals.doctree

0 Bytes
Binary file not shown.

‎.doctrees/shotgun_hierarchy_model.doctree

0 Bytes
Binary file not shown.

‎.doctrees/shotgun_model.doctree

0 Bytes
Binary file not shown.

‎.doctrees/task_manager.doctree

0 Bytes
Binary file not shown.

‎_modules/external_config/config/config_base.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>external_config.config.config_base &mdash; tk-framework-shotgunutils v5.10.0 documentation</title>
8+
<title>external_config.config.config_base &mdash; tk-framework-shotgunutils v5.10.1 documentation</title>
99
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
1010
<link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" />
1111
<link rel="stylesheet" href="../../../_static/graphviz.css" type="text/css" />
@@ -84,7 +84,7 @@
8484
text-decoration: underline; }
8585
</style>
8686

87-
<b>tk-framework-shotgunutils</b> v5.10.0.<br>
87+
<b>tk-framework-shotgunutils</b> v5.10.1.<br>
8888

8989
This documentation is part of the Flow Production Tracking.
9090

‎_modules/external_config/external_command.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>external_config.external_command &mdash; tk-framework-shotgunutils v5.10.0 documentation</title>
8+
<title>external_config.external_command &mdash; tk-framework-shotgunutils v5.10.1 documentation</title>
99
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
1010
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
1111
<link rel="stylesheet" href="../../_static/graphviz.css" type="text/css" />
@@ -84,7 +84,7 @@
8484
text-decoration: underline; }
8585
</style>
8686

87-
<b>tk-framework-shotgunutils</b> v5.10.0.<br>
87+
<b>tk-framework-shotgunutils</b> v5.10.1.<br>
8888

8989
This documentation is part of the Flow Production Tracking.
9090

‎_modules/external_config/external_config_loader.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>external_config.external_config_loader &mdash; tk-framework-shotgunutils v5.10.0 documentation</title>
8+
<title>external_config.external_config_loader &mdash; tk-framework-shotgunutils v5.10.1 documentation</title>
99
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
1010
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
1111
<link rel="stylesheet" href="../../_static/graphviz.css" type="text/css" />
@@ -84,7 +84,7 @@
8484
text-decoration: underline; }
8585
</style>
8686

87-
<b>tk-framework-shotgunutils</b> v5.10.0.<br>
87+
<b>tk-framework-shotgunutils</b> v5.10.1.<br>
8888

8989
This documentation is part of the Flow Production Tracking.
9090

‎_modules/index.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>Overview: module code &mdash; tk-framework-shotgunutils v5.10.0 documentation</title>
8+
<title>Overview: module code &mdash; tk-framework-shotgunutils v5.10.1 documentation</title>
99
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
1010
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
1111
<link rel="stylesheet" href="../_static/graphviz.css" type="text/css" />
@@ -84,7 +84,7 @@
8484
text-decoration: underline; }
8585
</style>
8686

87-
<b>tk-framework-shotgunutils</b> v5.10.0.<br>
87+
<b>tk-framework-shotgunutils</b> v5.10.1.<br>
8888

8989
This documentation is part of the Flow Production Tracking.
9090

‎_modules/shotgun_data/shotgun_data_retriever.html

+8-3
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>shotgun_data.shotgun_data_retriever &mdash; tk-framework-shotgunutils v5.10.0 documentation</title>
8+
<title>shotgun_data.shotgun_data_retriever &mdash; tk-framework-shotgunutils v5.10.1 documentation</title>
99
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
1010
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
1111
<link rel="stylesheet" href="../../_static/graphviz.css" type="text/css" />
@@ -84,7 +84,7 @@
8484
text-decoration: underline; }
8585
</style>
8686

87-
<b>tk-framework-shotgunutils</b> v5.10.0.<br>
87+
<b>tk-framework-shotgunutils</b> v5.10.1.<br>
8888

8989
This documentation is part of the Flow Production Tracking.
9090

@@ -147,6 +147,11 @@ <h1>Source code for shotgun_data.shotgun_data_retriever</h1><div class="highligh
147147
<span class="kn">from</span> <span class="nn">sgtk.platform.qt</span> <span class="kn">import</span> <span class="n">QtCore</span><span class="p">,</span> <span class="n">QtGui</span>
148148
<span class="kn">from</span> <span class="nn">sgtk</span> <span class="kn">import</span> <span class="n">TankError</span>
149149

150+
<span class="k">try</span><span class="p">:</span>
151+
<span class="kn">from</span> <span class="nn">tank_vendor</span> <span class="kn">import</span> <span class="n">sgutils</span>
152+
<span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
153+
<span class="kn">from</span> <span class="nn">tank_vendor</span> <span class="kn">import</span> <span class="n">six</span> <span class="k">as</span> <span class="n">sgutils</span>
154+
150155

151156
<span class="k">def</span> <span class="nf">_indicate_resource_accessed</span><span class="p">(</span><span class="n">file_path</span><span class="p">):</span>
152157
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
@@ -1120,7 +1125,7 @@ <h1>Source code for shotgun_data.shotgun_data_retriever</h1><div class="highligh
11201125
<span class="c1"># hash the path portion of the thumbnail url</span>
11211126
<span class="n">url_obj</span> <span class="o">=</span> <span class="n">six</span><span class="o">.</span><span class="n">moves</span><span class="o">.</span><span class="n">urllib</span><span class="o">.</span><span class="n">parse</span><span class="o">.</span><span class="n">urlparse</span><span class="p">(</span><span class="n">url</span><span class="p">)</span>
11221127
<span class="n">url_hash</span> <span class="o">=</span> <span class="n">hashlib</span><span class="o">.</span><span class="n">md5</span><span class="p">()</span>
1123-
<span class="n">url_hash</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">six</span><span class="o">.</span><span class="n">ensure_binary</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">url_obj</span><span class="o">.</span><span class="n">path</span><span class="p">)))</span>
1128+
<span class="n">url_hash</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">sgutils</span><span class="o">.</span><span class="n">ensure_binary</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">url_obj</span><span class="o">.</span><span class="n">path</span><span class="p">)))</span>
11241129
<span class="n">hash_str</span> <span class="o">=</span> <span class="n">url_hash</span><span class="o">.</span><span class="n">hexdigest</span><span class="p">()</span>
11251130

11261131
<span class="c1"># Now turn this hash into a tree structure. For a discussion about sensible</span>

‎_modules/shotgun_globals/date_time.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>shotgun_globals.date_time &mdash; tk-framework-shotgunutils v5.10.0 documentation</title>
8+
<title>shotgun_globals.date_time &mdash; tk-framework-shotgunutils v5.10.1 documentation</title>
99
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
1010
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
1111
<link rel="stylesheet" href="../../_static/graphviz.css" type="text/css" />
@@ -84,7 +84,7 @@
8484
text-decoration: underline; }
8585
</style>
8686

87-
<b>tk-framework-shotgunutils</b> v5.10.0.<br>
87+
<b>tk-framework-shotgunutils</b> v5.10.1.<br>
8888

8989
This documentation is part of the Flow Production Tracking.
9090

‎_modules/shotgun_globals/icon.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>shotgun_globals.icon &mdash; tk-framework-shotgunutils v5.10.0 documentation</title>
8+
<title>shotgun_globals.icon &mdash; tk-framework-shotgunutils v5.10.1 documentation</title>
99
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
1010
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
1111
<link rel="stylesheet" href="../../_static/graphviz.css" type="text/css" />
@@ -84,7 +84,7 @@
8484
text-decoration: underline; }
8585
</style>
8686

87-
<b>tk-framework-shotgunutils</b> v5.10.0.<br>
87+
<b>tk-framework-shotgunutils</b> v5.10.1.<br>
8888

8989
This documentation is part of the Flow Production Tracking.
9090

‎_modules/shotgun_model/shotgun_entity_model.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>shotgun_model.shotgun_entity_model &mdash; tk-framework-shotgunutils v5.10.0 documentation</title>
8+
<title>shotgun_model.shotgun_entity_model &mdash; tk-framework-shotgunutils v5.10.1 documentation</title>
99
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
1010
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
1111
<link rel="stylesheet" href="../../_static/graphviz.css" type="text/css" />
@@ -84,7 +84,7 @@
8484
text-decoration: underline; }
8585
</style>
8686

87-
<b>tk-framework-shotgunutils</b> v5.10.0.<br>
87+
<b>tk-framework-shotgunutils</b> v5.10.1.<br>
8888

8989
This documentation is part of the Flow Production Tracking.
9090

‎_modules/shotgun_model/shotgun_hierarchy_model.html

+12-8
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<head>
66
<meta charset="utf-8" />
77
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
8-
<title>shotgun_model.shotgun_hierarchy_model &mdash; tk-framework-shotgunutils v5.10.0 documentation</title>
8+
<title>shotgun_model.shotgun_hierarchy_model &mdash; tk-framework-shotgunutils v5.10.1 documentation</title>
99
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
1010
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
1111
<link rel="stylesheet" href="../../_static/graphviz.css" type="text/css" />
@@ -84,7 +84,7 @@
8484
text-decoration: underline; }
8585
</style>
8686

87-
<b>tk-framework-shotgunutils</b> v5.10.0.<br>
87+
<b>tk-framework-shotgunutils</b> v5.10.1.<br>
8888

8989
This documentation is part of the Flow Production Tracking.
9090

@@ -152,7 +152,11 @@ <h1>Source code for shotgun_model.shotgun_hierarchy_model</h1><div class="highli
152152
<span class="kn">from</span> <span class="nn">.shotgun_query_model</span> <span class="kn">import</span> <span class="n">ShotgunQueryModel</span>
153153
<span class="kn">from</span> <span class="nn">.data_handler_nav</span> <span class="kn">import</span> <span class="n">ShotgunNavDataHandler</span>
154154
<span class="kn">from</span> <span class="nn">.util</span> <span class="kn">import</span> <span class="n">sanitize_for_qt_model</span>
155-
<span class="kn">from</span> <span class="nn">tank_vendor</span> <span class="kn">import</span> <span class="n">six</span>
155+
156+
<span class="k">try</span><span class="p">:</span>
157+
<span class="kn">from</span> <span class="nn">tank_vendor</span> <span class="kn">import</span> <span class="n">sgutils</span>
158+
<span class="k">except</span> <span class="ne">ImportError</span><span class="p">:</span>
159+
<span class="kn">from</span> <span class="nn">tank_vendor</span> <span class="kn">import</span> <span class="n">six</span> <span class="k">as</span> <span class="n">sgutils</span>
156160

157161
<span class="n">logger</span> <span class="o">=</span> <span class="n">sgtk</span><span class="o">.</span><span class="n">platform</span><span class="o">.</span><span class="n">get_logger</span><span class="p">(</span><span class="vm">__name__</span><span class="p">)</span>
158162

@@ -734,26 +738,26 @@ <h1>Source code for shotgun_model.shotgun_hierarchy_model</h1><div class="highli
734738
<span class="c1"># even though the navigation path provides a nice organizational</span>
735739
<span class="c1"># structure for caching, it can get long. to avoid MAX_PATH issues on</span>
736740
<span class="c1"># windows, just hash it</span>
737-
<span class="n">params_hash</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">six</span><span class="o">.</span><span class="n">ensure_binary</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_path</span><span class="p">)))</span>
741+
<span class="n">params_hash</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">sgutils</span><span class="o">.</span><span class="n">ensure_binary</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_path</span><span class="p">)))</span>
738742

739743
<span class="c1"># include the schema generation number for clients</span>
740-
<span class="n">params_hash</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">six</span><span class="o">.</span><span class="n">ensure_binary</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_schema_generation</span><span class="p">)))</span>
744+
<span class="n">params_hash</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">sgutils</span><span class="o">.</span><span class="n">ensure_binary</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_schema_generation</span><span class="p">)))</span>
741745

742746
<span class="c1"># If this value changes over time (like between Qt4 and Qt5), we need to</span>
743747
<span class="c1"># assume our previous user roles are invalid since Qt might have taken</span>
744748
<span class="c1"># it over. If role&#39;s value is 32, don&#39;t add it to the hash so we don&#39;t</span>
745749
<span class="c1"># invalidate PySide/PyQt4 caches.</span>
746750
<span class="k">if</span> <span class="n">QtCore</span><span class="o">.</span><span class="n">Qt</span><span class="o">.</span><span class="n">UserRole</span> <span class="o">!=</span> <span class="mi">32</span><span class="p">:</span>
747-
<span class="n">params_hash</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">six</span><span class="o">.</span><span class="n">ensure_binary</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">QtCore</span><span class="o">.</span><span class="n">Qt</span><span class="o">.</span><span class="n">UserRole</span><span class="p">)))</span>
751+
<span class="n">params_hash</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">sgutils</span><span class="o">.</span><span class="n">ensure_binary</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">QtCore</span><span class="o">.</span><span class="n">Qt</span><span class="o">.</span><span class="n">UserRole</span><span class="p">)))</span>
748752

749753
<span class="c1"># include the cache_seed for additional user control over external state</span>
750-
<span class="n">params_hash</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">six</span><span class="o">.</span><span class="n">ensure_binary</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">cache_seed</span><span class="p">)))</span>
754+
<span class="n">params_hash</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">sgutils</span><span class="o">.</span><span class="n">ensure_binary</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">cache_seed</span><span class="p">)))</span>
751755

752756
<span class="c1"># iterate through the sorted entity fields to ensure consistent order</span>
753757
<span class="k">for</span> <span class="p">(</span><span class="n">entity_type</span><span class="p">,</span> <span class="n">fields</span><span class="p">)</span> <span class="ow">in</span> <span class="nb">sorted</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_entity_fields</span><span class="o">.</span><span class="n">items</span><span class="p">()):</span>
754758
<span class="k">for</span> <span class="n">field</span> <span class="ow">in</span> <span class="n">fields</span><span class="p">:</span>
755759
<span class="n">entity_field_hash</span><span class="o">.</span><span class="n">update</span><span class="p">(</span>
756-
<span class="n">six</span><span class="o">.</span><span class="n">ensure_binary</span><span class="p">(</span><span class="s2">&quot;</span><span class="si">%s</span><span class="s2">.</span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">entity_type</span><span class="p">,</span> <span class="n">field</span><span class="p">))</span>
760+
<span class="n">sgutils</span><span class="o">.</span><span class="n">ensure_binary</span><span class="p">(</span><span class="s2">&quot;</span><span class="si">%s</span><span class="s2">.</span><span class="si">%s</span><span class="s2">&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">entity_type</span><span class="p">,</span> <span class="n">field</span><span class="p">))</span>
757761
<span class="p">)</span>
758762

759763
<span class="c1"># convert the seed entity field into a path segment.</span>

0 commit comments

Comments
 (0)