ciocore 9.1.0rc2__py2.py3-none-any.whl → 9.1.1b1__py2.py3-none-any.whl

ciocore/docsite/apidoc/package_environment/index.html

@@ -867,10 +867,10 @@ PackageEnvironment        </code>
 
         <details class="quote">
           <summary>Source code in <code>ciocore/package_environment.py</code></summary>
-          <div class="highlight"><pre><span></span><code><span class="k">class</span> <span class="nc">PackageEnvironment</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
+          <div class="highlight"><pre><span></span><code><span class="k">class</span><span class="w"> </span><span class="nc">PackageEnvironment</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
 
 
-    <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">env_list</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">platform</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
+    <span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">env_list</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">platform</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Encapsulate a list of environment variables.</span>
 
@@ -888,7 +888,7 @@ PackageEnvironment        </code>
         <span class="bp">self</span><span class="o">.</span><span class="n">extend</span><span class="p">(</span><span class="n">env_list</span><span class="p">,</span> <span class="n">platform</span><span class="p">)</span>
 
 
-    <span class="k">def</span> <span class="nf">extend</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">env_list</span><span class="p">,</span> <span class="n">platform</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
+    <span class="k">def</span><span class="w"> </span><span class="nf">extend</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">env_list</span><span class="p">,</span> <span class="n">platform</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Extend the Package environment with the given variable specifications.</span>
 
@@ -971,7 +971,7 @@ PackageEnvironment        </code>
                 <span class="bp">self</span><span class="o">.</span><span class="n">_set</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span>
 
 
-    <span class="k">def</span> <span class="nf">_set</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
+    <span class="k">def</span><span class="w"> </span><span class="nf">_set</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;Set the value of an exclusive variable.</span>
 
 <span class="sd">        Can be overwritten by subsequent adds.</span>
@@ -984,7 +984,7 @@ PackageEnvironment        </code>
             <span class="p">)</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">_env</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span>
 
-    <span class="k">def</span> <span class="nf">_append</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
+    <span class="k">def</span><span class="w"> </span><span class="nf">_append</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;Set the value of an append variable.</span>
 
 <span class="sd">        Can be appended to with subsequent adds.</span>
@@ -1000,7 +1000,7 @@ PackageEnvironment        </code>
             <span class="bp">self</span><span class="o">.</span><span class="n">_env</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="p">[]</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">_env</span><span class="p">[</span><span class="n">name</span><span class="p">]</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">value</span><span class="p">)</span>
 
-    <span class="k">def</span> <span class="nf">_prepend</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
+    <span class="k">def</span><span class="w"> </span><span class="nf">_prepend</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;Set the value of an append/prepend variable.</span>
 
 <span class="sd">        Can be appended to with subsequent adds.</span>
@@ -1016,7 +1016,7 @@ PackageEnvironment        </code>
             <span class="bp">self</span><span class="o">.</span><span class="n">_env</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="p">[]</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">_env</span><span class="p">[</span><span class="n">name</span><span class="p">]</span><span class="o">.</span><span class="n">insert</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span>
 
-    <span class="k">def</span> <span class="fm">__iter__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+    <span class="k">def</span><span class="w"> </span><span class="fm">__iter__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;Cast the object as a dict.&quot;&quot;&quot;</span>
         <span class="n">sep</span> <span class="o">=</span> <span class="s2">&quot;;&quot;</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">platform</span> <span class="o">==</span> <span class="s2">&quot;windows&quot;</span> <span class="k">else</span> <span class="s2">&quot;:&quot;</span>
         <span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_env</span><span class="p">:</span>
@@ -1026,7 +1026,7 @@ PackageEnvironment        </code>
             <span class="k">else</span><span class="p">:</span>
                 <span class="k">yield</span> <span class="n">key</span><span class="p">,</span> <span class="n">var</span>
 
-    <span class="k">def</span> <span class="fm">__getitem__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">):</span>
+    <span class="k">def</span><span class="w"> </span><span class="fm">__getitem__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;Allow access by key.&quot;&quot;&quot;</span>
         <span class="n">sep</span> <span class="o">=</span> <span class="s2">&quot;;&quot;</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">platform</span> <span class="o">==</span> <span class="s2">&quot;windows&quot;</span> <span class="k">else</span> <span class="s2">&quot;:&quot;</span>
         <span class="n">var</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_env</span><span class="o">.</span><span class="fm">__getitem__</span><span class="p">(</span><span class="n">key</span><span class="p">)</span>
@@ -1094,7 +1094,7 @@ PackageEnvironment        </code>
 
         <details class="quote">
           <summary>Source code in <code>ciocore/package_environment.py</code></summary>
