nautobot 2.4.4__py3-none-any.whl → 2.4.6__py3-none-any.whl

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

@@ -7904,6 +7904,21 @@
     </span>
   </a>
   
+    <nav class="md-nav" aria-label="EnhancedURLValidator">
+      <ul class="md-nav__list">
+        
+          <li class="md-nav__item">
+  <a href="#nautobot.apps.models.EnhancedURLValidator.__getattribute__" class="md-nav__link">
+    <span class="md-ellipsis">
+      __getattribute__
+    </span>
+  </a>
+  
+</li>
+        
+      </ul>
+    </nav>
+  
 </li>
       
         <li class="md-nav__item">
@@ -10981,6 +10996,21 @@
     </span>
   </a>
   
+    <nav class="md-nav" aria-label="EnhancedURLValidator">
+      <ul class="md-nav__list">
+        
+          <li class="md-nav__item">
+  <a href="#nautobot.apps.models.EnhancedURLValidator.__getattribute__" class="md-nav__link">
+    <span class="md-ellipsis">
+      __getattribute__
+    </span>
+  </a>
+  
+</li>
+        
+      </ul>
+    </nav>
+  
 </li>
       
         <li class="md-nav__item">
@@ -13342,6 +13372,23 @@ schemes specified in the configuration.</p>
 
 
 
+<div class="doc doc-object doc-function">
+
+
+<h3 id="nautobot.apps.models.EnhancedURLValidator.__getattribute__" class="doc doc-heading">
+            <code class="highlight language-python"><span class="fm">__getattribute__</span><span class="p">(</span><span class="n">name</span><span class="p">)</span></code>
+
+<a href="#nautobot.apps.models.EnhancedURLValidator.__getattribute__" class="headerlink" title="Permanent link">&para;</a></h3>
+
+
+    <div class="doc doc-contents ">
+
+        <p>Dynamically fetch schemes each time it's accessed.</p>
+
+    </div>
+
+</div>
+
 
 
   </div>

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

@@ -10323,6 +10323,24 @@ If not specified, the first key in <code>url_params</code> will be implicitly us
                   <code>False</code>
             </td>
           </tr>
+          <tr class="doc-section-item">
+            <td>
+                <code>display_field</code>
+            </td>
+            <td>
+                  <code>str</code>
+            </td>
+            <td>
+              <div class="doc-md-description">
+                <p>Name of the field to use when displaying an object rather than just a count.
+This will be passed to hyperlinked_object() as the <code>field</code> parameter
+If not specified, it will use the "display" field.</p>
+              </div>
+            </td>
+            <td>
+                  <code>&#39;display&#39;</code>
+            </td>
+          </tr>
           <tr class="doc-section-item">
             <td>
                 <code>**kwargs</code>

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

@@ -8238,6 +8238,15 @@
     </span>
   </a>
   
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#nautobot.apps.testing.NautobotTestCaseMixin.assertJobResultStatus" class="md-nav__link">
+    <span class="md-ellipsis">
+      assertJobResultStatus
+    </span>
+  </a>
+  
 </li>
         
           <li class="md-nav__item">
@@ -11423,6 +11432,15 @@
     </span>
   </a>
   
+</li>
+        
+          <li class="md-nav__item">
+  <a href="#nautobot.apps.testing.NautobotTestCaseMixin.assertJobResultStatus" class="md-nav__link">
+    <span class="md-ellipsis">
+      assertJobResultStatus
+    </span>
+  </a>
+  
 </li>
         
           <li class="md-nav__item">
@@ -14322,6 +14340,23 @@ in the dictionary.</p>
 <div class="doc doc-object doc-function">
 
 
