nautobot 2.4.14__py3-none-any.whl → 2.4.15__py3-none-any.whl

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

@@ -8161,21 +8161,6 @@
     </span>
   </a>
   
-    <nav class="md-nav" aria-label="ContentTypeMultipleChoiceFilter">
-      <ul class="md-nav__list">
-        
-          <li class="md-nav__item">
-  <a href="#nautobot.apps.filters.ContentTypeMultipleChoiceFilter.filter" class="md-nav__link">
-    <span class="md-ellipsis">
-      filter
-    </span>
-  </a>
-  
-</li>
-        
-      </ul>
-    </nav>
-  
 </li>
       
         <li class="md-nav__item">
@@ -9082,6 +9067,29 @@
 
               
             
+              
+                
+  
+  
+  
+  
+    <li class="md-nav__item">
+      <a href="../../../development/apps/migration/ui-component-framework/breadcrumbs-titles.html" class="md-nav__link">
+        
+  
+  
+  <span class="md-ellipsis">
+    Breadcrumbs and titles
+    
+  </span>
+  
+
+      </a>
+    </li>
+  
+
+              
+            
           </ul>
         </nav>
       
@@ -10563,21 +10571,6 @@
     </span>
   </a>
   
-    <nav class="md-nav" aria-label="ContentTypeMultipleChoiceFilter">
-      <ul class="md-nav__list">
-        
-          <li class="md-nav__item">
-  <a href="#nautobot.apps.filters.ContentTypeMultipleChoiceFilter.filter" class="md-nav__link">
-    <span class="md-ellipsis">
-      filter
-    </span>
-  </a>
-  
-</li>
-        
-      </ul>
-    </nav>
-  
 </li>
       
         <li class="md-nav__item">
@@ -10863,6 +10856,7 @@
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -10898,6 +10892,7 @@
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -10923,6 +10918,7 @@
     <div class="doc doc-contents ">
 
         <p>Extend FilterSet.errors to potentially include additional errors from settings.STRICT_FILTERING.</p>
+
     </div>
 
 </div>
@@ -10947,6 +10943,7 @@
         <p>Allow filters to be added post-generation on import.</p>
 <p>Will provide <code>&lt;field_name&gt;__&lt;lookup_expr&gt;</code> generation automagically.</p>
 
+
     </div>
 
 </div>
@@ -10969,6 +10966,7 @@
         <p>Override filter_for_lookup method to set ChoiceField Filter to MultipleChoiceFilter.</p>
 <p>Note: Any CharField or IntegerField with choices set is a ChoiceField.</p>
 
+
     </div>
 
 </div>
@@ -10990,6 +10988,7 @@
 
         <p>Override filter generation to support dynamic lookup expressions for certain filter types.</p>
 
+
     </div>
 
 </div>
@@ -11007,6 +11006,7 @@
 
         <p>Extend FilterSet.is_valid() to potentially enforce settings.STRICT_FILTERING.</p>
 
+
     </div>
 
 </div>
@@ -11032,7 +11032,7 @@
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.filters.NaturalKeyOrPKMultipleChoiceFilter" href="#nautobot.apps.filters.NaturalKeyOrPKMultipleChoiceFilter">NaturalKeyOrPKMultipleChoiceFilter</a></code></p>
+              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.apps.filters.NaturalKeyOrPKMultipleChoiceFilter (nautobot.core.filters.NaturalKeyOrPKMultipleChoiceFilter)" href="#nautobot.apps.filters.NaturalKeyOrPKMultipleChoiceFilter">NaturalKeyOrPKMultipleChoiceFilter</a></code></p>
 
 
         <p>Limit role choices to the available role choices for Device and VM</p>
@@ -11045,6 +11045,7 @@
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -11076,7 +11077,7 @@
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.filters.ContentTypeFilterMixin" href="#nautobot.apps.filters.ContentTypeFilterMixin">ContentTypeFilterMixin</a></code>, <code><span title="django_filters.ChoiceFilter">ChoiceFilter</span></code></p>
+              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.apps.filters.ContentTypeFilterMixin (nautobot.core.filters.ContentTypeFilterMixin)" href="#nautobot.apps.filters.ContentTypeFilterMixin">ContentTypeFilterMixin</a></code>, <code><span title="django_filters.ChoiceFilter">ChoiceFilter</span></code></p>
 
 
         <p>Allows character-based ContentType filtering by <app_label>.<model> (e.g.
@@ -11086,6 +11087,8 @@
     choices=FeatureQuery(&quot;dynamic_groups&quot;).get_choices,
 )
 </code></pre></div>