-          <div class="highlight"><pre><span></span><code><span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">env_list</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">platform</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
+          <div class="highlight"><pre><span></span><code><span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">env_list</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">platform</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Encapsulate a list of environment variables.</span>
 
@@ -1182,7 +1182,7 @@ PackageEnvironment        </code>
   </tbody>
 </table>
 <p><strong>Examples:</strong></p>
-    <div class="highlight"><pre><span></span><code><span class="o">&gt;&gt;&gt;</span> <span class="kn">from</span> <span class="nn">ciocore</span> <span class="kn">import</span> <span class="n">api_client</span><span class="p">,</span> <span class="n">package_tree</span><span class="p">,</span> <span class="n">package_environment</span>
+    <div class="highlight"><pre><span></span><code><span class="o">&gt;&gt;&gt;</span> <span class="kn">from</span><span class="w"> </span><span class="nn">ciocore</span><span class="w"> </span><span class="kn">import</span> <span class="n">api_client</span><span class="p">,</span> <span class="n">package_tree</span><span class="p">,</span> <span class="n">package_environment</span>
 <span class="o">&gt;&gt;&gt;</span> <span class="n">packages</span> <span class="o">=</span> <span class="n">api_client</span><span class="o">.</span><span class="n">request_software_packages</span><span class="p">()</span>
 <span class="o">&gt;&gt;&gt;</span> <span class="n">pt</span> <span class="o">=</span> <span class="n">package_tree</span><span class="o">.</span><span class="n">PackageTree</span><span class="p">(</span><span class="n">packages</span><span class="p">,</span> <span class="n">product</span><span class="o">=</span><span class="s2">&quot;cinema4d&quot;</span><span class="p">)</span>
 <span class="o">&gt;&gt;&gt;</span> <span class="n">one_dcc_name</span> <span class="o">=</span> <span class="n">pt</span><span class="o">.</span><span class="n">supported_host_names</span><span class="p">()[</span><span class="mi">0</span><span class="p">]</span>
@@ -1215,7 +1215,7 @@ PackageEnvironment        </code>
 
         <details class="quote">
           <summary>Source code in <code>ciocore/package_environment.py</code></summary>
-          <div class="highlight"><pre><span></span><code><span class="k">def</span> <span class="nf">extend</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">env_list</span><span class="p">,</span> <span class="n">platform</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
+          <div class="highlight"><pre><span></span><code><span class="k">def</span><span class="w"> </span><span class="nf">extend</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">env_list</span><span class="p">,</span> <span class="n">platform</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Extend the Package environment with the given variable specifications.</span>
 
@@ -1323,7 +1323,7 @@ PackageEnvironment        </code>
 
         <details class="quote">
           <summary>Source code in <code>ciocore/package_environment.py</code></summary>
-          <div class="highlight"><pre><span></span><code><span class="k">def</span> <span class="fm">__iter__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+          <div class="highlight"><pre><span></span><code><span class="k">def</span><span class="w"> </span><span class="fm">__iter__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Cast the object as a dict.&quot;&quot;&quot;</span>
     <span class="n">sep</span> <span class="o">=</span> <span class="s2">&quot;;&quot;</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">platform</span> <span class="o">==</span> <span class="s2">&quot;windows&quot;</span> <span class="k">else</span> <span class="s2">&quot;:&quot;</span>
     <span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_env</span><span class="p">:</span>
@@ -1359,7 +1359,7 @@ PackageEnvironment        </code>
 
         <details class="quote">
           <summary>Source code in <code>ciocore/package_environment.py</code></summary>
-          <div class="highlight"><pre><span></span><code><span class="k">def</span> <span class="fm">__getitem__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">):</span>
+          <div class="highlight"><pre><span></span><code><span class="k">def</span><span class="w"> </span><span class="fm">__getitem__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">key</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Allow access by key.&quot;&quot;&quot;</span>
     <span class="n">sep</span> <span class="o">=</span> <span class="s2">&quot;;&quot;</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">platform</span> <span class="o">==</span> <span class="s2">&quot;windows&quot;</span> <span class="k">else</span> <span class="s2">&quot;:&quot;</span>
     <span class="n">var</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_env</span><span class="o">.</span><span class="fm">__getitem__</span><span class="p">(</span><span class="n">key</span><span class="p">)</span>

ciocore/docsite/apidoc/package_tree/index.html

@@ -964,8 +964,8 @@ PackageTree        </code>
 
         <details class="quote">
           <summary>Source code in <code>ciocore/package_tree.py</code></summary>
