Auto-updated documentation based on branch/tag v3.5.0

shotgunsoftware · Mar 26, 2024 · b6df757 · b6df757
1 parent e8115ee
commit b6df757
Show file tree

Hide file tree

Showing 93 changed files with 467 additions and 453 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 3e85bd666198641751efdabcdac08925
+config: 8f22a8c41bd9b065e7c4968525b99bc0
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/.doctrees/advanced.doctree b/.doctrees/advanced.doctree
diff --git a/.doctrees/advanced/iron_python.doctree b/.doctrees/advanced/iron_python.doctree
diff --git a/.doctrees/advanced/packaging.doctree b/.doctrees/advanced/packaging.doctree
diff --git a/.doctrees/authentication.doctree b/.doctrees/authentication.doctree
diff --git a/.doctrees/changelog.doctree b/.doctrees/changelog.doctree
diff --git a/.doctrees/cookbook.doctree b/.doctrees/cookbook.doctree
diff --git a/.doctrees/cookbook/attachments.doctree b/.doctrees/cookbook/attachments.doctree
diff --git a/.doctrees/cookbook/examples/ami_handler.doctree b/.doctrees/cookbook/examples/ami_handler.doctree
diff --git a/.doctrees/cookbook/examples/ami_version_packager.doctree b/.doctrees/cookbook/examples/ami_version_packager.doctree
diff --git a/.doctrees/cookbook/examples/basic_create_shot.doctree b/.doctrees/cookbook/examples/basic_create_shot.doctree
diff --git a/.doctrees/cookbook/examples/basic_create_shot_task_template.doctree b/.doctrees/cookbook/examples/basic_create_shot_task_template.doctree
diff --git a/.doctrees/cookbook/examples/basic_create_version_link_shot.doctree b/.doctrees/cookbook/examples/basic_create_version_link_shot.doctree
diff --git a/.doctrees/cookbook/examples/basic_delete_shot.doctree b/.doctrees/cookbook/examples/basic_delete_shot.doctree
diff --git a/.doctrees/cookbook/examples/basic_find_shot.doctree b/.doctrees/cookbook/examples/basic_find_shot.doctree
diff --git a/.doctrees/cookbook/examples/basic_sg_instance.doctree b/.doctrees/cookbook/examples/basic_sg_instance.doctree
diff --git a/.doctrees/cookbook/examples/basic_update_shot.doctree b/.doctrees/cookbook/examples/basic_update_shot.doctree
diff --git a/.doctrees/cookbook/examples/basic_upload_thumbnail_version.doctree b/.doctrees/cookbook/examples/basic_upload_thumbnail_version.doctree
diff --git a/.doctrees/cookbook/examples/svn_integration.doctree b/.doctrees/cookbook/examples/svn_integration.doctree
diff --git a/.doctrees/cookbook/smart_cut_fields.doctree b/.doctrees/cookbook/smart_cut_fields.doctree
diff --git a/.doctrees/cookbook/tasks.doctree b/.doctrees/cookbook/tasks.doctree
diff --git a/.doctrees/cookbook/tasks/split_tasks.doctree b/.doctrees/cookbook/tasks/split_tasks.doctree
diff --git a/.doctrees/cookbook/tasks/task_dependencies.doctree b/.doctrees/cookbook/tasks/task_dependencies.doctree
diff --git a/.doctrees/cookbook/tasks/updating_tasks.doctree b/.doctrees/cookbook/tasks/updating_tasks.doctree
diff --git a/.doctrees/cookbook/tutorials.doctree b/.doctrees/cookbook/tutorials.doctree
diff --git a/.doctrees/cookbook/usage_tips.doctree b/.doctrees/cookbook/usage_tips.doctree
diff --git a/.doctrees/environment.pickle b/.doctrees/environment.pickle
diff --git a/.doctrees/index.doctree b/.doctrees/index.doctree
diff --git a/.doctrees/installation.doctree b/.doctrees/installation.doctree
diff --git a/.doctrees/reference.doctree b/.doctrees/reference.doctree
diff --git a/_images/scripts_page.png b/_images/scripts_page.png
diff --git a/_modules/index.html b/_modules/index.html
@@ -5,7 +5,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>Overview: module code &mdash; python-api v3.4.1 documentation</title>
+  <title>Overview: module code &mdash; python-api v3.5.0 documentation</title>
       <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="../_static/graphviz.css" type="text/css" />
