nautobot 2.2.2__py3-none-any.whl → 2.2.3__py3-none-any.whl

nautobot/project-static/docs/code-reference/nautobot/apps/jobs.html

@@ -6154,15 +6154,6 @@
     </span>
   </a>
   
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#nautobot.apps.jobs.BaseJob.apply" class="md-nav__link">
-    <span class="md-ellipsis">
-      apply
-    </span>
-  </a>
-  
 </li>
         
           <li class="md-nav__item">
@@ -6217,15 +6208,6 @@
     </span>
   </a>
   
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#nautobot.apps.jobs.BaseJob.clear_cache" class="md-nav__link">
-    <span class="md-ellipsis">
-      clear_cache
-    </span>
-  </a>
-  
 </li>
         
           <li class="md-nav__item">
@@ -6247,27 +6229,27 @@
 </li>
         
           <li class="md-nav__item">
-  <a href="#nautobot.apps.jobs.BaseJob.load_json" class="md-nav__link">
+  <a href="#nautobot.apps.jobs.BaseJob.file_path" class="md-nav__link">
     <span class="md-ellipsis">
-      load_json
+      file_path
     </span>
   </a>
   
 </li>
         
           <li class="md-nav__item">
-  <a href="#nautobot.apps.jobs.BaseJob.load_yaml" class="md-nav__link">
+  <a href="#nautobot.apps.jobs.BaseJob.load_json" class="md-nav__link">
     <span class="md-ellipsis">
-      load_yaml
+      load_json
     </span>
   </a>
   
 </li>
         
           <li class="md-nav__item">
-  <a href="#nautobot.apps.jobs.BaseJob.on_bound" class="md-nav__link">
+  <a href="#nautobot.apps.jobs.BaseJob.load_yaml" class="md-nav__link">
     <span class="md-ellipsis">
-      on_bound
+      load_yaml
     </span>
   </a>
   
@@ -6319,27 +6301,27 @@
 </li>
         
           <li class="md-nav__item">
-  <a href="#nautobot.apps.jobs.BaseJob.run" class="md-nav__link">
+  <a href="#nautobot.apps.jobs.BaseJob.registered_name" class="md-nav__link">
     <span class="md-ellipsis">
-      run
+      registered_name
     </span>
   </a>
   
 </li>
         
           <li class="md-nav__item">
-  <a href="#nautobot.apps.jobs.BaseJob.serialize_data" class="md-nav__link">
+  <a href="#nautobot.apps.jobs.BaseJob.run" class="md-nav__link">
     <span class="md-ellipsis">
-      serialize_data
+      run
     </span>
   </a>
   
 </li>
         
           <li class="md-nav__item">
-  <a href="#nautobot.apps.jobs.BaseJob.shadow_name" class="md-nav__link">
+  <a href="#nautobot.apps.jobs.BaseJob.serialize_data" class="md-nav__link">
     <span class="md-ellipsis">
-      shadow_name
+      serialize_data
     </span>
   </a>
   
@@ -6636,6 +6618,15 @@
     </span>
   </a>
   
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#nautobot.apps.jobs.get_jobs" class="md-nav__link">
+    <span class="md-ellipsis">
+      get_jobs
+    </span>
+  </a>
+  
 </li>
       
         <li class="md-nav__item">
@@ -8310,15 +8301,6 @@
     </span>
   </a>
   
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#nautobot.apps.jobs.BaseJob.apply" class="md-nav__link">
-    <span class="md-ellipsis">
-      apply
-    </span>
-  </a>
-  
 </li>
         
           <li class="md-nav__item">
@@ -8373,15 +8355,6 @@
     </span>
   </a>
   
-</li>
-        
-          <li class="md-nav__item">
-  <a href="#nautobot.apps.jobs.BaseJob.clear_cache" class="md-nav__link">
-    <span class="md-ellipsis">
-      clear_cache
-    </span>
-  </a>
-  
 </li>
         
           <li class="md-nav__item">
@@ -8403,27 +8376,27 @@
 </li>
         
           <li class="md-nav__item">
-  <a href="#nautobot.apps.jobs.BaseJob.load_json" class="md-nav__link">
+  <a href="#nautobot.apps.jobs.BaseJob.file_path" class="md-nav__link">
     <span class="md-ellipsis">
-      load_json
+      file_path
     </span>
   </a>
   
 </li>
         
           <li class="md-nav__item">
-  <a href="#nautobot.apps.jobs.BaseJob.load_yaml" class="md-nav__link">
+  <a href="#nautobot.apps.jobs.BaseJob.load_json" class="md-nav__link">
     <span class="md-ellipsis">