-          <div class="highlight"><pre><span></span><code><span class="k">class</span> <span class="nc">PackageTree</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
-    <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">packages</span><span class="p">,</span>  <span class="o">*</span><span class="n">host_products</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
+          <div class="highlight"><pre><span></span><code><span class="k">class</span><span class="w"> </span><span class="nc">PackageTree</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
+    <span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">packages</span><span class="p">,</span>  <span class="o">*</span><span class="n">host_products</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;Build the tree with a list of packages.</span>
 
 <span class="sd">        Args:</span>
@@ -1019,7 +1019,7 @@ PackageTree        </code>
 
         <span class="bp">self</span><span class="o">.</span><span class="n">_tree</span> <span class="o">=</span> <span class="n">_build_tree</span><span class="p">(</span><span class="n">packages</span><span class="p">,</span> <span class="p">{</span><span class="s2">&quot;children&quot;</span><span class="p">:</span> <span class="p">[],</span> <span class="s2">&quot;plugins&quot;</span><span class="p">:</span> <span class="n">root_ids</span><span class="p">})</span>
 
-    <span class="k">def</span> <span class="nf">supported_host_names</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+    <span class="k">def</span><span class="w"> </span><span class="nf">supported_host_names</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        All host names from the software tree.</span>
 
@@ -1048,7 +1048,7 @@ PackageTree        </code>
             <span class="n">paths</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">to_name</span><span class="p">(</span><span class="n">pkg</span><span class="p">))</span>
         <span class="k">return</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">paths</span><span class="p">)</span>
 
-    <span class="k">def</span> <span class="nf">supported_plugins</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">host</span><span class="p">):</span>
+    <span class="k">def</span><span class="w"> </span><span class="nf">supported_plugins</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">host</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Find the plugins that are children of the given DCC host.</span>
 
@@ -1108,7 +1108,7 @@ PackageTree        </code>
 
         <span class="k">return</span> <span class="nb">sorted</span><span class="p">(</span><span class="n">plugins</span><span class="p">,</span> <span class="n">key</span><span class="o">=</span><span class="k">lambda</span> <span class="n">k</span><span class="p">:</span> <span class="n">k</span><span class="p">[</span><span class="s2">&quot;plugin&quot;</span><span class="p">])</span>
 
-    <span class="k">def</span> <span class="nf">find_by_name</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">limit</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
+    <span class="k">def</span><span class="w"> </span><span class="nf">find_by_name</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">limit</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Search the tree for a product with the given name.</span>
 
@@ -1140,7 +1140,7 @@ PackageTree        </code>
 
         <span class="k">return</span> <span class="n">_find_by_name</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_tree</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">limit</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
 
-    <span class="k">def</span> <span class="nf">find_by_path</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">):</span>
+    <span class="k">def</span><span class="w"> </span><span class="nf">find_by_path</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Find the package uniquely described by the given path.</span>
 
@@ -1172,7 +1172,7 @@ PackageTree        </code>
         <span class="k">return</span> <span class="n">_find_by_path</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_tree</span><span class="p">,</span> <span class="n">path</span><span class="p">)</span>
 
 
-    <span class="k">def</span> <span class="nf">to_path_list</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
+    <span class="k">def</span><span class="w"> </span><span class="nf">to_path_list</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Get paths to all nodes.</span>
 
@@ -1209,7 +1209,7 @@ PackageTree        </code>
             <span class="k">return</span> <span class="n">_to_path_list</span><span class="p">(</span><span class="n">subtree</span><span class="p">)</span>
         <span class="k">return</span> <span class="n">_to_path_list</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_tree</span><span class="p">)</span>
 
-    <span class="k">def</span> <span class="nf">platforms</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+    <span class="k">def</span><span class="w"> </span><span class="nf">platforms</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Get the platforms represented by packages in the tree.</span>
 
@@ -1220,7 +1220,7 @@ PackageTree        </code>
         <span class="c1"># No need to recurse. Plugins are assumed to be compatible with the host.</span>
         <span class="k">return</span> <span class="nb">set</span><span class="p">([</span><span class="n">host</span><span class="p">[</span><span class="s2">&quot;platform&quot;</span><span class="p">]</span> <span class="k">for</span> <span class="n">host</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_tree</span><span class="p">[</span><span class="s2">&quot;children&quot;</span><span class="p">]])</span>
 
-    <span class="k">def</span> <span class="nf">json</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+    <span class="k">def</span><span class="w"> </span><span class="nf">json</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        The whole tree of softwware as json.</span>
 
@@ -1230,10 +1230,10 @@ PackageTree        </code>
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="k">return</span> <span class="n">json</span><span class="o">.</span><span class="n">dumps</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_tree</span><span class="p">)</span>
 
