nautobot 2.3.8__py3-none-any.whl → 2.3.10__py3-none-any.whl

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

@@ -18,7 +18,7 @@
       
       
       <link rel="icon" href="../../../assets/favicon.ico">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.39">
+      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.42">
     
     
       
@@ -26,7 +26,7 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/stylesheets/main.8c3ca2c6.min.css">
+      <link rel="stylesheet" href="../../../assets/stylesheets/main.0253249f.min.css">
       
         
         <link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
@@ -6393,6 +6393,27 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../../development/apps/api/platform-features/table-extensions.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    Table Extensions
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
     <li class="md-nav__item">
       <a href="../../../development/apps/api/platform-features/uniquely-identify-objects.html" class="md-nav__link">
         
@@ -11901,15 +11922,94 @@ an actual instance of the class.</p>
 
 
 <h2 id="nautobot.apps.jobs.enqueue_job_hooks" 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">enqueue_job_hooks</span><span class="p">(</span><span class="n">object_change</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">enqueue_job_hooks</span><span class="p">(</span><span class="n">object_change</span><span class="p">,</span> <span class="n">may_reload_jobs</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">jobhook_queryset</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span></code>
 
 <a href="#nautobot.apps.jobs.enqueue_job_hooks" class="headerlink" title="Permanent link">&para;</a></h2>
 
 
     <div class="doc doc-contents ">
 
-      <p>Find job hook(s) assigned to this changed object type + action and enqueue them
-to be processed</p>
+      <p>Find job hook(s) assigned to this changed object type + action and enqueue them to be processed.</p>
+
+
+<p><span class="doc-section-title">Parameters:</span></p>
+    <table>
+      <thead>
+        <tr>
+          <th>Name</th>
+          <th>Type</th>
+          <th>Description</th>
+          <th>Default</th>
+        </tr>
+      </thead>
+      <tbody>
+          <tr class="doc-section-item">
+            <td><code>object_change</code></td>
+            <td>
+                  <code><autoref identifier="nautobot.extras.models.ObjectChange" optional hover>ObjectChange</autoref></code>
+            </td>
+            <td>
+              <div class="doc-md-description">
+                <p>The change that may trigger JobHooks to execute.</p>
+              </div>
+            </td>
+            <td>
+                <em>required</em>
+            </td>
+          </tr>
+          <tr class="doc-section-item">
+            <td><code>may_reload_jobs</code></td>
+            <td>
+                  <code><autoref identifier="bool" optional>bool</autoref></code>
+            </td>
+            <td>
+              <div class="doc-md-description">
+                <p>Whether to reload JobHook source code from disk to guarantee up-to-date code.</p>
+              </div>
+            </td>
+            <td>
+                  <code>True</code>
+            </td>
+          </tr>
+          <tr class="doc-section-item">
+            <td><code>jobhook_queryset</code></td>
+            <td>
+                  <code><autoref identifier="django.db.models.query.QuerySet" optional hover>QuerySet</autoref></code>
+            </td>
+            <td>
+              <div class="doc-md-description">
+                <p>Previously retrieved set of JobHooks to potentially enqueue</p>
+              </div>
+            </td>
+            <td>
+                  <code>None</code>
+            </td>
+          </tr>
+      </tbody>
+    </table>
+
+
+    <p><span class="doc-section-title">Returns:</span></p>
+    <table>
+      <thead>
+        <tr>
+<th>Name</th>          <th>Type</th>
+          <th>Description</th>
+        </tr>
+      </thead>
+      <tbody>
+          <tr class="doc-section-item">
+<td><code>result</code></td>            <td>
+                  <code><autoref identifier="tuple" optional>tuple</autoref>[<autoref identifier="bool" optional>bool</autoref>, <autoref identifier="django.db.models.query.QuerySet" optional hover>QuerySet</autoref>]</code>
+            </td>
+            <td>
+              <div class="doc-md-description">
+                <p>whether Jobs were reloaded here, and the jobhooks that were considered</p>
+              </div>
+            </td>
+          </tr>
+      </tbody>
+    </table>
 
     </div>
 
@@ -12236,7 +12336,7 @@ then refresh <strong>all</strong> such Jobs before retrieving the job class.</p>
     <script id="__config" type="application/json">{"base": "../../..", "features": ["content.code.copy", "content.tabs.link", "navigation.footer", "navigation.tabs", "navigation.tabs.sticky", "navigation.tracking", "search.highlight", "search.share", "search.suggest"], "search": "../../../assets/javascripts/workers/search.6ce7567c.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
     
     
-      <script src="../../../assets/javascripts/bundle.525ec568.min.js"></script>
+      <script src="../../../assets/javascripts/bundle.83f73b43.min.js"></script>
       
         <script src="https://code.jquery.com/jquery-3.7.1.min.js"></script>
       

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

@@ -18,7 +18,7 @@
       
       
       <link rel="icon" href="../../../assets/favicon.ico">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.39">
+      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.42">
     
     
       
@@ -26,7 +26,7 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/stylesheets/main.8c3ca2c6.min.css">
+      <link rel="stylesheet" href="../../../assets/stylesheets/main.0253249f.min.css">
       
         
         <link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
@@ -6393,6 +6393,27 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../../development/apps/api/platform-features/table-extensions.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    Table Extensions
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
     <li class="md-nav__item">
       <a href="../../../development/apps/api/platform-features/uniquely-identify-objects.html" class="md-nav__link">
         
@@ -15274,7 +15295,7 @@ e.g:
     <script id="__config" type="application/json">{"base": "../../..", "features": ["content.code.copy", "content.tabs.link", "navigation.footer", "navigation.tabs", "navigation.tabs.sticky", "navigation.tracking", "search.highlight", "search.share", "search.suggest"], "search": "../../../assets/javascripts/workers/search.6ce7567c.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
     
     
-      <script src="../../../assets/javascripts/bundle.525ec568.min.js"></script>
+      <script src="../../../assets/javascripts/bundle.83f73b43.min.js"></script>
       
         <script src="https://code.jquery.com/jquery-3.7.1.min.js"></script>
       

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

@@ -18,7 +18,7 @@
       
       
       <link rel="icon" href="../../../assets/favicon.ico">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.39">
+      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.42">
     
     
       
@@ -26,7 +26,7 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/stylesheets/main.8c3ca2c6.min.css">
+      <link rel="stylesheet" href="../../../assets/stylesheets/main.0253249f.min.css">
       
         
         <link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
@@ -6393,6 +6393,27 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../../development/apps/api/platform-features/table-extensions.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    Table Extensions
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
     <li class="md-nav__item">
       <a href="../../../development/apps/api/platform-features/uniquely-identify-objects.html" class="md-nav__link">
         
@@ -8911,7 +8932,7 @@ sort it within Python to ensure correctness.</p>
     <script id="__config" type="application/json">{"base": "../../..", "features": ["content.code.copy", "content.tabs.link", "navigation.footer", "navigation.tabs", "navigation.tabs.sticky", "navigation.tracking", "search.highlight", "search.share", "search.suggest"], "search": "../../../assets/javascripts/workers/search.6ce7567c.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
     
     
-      <script src="../../../assets/javascripts/bundle.525ec568.min.js"></script>
+      <script src="../../../assets/javascripts/bundle.83f73b43.min.js"></script>
       
         <script src="https://code.jquery.com/jquery-3.7.1.min.js"></script>
       

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

@@ -18,7 +18,7 @@
       
       
       <link rel="icon" href="../../../assets/favicon.ico">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.39">
+      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.42">
     
     
       
@@ -26,7 +26,7 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/stylesheets/main.8c3ca2c6.min.css">
+      <link rel="stylesheet" href="../../../assets/stylesheets/main.0253249f.min.css">
       
         
         <link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
@@ -6393,6 +6393,27 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../../development/apps/api/platform-features/table-extensions.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    Table Extensions
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
     <li class="md-nav__item">
       <a href="../../../development/apps/api/platform-features/uniquely-identify-objects.html" class="md-nav__link">
         
@@ -9071,7 +9092,7 @@
     <script id="__config" type="application/json">{"base": "../../..", "features": ["content.code.copy", "content.tabs.link", "navigation.footer", "navigation.tabs", "navigation.tabs.sticky", "navigation.tracking", "search.highlight", "search.share", "search.suggest"], "search": "../../../assets/javascripts/workers/search.6ce7567c.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
     
     
-      <script src="../../../assets/javascripts/bundle.525ec568.min.js"></script>
+      <script src="../../../assets/javascripts/bundle.83f73b43.min.js"></script>
       
         <script src="https://code.jquery.com/jquery-3.7.1.min.js"></script>
       

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

@@ -18,7 +18,7 @@
       
       
       <link rel="icon" href="../../../assets/favicon.ico">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.39">
+      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.42">
     
     
       
@@ -26,7 +26,7 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/stylesheets/main.8c3ca2c6.min.css">
+      <link rel="stylesheet" href="../../../assets/stylesheets/main.0253249f.min.css">
       
         
         <link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
@@ -6393,6 +6393,27 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../../development/apps/api/platform-features/table-extensions.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    Table Extensions
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
     <li class="md-nav__item">
       <a href="../../../development/apps/api/platform-features/uniquely-identify-objects.html" class="md-nav__link">
         
@@ -7184,6 +7205,30 @@
     </span>
   </a>
   
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#nautobot.apps.tables.TableExtension" class="md-nav__link">
+    <span class="md-ellipsis">
+      TableExtension
+    </span>
+  </a>
+  
+    <nav class="md-nav" aria-label="TableExtension">
+      <ul class="md-nav__list">
+        
+          <li class="md-nav__item">
+  <a href="#nautobot.apps.tables.TableExtension.alter_queryset" class="md-nav__link">
+    <span class="md-ellipsis">
+      alter_queryset
+    </span>
+  </a>
+  
+</li>
+        
+      </ul>
+    </nav>
+  
 </li>
       
         <li class="md-nav__item">
@@ -8899,6 +8944,30 @@
     </span>
   </a>
   
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#nautobot.apps.tables.TableExtension" class="md-nav__link">
+    <span class="md-ellipsis">
+      TableExtension
+    </span>
+  </a>
+  
+    <nav class="md-nav" aria-label="TableExtension">
+      <ul class="md-nav__list">
+        
+          <li class="md-nav__item">
+  <a href="#nautobot.apps.tables.TableExtension.alter_queryset" class="md-nav__link">
+    <span class="md-ellipsis">
+      alter_queryset
+    </span>
+  </a>
+  
+</li>
+        
+      </ul>
+    </nav>
+  
 </li>
       
         <li class="md-nav__item">
@@ -9514,6 +9583,72 @@ set <code>sort_items=False</code>.</p>
 
 
 
+  </div>
+
+    </div>
+
+</div>
+
+<div class="doc doc-object doc-class">
+
+
+
+<h2 id="nautobot.apps.tables.TableExtension" class="doc doc-heading">
+            <code>nautobot.apps.tables.TableExtension</code>
+
+
+<a href="#nautobot.apps.tables.TableExtension" class="headerlink" title="Permanent link">&para;</a></h2>
+
+
+    <div class="doc doc-contents ">
+
+
+      <p>Template class for extending Tables.</p>
+<p>An app can override the default columns for a table by either:
+- Extending the original default columns to include custom columns.
+    - add_to_default_columns = ("my_app_name_new_column",)
+- Removing native columns from the default columns.
+    - remove_from_default_columns = ("tenant",)</p>
+
+
+
+
+  <div class="doc doc-children">
+
+
+
+
+
+
+
+
+
+<div class="doc doc-object doc-function">
+
+
+<h3 id="nautobot.apps.tables.TableExtension.alter_queryset" class="doc doc-heading">
+            <code class="highlight language-python"><span class="n">alter_queryset</span><span class="p">(</span><span class="n">queryset</span><span class="p">)</span></code>
+
+  <span class="doc doc-labels">
+      <small class="doc doc-label doc-label-classmethod"><code>classmethod</code></small>
+  </span>
+
+<a href="#nautobot.apps.tables.TableExtension.alter_queryset" class="headerlink" title="Permanent link">&para;</a></h3>
+
+
+    <div class="doc doc-contents ">
+
+      <p>Alter the View class QuerySet.</p>
+<p>This is a good place to add <code>prefetch_related</code> to the view queryset.
+example:
+    return queryset.prefetch_related("my_model_set")</p>
+
+    </div>
+
+</div>
+
+
+
   </div>
 
     </div>
@@ -9752,7 +9887,7 @@ set <code>sort_items=False</code>.</p>
     <script id="__config" type="application/json">{"base": "../../..", "features": ["content.code.copy", "content.tabs.link", "navigation.footer", "navigation.tabs", "navigation.tabs.sticky", "navigation.tracking", "search.highlight", "search.share", "search.suggest"], "search": "../../../assets/javascripts/workers/search.6ce7567c.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
     
     
-      <script src="../../../assets/javascripts/bundle.525ec568.min.js"></script>
+      <script src="../../../assets/javascripts/bundle.83f73b43.min.js"></script>
       
         <script src="https://code.jquery.com/jquery-3.7.1.min.js"></script>
       

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

@@ -18,7 +18,7 @@
       
       
       <link rel="icon" href="../../../assets/favicon.ico">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.39">
+      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.42">
     
     
       
@@ -26,7 +26,7 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/stylesheets/main.8c3ca2c6.min.css">
+      <link rel="stylesheet" href="../../../assets/stylesheets/main.0253249f.min.css">
       
         
         <link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
@@ -6393,6 +6393,27 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../../development/apps/api/platform-features/table-extensions.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    Table Extensions
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
     <li class="md-nav__item">
       <a href="../../../development/apps/api/platform-features/uniquely-identify-objects.html" class="md-nav__link">
         
@@ -15679,7 +15700,7 @@ document$.subscribe(() => { lightbox.reload() });
     <script id="__config" type="application/json">{"base": "../../..", "features": ["content.code.copy", "content.tabs.link", "navigation.footer", "navigation.tabs", "navigation.tabs.sticky", "navigation.tracking", "search.highlight", "search.share", "search.suggest"], "search": "../../../assets/javascripts/workers/search.6ce7567c.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
     
     
-      <script src="../../../assets/javascripts/bundle.525ec568.min.js"></script>
+      <script src="../../../assets/javascripts/bundle.83f73b43.min.js"></script>
       
         <script src="https://code.jquery.com/jquery-3.7.1.min.js"></script>
       

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

@@ -18,7 +18,7 @@
       
       
       <link rel="icon" href="../../../assets/favicon.ico">
-      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.39">
+      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.42">
     
     
       
@@ -26,7 +26,7 @@
       
     
     
-      <link rel="stylesheet" href="../../../assets/stylesheets/main.8c3ca2c6.min.css">
+      <link rel="stylesheet" href="../../../assets/stylesheets/main.0253249f.min.css">
       
         
         <link rel="stylesheet" href="../../../assets/stylesheets/palette.06af60db.min.css">
@@ -6393,6 +6393,27 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../../development/apps/api/platform-features/table-extensions.html" class="md-nav__link">
+        
+  
+  <span class="md-ellipsis">
+    Table Extensions
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
+              
+                
+  
+  
+  
+  
     <li class="md-nav__item">
       <a href="../../../development/apps/api/platform-features/uniquely-identify-objects.html" class="md-nav__link">
         
@@ -11912,7 +11933,7 @@ HTML string. Note that content does not need to be marked as safe because this i
     <script id="__config" type="application/json">{"base": "../../..", "features": ["content.code.copy", "content.tabs.link", "navigation.footer", "navigation.tabs", "navigation.tabs.sticky", "navigation.tracking", "search.highlight", "search.share", "search.suggest"], "search": "../../../assets/javascripts/workers/search.6ce7567c.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
     
     
-      <script src="../../../assets/javascripts/bundle.525ec568.min.js"></script>
+      <script src="../../../assets/javascripts/bundle.83f73b43.min.js"></script>
       
         <script src="https://code.jquery.com/jquery-3.7.1.min.js"></script>