@@ -82,10 +82,10 @@
                              text-decoration: underline; }
     </style>
 
-    <b>python-api</b> v3.4.1.<br>
+    <b>python-api</b> v3.5.0.<br>
 
     For more information, please visit
-    <a class=custom_post_menu href='https://help.autodesk.com/view/SGDEV/ENU/'>The ShotGrid developer portal.</a>.
+    <a class=custom_post_menu href='https://help.autodesk.com/view/SGDEV/ENU/'>The Flow Production Tracking developer portal.</a>.
     The code associated with this documentation can be found
     <a class=custom_post_menu href='https://github.com/shotgunsoftware/python-api'>here</a>.
 

diff --git a/_modules/logging.html b/_modules/logging.html
@@ -5,7 +5,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>logging &mdash; python-api v3.4.1 documentation</title>
+  <title>logging &mdash; python-api v3.5.0 documentation</title>
       <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="../_static/graphviz.css" type="text/css" />
@@ -82,10 +82,10 @@
                              text-decoration: underline; }
     </style>
 
-    <b>python-api</b> v3.4.1.<br>
+    <b>python-api</b> v3.5.0.<br>
 
     For more information, please visit
-    <a class=custom_post_menu href='https://help.autodesk.com/view/SGDEV/ENU/'>The ShotGrid developer portal.</a>.
+    <a class=custom_post_menu href='https://help.autodesk.com/view/SGDEV/ENU/'>The Flow Production Tracking developer portal.</a>.
     The code associated with this documentation can be found
     <a class=custom_post_menu href='https://github.com/shotgunsoftware/python-api'>here</a>.
 

diff --git a/_modules/shotgun_api3/shotgun.html b/_modules/shotgun_api3/shotgun.html
@@ -5,7 +5,7 @@
 <head>
   <meta charset="utf-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>shotgun_api3.shotgun &mdash; python-api v3.4.1 documentation</title>
+  <title>shotgun_api3.shotgun &mdash; python-api v3.5.0 documentation</title>
       <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
       <link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
       <link rel="stylesheet" href="../../_static/graphviz.css" type="text/css" />
@@ -82,10 +82,10 @@
                              text-decoration: underline; }
     </style>
 
-    <b>python-api</b> v3.4.1.<br>
+    <b>python-api</b> v3.5.0.<br>
 
     For more information, please visit
-    <a class=custom_post_menu href='https://help.autodesk.com/view/SGDEV/ENU/'>The ShotGrid developer portal.</a>.
+    <a class=custom_post_menu href='https://help.autodesk.com/view/SGDEV/ENU/'>The Flow Production Tracking developer portal.</a>.
     The code associated with this documentation can be found
     <a class=custom_post_menu href='https://github.com/shotgunsoftware/python-api'>here</a>.
 
@@ -248,7 +248,7 @@ <h1>Source code for shotgun_api3.shotgun</h1><div class="highlight"><pre>
 
 <span class="c1"># ----------------------------------------------------------------------------</span>
 <span class="c1"># Version</span>
-<span class="n">__version__</span> <span class="o">=</span> <span class="s2">&quot;3.4.1&quot;</span>
+<span class="n">__version__</span> <span class="o">=</span> <span class="s2">&quot;3.5.0&quot;</span>
 
 <span class="c1"># ----------------------------------------------------------------------------</span>
 <span class="c1"># Errors</span>
@@ -350,10 +350,10 @@ <h1>Source code for shotgun_api3.shotgun</h1><div class="highlight"><pre>
         <span class="k">except</span> <span class="ne">AttributeError</span><span class="p">:</span>
             <span class="bp">self</span><span class="o">.</span><span class="n">version</span> <span class="o">=</span> <span class="kc">None</span>
         <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">version</span><span class="p">:</span>