+<p>In most cases you should use <code>ContentTypeMultipleChoiceFilter</code> instead.</p>
+
 
 
 
@@ -11126,7 +11129,7 @@
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.filters.ContentTypeFilterMixin" href="#nautobot.apps.filters.ContentTypeFilterMixin">ContentTypeFilterMixin</a></code>, <code><span title="django_filters.CharFilter">CharFilter</span></code></p>
+              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.apps.filters.ContentTypeFilterMixin (nautobot.core.filters.ContentTypeFilterMixin)" href="#nautobot.apps.filters.ContentTypeFilterMixin">ContentTypeFilterMixin</a></code>, <code><span title="django_filters.CharFilter">CharFilter</span></code></p>
 
 
         <p>Allows character-based ContentType filtering by <app_label>.<model> (e.g. "dcim.location").</p>
@@ -11142,6 +11145,7 @@
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -11184,6 +11188,7 @@
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -11219,6 +11224,8 @@
 
 
         <p>Allows multiple-choice ContentType filtering by <app_label>.<model> (e.g. "dcim.location").</p>
+<p>Does NOT allow filtering by PK at this time; it would need to be reimplemented similar to
+NaturalKeyOrPKMultipleChoiceFilter as a breaking change.</p>
 <p>Defaults to joining multiple options with "AND". Pass <code>conjoined=False</code> to
 override this behavior to join with "OR" instead.</p>
 <p>Example use on a <code>FilterSet</code>:</p>
@@ -11235,33 +11242,16 @@ override this behavior to join with "OR" instead.</p>
 
 
 
-  <div class="doc doc-children">
-
-
-
-
-
-
 
