PyPI - nautobot - Versions diffs - 2.2.0__py3-none-any.whl → 2.2.1__py3-none-any.whl - Mend - Supply Chain Defender

nautobot 2.2.0py3-none-any.whl → 2.2.1py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.

This version of nautobot might be problematic. Click here for more details.

Files changed (345) hide show

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

@@ -18,7 +18,7 @@
       <link rel="icon" href="../../assets/favicon.ico">
-      <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.8">
+      <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.16">
@@ -26,7 +26,7 @@
-      <link rel="stylesheet" href="../../assets/stylesheets/main.f2e4d321.min.css">
+      <link rel="stylesheet" href="../../assets/stylesheets/main.bcfcd587.min.css">
         <link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
@@ -399,16 +399,14 @@
-    <li class="md-nav__item md-nav__item--section md-nav__item--nested">
+    <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" >
@@ -425,7 +423,7 @@
             </a>
-              <label class="md-nav__link " for="__nav_2" id="__nav_2_label" tabindex="">
+              <label class="md-nav__link " for="__nav_2" id="__nav_2_label" tabindex="0">
                 <span class="md-nav__icon md-icon"></span>
               </label>
@@ -447,13 +445,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1" >
@@ -484,13 +483,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_1" >
@@ -739,13 +739,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_2" >
@@ -818,13 +819,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_2_3" >
@@ -884,13 +886,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_2_3_2" >
@@ -1037,13 +1040,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_3" >
@@ -1124,13 +1128,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_4" >
@@ -1232,13 +1237,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_4_4" >
@@ -1348,13 +1354,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_5" >
@@ -1435,13 +1442,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_1_6" >
@@ -1656,13 +1664,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_2" >
@@ -1693,13 +1702,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_2_1" >
@@ -2069,13 +2079,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_3" >
@@ -2106,13 +2117,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_3_1" >
@@ -2172,13 +2184,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_3_2" >
@@ -2322,13 +2335,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_3_3" >
@@ -2506,13 +2520,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_3_3_8" >
@@ -2727,13 +2742,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_3_3_9" >
@@ -3208,13 +3224,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_3_4" >
@@ -3337,13 +3354,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_3_5" >
@@ -3571,13 +3589,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_3_6" >
@@ -3658,13 +3677,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_3_7" >
@@ -3816,13 +3836,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4" >
@@ -4021,13 +4042,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_9" >
@@ -4116,13 +4138,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_11" >
@@ -4316,13 +4339,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_15" >
@@ -4537,13 +4561,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_4_21" >
@@ -4662,16 +4687,17 @@
     <li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" checked>
@@ -4710,13 +4736,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_1" >
@@ -4784,13 +4811,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_2" >
@@ -4871,13 +4899,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_2_3" >
@@ -4987,13 +5016,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_2_4" >
@@ -5179,13 +5209,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_2_4_8" >
@@ -5295,13 +5326,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_2_5" >
@@ -5558,13 +5590,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_2_6" >
@@ -5737,13 +5770,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_2_8" >
@@ -6265,13 +6299,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_2_9" >
@@ -6365,13 +6400,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_2_9_4" >
@@ -6502,13 +6538,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_2_10" >
@@ -6578,13 +6615,14 @@
     <li class="md-nav__item md-nav__item--active md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3_3" checked>
@@ -7054,11 +7092,11 @@
     <li class="md-nav__item">
-      <a href="extending-models.html" class="md-nav__link">
+      <a href="generic-views.html" class="md-nav__link">
   <span class="md-ellipsis">
-    Extending Models
+    Generic Views
   </span>
@@ -7075,11 +7113,11 @@
     <li class="md-nav__item">
-      <a href="generic-views.html" class="md-nav__link">
+      <a href="homepage.html" class="md-nav__link">
   <span class="md-ellipsis">
-    Generic Views
+    Home Page Panels
   </span>
@@ -7096,11 +7134,11 @@
     <li class="md-nav__item">
-      <a href="homepage.html" class="md-nav__link">
+      <a href="model-checklist.html" class="md-nav__link">
   <span class="md-ellipsis">
-    Home Page Panels
+    Model Development Checklist
   </span>
@@ -7323,16 +7361,14 @@
-    <li class="md-nav__item md-nav__item--section md-nav__item--nested">
+    <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
@@ -7349,7 +7385,7 @@
             </a>
-              <label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="">
+              <label class="md-nav__link " for="__nav_4" id="__nav_4_label" tabindex="0">
                 <span class="md-nav__icon md-icon"></span>
               </label>
@@ -7588,16 +7624,14 @@
-    <li class="md-nav__item md-nav__item--section md-nav__item--nested">
+    <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
@@ -7614,7 +7648,7 @@
             </a>
-              <label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="">
+              <label class="md-nav__link " for="__nav_5" id="__nav_5_label" tabindex="0">
                 <span class="md-nav__icon md-icon"></span>
               </label>
@@ -7636,13 +7670,14 @@
     <li class="md-nav__item md-nav__item--nested">
         <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5_1" >