-            <span class="k">raise</span> <span class="n">ShotgunError</span><span class="p">(</span><span class="s2">&quot;The ShotGrid Server didn&#39;t respond with a version number. &quot;</span>
+            <span class="k">raise</span> <span class="n">ShotgunError</span><span class="p">(</span><span class="s2">&quot;The Flow Production Tracking Server didn&#39;t respond with a version number. &quot;</span>
                                <span class="s2">&quot;This may be because you are running an older version of &quot;</span>
-                               <span class="s2">&quot;ShotGrid against a more recent version of the ShotGrid API. &quot;</span>
-                               <span class="s2">&quot;For more information, please contact ShotGrid Support.&quot;</span><span class="p">)</span>
+                               <span class="s2">&quot;Flow Production Tracking against a more recent version of the Flow Production Tracking API. &quot;</span>
+                               <span class="s2">&quot;For more information, please contact the Autodesk support.&quot;</span><span class="p">)</span>
 
         <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">version</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">3</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">version</span><span class="p">[</span><span class="mi">3</span><span class="p">]</span> <span class="o">==</span> <span class="s2">&quot;Dev&quot;</span><span class="p">:</span>
             <span class="bp">self</span><span class="o">.</span><span class="n">is_dev</span> <span class="o">=</span> <span class="kc">True</span>
@@ -465,7 +465,7 @@ <h1>Source code for shotgun_api3.shotgun</h1><div class="highlight"><pre>
 
 <span class="sd">    :ivar str platform: The current client platform. Valid values are ``mac``, ``linux``,</span>
 <span class="sd">        ``windows``, or ``None`` (if the current platform couldn&#39;t be determined).</span>
-<span class="sd">    :ivar str local_path_field: The SG field used for local file paths. This is calculated using</span>
+<span class="sd">    :ivar str local_path_field: The PTR field used for local file paths. This is calculated using</span>
 <span class="sd">        the value of ``platform``. Ex. ``local_path_mac``.</span>
 <span class="sd">    :ivar str py_version: Simple version of Python executable as a string. Eg. ``2.7``.</span>
 <span class="sd">    :ivar str ssl_version: Version of OpenSSL installed. Eg. ``OpenSSL 1.0.2g  1 Mar 2016``. This</span>
@@ -3567,8 +3567,8 @@ <h1>Source code for shotgun_api3.shotgun</h1><div class="highlight"><pre>
             <span class="k">except</span> <span class="n">ProtocolError</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
                 <span class="n">e</span><span class="o">.</span><span class="n">headers</span> <span class="o">=</span> <span class="n">resp_headers</span>
 
-                <span class="c1"># We&#39;ve seen some rare instances of SG returning 502 for issues that</span>
-                <span class="c1"># appear to be caused by something internal to SG. We&#39;re going to</span>
+                <span class="c1"># We&#39;ve seen some rare instances of PTR returning 502 for issues that</span>
+                <span class="c1"># appear to be caused by something internal to PTR. We&#39;re going to</span>
                 <span class="c1"># allow for limited retries for those specifically.</span>
                 <span class="k">if</span> <span class="n">attempt</span> <span class="o">!=</span> <span class="n">max_attempts</span> <span class="ow">and</span> <span class="n">e</span><span class="o">.</span><span class="n">errcode</span> <span class="ow">in</span> <span class="p">[</span><span class="mi">502</span><span class="p">,</span> <span class="mi">504</span><span class="p">]:</span>
                     <span class="n">LOG</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="s2">&quot;Got a 502 or 504 response. Waiting and retrying...&quot;</span><span class="p">)</span>