-    <span class="k">def</span> <span class="fm">__bool__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+    <span class="k">def</span><span class="w"> </span><span class="fm">__bool__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
         <span class="k">return</span> <span class="kc">True</span> <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_tree</span><span class="p">[</span><span class="s2">&quot;children&quot;</span><span class="p">]</span> <span class="k">else</span> <span class="kc">False</span>
 
-    <span class="k">def</span> <span class="nf">as_dict</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+    <span class="k">def</span><span class="w"> </span><span class="nf">as_dict</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Returns:</span>
 <span class="sd">            dict: The underlying software dictionary.</span>
@@ -1339,7 +1339,7 @@ PackageTree        </code>
   </tbody>
 </table>
 <p><strong>Examples:</strong></p>
-    <div class="highlight"><pre><span></span><code><span class="o">&gt;&gt;&gt;</span> <span class="kn">from</span> <span class="nn">ciocore</span> <span class="kn">import</span> <span class="n">api_client</span><span class="p">,</span> <span class="n">package_tree</span>
+    <div class="highlight"><pre><span></span><code><span class="o">&gt;&gt;&gt;</span> <span class="kn">from</span><span class="w"> </span><span class="nn">ciocore</span><span class="w"> </span><span class="kn">import</span> <span class="n">api_client</span><span class="p">,</span> <span class="n">package_tree</span>
 <span class="c1"># Request packages as a flat list from Conductor.</span>
 <span class="o">&gt;&gt;&gt;</span> <span class="n">packages</span> <span class="o">=</span> <span class="n">api_client</span><span class="o">.</span><span class="n">request_software_packages</span><span class="p">()</span>
 <span class="c1"># Build tree of dependencies from packages list</span>
@@ -1354,7 +1354,7 @@ PackageTree        </code>
 
         <details class="quote">
           <summary>Source code in <code>ciocore/package_tree.py</code></summary>
-          <div class="highlight"><pre><span></span><code><span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">packages</span><span class="p">,</span>  <span class="o">*</span><span class="n">host_products</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
+          <div class="highlight"><pre><span></span><code><span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">packages</span><span class="p">,</span>  <span class="o">*</span><span class="n">host_products</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;Build the tree with a list of packages.</span>
 
 <span class="sd">    Args:</span>
@@ -1448,7 +1448,7 @@ and get package IDs.</p>
   </tbody>
 </table>
 <p><strong>Examples:</strong></p>
-    <div class="highlight"><pre><span></span><code><span class="o">&gt;&gt;&gt;</span> <span class="kn">from</span> <span class="nn">ciocore</span> <span class="kn">import</span> <span class="n">api_client</span><span class="p">,</span> <span class="n">package_tree</span>
+    <div class="highlight"><pre><span></span><code><span class="o">&gt;&gt;&gt;</span> <span class="kn">from</span><span class="w"> </span><span class="nn">ciocore</span><span class="w"> </span><span class="kn">import</span> <span class="n">api_client</span><span class="p">,</span> <span class="n">package_tree</span>
 <span class="o">&gt;&gt;&gt;</span> <span class="n">packages</span> <span class="o">=</span> <span class="n">api_client</span><span class="o">.</span><span class="n">request_software_packages</span><span class="p">()</span>
 <span class="o">&gt;&gt;&gt;</span> <span class="n">pt</span> <span class="o">=</span> <span class="n">package_tree</span><span class="o">.</span><span class="n">PackageTree</span><span class="p">(</span><span class="n">packages</span><span class="p">,</span> <span class="n">product</span><span class="o">=</span><span class="s2">&quot;cinema4d&quot;</span><span class="p">)</span>
 <span class="o">&gt;&gt;&gt;</span> <span class="n">pt</span><span class="o">.</span><span class="n">supported_host_names</span><span class="p">()</span>
@@ -1462,7 +1462,7 @@ and get package IDs.</p>
 
         <details class="quote">
           <summary>Source code in <code>ciocore/package_tree.py</code></summary>
-          <div class="highlight"><pre><span></span><code><span class="k">def</span> <span class="nf">supported_host_names</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+          <div class="highlight"><pre><span></span><code><span class="k">def</span><span class="w"> </span><span class="nf">supported_host_names</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    All host names from the software tree.</span>
 
@@ -1548,7 +1548,7 @@ and get package IDs.</p>
   </tbody>
 </table>
 <p><strong>Examples:</strong></p>