+<h3 id="nautobot.apps.testing.NautobotTestCaseMixin.assertJobResultStatus" class="doc doc-heading">
+            <code class="highlight language-python"><span class="n">assertJobResultStatus</span><span class="p">(</span><span class="n">job_result</span><span class="p">,</span> <span class="n">expected_status</span><span class="o">=</span><span class="n">JobResultStatusChoices</span><span class="o">.</span><span class="n">STATUS_SUCCESS</span><span class="p">)</span></code>
+
+<a href="#nautobot.apps.testing.NautobotTestCaseMixin.assertJobResultStatus" class="headerlink" title="Permanent link">&para;</a></h3>
+
+
+    <div class="doc doc-contents ">
+
+        <p>Assert that the given job_result has the expected_status, or print the job logs to aid in debugging.</p>
+
+    </div>
+
+</div>
+
+<div class="doc doc-object doc-function">
+
+
 <h3 id="nautobot.apps.testing.NautobotTestCaseMixin.assertQuerysetEqualAndNotEmpty" class="doc doc-heading">
             <code class="highlight language-python"><span class="n">assertQuerysetEqualAndNotEmpty</span><span class="p">(</span><span class="n">qs</span><span class="p">,</span> <span class="n">values</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>
 

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

@@ -12583,6 +12583,69 @@ Mutually exclusive with <code>column_headers</code>.</p>
         <p>A Tab that doesn't render inline on the same page, but instead links to a distinct view of its own when clicked.</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>url_name</code>
+            </td>
+            <td>
+                  <code>str</code>
+            </td>
+            <td>
+              <div class="doc-md-description">
+                <p>The name of the URL pattern to link to, which will be reversed to generate the URL.</p>
+              </div>
+            </td>
+            <td>
+                <em>required</em>
+            </td>
+          </tr>
+          <tr class="doc-section-item">
+            <td>
+                <code>label_wrapper_template_path</code>
+            </td>
+            <td>
+                  <code>str</code>
+            </td>
+            <td>
+              <div class="doc-md-description">
+                <p>Template path to render the tab label to HTML.</p>
+              </div>
+            </td>
+            <td>
+                  <code>&#39;components/tab/label_wrapper_distinct_view.html&#39;</code>
+            </td>
+          </tr>
+          <tr class="doc-section-item">
+            <td>
+                <code>related_object_attribute</code>
+            </td>
+            <td>
+                  <code>str</code>
+            </td>
+            <td>
+              <div class="doc-md-description">
+                <p>The name of the related object attribute to count for the tab label.</p>
+              </div>
+            </td>
+            <td>
+                  <code>&#39;&#39;</code>
+            </td>
+          </tr>
+      </tbody>
+    </table>
+
+
 
 
 

nautobot/project-static/docs/development/apps/api/testing.html

@@ -6973,33 +6973,6 @@
     </span>
   </a>
   
-</li>
-      
-        <li class="md-nav__item">
-  <a href="#performance-tests" class="md-nav__link">
-    <span class="md-ellipsis">
-      Performance Tests
-    </span>
-  </a>
-  
-</li>
-      
-        <li class="md-nav__item">
-  <a href="#running-performance-tests" class="md-nav__link">
-    <span class="md-ellipsis">
-      Running Performance Tests
-    </span>
-  </a>
-  
-</li>
-      
-        <li class="md-nav__item">
-  <a href="#gathering-performance-test-baseline-data" class="md-nav__link">
-    <span class="md-ellipsis">
-      Gathering Performance Test Baseline Data
-    </span>
-  </a>
-  
 </li>
       
     </ul>
@@ -9182,33 +9155,6 @@
     </span>
   </a>
   
-</li>
-      
-        <li class="md-nav__item">
-  <a href="#performance-tests" class="md-nav__link">
-    <span class="md-ellipsis">
-      Performance Tests
-    </span>
-  </a>
-  
-</li>
-      
-        <li class="md-nav__item">
-  <a href="#running-performance-tests" class="md-nav__link">
-    <span class="md-ellipsis">
-      Running Performance Tests
-    </span>
-  </a>
-  
-</li>
-      
-        <li class="md-nav__item">
-  <a href="#gathering-performance-test-baseline-data" class="md-nav__link">
-    <span class="md-ellipsis">
-      Gathering Performance Test Baseline Data
-    </span>
-  </a>
-  
 </li>
       
     </ul>
@@ -9233,39 +9179,6 @@
 <p>In general apps can be tested like other Django apps. In most cases you'll want to run your automated tests via the <code>nautobot-server test &lt;app_module&gt;</code> command or, if using the <code>coverage</code> Python library, <code>coverage run --module nautobot.core.cli test &lt;app_module&gt;</code>.</p>
 <h2 id="factories">Factories<a class="headerlink" href="#factories" title="Permanent link">&para;</a></h2>
 <p>The <a href="../../../user-guide/administration/configuration/settings.html#test_use_factories"><code>TEST_USE_FACTORIES</code></a> setting defaults to <code>False</code> when testing apps, primarily for backwards-compatibility reasons. It can prove a useful way of populating a baseline of Nautobot database data for your tests and save you the trouble of creating a large amount of baseline data yourself. We recommend adding <a href="https://pypi.org/project/factory-boy/"><code>factory-boy</code></a> to your app's development dependencies and settings <code>TEST_USE_FACTORIES = True</code> in your app's development/test <code>nautobot_config.py</code> to take advantage of this.</p>
-<h2 id="performance-tests">Performance Tests<a class="headerlink" href="#performance-tests" title="Permanent link">&para;</a></h2>
-<h2 id="running-performance-tests">Running Performance Tests<a class="headerlink" href="#running-performance-tests" title="Permanent link">&para;</a></h2>
-<p>You need to install <code>django-slowtests</code> as a part of your app dev dependency to run performance tests. It has a very intuitive way to measure the performance of your own tests for your app  (all you have to do is tag your tests with <code>performance</code>) and do <code>invoke performance-test</code> to get the time to run your tests with <code>NautobotPerformanceTestRunner</code>.</p>
-<p><code>NautobotPerformanceTestRunner</code> is used by adding the flag <code>--testrunner nautobot.core.tests.runner.NautobotPerformanceTestRunner</code> to the <code>coverage run</code> command used for unit tests. This flag will replace the default <code>NautobotTestRunner</code> while retaining all its functionalities with the addition of performance evaluation after test
-runs.
-Checkout <a href="../../core/testing.html#performance-tests">Performance Tests</a> for more detail.</p>
-<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="nd">@tag</span><span class="p">(</span><span class="s2">&quot;performance&quot;</span><span class="p">)</span>
-<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="k">def</span> <span class="nf">test_your_app</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
-<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a>    <span class="k">pass</span>
-<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a><span class="o">...</span>
-</code></pre></div>
-<h2 id="gathering-performance-test-baseline-data">Gathering Performance Test Baseline Data<a class="headerlink" href="#gathering-performance-test-baseline-data" title="Permanent link">&para;</a></h2>
-<p>If you want to add baselines for your own test to <code>nautobot/core/tests/performance_baselines.yml</code> or have your own baseline yaml file for performance testing, specify a different file path for  <code>TEST_PERFORMANCE_BASELINE_FILE</code> in app's development/test <code>nautobot_config.py</code>, and store the output of <code>invoke performance-test --performance-snapshot</code> command in that file. <code>--performance-snapshot</code> flag will store the results of your performance test to <code>report.yml</code> and all you need to do is copy/paste the result to the file set by <code>TEST_PERFORMANCE_BASELINE_FILE</code>. Now you have baselines for your own tests!
-Example output of <code>invoke performance-test --performance-snapshot</code>:</p>
-<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="nt">tests</span><span class="p">:</span>
-<a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a><span class="w">  </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">&gt;-</span>
-<a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a><span class="w">      </span><span class="no">test_run_job_with_sensitive_variables_and_requires_approval</span>
-<a id="__codelineno-1-4" name="__codelineno-1-4" href="#__codelineno-1-4"></a><span class="w">      </span><span class="no">(nautobot.extras.tests.test_views.JobTestCase)</span>
-<a id="__codelineno-1-5" name="__codelineno-1-5" href="#__codelineno-1-5"></a><span class="w">    </span><span class="nt">execution_time</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">4.799533</span>
-<a id="__codelineno-1-6" name="__codelineno-1-6" href="#__codelineno-1-6"></a><span class="w">  </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">test_run_missing_schedule (nautobot.extras.tests.test_views.JobTestCase)</span>
-<a id="__codelineno-1-7" name="__codelineno-1-7" href="#__codelineno-1-7"></a><span class="w">    </span><span class="nt">execution_time</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">4.367563</span>
-<a id="__codelineno-1-8" name="__codelineno-1-8" href="#__codelineno-1-8"></a><span class="w">  </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">test_run_now_missing_args (nautobot.extras.tests.test_views.JobTestCase)</span>
-<a id="__codelineno-1-9" name="__codelineno-1-9" href="#__codelineno-1-9"></a><span class="w">    </span><span class="nt">execution_time</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">4.363194</span>
-<a id="__codelineno-1-10" name="__codelineno-1-10" href="#__codelineno-1-10"></a><span class="w">  </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">&gt;-</span>
-<a id="__codelineno-1-11" name="__codelineno-1-11" href="#__codelineno-1-11"></a><span class="w">      </span><span class="no">test_create_object_with_constrained_permission</span>
-<a id="__codelineno-1-12" name="__codelineno-1-12" href="#__codelineno-1-12"></a><span class="w">      </span><span class="no">(nautobot.extras.tests.test_views.GraphQLQueriesTestCase)</span>
-<a id="__codelineno-1-13" name="__codelineno-1-13" href="#__codelineno-1-13"></a><span class="w">    </span><span class="nt">execution_time</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">3.474244</span>
-<a id="__codelineno-1-14" name="__codelineno-1-14" href="#__codelineno-1-14"></a><span class="w">  </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">&gt;-</span>
-<a id="__codelineno-1-15" name="__codelineno-1-15" href="#__codelineno-1-15"></a><span class="w">      </span><span class="no">test_run_now_constrained_permissions</span>
-<a id="__codelineno-1-16" name="__codelineno-1-16" href="#__codelineno-1-16"></a><span class="w">      </span><span class="no">(nautobot.extras.tests.test_views.JobTestCase)</span>
-<a id="__codelineno-1-17" name="__codelineno-1-17" href="#__codelineno-1-17"></a><span class="w">    </span><span class="nt">execution_time</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">2.727531</span>
-</code></pre></div>
-<p>We recommend adding <a href="https://pypi.org/project/django-slowtests/"><code>django-slowtests</code></a> to your app's development dependencies to leverage this functionality to build better performing apps.</p>
 
 
 

nautobot/project-static/docs/development/apps/migration/dependency-updates.html

@@ -9217,7 +9217,7 @@
 <h2 id="nautobot-version">Nautobot Version<a class="headerlink" href="#nautobot-version" title="Permanent link">&para;</a></h2>
 <p>Change your Nautobot to the latest/v2.0 release.</p>
 <h2 id="python-version">Python Version<a class="headerlink" href="#python-version" title="Permanent link">&para;</a></h2>
-<p>Python 3.8 support is dropped for Nautobot v2.4 and Python 3.9 is the minimum version for Nautobot and its apps.</p>
+<p>Python 3.8 support is dropped for Nautobot v2.4 and Python 3.9.2 is the minimum version for Nautobot and its apps.</p>
 <h2 id="pylint-nautobot"><code>pylint-nautobot</code><a class="headerlink" href="#pylint-nautobot" title="Permanent link">&para;</a></h2>
 <p><code>pylint-nautobot</code> is now a required dev-dependency. Make sure you add <code>pylint-nautobot = "*"</code> under <code>tool.poetry.dev-dependencies</code> section in your <code>pyproject.toml</code>.</p>
 

nautobot/project-static/docs/development/core/best-practices.html

@@ -9616,17 +9616,17 @@
 <tr>
 <td>Object create/edit forms</td>
 <td><code>NautobotModelForm</code></td>
-<td><code>BootstrapMixin</code></td>
+<td><code>BootstrapMixin</code> + <code>django.forms.ModelForm</code></td>
 </tr>
 <tr>
 <td>Object bulk-edit forms</td>
 <td><code>NautobotBulkEditForm</code></td>
-<td><code>BootstrapMixin</code></td>
+<td><code>BootstrapMixin</code> + <code>BulkEditForm</code></td>
 </tr>
 <tr>
 <td>Table filter forms</td>
 <td><code>NautobotFilterForm</code></td>
-<td><code>BootstrapMixin</code></td>
+<td><code>BootstrapMixin</code> + <code>django.forms.Form</code></td>
 </tr>
 <tr>
 <td>Read-only serializers</td>