@@ -3805,7 +3805,7 @@ <h1>Source code for shotgun_api3.shotgun</h1><div class="highlight"><pre>
         <span class="k">if</span> <span class="n">status</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">&gt;=</span> <span class="mi">300</span><span class="p">:</span>
             <span class="n">headers</span> <span class="o">=</span> <span class="s2">&quot;HTTP error from server&quot;</span>
             <span class="k">if</span> <span class="n">status</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span> <span class="o">==</span> <span class="mi">503</span><span class="p">:</span>
-                <span class="n">errmsg</span> <span class="o">=</span> <span class="s2">&quot;ShotGrid is currently down for maintenance or too busy to reply. Please try again later.&quot;</span>
+                <span class="n">errmsg</span> <span class="o">=</span> <span class="s2">&quot;Flow Production Tracking is currently down for maintenance or too busy to reply. Please try again later.&quot;</span>
             <span class="k">raise</span> <span class="n">ProtocolError</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">server</span><span class="p">,</span>
                                 <span class="n">error_code</span><span class="p">,</span>
                                 <span class="n">errmsg</span><span class="p">,</span>
@@ -3891,12 +3891,12 @@ <h1>Source code for shotgun_api3.shotgun</h1><div class="highlight"><pre>
                 <span class="k">raise</span> <span class="n">UserCredentialsNotAllowedForSSOAuthenticationFault</span><span class="p">(</span>
                     <span class="n">sg_response</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;message&quot;</span><span class="p">,</span>
                                     <span class="s2">&quot;Authentication using username/password is not &quot;</span>
-                                    <span class="s2">&quot;allowed for an SSO-enabled ShotGrid site&quot;</span><span class="p">)</span>
+                                    <span class="s2">&quot;allowed for an SSO-enabled Flow Production Tracking site&quot;</span><span class="p">)</span>
                 <span class="p">)</span>
             <span class="k">elif</span> <span class="n">sg_response</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;error_code&quot;</span><span class="p">)</span> <span class="o">==</span> <span class="n">ERR_OXYG</span><span class="p">:</span>
                 <span class="k">raise</span> <span class="n">UserCredentialsNotAllowedForOxygenAuthenticationFault</span><span class="p">(</span>
                     <span class="n">sg_response</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;message&quot;</span><span class="p">,</span> <span class="s2">&quot;Authentication using username/password is not &quot;</span>
-                                    <span class="s2">&quot;allowed for an Autodesk Identity enabled ShotGrid site&quot;</span><span class="p">)</span>
+                                    <span class="s2">&quot;allowed for an Autodesk Identity enabled Flow Production Tracking site&quot;</span><span class="p">)</span>
                 <span class="p">)</span>
             <span class="k">else</span><span class="p">:</span>
                 <span class="c1"># raise general Fault</span>

diff --git a/_sources/advanced/packaging.rst.txt b/_sources/advanced/packaging.rst.txt
@@ -14,8 +14,8 @@ There are caveats you need to be aware of when creating such an app.
 ********************************
 HTTPS Validation and cacerts.txt
 ********************************
-When creating the connection to ShotGrid a file is used to validate the ShotGrid certificate. This
-file is located at ``shotgun_api3/lib/httplib2/cacerts.txt``. Because this file is not a Python
+When creating the connection to Flow Production Tracking, a file is used to validate the Flow Production Tracking
+certificate. This file is located at ``shotgun_api3/lib/httplib2/cacerts.txt``. Because this file is not a Python
 file imported by your application, py2app will not know to include it in your package, it will
 need to be explicitly specified in your ``setup.py`` file (edit the path based on the location
 where your ``shotgun_api3`` package is located)::
@@ -31,7 +31,7 @@ following structure::
     ./Contents/Resources/my_script.py
 
 Where in ``my_script.py`` you can access the ``cacerts.txt`` file using a relative path to pass it
-into the ShotGrid connection's constructor::
+into the Flow Production Tracking connection's constructor::
 
     ca_certs = os.path.join(os.path.dirname(__file__), 'shotgun_api3', 'cacerts.txt')
     sg = shotgun_api3.Shotgun('https://my-site.shotgrid.autodesk.com', 'script_name', 'script_key',