-    <div class="highlight"><pre><span></span><code><span class="o">&gt;&gt;&gt;</span> <span class="kn">from</span> <span class="nn">ciocore</span> <span class="kn">import</span> <span class="n">api_client</span><span class="p">,</span> <span class="n">package_tree</span> 
+    <div class="highlight"><pre><span></span><code><span class="o">&gt;&gt;&gt;</span> <span class="kn">from</span><span class="w"> </span><span class="nn">ciocore</span><span class="w"> </span><span class="kn">import</span> <span class="n">api_client</span><span class="p">,</span> <span class="n">package_tree</span> 
 <span class="o">&gt;&gt;&gt;</span> <span class="n">packages</span> <span class="o">=</span> <span class="n">api_client</span><span class="o">.</span><span class="n">request_software_packages</span><span class="p">()</span> 
 <span class="o">&gt;&gt;&gt;</span> <span class="n">pt</span> <span class="o">=</span> <span class="n">package_tree</span><span class="o">.</span><span class="n">PackageTree</span><span class="p">(</span><span class="n">packages</span><span class="p">,</span> <span class="n">product</span><span class="o">=</span><span class="s2">&quot;cinema4d&quot;</span><span class="p">)</span> 
 <span class="o">&gt;&gt;&gt;</span> <span class="n">name</span> <span class="o">=</span> <span class="n">pt</span><span class="o">.</span><span class="n">supported_host_names</span><span class="p">()[</span><span class="mi">0</span><span class="p">]</span>
@@ -1575,7 +1575,7 @@ and get package IDs.</p>
 
         <details class="quote">
           <summary>Source code in <code>ciocore/package_tree.py</code></summary>
-          <div class="highlight"><pre><span></span><code><span class="k">def</span> <span class="nf">supported_plugins</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">host</span><span class="p">):</span>
+          <div class="highlight"><pre><span></span><code><span class="k">def</span><span class="w"> </span><span class="nf">supported_plugins</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">host</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Find the plugins that are children of the given DCC host.</span>
 
@@ -1708,7 +1708,7 @@ and get package IDs.</p>
   </tbody>
 </table>
 <p><strong>Examples:</strong></p>
-    <div class="highlight"><pre><span></span><code><span class="o">&gt;&gt;&gt;</span> <span class="kn">from</span> <span class="nn">ciocore</span> <span class="kn">import</span> <span class="n">api_client</span><span class="p">,</span> <span class="n">package_tree</span>
+    <div class="highlight"><pre><span></span><code><span class="o">&gt;&gt;&gt;</span> <span class="kn">from</span><span class="w"> </span><span class="nn">ciocore</span><span class="w"> </span><span class="kn">import</span> <span class="n">api_client</span><span class="p">,</span> <span class="n">package_tree</span>
 <span class="o">&gt;&gt;&gt;</span> <span class="n">packages</span> <span class="o">=</span> <span class="n">api_client</span><span class="o">.</span><span class="n">request_software_packages</span><span class="p">()</span>
 <span class="o">&gt;&gt;&gt;</span> <span class="n">pt</span> <span class="o">=</span> <span class="n">package_tree</span><span class="o">.</span><span class="n">PackageTree</span><span class="p">(</span><span class="n">packages</span><span class="p">,</span> <span class="n">product</span><span class="o">=</span><span class="s2">&quot;cinema4d&quot;</span><span class="p">)</span>
 <span class="o">&gt;&gt;&gt;</span> <span class="n">pt</span><span class="o">.</span><span class="n">find_by_name</span><span class="p">(</span><span class="s2">&quot;redshift-cinema4d 3.0.64 linux&quot;</span><span class="p">)</span>
@@ -1726,7 +1726,7 @@ and get package IDs.</p>
 
         <details class="quote">
           <summary>Source code in <code>ciocore/package_tree.py</code></summary>
-          <div class="highlight"><pre><span></span><code><span class="k">def</span> <span class="nf">find_by_name</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">limit</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
+          <div class="highlight"><pre><span></span><code><span class="k">def</span><span class="w"> </span><span class="nf">find_by_name</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">limit</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Search the tree for a product with the given name.</span>
 
@@ -1815,7 +1815,7 @@ and get package IDs.</p>
   </tbody>
 </table>
 <p><strong>Examples:</strong></p>