@@ -8193,6 +8228,11 @@
 </thead>
 <tbody>
 <tr>
+<td>Data models</td>
+<td><code>PrimaryModel</code></td>
+<td><code>BaseModel</code></td>
+</tr>
+<tr>
 <td>FilterSets</td>
 <td><code>NautobotFilterSet</code></td>
 <td><code>BaseFilterSet</code></td>
@@ -8218,20 +8258,25 @@
 <td><code>BaseModelSerializer</code></td>
 </tr>
 <tr>
-<td>Nested serializers</td>
-<td><code>WritableNestedSerializer</code></td>
-<td><code>WritableNestedSerializer</code></td>
-</tr>
-<tr>
 <td>All other serializers</td>
 <td><code>NautobotModelSerializer</code></td>
 <td><code>ValidatedModelSerializer</code></td>
 </tr>
 <tr>
-<td>API View Sets</td>
+<td>List view tables</td>
+<td><code>BaseTable</code></td>
+<td><code>BaseTable</code></td>
+</tr>
+<tr>
+<td>API ViewSets</td>
 <td><code>NautobotModelViewSet</code></td>
 <td><code>ModelViewSet</code></td>
 </tr>
+<tr>
+<td>UI ViewSets</td>
+<td><code>NautobotUIViewSet</code></td>
+<td>individual mixins as needed</td>
+</tr>
 </tbody>
 </table>
 <h2 id="data-model-best-practices">Data Model Best Practices<a class="headerlink" href="#data-model-best-practices" title="Permanent link">&para;</a></h2>
@@ -8312,7 +8357,7 @@ For most purposes, this is not the case you are intending to check!</p>
 <a id="__codelineno-4-8" name="__codelineno-4-8" href="#__codelineno-4-8"></a>    <span class="n">slug</span> <span class="o">=</span> <span class="n">AutoSlugField</span><span class="p">(</span><span class="n">populate_from</span><span class="o">=</span><span class="s1">&#39;name&#39;</span><span class="p">)</span>
 </code></pre></div>
 <h3 id="charfield-and-slugfield-max-length">CharField and SlugField Max Length<a class="headerlink" href="#charfield-and-slugfield-max-length" title="Permanent link">&para;</a></h3>
-<p>When constructing a CharField or SlugField, always utilize the 'CHARFIELD_MAX_LENGTH' constant unless your field requires a value greater than 'CHARFIELD_MAX_LENGTH', which is '255'.</p>
+<p>When constructing a CharField or SlugField, always utilize the <code>CHARFIELD_MAX_LENGTH</code> constant unless your field requires a value greater than <code>CHARFIELD_MAX_LENGTH</code>, which is <code>255</code>.</p>
 <h2 id="getting-url-routes">Getting URL Routes<a class="headerlink" href="#getting-url-routes" title="Permanent link">&para;</a></h2>
 <p>When developing new models a need often arises to retrieve a reversible route for a model to access it in either the web UI or the REST API. When this time comes, you <strong>must</strong> use <code>nautobot.core.utils.lookup.get_route_for_model</code>. You <strong>must not</strong> write your own logic to construct route names.</p>
 <div class="admonition version-changed">
@@ -8386,7 +8431,7 @@ For most purposes, this is not the case you are intending to check!</p>
 <h3 id="mapping-model-fields-to-filters">Mapping Model Fields to Filters<a class="headerlink" href="#mapping-model-fields-to-filters" title="Permanent link">&para;</a></h3>
 <ul>
 <li>
-<p>FilterSets <strong>must</strong> inherit from <code>nautobot.extras.filters.NautobotFilterSet</code> (which inherits from <code>nautobot.core.filters.BaseFilterSet</code>)</p>
+<p>FilterSets <strong>must</strong> inherit from <code>nautobot.core.filters.BaseFilterSet</code> or <code>nautobot.extras.filters.NautobotFilterSet</code> (which inherits from <code>nautobot.core.filters.BaseFilterSet</code>)</p>
 <ul>
 <li>This affords that automatically generated lookup expressions (<code>ic</code>, <code>nic</code>, <code>iew</code>, <code>niew</code>, etc.) are always included</li>
 <li>This also asserts that the correct underlying <code>Form</code> class that maps the generated form field types and widgets will be included</li>
@@ -8763,9 +8808,9 @@ For most purposes, this is not the case you are intending to check!</p>
     <script id="__config" type="application/json">{"base": "../..", "features": ["content.code.copy", "navigation.footer", "navigation.tabs", "navigation.tabs.sticky", "navigation.tracking", "search.highlight", "search.share", "search.suggest"], "search": "../../assets/javascripts/workers/search.b8dbb3d2.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.8fd75fb4.min.js"></script>
+      <script src="../../assets/javascripts/bundle.bd41221c.min.js"></script>
-        <script src="https://code.jquery.com/jquery-3.6.0.min.js"></script>
+        <script src="https://code.jquery.com/jquery-3.7.1.min.js"></script>
   </body>