+  <div class="doc doc-children">
 
 
-<div class="doc doc-object doc-function">
-
-
-<h3 id="nautobot.apps.filters.ContentTypeMultipleChoiceFilter.filter" class="doc doc-heading">
-            <code class="highlight language-python"><span class="nb">filter</span><span class="p">(</span><span class="n">qs</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span></code>
 
-<a href="#nautobot.apps.filters.ContentTypeMultipleChoiceFilter.filter" class="headerlink" title="Permanent link">&para;</a></h3>
 
 
-    <div class="doc doc-contents ">
 
-        <p>Filter on value, which should be list of content-type names.</p>
-<p>e.g. <code>['dcim.device', 'dcim.rack']</code></p>
 
-    </div>
 
-</div>
 
 
 
@@ -11298,6 +11288,7 @@ extra lookup expressions on supported CustomField types.</p>
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -11340,6 +11331,7 @@ extra lookup expressions on supported CustomField types.</p>
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -11408,6 +11400,7 @@ skipped.</p>
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -11432,6 +11425,7 @@ skipped.</p>
         <p>Given a <code>value</code>, return a <code>Q</code> object for 2-tuple of <code>predicate=value</code>. Filter predicates are
 read from the instance filter. Any <code>kwargs</code> are ignored.</p>
 
+
     </div>
 
 </div>
@@ -11470,6 +11464,7 @@ read from the instance filter. Any <code>kwargs</code> are ignored.</p>
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -11514,6 +11509,7 @@ read from the instance filter. Any <code>kwargs</code> are ignored.</p>
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -11562,6 +11558,7 @@ was just the best name we could come up with for this filter</p>
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -11602,7 +11599,7 @@ was just the best name we could come up with for this filter</p>
                 <code>prefers_id</code>
             </td>
             <td>
-                  <code>bool</code>
+                  <code><span title="bool">bool</span></code>
             </td>
             <td>
               <div class="doc-md-description">
@@ -11616,6 +11613,7 @@ was just the best name we could come up with for this filter</p>
       </tbody>
     </table>
 
+
     </div>
 
 </div>
@@ -11634,6 +11632,7 @@ was just the best name we could come up with for this filter</p>
         <p>Override base filter behavior to force the filter to use the <code>pk</code> field instead of
 the natural key in the generated filter.</p>
 
+
     </div>
 
 </div>
@@ -11659,7 +11658,7 @@ the natural key in the generated filter.</p>
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.filters.BaseFilterSet" href="#nautobot.apps.filters.BaseFilterSet">BaseFilterSet</a></code>, <code><span title="nautobot.extras.filters.mixins.CreatedUpdatedModelFilterSetMixin">CreatedUpdatedModelFilterSetMixin</span></code>, <code><a class="autorefs autorefs-internal" title="nautobot.extras.filters.mixins.RelationshipModelFilterSetMixin" href="#nautobot.apps.filters.RelationshipModelFilterSetMixin">RelationshipModelFilterSetMixin</a></code>, <code><a class="autorefs autorefs-internal" title="nautobot.extras.filters.mixins.CustomFieldModelFilterSetMixin" href="#nautobot.apps.filters.CustomFieldModelFilterSetMixin">CustomFieldModelFilterSetMixin</a></code></p>
+              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.apps.filters.BaseFilterSet (nautobot.core.filters.BaseFilterSet)" href="#nautobot.apps.filters.BaseFilterSet">BaseFilterSet</a></code>, <code><span title="nautobot.extras.filters.mixins.CreatedUpdatedModelFilterSetMixin">CreatedUpdatedModelFilterSetMixin</span></code>, <code><a class="autorefs autorefs-internal" title="nautobot.apps.filters.RelationshipModelFilterSetMixin (nautobot.extras.filters.mixins.RelationshipModelFilterSetMixin)" href="#nautobot.apps.filters.RelationshipModelFilterSetMixin">RelationshipModelFilterSetMixin</a></code>, <code><a class="autorefs autorefs-internal" title="nautobot.apps.filters.CustomFieldModelFilterSetMixin (nautobot.extras.filters.mixins.CustomFieldModelFilterSetMixin)" href="#nautobot.apps.filters.CustomFieldModelFilterSetMixin">CustomFieldModelFilterSetMixin</a></code></p>
 
 
         <p>This class exists to combine common functionality and is used as a base class throughout the codebase where all of
@@ -11674,6 +11673,7 @@ are needed.</p>
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -11718,6 +11718,7 @@ are needed.</p>
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -11749,7 +11750,7 @@ are needed.</p>
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.filters.NaturalKeyOrPKMultipleChoiceFilter" href="#nautobot.apps.filters.NaturalKeyOrPKMultipleChoiceFilter">NaturalKeyOrPKMultipleChoiceFilter</a></code></p>
+              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.apps.filters.NaturalKeyOrPKMultipleChoiceFilter (nautobot.core.filters.NaturalKeyOrPKMultipleChoiceFilter)" href="#nautobot.apps.filters.NaturalKeyOrPKMultipleChoiceFilter">NaturalKeyOrPKMultipleChoiceFilter</a></code></p>
 
 
         <p>Filter that supports filtering a foreign key to Prefix by either its PK or by a literal <code>prefix</code> string.</p>
@@ -11762,6 +11763,7 @@ are needed.</p>
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -11835,6 +11837,7 @@ See the below table for more information:
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -11879,6 +11882,7 @@ See the below table for more information:
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -11923,6 +11927,7 @@ See the below table for more information:
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -11954,7 +11959,7 @@ See the below table for more information:
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.filters.NaturalKeyOrPKMultipleChoiceFilter" href="#nautobot.apps.filters.NaturalKeyOrPKMultipleChoiceFilter">NaturalKeyOrPKMultipleChoiceFilter</a></code></p>
+              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.apps.filters.NaturalKeyOrPKMultipleChoiceFilter (nautobot.core.filters.NaturalKeyOrPKMultipleChoiceFilter)" href="#nautobot.apps.filters.NaturalKeyOrPKMultipleChoiceFilter">NaturalKeyOrPKMultipleChoiceFilter</a></code></p>
 
 
         <p>Filter field used for filtering Role fields.</p>
@@ -11967,6 +11972,7 @@ See the below table for more information:
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -12011,6 +12017,7 @@ See the below table for more information:
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -12042,7 +12049,7 @@ See the below table for more information:
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.filters.MappedPredicatesFilterMixin" href="#nautobot.apps.filters.MappedPredicatesFilterMixin">MappedPredicatesFilterMixin</a></code>, <code><span title="django_filters.CharFilter">CharFilter</span></code></p>
+              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.apps.filters.MappedPredicatesFilterMixin (nautobot.core.filters.MappedPredicatesFilterMixin)" href="#nautobot.apps.filters.MappedPredicatesFilterMixin">MappedPredicatesFilterMixin</a></code>, <code><span title="django_filters.CharFilter">CharFilter</span></code></p>
 
 
         <p>Provide a search filter for use on filtersets as the <code>q=</code> parameter.</p>
@@ -12056,6 +12063,7 @@ See the below table for more information:
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -12087,7 +12095,7 @@ See the below table for more information:
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.filters.NaturalKeyOrPKMultipleChoiceFilter" href="#nautobot.apps.filters.NaturalKeyOrPKMultipleChoiceFilter">NaturalKeyOrPKMultipleChoiceFilter</a></code></p>
+              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.apps.filters.NaturalKeyOrPKMultipleChoiceFilter (nautobot.core.filters.NaturalKeyOrPKMultipleChoiceFilter)" href="#nautobot.apps.filters.NaturalKeyOrPKMultipleChoiceFilter">NaturalKeyOrPKMultipleChoiceFilter</a></code></p>
 
 
         <p>Filter field used for filtering Status fields.</p>
@@ -12100,6 +12108,7 @@ See the below table for more information:
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -12144,6 +12153,7 @@ See the below table for more information:
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -12175,7 +12185,7 @@ See the below table for more information:
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.filters.NaturalKeyOrPKMultipleChoiceFilter" href="#nautobot.apps.filters.NaturalKeyOrPKMultipleChoiceFilter">NaturalKeyOrPKMultipleChoiceFilter</a></code></p>
+              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.apps.filters.NaturalKeyOrPKMultipleChoiceFilter (nautobot.core.filters.NaturalKeyOrPKMultipleChoiceFilter)" href="#nautobot.apps.filters.NaturalKeyOrPKMultipleChoiceFilter">NaturalKeyOrPKMultipleChoiceFilter</a></code></p>
 
 
         <p>Match on one or more assigned tags. If multiple tags are specified (e.g. ?tag=foo&amp;tag=bar), the queryset is filtered
@@ -12189,6 +12199,7 @@ to objects matching all tags.</p>
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -12233,6 +12244,7 @@ to objects matching all tags.</p>
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -12264,7 +12276,7 @@ to objects matching all tags.</p>
 
     <div class="doc doc-contents ">
             <p class="doc doc-class-bases">
-              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.core.filters.NaturalKeyOrPKMultipleChoiceFilter" href="#nautobot.apps.filters.NaturalKeyOrPKMultipleChoiceFilter">NaturalKeyOrPKMultipleChoiceFilter</a></code></p>
+              Bases: <code><a class="autorefs autorefs-internal" title="nautobot.apps.filters.NaturalKeyOrPKMultipleChoiceFilter (nautobot.core.filters.NaturalKeyOrPKMultipleChoiceFilter)" href="#nautobot.apps.filters.NaturalKeyOrPKMultipleChoiceFilter">NaturalKeyOrPKMultipleChoiceFilter</a></code></p>
 
 
         <p>Filter that matches on the given model(s) (identified by name and/or pk) <em>as well as their tree descendants.</em></p>
@@ -12287,6 +12299,7 @@ would match both "Athens" and "Durham" in addition to "GA" and "NC".</p>
 
 
 
+
   <div class="doc doc-children">
 
 
@@ -12310,6 +12323,7 @@ would match both "Athens" and "Durham" in addition to "GA" and "NC".</p>
 
         <p>Given a filter value, return a <code>Q</code> object that accounts for nested tree node descendants.</p>
 
+
     </div>
 
 </div>
@@ -12337,6 +12351,7 @@ would match both "Athens" and "Durham" in addition to "GA" and "NC".</p>
         <p>Given a form field class, return a subclass capable of accepting multiple values. This allows us to OR on multiple
 filter values while maintaining the field's built-in validation. Example: GET /api/dcim/devices/?name=foo&amp;name=bar</p>
 
+
     </div>
 
 </div>