-    <div class="highlight"><pre><span></span><code><span class="o">&gt;&gt;&gt;</span> <span class="kn">from</span> <span class="nn">ciocore</span> <span class="kn">import</span> <span class="n">api_client</span><span class="p">,</span> <span class="n">package_tree</span><span class="p">,</span> <span class="n">package_environment</span>
+    <div class="highlight"><pre><span></span><code><span class="o">&gt;&gt;&gt;</span> <span class="kn">from</span><span class="w"> </span><span class="nn">ciocore</span><span class="w"> </span><span class="kn">import</span> <span class="n">api_client</span><span class="p">,</span> <span class="n">package_tree</span><span class="p">,</span> <span class="n">package_environment</span>
 <span class="o">&gt;&gt;&gt;</span> <span class="n">packages</span> <span class="o">=</span> <span class="n">api_client</span><span class="o">.</span><span class="n">request_software_packages</span><span class="p">()</span>
 <span class="o">&gt;&gt;&gt;</span> <span class="n">pt</span> <span class="o">=</span> <span class="n">package_tree</span><span class="o">.</span><span class="n">PackageTree</span><span class="p">(</span><span class="n">packages</span><span class="p">,</span> <span class="n">product</span><span class="o">=</span><span class="s2">&quot;cinema4d&quot;</span><span class="p">)</span>
 <span class="o">&gt;&gt;&gt;</span> <span class="n">pt</span><span class="o">.</span><span class="n">find_by_path</span><span class="p">(</span><span class="s2">&quot;cinema4d 24.111 linux/redshift-cinema4d 3.0.62 linux&quot;</span><span class="p">)</span>
@@ -1834,7 +1834,7 @@ and get package IDs.</p>
 
         <details class="quote">
           <summary>Source code in <code>ciocore/package_tree.py</code></summary>
-          <div class="highlight"><pre><span></span><code><span class="k">def</span> <span class="nf">find_by_path</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">):</span>
+          <div class="highlight"><pre><span></span><code><span class="k">def</span><span class="w"> </span><span class="nf">find_by_path</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">path</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Find the package uniquely described by the given path.</span>
 
@@ -1924,7 +1924,7 @@ appropriate UI.</p>
   </tbody>
 </table>
 <p><strong>Examples:</strong></p>
-    <div class="highlight"><pre><span></span><code><span class="o">&gt;&gt;&gt;</span> <span class="kn">from</span> <span class="nn">ciocore</span> <span class="kn">import</span> <span class="n">api_client</span><span class="p">,</span> <span class="n">package_tree</span>
+    <div class="highlight"><pre><span></span><code><span class="o">&gt;&gt;&gt;</span> <span class="kn">from</span><span class="w"> </span><span class="nn">ciocore</span><span class="w"> </span><span class="kn">import</span> <span class="n">api_client</span><span class="p">,</span> <span class="n">package_tree</span>
 <span class="o">&gt;&gt;&gt;</span> <span class="n">packages</span> <span class="o">=</span> <span class="n">api_client</span><span class="o">.</span><span class="n">request_software_packages</span><span class="p">()</span>
 <span class="o">&gt;&gt;&gt;</span> <span class="n">pt</span> <span class="o">=</span> <span class="n">package_tree</span><span class="o">.</span><span class="n">PackageTree</span><span class="p">(</span><span class="n">packages</span><span class="p">,</span> <span class="n">product</span><span class="o">=</span><span class="s2">&quot;cinema4d&quot;</span><span class="p">)</span>
 <span class="o">&gt;&gt;&gt;</span> <span class="n">pt</span><span class="o">.</span><span class="n">to_path_list</span><span class="p">()</span>
@@ -1944,7 +1944,7 @@ appropriate UI.</p>
 
         <details class="quote">
           <summary>Source code in <code>ciocore/package_tree.py</code></summary>
-          <div class="highlight"><pre><span></span><code><span class="k">def</span> <span class="nf">to_path_list</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
+          <div class="highlight"><pre><span></span><code><span class="k">def</span><span class="w"> </span><span class="nf">to_path_list</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Get paths to all nodes.</span>
 
@@ -2019,7 +2019,7 @@ appropriate UI.</p>
 </table>
         <details class="quote">
           <summary>Source code in <code>ciocore/package_tree.py</code></summary>
-          <div class="highlight"><pre><span></span><code><span class="k">def</span> <span class="nf">platforms</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+          <div class="highlight"><pre><span></span><code><span class="k">def</span><span class="w"> </span><span class="nf">platforms</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Get the platforms represented by packages in the tree.</span>
 
@@ -2068,7 +2068,7 @@ appropriate UI.</p>
 </table>
         <details class="quote">
           <summary>Source code in <code>ciocore/package_tree.py</code></summary>
-          <div class="highlight"><pre><span></span><code><span class="k">def</span> <span class="nf">json</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+          <div class="highlight"><pre><span></span><code><span class="k">def</span><span class="w"> </span><span class="nf">json</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    The whole tree of softwware as json.</span>
 
@@ -2116,7 +2116,7 @@ appropriate UI.</p>
 </table>
         <details class="quote">
           <summary>Source code in <code>ciocore/package_tree.py</code></summary>
-          <div class="highlight"><pre><span></span><code><span class="k">def</span> <span class="nf">as_dict</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
+          <div class="highlight"><pre><span></span><code><span class="k">def</span><span class="w"> </span><span class="nf">as_dict</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Returns:</span>
 <span class="sd">        dict: The underlying software dictionary.</span>