-      load_yaml
+      load_json
     </span>
   </a>
   
 </li>
         
           <li class="md-nav__item">
-  <a href="#nautobot.apps.jobs.BaseJob.on_bound" class="md-nav__link">
+  <a href="#nautobot.apps.jobs.BaseJob.load_yaml" class="md-nav__link">
     <span class="md-ellipsis">
-      on_bound
+      load_yaml
     </span>
   </a>
   
@@ -8475,27 +8448,27 @@
 </li>
         
           <li class="md-nav__item">
-  <a href="#nautobot.apps.jobs.BaseJob.run" class="md-nav__link">
+  <a href="#nautobot.apps.jobs.BaseJob.registered_name" class="md-nav__link">
     <span class="md-ellipsis">
-      run
+      registered_name
     </span>
   </a>
   
 </li>
         
           <li class="md-nav__item">
-  <a href="#nautobot.apps.jobs.BaseJob.serialize_data" class="md-nav__link">
+  <a href="#nautobot.apps.jobs.BaseJob.run" class="md-nav__link">
     <span class="md-ellipsis">
-      serialize_data
+      run
     </span>
   </a>
   
 </li>
         
           <li class="md-nav__item">
-  <a href="#nautobot.apps.jobs.BaseJob.shadow_name" class="md-nav__link">
+  <a href="#nautobot.apps.jobs.BaseJob.serialize_data" class="md-nav__link">
     <span class="md-ellipsis">
-      shadow_name
+      serialize_data
     </span>
   </a>
   
@@ -8792,6 +8765,15 @@
     </span>
   </a>
   
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#nautobot.apps.jobs.get_jobs" class="md-nav__link">
+    <span class="md-ellipsis">
+      get_jobs
+    </span>
+  </a>
+  
 </li>
       
         <li class="md-nav__item">
@@ -8876,8 +8858,6 @@
 
 
   <div class="doc doc-contents ">
-          <p class="doc doc-class-bases">
-            Bases: <code><span title="nautobot.core.celery.task.Task">Task</span></code></p>
 
   
       <p>Base model for jobs.</p>
@@ -9079,25 +9059,6 @@ with shared functionality; if no such sharing is required, use Job class instead
 
 
 