@@ -2193,7 +2193,7 @@ necessarily possible to go the other way and extract version fields from the nam
   </tbody>
 </table>
 <p><strong>Examples:</strong></p>
-    <div class="highlight"><pre><span></span><code><span class="o">&gt;&gt;&gt;</span> <span class="kn">from</span> <span class="nn">ciocore</span> <span class="kn">import</span> <span class="n">api_client</span><span class="p">,</span> <span class="n">package_tree</span>
+    <div class="highlight"><pre><span></span><code><span class="o">&gt;&gt;&gt;</span> <span class="kn">from</span><span class="w"> </span><span class="nn">ciocore</span><span class="w"> </span><span class="kn">import</span> <span class="n">api_client</span><span class="p">,</span> <span class="n">package_tree</span>
 <span class="o">&gt;&gt;&gt;</span> <span class="n">packages</span> <span class="o">=</span> <span class="n">api_client</span><span class="o">.</span><span class="n">request_software_packages</span><span class="p">()</span>
 <span class="o">&gt;&gt;&gt;</span> <span class="n">package_tree</span><span class="o">.</span><span class="n">to_name</span><span class="p">(</span><span class="n">packages</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
 <span class="n">redshift</span><span class="o">-</span><span class="n">maya</span> <span class="mf">3.0.64</span> <span class="n">linux</span>
@@ -2201,7 +2201,7 @@ necessarily possible to go the other way and extract version fields from the nam
 
         <details class="quote">
           <summary>Source code in <code>ciocore/package_tree.py</code></summary>
-          <div class="highlight"><pre><span></span><code><span class="k">def</span> <span class="nf">to_name</span><span class="p">(</span><span class="n">pkg</span><span class="p">):</span>
+          <div class="highlight"><pre><span></span><code><span class="k">def</span><span class="w"> </span><span class="nf">to_name</span><span class="p">(</span><span class="n">pkg</span><span class="p">):</span>
 <span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">    Generate a name like `houdini 16.5.323 linux` or `maya 2016.SP3 linux`.</span>
 

ciocore/docsite/how-to-guides/index.html

@@ -764,13 +764,13 @@
 <p>This part of the documentation includes recipes and tutorials for common tasks and workflows using Conductor Core. If you have a suggestion for a new guide, feel free to <a href="https://support.conductortech.com/hc/en-us/requests/new">open an issue</a></p>
 <h2 id="how-to-create-a-submission">How to create a submission?</h2>
 <div class="highlight"><pre><span></span><code><span class="c1"># your_script.py</span>
-<span class="kn">from</span> <span class="nn">ciocore</span> <span class="kn">import</span> <span class="n">data</span> <span class="k">as</span> <span class="n">coredata</span>
+<span class="kn">from</span><span class="w"> </span><span class="nn">ciocore</span><span class="w"> </span><span class="kn">import</span> <span class="n">data</span> <span class="k">as</span> <span class="n">coredata</span>
 
 <span class="o">...</span>
 </code></pre></div>
 <h2 id="how-to-authenticate-with-an-api-key">How to authenticate with an API key?</h2>
 <div class="highlight"><pre><span></span><code><span class="c1"># your_script.py</span>
-<span class="kn">from</span> <span class="nn">ciocore</span> <span class="kn">import</span> <span class="n">api_client</span>
+<span class="kn">from</span><span class="w"> </span><span class="nn">ciocore</span><span class="w"> </span><span class="kn">import</span> <span class="n">api_client</span>
 
 <span class="o">...</span>
 </code></pre></div>

ciocore/downloader/base_downloader.py

@@ -293,7 +293,7 @@ class BaseDownloader(object):
             self.emit_start_task_event(task_info)
             for file_info in task_info["files"]:
 
-                file_info["output_dir"] = self.ensure_writable_output_path(file_info, task_info)
+                file_info["output_dir"] = ensure_writable_output_path(file_info, task_info, self.output_path)
                 file_info["filepath"] = os.path.join(file_info["output_dir"], file_info["relative_path"])
 
                 future = executor.submit(self.attempt_download, file_info)
@@ -305,7 +305,6 @@ class BaseDownloader(object):
                     # Throttle to prevent the queue from growing too large.
                     time.sleep(self.WORK_QUEUE_THROTTLE)
 
-
     def attempt_download(self, file_info):
         """
         Attempt to download a file with exponential backoff retries.
@@ -316,6 +315,14 @@ class BaseDownloader(object):
         Returns:
             - file_done_event: A dictionary indicating the completion status of the download.
         """
+ 
+        if file_info["output_dir"] is None:
+            identifier = f"{file_info['job_id']}::{file_info['task_id']}::{file_info['relative_path']}"
+            logger.debug("Download destination is None for file %s.", identifier)
+            return self.generate_file_done_event(
+                file_info, 
+                error=f"Download destination is None for file {identifier}."
+            )
         filepath = file_info["filepath"]
         attempts_remaining = self.max_attempts
         retry_delay = self.delay
@@ -368,37 +375,7 @@ class BaseDownloader(object):
         # Return the final file done event after all attempts.
         return file_done_event
 
-
-    def ensure_writable_output_path(self,file_info,task_info):
-        """
-        Resolve the output directory for the file. 
-        If the file's output directory is from a Windows machine, we provisionally use the fallback directory.
-
-        If the output_path is not writable, we try to use a fallback directory. If that fails, we use the temp folder.
-        """
-
-        output_path = file_info["output_dir"]
-        if os.name == "posix":
-            if re.match(r"^[a-zA-Z]:", output_path):
-                self.output_path =  os.path.expanduser(os.path.join("~", FALLBACK_DOWNLOADS_FOLDER))
-
-        if self.output_path:
-            output_path =  os.path.join(self.output_path, task_info["job_id"])
-
-        try:
-            os.makedirs(output_path, exist_ok=True)
-            return output_path
-        except Exception:
-            logger.exception("Can't use specified output directory %s. Trying fallback", output_path) 
-
-        output_path = os.path.expanduser(os.path.join("~", FALLBACK_DOWNLOADS_FOLDER, task_info["job_id"]))
-        try:
-            os.makedirs(output_path, exist_ok=True)
-            return output_path
-        except Exception:
-            logger.exception("Can't use fallback output directory %s. Trying temp folder", output_path) 
-        return os.path.join(tempfile.gettempdir(), FALLBACK_DOWNLOADS_FOLDER, task_info["job_id"])
-
+ 
 
     def can_skip(self, file_info):
         """Determine if a file download should be skipped.
@@ -642,3 +619,64 @@ class BaseDownloader(object):
             md5_digest = md5_hash.digest()
             md5_base64 = base64.b64encode(md5_digest)
             return md5_base64.decode("utf-8")
+
+
+def ensure_writable_output_path(file_info, task_info, user_specified_path=None):
+    """
+    Resolve the output directory for the file. 
+    If the file's output directory is from a Windows machine, we provisionally use the fallback directory.
+
+    If the output_path is not writable, we try to use a fallback directory. If that fails, we use the temp folder.
+    """
+    fallback_path = get_fallback_path(task_info["job_id"])
+    identifier = f"{file_info['job_id']}::{file_info['task_id']}::{file_info['relative_path']}"
+    if user_specified_path:
+        logger.debug("Using user-specified output directory: %s", user_specified_path)
+        full_user_specified_path = os.path.join(user_specified_path, task_info["job_id"])
+        logger.debug("Using user-specified output directory: %s", full_user_specified_path)
+        if ensure_path_valid(full_user_specified_path):
+            return full_user_specified_path
+        if ensure_path_valid(fallback_path):
+            logger.info("Using fallback output directory: %s for file %s", fallback_path, identifier)
+            return fallback_path
+        logger.warning("No valid output directory found for file %s.", identifier)
+        return None
+    else:
+        logger.debug("No user-specified output directory. Using job's output directory.")
+        output_path = file_info["output_dir"]
+        if ensure_path_valid(output_path):
+            logger.debug("Using job's output directory: %s", output_path)
+            return output_path
+        if ensure_path_valid(fallback_path):
+            logger.info("%s is not valid. Using fallback output directory: %s for file %s", output_path, fallback_path, identifier)
+            return fallback_path
+        logger.warning("No valid output directory found for file %s.", identifier)
+        return None
+
+def get_fallback_path(job_id):
+    return os.path.expanduser(os.path.join("~", FALLBACK_DOWNLOADS_FOLDER, job_id))
+
+def ensure_path_valid(path):
+    """
+    Ensure that a path is valid and writable.
+
+    This function ensures:
+    1. The path is a posix path, or a Windows path on a Windows system
+    2. The directory can be created and is writable
+
+    Parameters:
+        path (str): The filesystem path to validate
+
+    Returns:
+        bool: True if the path is valid and writable, False otherwise
+    """
+    os_name = os.name
+    is_drive_letter_path = re.match(r"^[a-zA-Z]:", path)
+    
+    if is_drive_letter_path and (os_name != "nt"):
+        return False
+    try:
+        os.makedirs(path, exist_ok=True)
+        return True
+    except Exception:
+        return False