-<h3 id="nautobot.apps.jobs.BaseJob.apply" class="doc doc-heading">
-          <code class="highlight language-python"><span class="n">apply</span><span class="p">(</span><span class="n">args</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">kwargs</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">link</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">link_error</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">task_id</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">retries</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">throw</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">logfile</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">loglevel</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">headers</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="o">**</span><span class="n">options</span><span class="p">)</span></code>
-
-<a href="#nautobot.apps.jobs.BaseJob.apply" class="headerlink" title="Permanent link">&para;</a></h3>
-
-
-  <div class="doc doc-contents ">
-  
-      <p>Fix celery's apply method to propagate options to the task result</p>
-
-  </div>
-
-</div>
-
-
-<div class="doc doc-object doc-function">
-
-
-
 <h3 id="nautobot.apps.jobs.BaseJob.as_form" class="doc doc-heading">
           <code class="highlight language-python"><span class="n">as_form</span><span class="p">(</span><span class="n">data</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">files</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">initial</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">approval_view</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span></code>
   
@@ -9311,26 +9272,6 @@ during a approval review workflow.</p>
 
 
 
-<h3 id="nautobot.apps.jobs.BaseJob.clear_cache" class="doc doc-heading">
-          <code class="highlight language-python"><span class="n">clear_cache</span><span class="p">()</span></code>
-
-<a href="#nautobot.apps.jobs.BaseJob.clear_cache" class="headerlink" title="Permanent link">&para;</a></h3>
-
-
-  <div class="doc doc-contents ">
-  
-      <p>Clear all cached properties on this instance without accessing them. This is required because
-celery reuses task instances for multiple runs.</p>
-
-  </div>
-
-</div>
-
-
-<div class="doc doc-object doc-function">
-
-
-
 <h3 id="nautobot.apps.jobs.BaseJob.create_file" class="doc doc-heading">
           <code class="highlight language-python"><span class="n">create_file</span><span class="p">(</span><span class="n">filename</span><span class="p">,</span> <span class="n">content</span><span class="p">)</span></code>
 
@@ -9470,15 +9411,15 @@ path would consider this a failure of the job execution, as described in <code>n
 
 
 
-<h3 id="nautobot.apps.jobs.BaseJob.load_json" class="doc doc-heading">
-          <code class="highlight language-python"><span class="n">load_json</span><span class="p">(</span><span class="n">filename</span><span class="p">)</span></code>
+<h3 id="nautobot.apps.jobs.BaseJob.file_path" class="doc doc-heading">
+          <code class="highlight language-python"><span class="n">file_path</span><span class="p">()</span></code>
 
-<a href="#nautobot.apps.jobs.BaseJob.load_json" class="headerlink" title="Permanent link">&para;</a></h3>
+<a href="#nautobot.apps.jobs.BaseJob.file_path" class="headerlink" title="Permanent link">&para;</a></h3>
 
 
   <div class="doc doc-contents ">
   
-      <p>Return data from a JSON file</p>
+      <p>Deprecated as of Nautobot 2.2.3.</p>
 
   </div>
 
@@ -9489,15 +9430,15 @@ path would consider this a failure of the job execution, as described in <code>n
 
 
 
-<h3 id="nautobot.apps.jobs.BaseJob.load_yaml" class="doc doc-heading">
-          <code class="highlight language-python"><span class="n">load_yaml</span><span class="p">(</span><span class="n">filename</span><span class="p">)</span></code>
+<h3 id="nautobot.apps.jobs.BaseJob.load_json" class="doc doc-heading">
+          <code class="highlight language-python"><span class="n">load_json</span><span class="p">(</span><span class="n">filename</span><span class="p">)</span></code>
 
-<a href="#nautobot.apps.jobs.BaseJob.load_yaml" class="headerlink" title="Permanent link">&para;</a></h3>
+<a href="#nautobot.apps.jobs.BaseJob.load_json" class="headerlink" title="Permanent link">&para;</a></h3>
 
 
   <div class="doc doc-contents ">
   
-      <p>Return data from a YAML file</p>
+      <p>Return data from a JSON file</p>
 
   </div>
 
@@ -9508,25 +9449,16 @@ path would consider this a failure of the job execution, as described in <code>n
 
 
 
-<h3 id="nautobot.apps.jobs.BaseJob.on_bound" class="doc doc-heading">
-          <code class="highlight language-python"><span class="n">on_bound</span><span class="p">(</span><span class="n">app</span><span class="p">)</span></code>
-  
-  <span class="doc doc-labels">
-      <small class="doc doc-label doc-label-classmethod"><code>classmethod</code></small>
-  </span>
+<h3 id="nautobot.apps.jobs.BaseJob.load_yaml" class="doc doc-heading">
+          <code class="highlight language-python"><span class="n">load_yaml</span><span class="p">(</span><span class="n">filename</span><span class="p">)</span></code>
 
-<a href="#nautobot.apps.jobs.BaseJob.on_bound" class="headerlink" title="Permanent link">&para;</a></h3>
+<a href="#nautobot.apps.jobs.BaseJob.load_yaml" class="headerlink" title="Permanent link">&para;</a></h3>
 
 
   <div class="doc doc-contents ">
   
-      <p>Called when the task is bound to an app.</p>
+      <p>Return data from a YAML file</p>
 
-<details class="note" open>
-  <summary>Note</summary>
-  <p>This class method can be defined to do additional actions when
-the task class is bound to an app.</p>
-</details>
   </div>
 
 </div>
@@ -9955,15 +9887,15 @@ the task class is bound to an app.</p>
 
 
 
-<h3 id="nautobot.apps.jobs.BaseJob.run" class="doc doc-heading">
-          <code class="highlight language-python"><span class="n">run</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span></code>
+<h3 id="nautobot.apps.jobs.BaseJob.registered_name" class="doc doc-heading">
+          <code class="highlight language-python"><span class="n">registered_name</span><span class="p">()</span></code>
 
-<a href="#nautobot.apps.jobs.BaseJob.run" class="headerlink" title="Permanent link">&para;</a></h3>
+<a href="#nautobot.apps.jobs.BaseJob.registered_name" class="headerlink" title="Permanent link">&para;</a></h3>
 
 
   <div class="doc doc-contents ">
   
-      <p>Method invoked when this Job is run.</p>
+      <p>Deprecated - use class_path classproperty instead.</p>
 
   </div>
 
@@ -9974,22 +9906,15 @@ the task class is bound to an app.</p>
 
 
 
-<h3 id="nautobot.apps.jobs.BaseJob.serialize_data" class="doc doc-heading">
-          <code class="highlight language-python"><span class="n">serialize_data</span><span class="p">(</span><span class="n">data</span><span class="p">)</span></code>
-  
-  <span class="doc doc-labels">
-      <small class="doc doc-label doc-label-staticmethod"><code>staticmethod</code></small>
-  </span>
+<h3 id="nautobot.apps.jobs.BaseJob.run" class="doc doc-heading">
+          <code class="highlight language-python"><span class="n">run</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span></code>
 
-<a href="#nautobot.apps.jobs.BaseJob.serialize_data" class="headerlink" title="Permanent link">&para;</a></h3>
+<a href="#nautobot.apps.jobs.BaseJob.run" class="headerlink" title="Permanent link">&para;</a></h3>
 
 
   <div class="doc doc-contents ">
   
-      <p>This method parses input data (from JobForm usually) and returns a dict which is safe to serialize</p>
-<p>Here we convert the QuerySet of a MultiObjectVar to a list of the pk's and the model instance
-of an ObjectVar into the pk value.</p>
-<p>These are converted back during job execution.</p>
+      <p>Method invoked when this Job is run.</p>
 
   </div>
 
@@ -10000,82 +9925,22 @@ of an ObjectVar into the pk value.</p>
 
 
 
-<h3 id="nautobot.apps.jobs.BaseJob.shadow_name" class="doc doc-heading">
-          <code class="highlight language-python"><span class="n">shadow_name</span><span class="p">(</span><span class="n">args</span><span class="p">,</span> <span class="n">kwargs</span><span class="p">,</span> <span class="n">options</span><span class="p">)</span></code>
+<h3 id="nautobot.apps.jobs.BaseJob.serialize_data" class="doc doc-heading">
+          <code class="highlight language-python"><span class="n">serialize_data</span><span class="p">(</span><span class="n">data</span><span class="p">)</span></code>
+  
+  <span class="doc doc-labels">
+      <small class="doc doc-label doc-label-staticmethod"><code>staticmethod</code></small>
+  </span>
 
-<a href="#nautobot.apps.jobs.BaseJob.shadow_name" class="headerlink" title="Permanent link">&para;</a></h3>
+<a href="#nautobot.apps.jobs.BaseJob.serialize_data" class="headerlink" title="Permanent link">&para;</a></h3>
 
 
   <div class="doc doc-contents ">
   
-      <p>Override for custom task name in worker logs/monitoring.</p>
-
-<details class="example" open>
-  <summary>Example</summary>
-  <p>from celery.utils.imports import qualname</p>
-<p>def shadow_name(task, args, kwargs, options):
-    return qualname(args[0])</p>
-<p>@app.task(shadow_name=shadow_name, serializer='pickle')
-def apply_function_async(fun, <em>args, </em><em>kwargs):
-    return fun(</em>args, **kwargs)</p>
-</details>
-
-
-  <p><strong>Parameters:</strong></p>
-  <table>
-    <thead>
-      <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th>Description</th>
-        <th>Default</th>
-      </tr>
-    </thead>
-    <tbody>
-        <tr>
-          <td><code>args</code></td>
-          <td>
-                <code>Tuple</code>
-          </td>
-          <td>
-            <div class="doc-md-description">
-              <p>Task positional arguments.</p>
-            </div>
-          </td>
-          <td>
-              <em>required</em>
-          </td>
-        </tr>
-        <tr>
-          <td><code>kwargs</code></td>
-          <td>
-                <code>Dict</code>
-          </td>
-          <td>
-            <div class="doc-md-description">
-              <p>Task keyword arguments.</p>
-            </div>
-          </td>
-          <td>
-              <em>required</em>
-          </td>
-        </tr>
-        <tr>
-          <td><code>options</code></td>
-          <td>
-                <code>Dict</code>
-          </td>
-          <td>
-            <div class="doc-md-description">
-              <p>Task execution options.</p>
-            </div>
-          </td>
-          <td>
-              <em>required</em>
-          </td>
-        </tr>
-    </tbody>
-  </table>
+      <p>This method parses input data (from JobForm usually) and returns a dict which is safe to serialize</p>
+<p>Here we convert the QuerySet of a MultiObjectVar to a list of the pk's and the model instance
+of an ObjectVar into the pk value.</p>
+<p>These are converted back during job execution.</p>
 
   </div>
 
@@ -11279,7 +11144,7 @@ to be processed</p>
 
 
 <h2 id="nautobot.apps.jobs.get_job" class="doc doc-heading">
-          <code class="highlight language-python"><span class="n">nautobot</span><span class="o">.</span><span class="n">apps</span><span class="o">.</span><span class="n">jobs</span><span class="o">.</span><span class="n">get_job</span><span class="p">(</span><span class="n">class_path</span><span class="p">)</span></code>
+          <code class="highlight language-python"><span class="n">nautobot</span><span class="o">.</span><span class="n">apps</span><span class="o">.</span><span class="n">jobs</span><span class="o">.</span><span class="n">get_job</span><span class="p">(</span><span class="n">class_path</span><span class="p">,</span> <span class="n">reload</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span></code>
 
 <a href="#nautobot.apps.jobs.get_job" class="headerlink" title="Permanent link">&para;</a></h2>
 
@@ -11287,7 +11152,111 @@ to be processed</p>
   <div class="doc doc-contents ">
   
       <p>Retrieve a specific job class by its class_path (<code>&lt;module_name&gt;.&lt;JobClassName&gt;</code>).</p>
-<p>May return None if the job isn't properly registered with Celery at this time.</p>
+<p>May return None if the job can't be imported.</p>
+
+
+
+  <p><strong>Parameters:</strong></p>
+  <table>
+    <thead>
+      <tr>
+        <th>Name</th>
+        <th>Type</th>
+        <th>Description</th>
+        <th>Default</th>
+      </tr>
+    </thead>
+    <tbody>
+        <tr>
+          <td><code>reload</code></td>
+          <td>
+                <code>bool</code>
+          </td>
+          <td>
+            <div class="doc-md-description">
+              <p>If True, <strong>and</strong> the given class_path describes a JOBS_ROOT or GitRepository Job,
+then refresh <strong>all</strong> such Jobs before retrieving the job class.</p>
+            </div>
+          </td>
+          <td>
+                <code>False</code>
+          </td>
+        </tr>
+    </tbody>
+  </table>
+
+  </div>
+
+</div>
+
+
+<div class="doc doc-object doc-function">
+
+
+
+<h2 id="nautobot.apps.jobs.get_jobs" class="doc doc-heading">
+          <code class="highlight language-python"><span class="n">nautobot</span><span class="o">.</span><span class="n">apps</span><span class="o">.</span><span class="n">jobs</span><span class="o">.</span><span class="n">get_jobs</span><span class="p">(</span><span class="o">*</span><span class="p">,</span> <span class="n">reload</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span></code>
+
+<a href="#nautobot.apps.jobs.get_jobs" class="headerlink" title="Permanent link">&para;</a></h2>
+
+
+  <div class="doc doc-contents ">
+  
+      <p>Compile a dictionary of all Job classes available at this time.</p>
+
+
+
+  <p><strong>Parameters:</strong></p>
+  <table>
+    <thead>
+      <tr>
+        <th>Name</th>
+        <th>Type</th>
+        <th>Description</th>
+        <th>Default</th>
+      </tr>
+    </thead>
+    <tbody>
+        <tr>
+          <td><code>reload</code></td>
+          <td>
+                <code>bool</code>
+          </td>
+          <td>
+            <div class="doc-md-description">
+              <p>If True, reimport Jobs from <code>JOBS_ROOT</code> and all applicable GitRepositories.</p>
+            </div>
+          </td>
+          <td>
+                <code>False</code>
+          </td>
+        </tr>
+    </tbody>
+  </table>
+
+
+
+  <p><strong>Returns:</strong></p>
+  <table>
+    <thead>
+      <tr>
+        <th>Type</th>
+        <th>Description</th>
+      </tr>
+    </thead>
+    <tbody>
+        <tr>
+          <td>
+                <code>dict</code>
+          </td>
+          <td>
+            <div class="doc-md-description">
+              <p><code>{"class_path.Job1": &lt;job_class&gt;, "class_path.Job2": &lt;job_class&gt;, ...}</code></p>
+            </div>
+          </td>
+        </tr>
+    </tbody>
+  </table>
 
   </div>
 
@@ -11344,7 +11313,7 @@ to be processed</p>
 
   <div class="doc doc-contents ">
   
-      <p>Helper method to register jobs with Celery</p>
+      <p>Method to register jobs - with Celery in Nautobot 2.0 through 2.2.2, with Nautobot itself in 2.2.3 and later.</p>
 
   </div>
 

nautobot/project-static/docs/development/apps/api/platform-features/jobs.html

@@ -7751,7 +7751,7 @@
 </code></pre></div>
 <div class="admonition version-changed">
 <p class="admonition-title">Changed in version 2.0.0</p>
-<p>Because Jobs are now proper Celery tasks, you now must call <code>register_jobs()</code> from within your <code>jobs.py</code> file when it is imported; any jobs not included in this call will not be available for Celery to schedule and execute.</p>
+<p>You now must call <code>register_jobs()</code> from within your <code>jobs.py</code> file when it is imported; any jobs not included in this call will not be available for Nautobot to schedule and execute.</p>
 </div>