nautobot 2.1.8__py3-none-any.whl → 2.1.9__py3-none-any.whl

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

@@ -550,6 +550,20 @@
   
   
   
+    <li class="md-nav__item">
+      <a href="../../../user-guide/administration/installation/health-checks.html" class="md-nav__link">
+        Health Checks
+      </a>
+    </li>
+  
+
+            
+          
+            
+              
+  
+  
+  
     <li class="md-nav__item">
       <a href="../../../user-guide/administration/installation/selinux-troubleshooting.html" class="md-nav__link">
         SELinux Troubleshooting
@@ -4642,6 +4656,20 @@
     get_table_for_model()
   </a>
   
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#nautobot.apps.utils.get_url_for_url_pattern" class="md-nav__link">
+    get_url_for_url_pattern()
+  </a>
+  
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#nautobot.apps.utils.get_url_patterns" class="md-nav__link">
+    get_url_patterns()
+  </a>
+  
 </li>
       
         <li class="md-nav__item">
@@ -6147,6 +6175,20 @@
     get_table_for_model()
   </a>
   
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#nautobot.apps.utils.get_url_for_url_pattern" class="md-nav__link">
+    get_url_for_url_pattern()
+  </a>
+  
+</li>
+      
+        <li class="md-nav__item">
+  <a href="#nautobot.apps.utils.get_url_patterns" class="md-nav__link">
+    get_url_patterns()
+  </a>
+  
 </li>
       
         <li class="md-nav__item">
@@ -8872,9 +8914,7 @@ by the model class. If an instance is provided, the queryset will also be filter
 
           <details class="quote">
             <summary>Source code in <code>nautobot/core/utils/lookup.py</code></summary>
-            <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-13">13</a></span>
-<span class="normal"><a href="#__codelineno-0-14">14</a></span>
-<span class="normal"><a href="#__codelineno-0-15">15</a></span>
+            <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-15">15</a></span>
 <span class="normal"><a href="#__codelineno-0-16">16</a></span>
 <span class="normal"><a href="#__codelineno-0-17">17</a></span>
 <span class="normal"><a href="#__codelineno-0-18">18</a></span>
@@ -8886,21 +8926,23 @@ by the model class. If an instance is provided, the queryset will also be filter
 <span class="normal"><a href="#__codelineno-0-24">24</a></span>
 <span class="normal"><a href="#__codelineno-0-25">25</a></span>
 <span class="normal"><a href="#__codelineno-0-26">26</a></span>
-<span class="normal"><a href="#__codelineno-0-27">27</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-13" name="__codelineno-0-13"></a><span class="k">def</span> <span class="nf">get_changes_for_model</span><span class="p">(</span><span class="n">model</span><span class="p">):</span>
-<a id="__codelineno-0-14" name="__codelineno-0-14"></a><span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
-<a id="__codelineno-0-15" name="__codelineno-0-15"></a><span class="sd">    Return a queryset of ObjectChanges for a model or instance. The queryset will be filtered</span>
-<a id="__codelineno-0-16" name="__codelineno-0-16"></a><span class="sd">    by the model class. If an instance is provided, the queryset will also be filtered by the instance id.</span>
-<a id="__codelineno-0-17" name="__codelineno-0-17"></a><span class="sd">    &quot;&quot;&quot;</span>
-<a id="__codelineno-0-18" name="__codelineno-0-18"></a>    <span class="kn">from</span> <span class="nn">nautobot.extras.models</span> <span class="kn">import</span> <span class="n">ObjectChange</span>  <span class="c1"># prevent circular import</span>
-<a id="__codelineno-0-19" name="__codelineno-0-19"></a>
-<a id="__codelineno-0-20" name="__codelineno-0-20"></a>    <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">Model</span><span class="p">):</span>
-<a id="__codelineno-0-21" name="__codelineno-0-21"></a>        <span class="k">return</span> <span class="n">ObjectChange</span><span class="o">.</span><span class="n">objects</span><span class="o">.</span><span class="n">filter</span><span class="p">(</span>
-<a id="__codelineno-0-22" name="__codelineno-0-22"></a>            <span class="n">changed_object_type</span><span class="o">=</span><span class="n">ContentType</span><span class="o">.</span><span class="n">objects</span><span class="o">.</span><span class="n">get_for_model</span><span class="p">(</span><span class="n">model</span><span class="o">.</span><span class="n">_meta</span><span class="o">.</span><span class="n">model</span><span class="p">),</span>
-<a id="__codelineno-0-23" name="__codelineno-0-23"></a>            <span class="n">changed_object_id</span><span class="o">=</span><span class="n">model</span><span class="o">.</span><span class="n">pk</span><span class="p">,</span>
-<a id="__codelineno-0-24" name="__codelineno-0-24"></a>        <span class="p">)</span>
-<a id="__codelineno-0-25" name="__codelineno-0-25"></a>    <span class="k">if</span> <span class="nb">issubclass</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">Model</span><span class="p">):</span>
-<a id="__codelineno-0-26" name="__codelineno-0-26"></a>        <span class="k">return</span> <span class="n">ObjectChange</span><span class="o">.</span><span class="n">objects</span><span class="o">.</span><span class="n">filter</span><span class="p">(</span><span class="n">changed_object_type</span><span class="o">=</span><span class="n">ContentType</span><span class="o">.</span><span class="n">objects</span><span class="o">.</span><span class="n">get_for_model</span><span class="p">(</span><span class="n">model</span><span class="o">.</span><span class="n">_meta</span><span class="o">.</span><span class="n">model</span><span class="p">))</span>
-<a id="__codelineno-0-27" name="__codelineno-0-27"></a>    <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">model</span><span class="si">!r}</span><span class="s2"> is not a Django Model class or instance&quot;</span><span class="p">)</span>
+<span class="normal"><a href="#__codelineno-0-27">27</a></span>
+<span class="normal"><a href="#__codelineno-0-28">28</a></span>
+<span class="normal"><a href="#__codelineno-0-29">29</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-15" name="__codelineno-0-15"></a><span class="k">def</span> <span class="nf">get_changes_for_model</span><span class="p">(</span><span class="n">model</span><span class="p">):</span>
+<a id="__codelineno-0-16" name="__codelineno-0-16"></a><span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
+<a id="__codelineno-0-17" name="__codelineno-0-17"></a><span class="sd">    Return a queryset of ObjectChanges for a model or instance. The queryset will be filtered</span>
+<a id="__codelineno-0-18" name="__codelineno-0-18"></a><span class="sd">    by the model class. If an instance is provided, the queryset will also be filtered by the instance id.</span>
+<a id="__codelineno-0-19" name="__codelineno-0-19"></a><span class="sd">    &quot;&quot;&quot;</span>
+<a id="__codelineno-0-20" name="__codelineno-0-20"></a>    <span class="kn">from</span> <span class="nn">nautobot.extras.models</span> <span class="kn">import</span> <span class="n">ObjectChange</span>  <span class="c1"># prevent circular import</span>
+<a id="__codelineno-0-21" name="__codelineno-0-21"></a>
+<a id="__codelineno-0-22" name="__codelineno-0-22"></a>    <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">Model</span><span class="p">):</span>
+<a id="__codelineno-0-23" name="__codelineno-0-23"></a>        <span class="k">return</span> <span class="n">ObjectChange</span><span class="o">.</span><span class="n">objects</span><span class="o">.</span><span class="n">filter</span><span class="p">(</span>
+<a id="__codelineno-0-24" name="__codelineno-0-24"></a>            <span class="n">changed_object_type</span><span class="o">=</span><span class="n">ContentType</span><span class="o">.</span><span class="n">objects</span><span class="o">.</span><span class="n">get_for_model</span><span class="p">(</span><span class="n">model</span><span class="o">.</span><span class="n">_meta</span><span class="o">.</span><span class="n">model</span><span class="p">),</span>
+<a id="__codelineno-0-25" name="__codelineno-0-25"></a>            <span class="n">changed_object_id</span><span class="o">=</span><span class="n">model</span><span class="o">.</span><span class="n">pk</span><span class="p">,</span>
+<a id="__codelineno-0-26" name="__codelineno-0-26"></a>        <span class="p">)</span>
+<a id="__codelineno-0-27" name="__codelineno-0-27"></a>    <span class="k">if</span> <span class="nb">issubclass</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">Model</span><span class="p">):</span>
+<a id="__codelineno-0-28" name="__codelineno-0-28"></a>        <span class="k">return</span> <span class="n">ObjectChange</span><span class="o">.</span><span class="n">objects</span><span class="o">.</span><span class="n">filter</span><span class="p">(</span><span class="n">changed_object_type</span><span class="o">=</span><span class="n">ContentType</span><span class="o">.</span><span class="n">objects</span><span class="o">.</span><span class="n">get_for_model</span><span class="p">(</span><span class="n">model</span><span class="o">.</span><span class="n">_meta</span><span class="o">.</span><span class="n">model</span><span class="p">))</span>
+<a id="__codelineno-0-29" name="__codelineno-0-29"></a>    <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">model</span><span class="si">!r}</span><span class="s2"> is not a Django Model class or instance&quot;</span><span class="p">)</span>
 </code></pre></div></td></tr></table></div>
           </details>
   </div>
@@ -9266,9 +9308,7 @@ associated with the model and its name is expected to be <code>{ModelName}Filter
 
           <details class="quote">
             <summary>Source code in <code>nautobot/core/utils/lookup.py</code></summary>
-            <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-141">141</a></span>
-<span class="normal"><a href="#__codelineno-0-142">142</a></span>
-<span class="normal"><a href="#__codelineno-0-143">143</a></span>
+            <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-143">143</a></span>
 <span class="normal"><a href="#__codelineno-0-144">144</a></span>
 <span class="normal"><a href="#__codelineno-0-145">145</a></span>
 <span class="normal"><a href="#__codelineno-0-146">146</a></span>
@@ -9280,21 +9320,23 @@ associated with the model and its name is expected to be <code>{ModelName}Filter
 <span class="normal"><a href="#__codelineno-0-152">152</a></span>
 <span class="normal"><a href="#__codelineno-0-153">153</a></span>
 <span class="normal"><a href="#__codelineno-0-154">154</a></span>
-<span class="normal"><a href="#__codelineno-0-155">155</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-141" name="__codelineno-0-141"></a><span class="k">def</span> <span class="nf">get_filterset_for_model</span><span class="p">(</span><span class="n">model</span><span class="p">):</span>
-<a id="__codelineno-0-142" name="__codelineno-0-142"></a><span class="w">    </span><span class="sd">&quot;&quot;&quot;Return the `FilterSet` class associated with a given `model`.</span>
-<a id="__codelineno-0-143" name="__codelineno-0-143"></a>
-<a id="__codelineno-0-144" name="__codelineno-0-144"></a><span class="sd">    The `FilterSet` class is expected to be in the `filters` module within the application</span>
-<a id="__codelineno-0-145" name="__codelineno-0-145"></a><span class="sd">    associated with the model and its name is expected to be `{ModelName}FilterSet`.</span>
-<a id="__codelineno-0-146" name="__codelineno-0-146"></a>
-<a id="__codelineno-0-147" name="__codelineno-0-147"></a><span class="sd">    If a matching `FilterSet` is not found, this will return `None`.</span>
+<span class="normal"><a href="#__codelineno-0-155">155</a></span>
+<span class="normal"><a href="#__codelineno-0-156">156</a></span>
+<span class="normal"><a href="#__codelineno-0-157">157</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-143" name="__codelineno-0-143"></a><span class="k">def</span> <span class="nf">get_filterset_for_model</span><span class="p">(</span><span class="n">model</span><span class="p">):</span>
+<a id="__codelineno-0-144" name="__codelineno-0-144"></a><span class="w">    </span><span class="sd">&quot;&quot;&quot;Return the `FilterSet` class associated with a given `model`.</span>
+<a id="__codelineno-0-145" name="__codelineno-0-145"></a>
+<a id="__codelineno-0-146" name="__codelineno-0-146"></a><span class="sd">    The `FilterSet` class is expected to be in the `filters` module within the application</span>
+<a id="__codelineno-0-147" name="__codelineno-0-147"></a><span class="sd">    associated with the model and its name is expected to be `{ModelName}FilterSet`.</span>
 <a id="__codelineno-0-148" name="__codelineno-0-148"></a>
-<a id="__codelineno-0-149" name="__codelineno-0-149"></a><span class="sd">    Args:</span>
-<a id="__codelineno-0-150" name="__codelineno-0-150"></a><span class="sd">        model (BaseModel): A model class</span>
-<a id="__codelineno-0-151" name="__codelineno-0-151"></a>
-<a id="__codelineno-0-152" name="__codelineno-0-152"></a><span class="sd">    Returns:</span>
-<a id="__codelineno-0-153" name="__codelineno-0-153"></a><span class="sd">        (Union[FilterSet,None]): Either the `FilterSet` class or `None`</span>
-<a id="__codelineno-0-154" name="__codelineno-0-154"></a><span class="sd">    &quot;&quot;&quot;</span>
-<a id="__codelineno-0-155" name="__codelineno-0-155"></a>    <span class="k">return</span> <span class="n">get_related_class_for_model</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">module_name</span><span class="o">=</span><span class="s2">&quot;filters&quot;</span><span class="p">,</span> <span class="n">object_suffix</span><span class="o">=</span><span class="s2">&quot;FilterSet&quot;</span><span class="p">)</span>
+<a id="__codelineno-0-149" name="__codelineno-0-149"></a><span class="sd">    If a matching `FilterSet` is not found, this will return `None`.</span>
+<a id="__codelineno-0-150" name="__codelineno-0-150"></a>
+<a id="__codelineno-0-151" name="__codelineno-0-151"></a><span class="sd">    Args:</span>
+<a id="__codelineno-0-152" name="__codelineno-0-152"></a><span class="sd">        model (BaseModel): A model class</span>
+<a id="__codelineno-0-153" name="__codelineno-0-153"></a>
+<a id="__codelineno-0-154" name="__codelineno-0-154"></a><span class="sd">    Returns:</span>
+<a id="__codelineno-0-155" name="__codelineno-0-155"></a><span class="sd">        (Union[FilterSet,None]): Either the `FilterSet` class or `None`</span>
+<a id="__codelineno-0-156" name="__codelineno-0-156"></a><span class="sd">    &quot;&quot;&quot;</span>
+<a id="__codelineno-0-157" name="__codelineno-0-157"></a>    <span class="k">return</span> <span class="n">get_related_class_for_model</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">module_name</span><span class="o">=</span><span class="s2">&quot;filters&quot;</span><span class="p">,</span> <span class="n">object_suffix</span><span class="o">=</span><span class="s2">&quot;FilterSet&quot;</span><span class="p">)</span>
 </code></pre></div></td></tr></table></div>
           </details>
   </div>
@@ -9562,9 +9604,7 @@ associated with the model and its name is expected to be <code>{ModelName}{form_
 
           <details class="quote">
             <summary>Source code in <code>nautobot/core/utils/lookup.py</code></summary>
-            <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-158">158</a></span>
-<span class="normal"><a href="#__codelineno-0-159">159</a></span>
-<span class="normal"><a href="#__codelineno-0-160">160</a></span>
+            <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-160">160</a></span>
 <span class="normal"><a href="#__codelineno-0-161">161</a></span>
 <span class="normal"><a href="#__codelineno-0-162">162</a></span>
 <span class="normal"><a href="#__codelineno-0-163">163</a></span>
@@ -9579,24 +9619,26 @@ associated with the model and its name is expected to be <code>{ModelName}{form_
 <span class="normal"><a href="#__codelineno-0-172">172</a></span>
 <span class="normal"><a href="#__codelineno-0-173">173</a></span>
 <span class="normal"><a href="#__codelineno-0-174">174</a></span>
-<span class="normal"><a href="#__codelineno-0-175">175</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-158" name="__codelineno-0-158"></a><span class="k">def</span> <span class="nf">get_form_for_model</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">form_prefix</span><span class="o">=</span><span class="s2">&quot;&quot;</span><span class="p">):</span>
-<a id="__codelineno-0-159" name="__codelineno-0-159"></a><span class="w">    </span><span class="sd">&quot;&quot;&quot;Return the `Form` class associated with a given `model`.</span>
-<a id="__codelineno-0-160" name="__codelineno-0-160"></a>
-<a id="__codelineno-0-161" name="__codelineno-0-161"></a><span class="sd">    The `Form` class is expected to be in the `forms` module within the application</span>
-<a id="__codelineno-0-162" name="__codelineno-0-162"></a><span class="sd">    associated with the model and its name is expected to be `{ModelName}{form_prefix}Form`.</span>
-<a id="__codelineno-0-163" name="__codelineno-0-163"></a>
-<a id="__codelineno-0-164" name="__codelineno-0-164"></a><span class="sd">    If a matching `Form` is not found, this will return `None`.</span>
+<span class="normal"><a href="#__codelineno-0-175">175</a></span>
+<span class="normal"><a href="#__codelineno-0-176">176</a></span>
+<span class="normal"><a href="#__codelineno-0-177">177</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-160" name="__codelineno-0-160"></a><span class="k">def</span> <span class="nf">get_form_for_model</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">form_prefix</span><span class="o">=</span><span class="s2">&quot;&quot;</span><span class="p">):</span>
+<a id="__codelineno-0-161" name="__codelineno-0-161"></a><span class="w">    </span><span class="sd">&quot;&quot;&quot;Return the `Form` class associated with a given `model`.</span>
+<a id="__codelineno-0-162" name="__codelineno-0-162"></a>
+<a id="__codelineno-0-163" name="__codelineno-0-163"></a><span class="sd">    The `Form` class is expected to be in the `forms` module within the application</span>
+<a id="__codelineno-0-164" name="__codelineno-0-164"></a><span class="sd">    associated with the model and its name is expected to be `{ModelName}{form_prefix}Form`.</span>
 <a id="__codelineno-0-165" name="__codelineno-0-165"></a>
-<a id="__codelineno-0-166" name="__codelineno-0-166"></a><span class="sd">    Args:</span>
-<a id="__codelineno-0-167" name="__codelineno-0-167"></a><span class="sd">        form_prefix (str):</span>
-<a id="__codelineno-0-168" name="__codelineno-0-168"></a><span class="sd">            An additional prefix for the form name (e.g. `Filter`, such as to retrieve</span>
-<a id="__codelineno-0-169" name="__codelineno-0-169"></a><span class="sd">            `FooFilterForm`) that will come after the model name.</span>
-<a id="__codelineno-0-170" name="__codelineno-0-170"></a>
-<a id="__codelineno-0-171" name="__codelineno-0-171"></a><span class="sd">    Returns:</span>
-<a id="__codelineno-0-172" name="__codelineno-0-172"></a><span class="sd">        (Union[Form, None]): Either the `Form` class or `None`</span>
-<a id="__codelineno-0-173" name="__codelineno-0-173"></a><span class="sd">    &quot;&quot;&quot;</span>
-<a id="__codelineno-0-174" name="__codelineno-0-174"></a>    <span class="n">object_suffix</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">form_prefix</span><span class="si">}</span><span class="s2">Form&quot;</span>
-<a id="__codelineno-0-175" name="__codelineno-0-175"></a>    <span class="k">return</span> <span class="n">get_related_class_for_model</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">module_name</span><span class="o">=</span><span class="s2">&quot;forms&quot;</span><span class="p">,</span> <span class="n">object_suffix</span><span class="o">=</span><span class="n">object_suffix</span><span class="p">)</span>
+<a id="__codelineno-0-166" name="__codelineno-0-166"></a><span class="sd">    If a matching `Form` is not found, this will return `None`.</span>
+<a id="__codelineno-0-167" name="__codelineno-0-167"></a>
+<a id="__codelineno-0-168" name="__codelineno-0-168"></a><span class="sd">    Args:</span>
+<a id="__codelineno-0-169" name="__codelineno-0-169"></a><span class="sd">        form_prefix (str):</span>
+<a id="__codelineno-0-170" name="__codelineno-0-170"></a><span class="sd">            An additional prefix for the form name (e.g. `Filter`, such as to retrieve</span>
+<a id="__codelineno-0-171" name="__codelineno-0-171"></a><span class="sd">            `FooFilterForm`) that will come after the model name.</span>
+<a id="__codelineno-0-172" name="__codelineno-0-172"></a>
+<a id="__codelineno-0-173" name="__codelineno-0-173"></a><span class="sd">    Returns:</span>
+<a id="__codelineno-0-174" name="__codelineno-0-174"></a><span class="sd">        (Union[Form, None]): Either the `Form` class or `None`</span>
+<a id="__codelineno-0-175" name="__codelineno-0-175"></a><span class="sd">    &quot;&quot;&quot;</span>
+<a id="__codelineno-0-176" name="__codelineno-0-176"></a>    <span class="n">object_suffix</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">form_prefix</span><span class="si">}</span><span class="s2">Form&quot;</span>
+<a id="__codelineno-0-177" name="__codelineno-0-177"></a>    <span class="k">return</span> <span class="n">get_related_class_for_model</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">module_name</span><span class="o">=</span><span class="s2">&quot;forms&quot;</span><span class="p">,</span> <span class="n">object_suffix</span><span class="o">=</span><span class="n">object_suffix</span><span class="p">)</span>
 </code></pre></div></td></tr></table></div>
           </details>
   </div>
@@ -9724,9 +9766,7 @@ associated with the model and its name is expected to be <code>{ModelName}{form_
 
           <details class="quote">
             <summary>Source code in <code>nautobot/core/utils/lookup.py</code></summary>
-            <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-30">30</a></span>
-<span class="normal"><a href="#__codelineno-0-31">31</a></span>
-<span class="normal"><a href="#__codelineno-0-32">32</a></span>
+            <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-32">32</a></span>
 <span class="normal"><a href="#__codelineno-0-33">33</a></span>
 <span class="normal"><a href="#__codelineno-0-34">34</a></span>
 <span class="normal"><a href="#__codelineno-0-35">35</a></span>
@@ -9738,21 +9778,23 @@ associated with the model and its name is expected to be <code>{ModelName}{form_
 <span class="normal"><a href="#__codelineno-0-41">41</a></span>
 <span class="normal"><a href="#__codelineno-0-42">42</a></span>
 <span class="normal"><a href="#__codelineno-0-43">43</a></span>
-<span class="normal"><a href="#__codelineno-0-44">44</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-30" name="__codelineno-0-30"></a><span class="k">def</span> <span class="nf">get_model_from_name</span><span class="p">(</span><span class="n">model_name</span><span class="p">):</span>
-<a id="__codelineno-0-31" name="__codelineno-0-31"></a><span class="w">    </span><span class="sd">&quot;&quot;&quot;Given a full model name in dotted format (example: `dcim.model`), a model class is returned if valid.</span>
-<a id="__codelineno-0-32" name="__codelineno-0-32"></a>
-<a id="__codelineno-0-33" name="__codelineno-0-33"></a><span class="sd">    :param model_name: Full dotted name for a model as a string (ex: `dcim.model`)</span>
-<a id="__codelineno-0-34" name="__codelineno-0-34"></a><span class="sd">    :type model_name: str</span>
-<a id="__codelineno-0-35" name="__codelineno-0-35"></a>
-<a id="__codelineno-0-36" name="__codelineno-0-36"></a><span class="sd">    :raises TypeError: If given model name is not found.</span>
+<span class="normal"><a href="#__codelineno-0-44">44</a></span>
+<span class="normal"><a href="#__codelineno-0-45">45</a></span>
+<span class="normal"><a href="#__codelineno-0-46">46</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-32" name="__codelineno-0-32"></a><span class="k">def</span> <span class="nf">get_model_from_name</span><span class="p">(</span><span class="n">model_name</span><span class="p">):</span>
+<a id="__codelineno-0-33" name="__codelineno-0-33"></a><span class="w">    </span><span class="sd">&quot;&quot;&quot;Given a full model name in dotted format (example: `dcim.model`), a model class is returned if valid.</span>
+<a id="__codelineno-0-34" name="__codelineno-0-34"></a>
+<a id="__codelineno-0-35" name="__codelineno-0-35"></a><span class="sd">    :param model_name: Full dotted name for a model as a string (ex: `dcim.model`)</span>
+<a id="__codelineno-0-36" name="__codelineno-0-36"></a><span class="sd">    :type model_name: str</span>
 <a id="__codelineno-0-37" name="__codelineno-0-37"></a>
-<a id="__codelineno-0-38" name="__codelineno-0-38"></a><span class="sd">    :return: Found model.</span>
-<a id="__codelineno-0-39" name="__codelineno-0-39"></a><span class="sd">    &quot;&quot;&quot;</span>
-<a id="__codelineno-0-40" name="__codelineno-0-40"></a>
-<a id="__codelineno-0-41" name="__codelineno-0-41"></a>    <span class="k">try</span><span class="p">:</span>
-<a id="__codelineno-0-42" name="__codelineno-0-42"></a>        <span class="k">return</span> <span class="n">apps</span><span class="o">.</span><span class="n">get_model</span><span class="p">(</span><span class="n">model_name</span><span class="p">)</span>
-<a id="__codelineno-0-43" name="__codelineno-0-43"></a>    <span class="k">except</span> <span class="p">(</span><span class="ne">ValueError</span><span class="p">,</span> <span class="ne">LookupError</span><span class="p">)</span> <span class="k">as</span> <span class="n">exc</span><span class="p">:</span>
-<a id="__codelineno-0-44" name="__codelineno-0-44"></a>        <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="n">exc</span><span class="p">)</span> <span class="kn">from</span> <span class="nn">exc</span>
+<a id="__codelineno-0-38" name="__codelineno-0-38"></a><span class="sd">    :raises TypeError: If given model name is not found.</span>
+<a id="__codelineno-0-39" name="__codelineno-0-39"></a>
+<a id="__codelineno-0-40" name="__codelineno-0-40"></a><span class="sd">    :return: Found model.</span>
+<a id="__codelineno-0-41" name="__codelineno-0-41"></a><span class="sd">    &quot;&quot;&quot;</span>
+<a id="__codelineno-0-42" name="__codelineno-0-42"></a>
+<a id="__codelineno-0-43" name="__codelineno-0-43"></a>    <span class="k">try</span><span class="p">:</span>
+<a id="__codelineno-0-44" name="__codelineno-0-44"></a>        <span class="k">return</span> <span class="n">apps</span><span class="o">.</span><span class="n">get_model</span><span class="p">(</span><span class="n">model_name</span><span class="p">)</span>
+<a id="__codelineno-0-45" name="__codelineno-0-45"></a>    <span class="k">except</span> <span class="p">(</span><span class="ne">ValueError</span><span class="p">,</span> <span class="ne">LookupError</span><span class="p">)</span> <span class="k">as</span> <span class="n">exc</span><span class="p">:</span>
+<a id="__codelineno-0-46" name="__codelineno-0-46"></a>        <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="n">exc</span><span class="p">)</span> <span class="kn">from</span> <span class="nn">exc</span>
 </code></pre></div></td></tr></table></div>
           </details>
   </div>
@@ -10068,9 +10110,7 @@ associated with the model and its name is expected to be <code>{ModelName}{objec
 
           <details class="quote">
             <summary>Source code in <code>nautobot/core/utils/lookup.py</code></summary>
-            <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-99"> 99</a></span>
-<span class="normal"><a href="#__codelineno-0-100">100</a></span>
-<span class="normal"><a href="#__codelineno-0-101">101</a></span>
+            <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-101">101</a></span>
 <span class="normal"><a href="#__codelineno-0-102">102</a></span>
 <span class="normal"><a href="#__codelineno-0-103">103</a></span>
 <span class="normal"><a href="#__codelineno-0-104">104</a></span>
@@ -10107,46 +10147,48 @@ associated with the model and its name is expected to be <code>{ModelName}{objec
 <span class="normal"><a href="#__codelineno-0-135">135</a></span>
 <span class="normal"><a href="#__codelineno-0-136">136</a></span>
 <span class="normal"><a href="#__codelineno-0-137">137</a></span>
-<span class="normal"><a href="#__codelineno-0-138">138</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-99" name="__codelineno-0-99"></a><span class="k">def</span> <span class="nf">get_related_class_for_model</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">module_name</span><span class="p">,</span> <span class="n">object_suffix</span><span class="p">):</span>
-<a id="__codelineno-0-100" name="__codelineno-0-100"></a><span class="w">    </span><span class="sd">&quot;&quot;&quot;Return the appropriate class associated with a given model matching the `module_name` and</span>
-<a id="__codelineno-0-101" name="__codelineno-0-101"></a><span class="sd">    `object_suffix`.</span>
-<a id="__codelineno-0-102" name="__codelineno-0-102"></a>
-<a id="__codelineno-0-103" name="__codelineno-0-103"></a><span class="sd">    The given `model` can either be a model class, a model instance, or a dotted representation (ex: `dcim.device`).</span>
+<span class="normal"><a href="#__codelineno-0-138">138</a></span>
+<span class="normal"><a href="#__codelineno-0-139">139</a></span>
+<span class="normal"><a href="#__codelineno-0-140">140</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-101" name="__codelineno-0-101"></a><span class="k">def</span> <span class="nf">get_related_class_for_model</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">module_name</span><span class="p">,</span> <span class="n">object_suffix</span><span class="p">):</span>
+<a id="__codelineno-0-102" name="__codelineno-0-102"></a><span class="w">    </span><span class="sd">&quot;&quot;&quot;Return the appropriate class associated with a given model matching the `module_name` and</span>
+<a id="__codelineno-0-103" name="__codelineno-0-103"></a><span class="sd">    `object_suffix`.</span>
 <a id="__codelineno-0-104" name="__codelineno-0-104"></a>
-<a id="__codelineno-0-105" name="__codelineno-0-105"></a><span class="sd">    The object class is expected to be in the module within the application</span>
-<a id="__codelineno-0-106" name="__codelineno-0-106"></a><span class="sd">    associated with the model and its name is expected to be `{ModelName}{object_suffix}`.</span>
-<a id="__codelineno-0-107" name="__codelineno-0-107"></a>
-<a id="__codelineno-0-108" name="__codelineno-0-108"></a><span class="sd">    If a matching class is not found, this will return `None`.</span>
+<a id="__codelineno-0-105" name="__codelineno-0-105"></a><span class="sd">    The given `model` can either be a model class, a model instance, or a dotted representation (ex: `dcim.device`).</span>
+<a id="__codelineno-0-106" name="__codelineno-0-106"></a>
+<a id="__codelineno-0-107" name="__codelineno-0-107"></a><span class="sd">    The object class is expected to be in the module within the application</span>
+<a id="__codelineno-0-108" name="__codelineno-0-108"></a><span class="sd">    associated with the model and its name is expected to be `{ModelName}{object_suffix}`.</span>
 <a id="__codelineno-0-109" name="__codelineno-0-109"></a>
-<a id="__codelineno-0-110" name="__codelineno-0-110"></a><span class="sd">    Args:</span>
-<a id="__codelineno-0-111" name="__codelineno-0-111"></a><span class="sd">        model (Union[BaseModel, str]): A model class, instance, or dotted representation</span>
-<a id="__codelineno-0-112" name="__codelineno-0-112"></a><span class="sd">        module_name (str): The name of the module to search for the object class</span>
-<a id="__codelineno-0-113" name="__codelineno-0-113"></a><span class="sd">        object_suffix (str): The suffix to append to the model name to find the object class</span>
-<a id="__codelineno-0-114" name="__codelineno-0-114"></a>
-<a id="__codelineno-0-115" name="__codelineno-0-115"></a><span class="sd">    Returns:</span>
-<a id="__codelineno-0-116" name="__codelineno-0-116"></a><span class="sd">        (Union[BaseModel, str]): Either the matching object class or None</span>
-<a id="__codelineno-0-117" name="__codelineno-0-117"></a><span class="sd">    &quot;&quot;&quot;</span>
-<a id="__codelineno-0-118" name="__codelineno-0-118"></a>    <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
-<a id="__codelineno-0-119" name="__codelineno-0-119"></a>        <span class="n">model</span> <span class="o">=</span> <span class="n">get_model_from_name</span><span class="p">(</span><span class="n">model</span><span class="p">)</span>
-<a id="__codelineno-0-120" name="__codelineno-0-120"></a>    <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">Model</span><span class="p">):</span>
-<a id="__codelineno-0-121" name="__codelineno-0-121"></a>        <span class="n">model</span> <span class="o">=</span> <span class="nb">type</span><span class="p">(</span><span class="n">model</span><span class="p">)</span>
-<a id="__codelineno-0-122" name="__codelineno-0-122"></a>    <span class="k">if</span> <span class="ow">not</span> <span class="n">inspect</span><span class="o">.</span><span class="n">isclass</span><span class="p">(</span><span class="n">model</span><span class="p">):</span>
-<a id="__codelineno-0-123" name="__codelineno-0-123"></a>        <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">model</span><span class="si">!r}</span><span class="s2"> is not a Django Model class&quot;</span><span class="p">)</span>
-<a id="__codelineno-0-124" name="__codelineno-0-124"></a>    <span class="k">if</span> <span class="ow">not</span> <span class="nb">issubclass</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">Model</span><span class="p">):</span>
-<a id="__codelineno-0-125" name="__codelineno-0-125"></a>        <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">model</span><span class="si">!r}</span><span class="s2"> is not a subclass of a Django Model class&quot;</span><span class="p">)</span>
-<a id="__codelineno-0-126" name="__codelineno-0-126"></a>
-<a id="__codelineno-0-127" name="__codelineno-0-127"></a>    <span class="c1"># e.g. &quot;nautobot.dcim.forms.DeviceFilterForm&quot;</span>
-<a id="__codelineno-0-128" name="__codelineno-0-128"></a>    <span class="n">app_config</span> <span class="o">=</span> <span class="n">apps</span><span class="o">.</span><span class="n">get_app_config</span><span class="p">(</span><span class="n">model</span><span class="o">.</span><span class="n">_meta</span><span class="o">.</span><span class="n">app_label</span><span class="p">)</span>
-<a id="__codelineno-0-129" name="__codelineno-0-129"></a>    <span class="n">object_name</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">model</span><span class="o">.</span><span class="vm">__name__</span><span class="si">}{</span><span class="n">object_suffix</span><span class="si">}</span><span class="s2">&quot;</span>
-<a id="__codelineno-0-130" name="__codelineno-0-130"></a>    <span class="n">object_path</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">app_config</span><span class="o">.</span><span class="n">name</span><span class="si">}</span><span class="s2">.</span><span class="si">{</span><span class="n">module_name</span><span class="si">}</span><span class="s2">.</span><span class="si">{</span><span class="n">object_name</span><span class="si">}</span><span class="s2">&quot;</span>
-<a id="__codelineno-0-131" name="__codelineno-0-131"></a>
-<a id="__codelineno-0-132" name="__codelineno-0-132"></a>    <span class="k">try</span><span class="p">:</span>
-<a id="__codelineno-0-133" name="__codelineno-0-133"></a>        <span class="k">return</span> <span class="n">import_string</span><span class="p">(</span><span class="n">object_path</span><span class="p">)</span>
-<a id="__codelineno-0-134" name="__codelineno-0-134"></a>    <span class="c1"># The name of the module is not correct or unable to find the desired object for this model</span>
-<a id="__codelineno-0-135" name="__codelineno-0-135"></a>    <span class="k">except</span> <span class="p">(</span><span class="ne">AttributeError</span><span class="p">,</span> <span class="ne">ImportError</span><span class="p">,</span> <span class="ne">ModuleNotFoundError</span><span class="p">):</span>
-<a id="__codelineno-0-136" name="__codelineno-0-136"></a>        <span class="k">pass</span>
-<a id="__codelineno-0-137" name="__codelineno-0-137"></a>
-<a id="__codelineno-0-138" name="__codelineno-0-138"></a>    <span class="k">return</span> <span class="kc">None</span>
+<a id="__codelineno-0-110" name="__codelineno-0-110"></a><span class="sd">    If a matching class is not found, this will return `None`.</span>
+<a id="__codelineno-0-111" name="__codelineno-0-111"></a>
+<a id="__codelineno-0-112" name="__codelineno-0-112"></a><span class="sd">    Args:</span>
+<a id="__codelineno-0-113" name="__codelineno-0-113"></a><span class="sd">        model (Union[BaseModel, str]): A model class, instance, or dotted representation</span>
+<a id="__codelineno-0-114" name="__codelineno-0-114"></a><span class="sd">        module_name (str): The name of the module to search for the object class</span>
+<a id="__codelineno-0-115" name="__codelineno-0-115"></a><span class="sd">        object_suffix (str): The suffix to append to the model name to find the object class</span>
+<a id="__codelineno-0-116" name="__codelineno-0-116"></a>
+<a id="__codelineno-0-117" name="__codelineno-0-117"></a><span class="sd">    Returns:</span>
+<a id="__codelineno-0-118" name="__codelineno-0-118"></a><span class="sd">        (Union[BaseModel, str]): Either the matching object class or None</span>
+<a id="__codelineno-0-119" name="__codelineno-0-119"></a><span class="sd">    &quot;&quot;&quot;</span>
+<a id="__codelineno-0-120" name="__codelineno-0-120"></a>    <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
+<a id="__codelineno-0-121" name="__codelineno-0-121"></a>        <span class="n">model</span> <span class="o">=</span> <span class="n">get_model_from_name</span><span class="p">(</span><span class="n">model</span><span class="p">)</span>
+<a id="__codelineno-0-122" name="__codelineno-0-122"></a>    <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">Model</span><span class="p">):</span>
+<a id="__codelineno-0-123" name="__codelineno-0-123"></a>        <span class="n">model</span> <span class="o">=</span> <span class="nb">type</span><span class="p">(</span><span class="n">model</span><span class="p">)</span>
+<a id="__codelineno-0-124" name="__codelineno-0-124"></a>    <span class="k">if</span> <span class="ow">not</span> <span class="n">inspect</span><span class="o">.</span><span class="n">isclass</span><span class="p">(</span><span class="n">model</span><span class="p">):</span>
+<a id="__codelineno-0-125" name="__codelineno-0-125"></a>        <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">model</span><span class="si">!r}</span><span class="s2"> is not a Django Model class&quot;</span><span class="p">)</span>
+<a id="__codelineno-0-126" name="__codelineno-0-126"></a>    <span class="k">if</span> <span class="ow">not</span> <span class="nb">issubclass</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">Model</span><span class="p">):</span>
+<a id="__codelineno-0-127" name="__codelineno-0-127"></a>        <span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">model</span><span class="si">!r}</span><span class="s2"> is not a subclass of a Django Model class&quot;</span><span class="p">)</span>
+<a id="__codelineno-0-128" name="__codelineno-0-128"></a>
+<a id="__codelineno-0-129" name="__codelineno-0-129"></a>    <span class="c1"># e.g. &quot;nautobot.dcim.forms.DeviceFilterForm&quot;</span>
+<a id="__codelineno-0-130" name="__codelineno-0-130"></a>    <span class="n">app_config</span> <span class="o">=</span> <span class="n">apps</span><span class="o">.</span><span class="n">get_app_config</span><span class="p">(</span><span class="n">model</span><span class="o">.</span><span class="n">_meta</span><span class="o">.</span><span class="n">app_label</span><span class="p">)</span>
+<a id="__codelineno-0-131" name="__codelineno-0-131"></a>    <span class="n">object_name</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">model</span><span class="o">.</span><span class="vm">__name__</span><span class="si">}{</span><span class="n">object_suffix</span><span class="si">}</span><span class="s2">&quot;</span>
+<a id="__codelineno-0-132" name="__codelineno-0-132"></a>    <span class="n">object_path</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">app_config</span><span class="o">.</span><span class="n">name</span><span class="si">}</span><span class="s2">.</span><span class="si">{</span><span class="n">module_name</span><span class="si">}</span><span class="s2">.</span><span class="si">{</span><span class="n">object_name</span><span class="si">}</span><span class="s2">&quot;</span>
+<a id="__codelineno-0-133" name="__codelineno-0-133"></a>
+<a id="__codelineno-0-134" name="__codelineno-0-134"></a>    <span class="k">try</span><span class="p">:</span>
+<a id="__codelineno-0-135" name="__codelineno-0-135"></a>        <span class="k">return</span> <span class="n">import_string</span><span class="p">(</span><span class="n">object_path</span><span class="p">)</span>
+<a id="__codelineno-0-136" name="__codelineno-0-136"></a>    <span class="c1"># The name of the module is not correct or unable to find the desired object for this model</span>
+<a id="__codelineno-0-137" name="__codelineno-0-137"></a>    <span class="k">except</span> <span class="p">(</span><span class="ne">AttributeError</span><span class="p">,</span> <span class="ne">ImportError</span><span class="p">,</span> <span class="ne">ModuleNotFoundError</span><span class="p">):</span>
+<a id="__codelineno-0-138" name="__codelineno-0-138"></a>        <span class="k">pass</span>
+<a id="__codelineno-0-139" name="__codelineno-0-139"></a>
+<a id="__codelineno-0-140" name="__codelineno-0-140"></a>    <span class="k">return</span> <span class="kc">None</span>
 </code></pre></div></td></tr></table></div>
           </details>
   </div>
@@ -10270,9 +10312,7 @@ Supports both core and plugin routes.</p>
 
           <details class="quote">
             <summary>Source code in <code>nautobot/core/utils/lookup.py</code></summary>
-            <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-47">47</a></span>
-<span class="normal"><a href="#__codelineno-0-48">48</a></span>
-<span class="normal"><a href="#__codelineno-0-49">49</a></span>
+            <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-49">49</a></span>
 <span class="normal"><a href="#__codelineno-0-50">50</a></span>
 <span class="normal"><a href="#__codelineno-0-51">51</a></span>
 <span class="normal"><a href="#__codelineno-0-52">52</a></span>
@@ -10319,56 +10359,58 @@ Supports both core and plugin routes.</p>
 <span class="normal"><a href="#__codelineno-0-93">93</a></span>
 <span class="normal"><a href="#__codelineno-0-94">94</a></span>
 <span class="normal"><a href="#__codelineno-0-95">95</a></span>
-<span class="normal"><a href="#__codelineno-0-96">96</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-47" name="__codelineno-0-47"></a><span class="k">def</span> <span class="nf">get_route_for_model</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">action</span><span class="p">,</span> <span class="n">api</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
-<a id="__codelineno-0-48" name="__codelineno-0-48"></a><span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
-<a id="__codelineno-0-49" name="__codelineno-0-49"></a><span class="sd">    Return the URL route name for the given model and action. Does not perform any validation.</span>
-<a id="__codelineno-0-50" name="__codelineno-0-50"></a><span class="sd">    Supports both core and plugin routes.</span>
-<a id="__codelineno-0-51" name="__codelineno-0-51"></a>
-<a id="__codelineno-0-52" name="__codelineno-0-52"></a><span class="sd">    Args:</span>
-<a id="__codelineno-0-53" name="__codelineno-0-53"></a><span class="sd">        model (models.Model, str): Class, Instance, or dotted string of a Django Model</span>
-<a id="__codelineno-0-54" name="__codelineno-0-54"></a><span class="sd">        action (str): name of the action in the route</span>
-<a id="__codelineno-0-55" name="__codelineno-0-55"></a><span class="sd">        api (bool): If set, return an API route.</span>
-<a id="__codelineno-0-56" name="__codelineno-0-56"></a>
-<a id="__codelineno-0-57" name="__codelineno-0-57"></a><span class="sd">    Returns:</span>
-<a id="__codelineno-0-58" name="__codelineno-0-58"></a><span class="sd">        (str): return the name of the view for the model/action provided.</span>
-<a id="__codelineno-0-59" name="__codelineno-0-59"></a>
-<a id="__codelineno-0-60" name="__codelineno-0-60"></a><span class="sd">    Examples:</span>
-<a id="__codelineno-0-61" name="__codelineno-0-61"></a><span class="sd">        &gt;&gt;&gt; get_route_for_model(Device, &quot;list&quot;)</span>
-<a id="__codelineno-0-62" name="__codelineno-0-62"></a><span class="sd">        &quot;dcim:device_list&quot;</span>
-<a id="__codelineno-0-63" name="__codelineno-0-63"></a><span class="sd">        &gt;&gt;&gt; get_route_for_model(Device, &quot;list&quot;, api=True)</span>
-<a id="__codelineno-0-64" name="__codelineno-0-64"></a><span class="sd">        &quot;dcim-api:device-list&quot;</span>
-<a id="__codelineno-0-65" name="__codelineno-0-65"></a><span class="sd">        &gt;&gt;&gt; get_route_for_model(&quot;dcim.location&quot;, &quot;list&quot;)</span>
-<a id="__codelineno-0-66" name="__codelineno-0-66"></a><span class="sd">        &quot;dcim:location_list&quot;</span>
-<a id="__codelineno-0-67" name="__codelineno-0-67"></a><span class="sd">        &gt;&gt;&gt; get_route_for_model(&quot;dcim.location&quot;, &quot;list&quot;, api=True)</span>
-<a id="__codelineno-0-68" name="__codelineno-0-68"></a><span class="sd">        &quot;dcim-api:location-list&quot;</span>
-<a id="__codelineno-0-69" name="__codelineno-0-69"></a><span class="sd">        &gt;&gt;&gt; get_route_for_model(ExampleModel, &quot;list&quot;)</span>
-<a id="__codelineno-0-70" name="__codelineno-0-70"></a><span class="sd">        &quot;plugins:example_plugin:examplemodel_list&quot;</span>
-<a id="__codelineno-0-71" name="__codelineno-0-71"></a><span class="sd">        &gt;&gt;&gt; get_route_for_model(ExampleModel, &quot;list&quot;, api=True)</span>
-<a id="__codelineno-0-72" name="__codelineno-0-72"></a><span class="sd">        &quot;plugins-api:example_plugin-api:examplemodel-list&quot;</span>
-<a id="__codelineno-0-73" name="__codelineno-0-73"></a><span class="sd">    &quot;&quot;&quot;</span>
-<a id="__codelineno-0-74" name="__codelineno-0-74"></a>
-<a id="__codelineno-0-75" name="__codelineno-0-75"></a>    <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
-<a id="__codelineno-0-76" name="__codelineno-0-76"></a>        <span class="n">model</span> <span class="o">=</span> <span class="n">get_model_from_name</span><span class="p">(</span><span class="n">model</span><span class="p">)</span>
-<a id="__codelineno-0-77" name="__codelineno-0-77"></a>
-<a id="__codelineno-0-78" name="__codelineno-0-78"></a>    <span class="n">suffix</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span> <span class="k">if</span> <span class="ow">not</span> <span class="n">api</span> <span class="k">else</span> <span class="s2">&quot;-api&quot;</span>
-<a id="__codelineno-0-79" name="__codelineno-0-79"></a>    <span class="c1"># The `contenttypes` and `auth` app doesn&#39;t provide REST API endpoints,</span>
-<a id="__codelineno-0-80" name="__codelineno-0-80"></a>    <span class="c1"># but Nautobot provides one for the ContentType model in our `extras` and Group model in `users` app.</span>
-<a id="__codelineno-0-81" name="__codelineno-0-81"></a>    <span class="k">if</span> <span class="n">model</span> <span class="ow">is</span> <span class="n">ContentType</span><span class="p">:</span>
-<a id="__codelineno-0-82" name="__codelineno-0-82"></a>        <span class="n">app_label</span> <span class="o">=</span> <span class="s2">&quot;extras&quot;</span>
-<a id="__codelineno-0-83" name="__codelineno-0-83"></a>    <span class="k">elif</span> <span class="n">model</span> <span class="ow">is</span> <span class="n">Group</span><span class="p">:</span>
-<a id="__codelineno-0-84" name="__codelineno-0-84"></a>        <span class="n">app_label</span> <span class="o">=</span> <span class="s2">&quot;users&quot;</span>
-<a id="__codelineno-0-85" name="__codelineno-0-85"></a>    <span class="k">else</span><span class="p">:</span>
-<a id="__codelineno-0-86" name="__codelineno-0-86"></a>        <span class="n">app_label</span> <span class="o">=</span> <span class="n">model</span><span class="o">.</span><span class="n">_meta</span><span class="o">.</span><span class="n">app_label</span>
-<a id="__codelineno-0-87" name="__codelineno-0-87"></a>    <span class="n">prefix</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">app_label</span><span class="si">}{</span><span class="n">suffix</span><span class="si">}</span><span class="s2">:</span><span class="si">{</span><span class="n">model</span><span class="o">.</span><span class="n">_meta</span><span class="o">.</span><span class="n">model_name</span><span class="si">}</span><span class="s2">&quot;</span>
-<a id="__codelineno-0-88" name="__codelineno-0-88"></a>    <span class="n">sep</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
-<a id="__codelineno-0-89" name="__codelineno-0-89"></a>    <span class="k">if</span> <span class="n">action</span> <span class="o">!=</span> <span class="s2">&quot;&quot;</span><span class="p">:</span>
-<a id="__codelineno-0-90" name="__codelineno-0-90"></a>        <span class="n">sep</span> <span class="o">=</span> <span class="s2">&quot;_&quot;</span> <span class="k">if</span> <span class="ow">not</span> <span class="n">api</span> <span class="k">else</span> <span class="s2">&quot;-&quot;</span>
-<a id="__codelineno-0-91" name="__codelineno-0-91"></a>    <span class="n">viewname</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">prefix</span><span class="si">}{</span><span class="n">sep</span><span class="si">}{</span><span class="n">action</span><span class="si">}</span><span class="s2">&quot;</span>
-<a id="__codelineno-0-92" name="__codelineno-0-92"></a>
-<a id="__codelineno-0-93" name="__codelineno-0-93"></a>    <span class="k">if</span> <span class="n">apps</span><span class="o">.</span><span class="n">get_app_config</span><span class="p">(</span><span class="n">app_label</span><span class="p">)</span><span class="o">.</span><span class="n">name</span> <span class="ow">in</span> <span class="n">settings</span><span class="o">.</span><span class="n">PLUGINS</span><span class="p">:</span>
-<a id="__codelineno-0-94" name="__codelineno-0-94"></a>        <span class="n">viewname</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;plugins</span><span class="si">{</span><span class="n">suffix</span><span class="si">}</span><span class="s2">:</span><span class="si">{</span><span class="n">viewname</span><span class="si">}</span><span class="s2">&quot;</span>
-<a id="__codelineno-0-95" name="__codelineno-0-95"></a>
-<a id="__codelineno-0-96" name="__codelineno-0-96"></a>    <span class="k">return</span> <span class="n">viewname</span>
+<span class="normal"><a href="#__codelineno-0-96">96</a></span>
+<span class="normal"><a href="#__codelineno-0-97">97</a></span>
+<span class="normal"><a href="#__codelineno-0-98">98</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-49" name="__codelineno-0-49"></a><span class="k">def</span> <span class="nf">get_route_for_model</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">action</span><span class="p">,</span> <span class="n">api</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
+<a id="__codelineno-0-50" name="__codelineno-0-50"></a><span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
+<a id="__codelineno-0-51" name="__codelineno-0-51"></a><span class="sd">    Return the URL route name for the given model and action. Does not perform any validation.</span>
+<a id="__codelineno-0-52" name="__codelineno-0-52"></a><span class="sd">    Supports both core and plugin routes.</span>
+<a id="__codelineno-0-53" name="__codelineno-0-53"></a>
+<a id="__codelineno-0-54" name="__codelineno-0-54"></a><span class="sd">    Args:</span>
+<a id="__codelineno-0-55" name="__codelineno-0-55"></a><span class="sd">        model (models.Model, str): Class, Instance, or dotted string of a Django Model</span>
+<a id="__codelineno-0-56" name="__codelineno-0-56"></a><span class="sd">        action (str): name of the action in the route</span>
+<a id="__codelineno-0-57" name="__codelineno-0-57"></a><span class="sd">        api (bool): If set, return an API route.</span>
+<a id="__codelineno-0-58" name="__codelineno-0-58"></a>
+<a id="__codelineno-0-59" name="__codelineno-0-59"></a><span class="sd">    Returns:</span>
+<a id="__codelineno-0-60" name="__codelineno-0-60"></a><span class="sd">        (str): return the name of the view for the model/action provided.</span>
+<a id="__codelineno-0-61" name="__codelineno-0-61"></a>
+<a id="__codelineno-0-62" name="__codelineno-0-62"></a><span class="sd">    Examples:</span>
+<a id="__codelineno-0-63" name="__codelineno-0-63"></a><span class="sd">        &gt;&gt;&gt; get_route_for_model(Device, &quot;list&quot;)</span>
+<a id="__codelineno-0-64" name="__codelineno-0-64"></a><span class="sd">        &quot;dcim:device_list&quot;</span>
+<a id="__codelineno-0-65" name="__codelineno-0-65"></a><span class="sd">        &gt;&gt;&gt; get_route_for_model(Device, &quot;list&quot;, api=True)</span>
+<a id="__codelineno-0-66" name="__codelineno-0-66"></a><span class="sd">        &quot;dcim-api:device-list&quot;</span>
+<a id="__codelineno-0-67" name="__codelineno-0-67"></a><span class="sd">        &gt;&gt;&gt; get_route_for_model(&quot;dcim.location&quot;, &quot;list&quot;)</span>
+<a id="__codelineno-0-68" name="__codelineno-0-68"></a><span class="sd">        &quot;dcim:location_list&quot;</span>
+<a id="__codelineno-0-69" name="__codelineno-0-69"></a><span class="sd">        &gt;&gt;&gt; get_route_for_model(&quot;dcim.location&quot;, &quot;list&quot;, api=True)</span>
+<a id="__codelineno-0-70" name="__codelineno-0-70"></a><span class="sd">        &quot;dcim-api:location-list&quot;</span>
+<a id="__codelineno-0-71" name="__codelineno-0-71"></a><span class="sd">        &gt;&gt;&gt; get_route_for_model(ExampleModel, &quot;list&quot;)</span>
+<a id="__codelineno-0-72" name="__codelineno-0-72"></a><span class="sd">        &quot;plugins:example_plugin:examplemodel_list&quot;</span>
+<a id="__codelineno-0-73" name="__codelineno-0-73"></a><span class="sd">        &gt;&gt;&gt; get_route_for_model(ExampleModel, &quot;list&quot;, api=True)</span>
+<a id="__codelineno-0-74" name="__codelineno-0-74"></a><span class="sd">        &quot;plugins-api:example_plugin-api:examplemodel-list&quot;</span>
+<a id="__codelineno-0-75" name="__codelineno-0-75"></a><span class="sd">    &quot;&quot;&quot;</span>
+<a id="__codelineno-0-76" name="__codelineno-0-76"></a>
+<a id="__codelineno-0-77" name="__codelineno-0-77"></a>    <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="nb">str</span><span class="p">):</span>
+<a id="__codelineno-0-78" name="__codelineno-0-78"></a>        <span class="n">model</span> <span class="o">=</span> <span class="n">get_model_from_name</span><span class="p">(</span><span class="n">model</span><span class="p">)</span>
+<a id="__codelineno-0-79" name="__codelineno-0-79"></a>
+<a id="__codelineno-0-80" name="__codelineno-0-80"></a>    <span class="n">suffix</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span> <span class="k">if</span> <span class="ow">not</span> <span class="n">api</span> <span class="k">else</span> <span class="s2">&quot;-api&quot;</span>
+<a id="__codelineno-0-81" name="__codelineno-0-81"></a>    <span class="c1"># The `contenttypes` and `auth` app doesn&#39;t provide REST API endpoints,</span>
+<a id="__codelineno-0-82" name="__codelineno-0-82"></a>    <span class="c1"># but Nautobot provides one for the ContentType model in our `extras` and Group model in `users` app.</span>
+<a id="__codelineno-0-83" name="__codelineno-0-83"></a>    <span class="k">if</span> <span class="n">model</span> <span class="ow">is</span> <span class="n">ContentType</span><span class="p">:</span>
+<a id="__codelineno-0-84" name="__codelineno-0-84"></a>        <span class="n">app_label</span> <span class="o">=</span> <span class="s2">&quot;extras&quot;</span>
+<a id="__codelineno-0-85" name="__codelineno-0-85"></a>    <span class="k">elif</span> <span class="n">model</span> <span class="ow">is</span> <span class="n">Group</span><span class="p">:</span>
+<a id="__codelineno-0-86" name="__codelineno-0-86"></a>        <span class="n">app_label</span> <span class="o">=</span> <span class="s2">&quot;users&quot;</span>
+<a id="__codelineno-0-87" name="__codelineno-0-87"></a>    <span class="k">else</span><span class="p">:</span>
+<a id="__codelineno-0-88" name="__codelineno-0-88"></a>        <span class="n">app_label</span> <span class="o">=</span> <span class="n">model</span><span class="o">.</span><span class="n">_meta</span><span class="o">.</span><span class="n">app_label</span>
+<a id="__codelineno-0-89" name="__codelineno-0-89"></a>    <span class="n">prefix</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">app_label</span><span class="si">}{</span><span class="n">suffix</span><span class="si">}</span><span class="s2">:</span><span class="si">{</span><span class="n">model</span><span class="o">.</span><span class="n">_meta</span><span class="o">.</span><span class="n">model_name</span><span class="si">}</span><span class="s2">&quot;</span>
+<a id="__codelineno-0-90" name="__codelineno-0-90"></a>    <span class="n">sep</span> <span class="o">=</span> <span class="s2">&quot;&quot;</span>
+<a id="__codelineno-0-91" name="__codelineno-0-91"></a>    <span class="k">if</span> <span class="n">action</span> <span class="o">!=</span> <span class="s2">&quot;&quot;</span><span class="p">:</span>
+<a id="__codelineno-0-92" name="__codelineno-0-92"></a>        <span class="n">sep</span> <span class="o">=</span> <span class="s2">&quot;_&quot;</span> <span class="k">if</span> <span class="ow">not</span> <span class="n">api</span> <span class="k">else</span> <span class="s2">&quot;-&quot;</span>
+<a id="__codelineno-0-93" name="__codelineno-0-93"></a>    <span class="n">viewname</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="n">prefix</span><span class="si">}{</span><span class="n">sep</span><span class="si">}{</span><span class="n">action</span><span class="si">}</span><span class="s2">&quot;</span>
+<a id="__codelineno-0-94" name="__codelineno-0-94"></a>
+<a id="__codelineno-0-95" name="__codelineno-0-95"></a>    <span class="k">if</span> <span class="n">apps</span><span class="o">.</span><span class="n">get_app_config</span><span class="p">(</span><span class="n">app_label</span><span class="p">)</span><span class="o">.</span><span class="n">name</span> <span class="ow">in</span> <span class="n">settings</span><span class="o">.</span><span class="n">PLUGINS</span><span class="p">:</span>
+<a id="__codelineno-0-96" name="__codelineno-0-96"></a>        <span class="n">viewname</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">&quot;plugins</span><span class="si">{</span><span class="n">suffix</span><span class="si">}</span><span class="s2">:</span><span class="si">{</span><span class="n">viewname</span><span class="si">}</span><span class="s2">&quot;</span>
+<a id="__codelineno-0-97" name="__codelineno-0-97"></a>
+<a id="__codelineno-0-98" name="__codelineno-0-98"></a>    <span class="k">return</span> <span class="n">viewname</span>
 </code></pre></div></td></tr></table></div>
           </details>
   </div>
@@ -10483,9 +10525,7 @@ associated with the model and its name is expected to be <code>{ModelName}Table<
 
           <details class="quote">
             <summary>Source code in <code>nautobot/core/utils/lookup.py</code></summary>
-            <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-178">178</a></span>
-<span class="normal"><a href="#__codelineno-0-179">179</a></span>
-<span class="normal"><a href="#__codelineno-0-180">180</a></span>
+            <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-180">180</a></span>
 <span class="normal"><a href="#__codelineno-0-181">181</a></span>
 <span class="normal"><a href="#__codelineno-0-182">182</a></span>
 <span class="normal"><a href="#__codelineno-0-183">183</a></span>
@@ -10497,21 +10537,447 @@ associated with the model and its name is expected to be <code>{ModelName}Table<
 <span class="normal"><a href="#__codelineno-0-189">189</a></span>
 <span class="normal"><a href="#__codelineno-0-190">190</a></span>
 <span class="normal"><a href="#__codelineno-0-191">191</a></span>
-<span class="normal"><a href="#__codelineno-0-192">192</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-178" name="__codelineno-0-178"></a><span class="k">def</span> <span class="nf">get_table_for_model</span><span class="p">(</span><span class="n">model</span><span class="p">):</span>
-<a id="__codelineno-0-179" name="__codelineno-0-179"></a><span class="w">    </span><span class="sd">&quot;&quot;&quot;Return the `Table` class associated with a given `model`.</span>
-<a id="__codelineno-0-180" name="__codelineno-0-180"></a>
-<a id="__codelineno-0-181" name="__codelineno-0-181"></a><span class="sd">    The `Table` class is expected to be in the `tables` module within the application</span>
-<a id="__codelineno-0-182" name="__codelineno-0-182"></a><span class="sd">    associated with the model and its name is expected to be `{ModelName}Table`.</span>
-<a id="__codelineno-0-183" name="__codelineno-0-183"></a>
-<a id="__codelineno-0-184" name="__codelineno-0-184"></a><span class="sd">    If a matching `Table` is not found, this will return `None`.</span>
+<span class="normal"><a href="#__codelineno-0-192">192</a></span>
+<span class="normal"><a href="#__codelineno-0-193">193</a></span>
+<span class="normal"><a href="#__codelineno-0-194">194</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-180" name="__codelineno-0-180"></a><span class="k">def</span> <span class="nf">get_table_for_model</span><span class="p">(</span><span class="n">model</span><span class="p">):</span>
+<a id="__codelineno-0-181" name="__codelineno-0-181"></a><span class="w">    </span><span class="sd">&quot;&quot;&quot;Return the `Table` class associated with a given `model`.</span>
+<a id="__codelineno-0-182" name="__codelineno-0-182"></a>
+<a id="__codelineno-0-183" name="__codelineno-0-183"></a><span class="sd">    The `Table` class is expected to be in the `tables` module within the application</span>
+<a id="__codelineno-0-184" name="__codelineno-0-184"></a><span class="sd">    associated with the model and its name is expected to be `{ModelName}Table`.</span>
 <a id="__codelineno-0-185" name="__codelineno-0-185"></a>
-<a id="__codelineno-0-186" name="__codelineno-0-186"></a><span class="sd">    Args:</span>
-<a id="__codelineno-0-187" name="__codelineno-0-187"></a><span class="sd">        model (BaseModel): A model class</span>
-<a id="__codelineno-0-188" name="__codelineno-0-188"></a>
-<a id="__codelineno-0-189" name="__codelineno-0-189"></a><span class="sd">    Returns:</span>
-<a id="__codelineno-0-190" name="__codelineno-0-190"></a><span class="sd">        (Union[Table, None]): Either the `Table` class or `None`</span>
-<a id="__codelineno-0-191" name="__codelineno-0-191"></a><span class="sd">    &quot;&quot;&quot;</span>
-<a id="__codelineno-0-192" name="__codelineno-0-192"></a>    <span class="k">return</span> <span class="n">get_related_class_for_model</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">module_name</span><span class="o">=</span><span class="s2">&quot;tables&quot;</span><span class="p">,</span> <span class="n">object_suffix</span><span class="o">=</span><span class="s2">&quot;Table&quot;</span><span class="p">)</span>
+<a id="__codelineno-0-186" name="__codelineno-0-186"></a><span class="sd">    If a matching `Table` is not found, this will return `None`.</span>
+<a id="__codelineno-0-187" name="__codelineno-0-187"></a>
+<a id="__codelineno-0-188" name="__codelineno-0-188"></a><span class="sd">    Args:</span>
+<a id="__codelineno-0-189" name="__codelineno-0-189"></a><span class="sd">        model (BaseModel): A model class</span>
+<a id="__codelineno-0-190" name="__codelineno-0-190"></a>
+<a id="__codelineno-0-191" name="__codelineno-0-191"></a><span class="sd">    Returns:</span>
+<a id="__codelineno-0-192" name="__codelineno-0-192"></a><span class="sd">        (Union[Table, None]): Either the `Table` class or `None`</span>
+<a id="__codelineno-0-193" name="__codelineno-0-193"></a><span class="sd">    &quot;&quot;&quot;</span>
+<a id="__codelineno-0-194" name="__codelineno-0-194"></a>    <span class="k">return</span> <span class="n">get_related_class_for_model</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">module_name</span><span class="o">=</span><span class="s2">&quot;tables&quot;</span><span class="p">,</span> <span class="n">object_suffix</span><span class="o">=</span><span class="s2">&quot;Table&quot;</span><span class="p">)</span>
+</code></pre></div></td></tr></table></div>
+          </details>
+  </div>
+
+</div>
+
+
+<div class="doc doc-object doc-function">
+
+
+
+<h2 id="nautobot.apps.utils.get_url_for_url_pattern" 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">utils</span><span class="o">.</span><span class="n">get_url_for_url_pattern</span><span class="p">(</span><span class="n">url_pattern</span><span class="p">)</span></code>
+
+<a href="#nautobot.apps.utils.get_url_for_url_pattern" class="headerlink" title="Permanent link">&para;</a></h2>
+
+
+  <div class="doc doc-contents ">
+  
+      <p>Given a URL pattern, construct a URL string that would match that pattern.</p>
+
+
+
+<p><strong>Examples:</strong></p>
+    <div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="gp">&gt;&gt;&gt; </span><span class="n">get_url_for_url_pattern</span><span class="p">(</span><span class="s2">&quot;/plugins/example-plugin/^models/(?P&lt;pk&gt;[^/.]+)/$&quot;</span><span class="p">)</span>
+<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="go">&#39;/plugins/example-plugin/models/00000000-0000-0000-0000-000000000000/&#39;</span>
+<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="gp">&gt;&gt;&gt; </span><span class="n">get_url_for_url_pattern</span><span class="p">(</span><span class="s2">&quot;/circuits/circuit-terminations/&lt;uuid:termination_a_id&gt;/connect/&lt;str:termination_b_type&gt;/&quot;</span><span class="p">)</span>
+<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a><span class="go">&#39;/circuits/circuit-terminations/00000000-0000-0000-0000-000000000000/connect/string/&#39;</span>
+</code></pre></div>
+
+          <details class="quote">
+            <summary>Source code in <code>nautobot/core/utils/lookup.py</code></summary>
+            <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-300">300</a></span>
+<span class="normal"><a href="#__codelineno-0-301">301</a></span>
+<span class="normal"><a href="#__codelineno-0-302">302</a></span>
+<span class="normal"><a href="#__codelineno-0-303">303</a></span>
+<span class="normal"><a href="#__codelineno-0-304">304</a></span>
+<span class="normal"><a href="#__codelineno-0-305">305</a></span>
+<span class="normal"><a href="#__codelineno-0-306">306</a></span>
+<span class="normal"><a href="#__codelineno-0-307">307</a></span>
+<span class="normal"><a href="#__codelineno-0-308">308</a></span>
+<span class="normal"><a href="#__codelineno-0-309">309</a></span>
+<span class="normal"><a href="#__codelineno-0-310">310</a></span>
+<span class="normal"><a href="#__codelineno-0-311">311</a></span>
+<span class="normal"><a href="#__codelineno-0-312">312</a></span>
+<span class="normal"><a href="#__codelineno-0-313">313</a></span>
+<span class="normal"><a href="#__codelineno-0-314">314</a></span>
+<span class="normal"><a href="#__codelineno-0-315">315</a></span>
+<span class="normal"><a href="#__codelineno-0-316">316</a></span>
+<span class="normal"><a href="#__codelineno-0-317">317</a></span>
+<span class="normal"><a href="#__codelineno-0-318">318</a></span>
+<span class="normal"><a href="#__codelineno-0-319">319</a></span>
+<span class="normal"><a href="#__codelineno-0-320">320</a></span>
+<span class="normal"><a href="#__codelineno-0-321">321</a></span>
+<span class="normal"><a href="#__codelineno-0-322">322</a></span>
+<span class="normal"><a href="#__codelineno-0-323">323</a></span>
+<span class="normal"><a href="#__codelineno-0-324">324</a></span>
+<span class="normal"><a href="#__codelineno-0-325">325</a></span>
+<span class="normal"><a href="#__codelineno-0-326">326</a></span>
+<span class="normal"><a href="#__codelineno-0-327">327</a></span>
+<span class="normal"><a href="#__codelineno-0-328">328</a></span>
+<span class="normal"><a href="#__codelineno-0-329">329</a></span>
+<span class="normal"><a href="#__codelineno-0-330">330</a></span>
+<span class="normal"><a href="#__codelineno-0-331">331</a></span>
+<span class="normal"><a href="#__codelineno-0-332">332</a></span>
+<span class="normal"><a href="#__codelineno-0-333">333</a></span>
+<span class="normal"><a href="#__codelineno-0-334">334</a></span>
+<span class="normal"><a href="#__codelineno-0-335">335</a></span>
+<span class="normal"><a href="#__codelineno-0-336">336</a></span>
+<span class="normal"><a href="#__codelineno-0-337">337</a></span>
+<span class="normal"><a href="#__codelineno-0-338">338</a></span>
+<span class="normal"><a href="#__codelineno-0-339">339</a></span>
+<span class="normal"><a href="#__codelineno-0-340">340</a></span>
+<span class="normal"><a href="#__codelineno-0-341">341</a></span>
+<span class="normal"><a href="#__codelineno-0-342">342</a></span>
+<span class="normal"><a href="#__codelineno-0-343">343</a></span>
+<span class="normal"><a href="#__codelineno-0-344">344</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-300" name="__codelineno-0-300"></a><span class="k">def</span> <span class="nf">get_url_for_url_pattern</span><span class="p">(</span><span class="n">url_pattern</span><span class="p">):</span>
+<a id="__codelineno-0-301" name="__codelineno-0-301"></a><span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
+<a id="__codelineno-0-302" name="__codelineno-0-302"></a><span class="sd">    Given a URL pattern, construct a URL string that would match that pattern.</span>
+<a id="__codelineno-0-303" name="__codelineno-0-303"></a>
+<a id="__codelineno-0-304" name="__codelineno-0-304"></a><span class="sd">    Examples:</span>
+<a id="__codelineno-0-305" name="__codelineno-0-305"></a><span class="sd">        &gt;&gt;&gt; get_url_for_url_pattern(&quot;/plugins/example-plugin/^models/(?P&lt;pk&gt;[^/.]+)/$&quot;)</span>
+<a id="__codelineno-0-306" name="__codelineno-0-306"></a><span class="sd">        &#39;/plugins/example-plugin/models/00000000-0000-0000-0000-000000000000/&#39;</span>
+<a id="__codelineno-0-307" name="__codelineno-0-307"></a><span class="sd">        &gt;&gt;&gt; get_url_for_url_pattern(&quot;/circuits/circuit-terminations/&lt;uuid:termination_a_id&gt;/connect/&lt;str:termination_b_type&gt;/&quot;)</span>
+<a id="__codelineno-0-308" name="__codelineno-0-308"></a><span class="sd">        &#39;/circuits/circuit-terminations/00000000-0000-0000-0000-000000000000/connect/string/&#39;</span>
+<a id="__codelineno-0-309" name="__codelineno-0-309"></a><span class="sd">    &quot;&quot;&quot;</span>
+<a id="__codelineno-0-310" name="__codelineno-0-310"></a>    <span class="n">url</span> <span class="o">=</span> <span class="n">url_pattern</span>
+<a id="__codelineno-0-311" name="__codelineno-0-311"></a>    <span class="c1"># Fixup tokens in path-style &quot;classic&quot; view URLs:</span>
+<a id="__codelineno-0-312" name="__codelineno-0-312"></a>    <span class="c1"># &quot;/admin/users/user/&lt;id&gt;/password/&quot;</span>
+<a id="__codelineno-0-313" name="__codelineno-0-313"></a>    <span class="n">url</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="sa">r</span><span class="s2">&quot;&lt;id&gt;&quot;</span><span class="p">,</span> <span class="s2">&quot;00000000-0000-0000-0000-000000000000&quot;</span><span class="p">,</span> <span class="n">url</span><span class="p">)</span>
+<a id="__codelineno-0-314" name="__codelineno-0-314"></a>    <span class="c1"># &quot;/silk/request/&lt;uuid:request_id&gt;/profile/&lt;int:profile_id&gt;/&quot;</span>
+<a id="__codelineno-0-315" name="__codelineno-0-315"></a>    <span class="n">url</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="sa">r</span><span class="s2">&quot;&lt;int:\w+&gt;&quot;</span><span class="p">,</span> <span class="s2">&quot;1&quot;</span><span class="p">,</span> <span class="n">url</span><span class="p">)</span>
+<a id="__codelineno-0-316" name="__codelineno-0-316"></a>    <span class="c1"># &quot;/admin/admin/logentry/&lt;path:object_id&gt;/&quot;</span>
+<a id="__codelineno-0-317" name="__codelineno-0-317"></a>    <span class="n">url</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="sa">r</span><span class="s2">&quot;&lt;path:\w+&gt;&quot;</span><span class="p">,</span> <span class="s2">&quot;1&quot;</span><span class="p">,</span> <span class="n">url</span><span class="p">)</span>
+<a id="__codelineno-0-318" name="__codelineno-0-318"></a>    <span class="c1"># &quot;/dcim/sites/&lt;slug:slug&gt;/&quot;</span>
+<a id="__codelineno-0-319" name="__codelineno-0-319"></a>    <span class="n">url</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="sa">r</span><span class="s2">&quot;&lt;slug:\w+&gt;&quot;</span><span class="p">,</span> <span class="s2">&quot;slug&quot;</span><span class="p">,</span> <span class="n">url</span><span class="p">)</span>
+<a id="__codelineno-0-320" name="__codelineno-0-320"></a>    <span class="c1"># &quot;/apps/installed-apps/&lt;str:app&gt;/&quot;</span>
+<a id="__codelineno-0-321" name="__codelineno-0-321"></a>    <span class="n">url</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="sa">r</span><span class="s2">&quot;&lt;str:\w+&gt;&quot;</span><span class="p">,</span> <span class="s2">&quot;string&quot;</span><span class="p">,</span> <span class="n">url</span><span class="p">)</span>
+<a id="__codelineno-0-322" name="__codelineno-0-322"></a>    <span class="c1"># &quot;/dcim/locations/&lt;uuid:pk&gt;/&quot;</span>
+<a id="__codelineno-0-323" name="__codelineno-0-323"></a>    <span class="n">url</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="sa">r</span><span class="s2">&quot;&lt;uuid:\w+&gt;&quot;</span><span class="p">,</span> <span class="s2">&quot;00000000-0000-0000-0000-000000000000&quot;</span><span class="p">,</span> <span class="n">url</span><span class="p">)</span>
+<a id="__codelineno-0-324" name="__codelineno-0-324"></a>    <span class="c1"># tokens in regexp-style router urls, including REST and NautobotUIViewSet:</span>
+<a id="__codelineno-0-325" name="__codelineno-0-325"></a>    <span class="c1"># &quot;/extras/^external-integrations/(?P&lt;pk&gt;[^/.]+)/$&quot;</span>
+<a id="__codelineno-0-326" name="__codelineno-0-326"></a>    <span class="c1"># &quot;/api/virtualization/^interfaces/(?P&lt;pk&gt;[^/.]+)/$&quot;</span>
+<a id="__codelineno-0-327" name="__codelineno-0-327"></a>    <span class="c1"># &quot;/api/virtualization/^interfaces/(?P&lt;pk&gt;[^/.]+)\\.(?P&lt;format&gt;[a-z0-9]+)/?$&quot;</span>
+<a id="__codelineno-0-328" name="__codelineno-0-328"></a>    <span class="n">url</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="sa">r</span><span class="s2">&quot;[$^]&quot;</span><span class="p">,</span> <span class="s2">&quot;&quot;</span><span class="p">,</span> <span class="n">url</span><span class="p">)</span>
+<a id="__codelineno-0-329" name="__codelineno-0-329"></a>    <span class="n">url</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="sa">r</span><span class="s2">&quot;/\?&quot;</span><span class="p">,</span> <span class="s2">&quot;/&quot;</span><span class="p">,</span> <span class="n">url</span><span class="p">)</span>
+<a id="__codelineno-0-330" name="__codelineno-0-330"></a>    <span class="n">url</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="sa">r</span><span class="s2">&quot;\(\?P&lt;app_label&gt;[^)]+\)&quot;</span><span class="p">,</span> <span class="s2">&quot;users&quot;</span><span class="p">,</span> <span class="n">url</span><span class="p">)</span>
+<a id="__codelineno-0-331" name="__codelineno-0-331"></a>    <span class="n">url</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="sa">r</span><span class="s2">&quot;\(\?P&lt;class_path&gt;[^)]+\)&quot;</span><span class="p">,</span> <span class="s2">&quot;foo/bar/baz&quot;</span><span class="p">,</span> <span class="n">url</span><span class="p">)</span>
+<a id="__codelineno-0-332" name="__codelineno-0-332"></a>    <span class="n">url</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="sa">r</span><span class="s2">&quot;\(\?P&lt;format&gt;[^)]+\)&quot;</span><span class="p">,</span> <span class="s2">&quot;json&quot;</span><span class="p">,</span> <span class="n">url</span><span class="p">)</span>
+<a id="__codelineno-0-333" name="__codelineno-0-333"></a>    <span class="n">url</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="sa">r</span><span class="s2">&quot;\(\?P&lt;name&gt;[^)]+\)&quot;</span><span class="p">,</span> <span class="s2">&quot;string&quot;</span><span class="p">,</span> <span class="n">url</span><span class="p">)</span>
+<a id="__codelineno-0-334" name="__codelineno-0-334"></a>    <span class="n">url</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="sa">r</span><span class="s2">&quot;\(\?P&lt;pk&gt;[^)]+\)&quot;</span><span class="p">,</span> <span class="s2">&quot;00000000-0000-0000-0000-000000000000&quot;</span><span class="p">,</span> <span class="n">url</span><span class="p">)</span>
+<a id="__codelineno-0-335" name="__codelineno-0-335"></a>    <span class="n">url</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="sa">r</span><span class="s2">&quot;\(\?P&lt;slug&gt;[^)]+\)&quot;</span><span class="p">,</span> <span class="s2">&quot;string&quot;</span><span class="p">,</span> <span class="n">url</span><span class="p">)</span>
+<a id="__codelineno-0-336" name="__codelineno-0-336"></a>    <span class="n">url</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="sa">r</span><span class="s2">&quot;\(\?P&lt;url&gt;[^)]+\)&quot;</span><span class="p">,</span> <span class="s2">&quot;any&quot;</span><span class="p">,</span> <span class="n">url</span><span class="p">)</span>
+<a id="__codelineno-0-337" name="__codelineno-0-337"></a>    <span class="c1"># Fallthru for generic URL parameters</span>
+<a id="__codelineno-0-338" name="__codelineno-0-338"></a>    <span class="n">url</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="sa">r</span><span class="s2">&quot;\(\?P&lt;\w+&gt;[^)]+\)\??&quot;</span><span class="p">,</span> <span class="s2">&quot;unknown&quot;</span><span class="p">,</span> <span class="n">url</span><span class="p">)</span>
+<a id="__codelineno-0-339" name="__codelineno-0-339"></a>    <span class="n">url</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">sub</span><span class="p">(</span><span class="sa">r</span><span class="s2">&quot;</span><span class="se">\\</span><span class="s2">&quot;</span><span class="p">,</span> <span class="s2">&quot;&quot;</span><span class="p">,</span> <span class="n">url</span><span class="p">)</span>
+<a id="__codelineno-0-340" name="__codelineno-0-340"></a>
+<a id="__codelineno-0-341" name="__codelineno-0-341"></a>    <span class="k">if</span> <span class="nb">any</span><span class="p">(</span><span class="n">char</span> <span class="ow">in</span> <span class="n">url</span> <span class="k">for</span> <span class="n">char</span> <span class="ow">in</span> <span class="s2">&quot;&lt;&gt;[]()?+^$&quot;</span><span class="p">):</span>
+<a id="__codelineno-0-342" name="__codelineno-0-342"></a>        <span class="k">raise</span> <span class="ne">RuntimeError</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Unhandled token in URL </span><span class="si">{</span><span class="n">url</span><span class="si">}</span><span class="s2"> derived from </span><span class="si">{</span><span class="n">url_pattern</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
+<a id="__codelineno-0-343" name="__codelineno-0-343"></a>
+<a id="__codelineno-0-344" name="__codelineno-0-344"></a>    <span class="k">return</span> <span class="n">url</span>
+</code></pre></div></td></tr></table></div>
+          </details>
+  </div>
+
+</div>
+
+
+<div class="doc doc-object doc-function">
+
+
+
+<h2 id="nautobot.apps.utils.get_url_patterns" 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">utils</span><span class="o">.</span><span class="n">get_url_patterns</span><span class="p">(</span><span class="n">urlconf</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">patterns_list</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">base_path</span><span class="o">=</span><span class="s1">&#39;/&#39;</span><span class="p">)</span></code>
+
+<a href="#nautobot.apps.utils.get_url_patterns" class="headerlink" title="Permanent link">&para;</a></h2>
+
+
+  <div class="doc doc-contents ">
+  
+      <p>Recursively yield a list of registered URL patterns.</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>urlconf</code></td>
+          <td>
+                <code>URLConf</code>
+          </td>
+          <td>
+            <div class="doc-md-description">
+              <p>Python module such as <code>nautobot.core.urls</code>.
+Default if unspecified is the value of <code>settings.ROOT_URLCONF</code>, i.e. the <code>nautobot.core.urls</code> module.</p>
+            </div>
+          </td>
+          <td>
+                <code>None</code>
+          </td>
+        </tr>
+        <tr>
+          <td><code>patterns_list</code></td>
+          <td>
+                <code>list</code>
+          </td>
+          <td>
+            <div class="doc-md-description">
+              <p>Used in recursion. Generally can be omitted on initial call.
+Default if unspecified is the <code>url_patterns</code> attribute of the given <code>urlconf</code> module.</p>
+            </div>
+          </td>
+          <td>
+                <code>None</code>
+          </td>
+        </tr>
+        <tr>
+          <td><code>base_path</code></td>
+          <td>
+                <code>str</code>
+          </td>
+          <td>
+            <div class="doc-md-description">
+              <p>String to prepend to all URL patterns yielded.
+Default if unspecified is the string <code>"/"</code>.</p>
+            </div>
+          </td>
+          <td>
+                <code>&#39;/&#39;</code>
+          </td>
+        </tr>
+    </tbody>
+  </table>
+
+
+
+  <p><strong>Yields:</strong></p>
+  <table>
+    <thead>
+      <tr>
+        <th>Type</th>
+        <th>Description</th>
+      </tr>
+    </thead>
+    <tbody>
+        <tr>
+          <td>
+                <code>str</code>
+          </td>
+          <td>
+            <div class="doc-md-description">
+              <p>Each URL pattern defined in the given urlconf and its descendants</p>
+            </div>
+          </td>
+        </tr>
+    </tbody>
+  </table>
+
+
+
+<p><strong>Examples:</strong></p>
+    <div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="gp">&gt;&gt;&gt; </span><span class="n">generator</span> <span class="o">=</span> <span class="n">get_url_patterns</span><span class="p">()</span>
+<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="gp">&gt;&gt;&gt; </span><span class="nb">next</span><span class="p">(</span><span class="n">generator</span><span class="p">)</span>
+<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="go">&#39;/&#39;</span>
+<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a><span class="gp">&gt;&gt;&gt; </span><span class="nb">next</span><span class="p">(</span><span class="n">generator</span><span class="p">)</span>
+<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a><span class="go">&#39;/search/&#39;</span>
+<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a><span class="gp">&gt;&gt;&gt; </span><span class="nb">next</span><span class="p">(</span><span class="n">generator</span><span class="p">)</span>
+<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a><span class="go">&#39;/login/&#39;</span>
+<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a><span class="gp">&gt;&gt;&gt; </span><span class="nb">next</span><span class="p">(</span><span class="n">generator</span><span class="p">)</span>
+<a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a><span class="go">&#39;/logout/&#39;</span>
+<a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a><span class="gp">&gt;&gt;&gt; </span><span class="nb">next</span><span class="p">(</span><span class="n">generator</span><span class="p">)</span>
+<a id="__codelineno-0-11" name="__codelineno-0-11" href="#__codelineno-0-11"></a><span class="go">&#39;/circuits/circuits/&lt;uuid:pk&gt;/terminations/swap/&#39;</span>
+</code></pre></div>
+    <div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="gp">&gt;&gt;&gt; </span><span class="kn">import</span> <span class="nn">example_plugin.urls</span> <span class="k">as</span> <span class="nn">example_urls</span>
+<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="gp">&gt;&gt;&gt; </span><span class="k">for</span> <span class="n">url_pattern</span> <span class="ow">in</span> <span class="n">get_url_patterns</span><span class="p">(</span><span class="n">example_urls</span><span class="p">,</span> <span class="n">base_path</span><span class="o">=</span><span class="s2">&quot;/plugins/example-plugin/&quot;</span><span class="p">):</span>
+<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="gp">... </span>    <span class="nb">print</span><span class="p">(</span><span class="n">url_pattern</span><span class="p">)</span>
+<a id="__codelineno-0-4" name="__codelineno-0-4" href="#__codelineno-0-4"></a><span class="gp">...</span>
+<a id="__codelineno-0-5" name="__codelineno-0-5" href="#__codelineno-0-5"></a><span class="go">/plugins/example-plugin/</span>
+<a id="__codelineno-0-6" name="__codelineno-0-6" href="#__codelineno-0-6"></a><span class="go">/plugins/example-plugin/config/</span>
+<a id="__codelineno-0-7" name="__codelineno-0-7" href="#__codelineno-0-7"></a><span class="go">/plugins/example-plugin/models/&lt;uuid:pk&gt;/dynamic-groups/</span>
+<a id="__codelineno-0-8" name="__codelineno-0-8" href="#__codelineno-0-8"></a><span class="go">/plugins/example-plugin/other-models/&lt;uuid:pk&gt;/dynamic-groups/</span>
+<a id="__codelineno-0-9" name="__codelineno-0-9" href="#__codelineno-0-9"></a><span class="go">/plugins/example-plugin/docs/</span>
+<a id="__codelineno-0-10" name="__codelineno-0-10" href="#__codelineno-0-10"></a><span class="go">/plugins/example-plugin/circuits/&lt;uuid:pk&gt;/example-plugin-tab/</span>
+<a id="__codelineno-0-11" name="__codelineno-0-11" href="#__codelineno-0-11"></a><span class="go">/plugins/example-plugin/devices/&lt;uuid:pk&gt;/example-plugin-tab-1/</span>
+<a id="__codelineno-0-12" name="__codelineno-0-12" href="#__codelineno-0-12"></a><span class="go">/plugins/example-plugin/devices/&lt;uuid:pk&gt;/example-plugin-tab-2/</span>
+<a id="__codelineno-0-13" name="__codelineno-0-13" href="#__codelineno-0-13"></a><span class="go">/plugins/example-plugin/override-target/</span>
+<a id="__codelineno-0-14" name="__codelineno-0-14" href="#__codelineno-0-14"></a><span class="go">/plugins/example-plugin/^models/$</span>
+<a id="__codelineno-0-15" name="__codelineno-0-15" href="#__codelineno-0-15"></a><span class="go">/plugins/example-plugin/^models/add/$</span>
+<a id="__codelineno-0-16" name="__codelineno-0-16" href="#__codelineno-0-16"></a><span class="go">/plugins/example-plugin/^models/import/$</span>
+<a id="__codelineno-0-17" name="__codelineno-0-17" href="#__codelineno-0-17"></a><span class="go">/plugins/example-plugin/^models/edit/$</span>
+<a id="__codelineno-0-18" name="__codelineno-0-18" href="#__codelineno-0-18"></a><span class="go">/plugins/example-plugin/^models/delete/$</span>
+<a id="__codelineno-0-19" name="__codelineno-0-19" href="#__codelineno-0-19"></a><span class="go">/plugins/example-plugin/^models/all-names/$</span>
+<a id="__codelineno-0-20" name="__codelineno-0-20" href="#__codelineno-0-20"></a><span class="go">/plugins/example-plugin/^models/(?P&lt;pk&gt;[^/.]+)/$</span>
+<a id="__codelineno-0-21" name="__codelineno-0-21" href="#__codelineno-0-21"></a><span class="go">/plugins/example-plugin/^models/(?P&lt;pk&gt;[^/.]+)/delete/$</span>
+<a id="__codelineno-0-22" name="__codelineno-0-22" href="#__codelineno-0-22"></a><span class="go">/plugins/example-plugin/^models/(?P&lt;pk&gt;[^/.]+)/edit/$</span>
+<a id="__codelineno-0-23" name="__codelineno-0-23" href="#__codelineno-0-23"></a><span class="go">/plugins/example-plugin/^models/(?P&lt;pk&gt;[^/.]+)/changelog/$</span>
+<a id="__codelineno-0-24" name="__codelineno-0-24" href="#__codelineno-0-24"></a><span class="go">/plugins/example-plugin/^models/(?P&lt;pk&gt;[^/.]+)/notes/$</span>
+<a id="__codelineno-0-25" name="__codelineno-0-25" href="#__codelineno-0-25"></a><span class="go">/plugins/example-plugin/^other-models/$</span>
+<a id="__codelineno-0-26" name="__codelineno-0-26" href="#__codelineno-0-26"></a><span class="go">/plugins/example-plugin/^other-models/add/$</span>
+<a id="__codelineno-0-27" name="__codelineno-0-27" href="#__codelineno-0-27"></a><span class="go">/plugins/example-plugin/^other-models/edit/$</span>
+<a id="__codelineno-0-28" name="__codelineno-0-28" href="#__codelineno-0-28"></a><span class="go">/plugins/example-plugin/^other-models/delete/$</span>
+<a id="__codelineno-0-29" name="__codelineno-0-29" href="#__codelineno-0-29"></a><span class="go">/plugins/example-plugin/^other-models/(?P&lt;pk&gt;[^/.]+)/$</span>
+<a id="__codelineno-0-30" name="__codelineno-0-30" href="#__codelineno-0-30"></a><span class="go">/plugins/example-plugin/^other-models/(?P&lt;pk&gt;[^/.]+)/delete/$</span>
+<a id="__codelineno-0-31" name="__codelineno-0-31" href="#__codelineno-0-31"></a><span class="go">/plugins/example-plugin/^other-models/(?P&lt;pk&gt;[^/.]+)/edit/$</span>
+<a id="__codelineno-0-32" name="__codelineno-0-32" href="#__codelineno-0-32"></a><span class="go">/plugins/example-plugin/^other-models/(?P&lt;pk&gt;[^/.]+)/changelog/$</span>
+<a id="__codelineno-0-33" name="__codelineno-0-33" href="#__codelineno-0-33"></a><span class="go">/plugins/example-plugin/^other-models/(?P&lt;pk&gt;[^/.]+)/notes/$</span>
+</code></pre></div>
+
+          <details class="quote">
+            <summary>Source code in <code>nautobot/core/utils/lookup.py</code></summary>
+            <div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span></span><span class="normal"><a href="#__codelineno-0-225">225</a></span>
+<span class="normal"><a href="#__codelineno-0-226">226</a></span>
+<span class="normal"><a href="#__codelineno-0-227">227</a></span>
+<span class="normal"><a href="#__codelineno-0-228">228</a></span>
+<span class="normal"><a href="#__codelineno-0-229">229</a></span>
+<span class="normal"><a href="#__codelineno-0-230">230</a></span>
+<span class="normal"><a href="#__codelineno-0-231">231</a></span>
+<span class="normal"><a href="#__codelineno-0-232">232</a></span>
+<span class="normal"><a href="#__codelineno-0-233">233</a></span>
+<span class="normal"><a href="#__codelineno-0-234">234</a></span>
+<span class="normal"><a href="#__codelineno-0-235">235</a></span>
+<span class="normal"><a href="#__codelineno-0-236">236</a></span>
+<span class="normal"><a href="#__codelineno-0-237">237</a></span>
+<span class="normal"><a href="#__codelineno-0-238">238</a></span>
+<span class="normal"><a href="#__codelineno-0-239">239</a></span>
+<span class="normal"><a href="#__codelineno-0-240">240</a></span>
+<span class="normal"><a href="#__codelineno-0-241">241</a></span>
+<span class="normal"><a href="#__codelineno-0-242">242</a></span>
+<span class="normal"><a href="#__codelineno-0-243">243</a></span>
+<span class="normal"><a href="#__codelineno-0-244">244</a></span>
+<span class="normal"><a href="#__codelineno-0-245">245</a></span>
+<span class="normal"><a href="#__codelineno-0-246">246</a></span>
+<span class="normal"><a href="#__codelineno-0-247">247</a></span>
+<span class="normal"><a href="#__codelineno-0-248">248</a></span>
+<span class="normal"><a href="#__codelineno-0-249">249</a></span>
+<span class="normal"><a href="#__codelineno-0-250">250</a></span>
+<span class="normal"><a href="#__codelineno-0-251">251</a></span>
+<span class="normal"><a href="#__codelineno-0-252">252</a></span>
+<span class="normal"><a href="#__codelineno-0-253">253</a></span>
+<span class="normal"><a href="#__codelineno-0-254">254</a></span>
+<span class="normal"><a href="#__codelineno-0-255">255</a></span>
+<span class="normal"><a href="#__codelineno-0-256">256</a></span>
+<span class="normal"><a href="#__codelineno-0-257">257</a></span>
+<span class="normal"><a href="#__codelineno-0-258">258</a></span>
+<span class="normal"><a href="#__codelineno-0-259">259</a></span>
+<span class="normal"><a href="#__codelineno-0-260">260</a></span>
+<span class="normal"><a href="#__codelineno-0-261">261</a></span>
+<span class="normal"><a href="#__codelineno-0-262">262</a></span>
+<span class="normal"><a href="#__codelineno-0-263">263</a></span>
+<span class="normal"><a href="#__codelineno-0-264">264</a></span>
+<span class="normal"><a href="#__codelineno-0-265">265</a></span>
+<span class="normal"><a href="#__codelineno-0-266">266</a></span>
+<span class="normal"><a href="#__codelineno-0-267">267</a></span>
+<span class="normal"><a href="#__codelineno-0-268">268</a></span>
+<span class="normal"><a href="#__codelineno-0-269">269</a></span>
+<span class="normal"><a href="#__codelineno-0-270">270</a></span>
+<span class="normal"><a href="#__codelineno-0-271">271</a></span>
+<span class="normal"><a href="#__codelineno-0-272">272</a></span>
+<span class="normal"><a href="#__codelineno-0-273">273</a></span>
+<span class="normal"><a href="#__codelineno-0-274">274</a></span>
+<span class="normal"><a href="#__codelineno-0-275">275</a></span>
+<span class="normal"><a href="#__codelineno-0-276">276</a></span>
+<span class="normal"><a href="#__codelineno-0-277">277</a></span>
+<span class="normal"><a href="#__codelineno-0-278">278</a></span>
+<span class="normal"><a href="#__codelineno-0-279">279</a></span>
+<span class="normal"><a href="#__codelineno-0-280">280</a></span>
+<span class="normal"><a href="#__codelineno-0-281">281</a></span>
+<span class="normal"><a href="#__codelineno-0-282">282</a></span>
+<span class="normal"><a href="#__codelineno-0-283">283</a></span>
+<span class="normal"><a href="#__codelineno-0-284">284</a></span>
+<span class="normal"><a href="#__codelineno-0-285">285</a></span>
+<span class="normal"><a href="#__codelineno-0-286">286</a></span>
+<span class="normal"><a href="#__codelineno-0-287">287</a></span>
+<span class="normal"><a href="#__codelineno-0-288">288</a></span>
+<span class="normal"><a href="#__codelineno-0-289">289</a></span>
+<span class="normal"><a href="#__codelineno-0-290">290</a></span>
+<span class="normal"><a href="#__codelineno-0-291">291</a></span>
+<span class="normal"><a href="#__codelineno-0-292">292</a></span>
+<span class="normal"><a href="#__codelineno-0-293">293</a></span>
+<span class="normal"><a href="#__codelineno-0-294">294</a></span>
+<span class="normal"><a href="#__codelineno-0-295">295</a></span>
+<span class="normal"><a href="#__codelineno-0-296">296</a></span>
+<span class="normal"><a href="#__codelineno-0-297">297</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-225" name="__codelineno-0-225"></a><span class="k">def</span> <span class="nf">get_url_patterns</span><span class="p">(</span><span class="n">urlconf</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">patterns_list</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">base_path</span><span class="o">=</span><span class="s2">&quot;/&quot;</span><span class="p">):</span>
+<a id="__codelineno-0-226" name="__codelineno-0-226"></a><span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
+<a id="__codelineno-0-227" name="__codelineno-0-227"></a><span class="sd">    Recursively yield a list of registered URL patterns.</span>
+<a id="__codelineno-0-228" name="__codelineno-0-228"></a>
+<a id="__codelineno-0-229" name="__codelineno-0-229"></a><span class="sd">    Args:</span>
+<a id="__codelineno-0-230" name="__codelineno-0-230"></a><span class="sd">        urlconf (URLConf): Python module such as `nautobot.core.urls`.</span>
+<a id="__codelineno-0-231" name="__codelineno-0-231"></a><span class="sd">            Default if unspecified is the value of `settings.ROOT_URLCONF`, i.e. the `nautobot.core.urls` module.</span>
+<a id="__codelineno-0-232" name="__codelineno-0-232"></a><span class="sd">        patterns_list (list): Used in recursion. Generally can be omitted on initial call.</span>
+<a id="__codelineno-0-233" name="__codelineno-0-233"></a><span class="sd">            Default if unspecified is the `url_patterns` attribute of the given `urlconf` module.</span>
+<a id="__codelineno-0-234" name="__codelineno-0-234"></a><span class="sd">        base_path (str): String to prepend to all URL patterns yielded.</span>
+<a id="__codelineno-0-235" name="__codelineno-0-235"></a><span class="sd">            Default if unspecified is the string `&quot;/&quot;`.</span>
+<a id="__codelineno-0-236" name="__codelineno-0-236"></a>
+<a id="__codelineno-0-237" name="__codelineno-0-237"></a><span class="sd">    Yields:</span>
+<a id="__codelineno-0-238" name="__codelineno-0-238"></a><span class="sd">        (str): Each URL pattern defined in the given urlconf and its descendants</span>
+<a id="__codelineno-0-239" name="__codelineno-0-239"></a>
+<a id="__codelineno-0-240" name="__codelineno-0-240"></a><span class="sd">    Examples:</span>
+<a id="__codelineno-0-241" name="__codelineno-0-241"></a><span class="sd">        &gt;&gt;&gt; generator = get_url_patterns()</span>
+<a id="__codelineno-0-242" name="__codelineno-0-242"></a><span class="sd">        &gt;&gt;&gt; next(generator)</span>
+<a id="__codelineno-0-243" name="__codelineno-0-243"></a><span class="sd">        &#39;/&#39;</span>
+<a id="__codelineno-0-244" name="__codelineno-0-244"></a><span class="sd">        &gt;&gt;&gt; next(generator)</span>
+<a id="__codelineno-0-245" name="__codelineno-0-245"></a><span class="sd">        &#39;/search/&#39;</span>
+<a id="__codelineno-0-246" name="__codelineno-0-246"></a><span class="sd">        &gt;&gt;&gt; next(generator)</span>
+<a id="__codelineno-0-247" name="__codelineno-0-247"></a><span class="sd">        &#39;/login/&#39;</span>
+<a id="__codelineno-0-248" name="__codelineno-0-248"></a><span class="sd">        &gt;&gt;&gt; next(generator)</span>
+<a id="__codelineno-0-249" name="__codelineno-0-249"></a><span class="sd">        &#39;/logout/&#39;</span>
+<a id="__codelineno-0-250" name="__codelineno-0-250"></a><span class="sd">        &gt;&gt;&gt; next(generator)</span>
+<a id="__codelineno-0-251" name="__codelineno-0-251"></a><span class="sd">        &#39;/circuits/circuits/&lt;uuid:pk&gt;/terminations/swap/&#39;</span>
+<a id="__codelineno-0-252" name="__codelineno-0-252"></a>
+<a id="__codelineno-0-253" name="__codelineno-0-253"></a><span class="sd">        &gt;&gt;&gt; import example_plugin.urls as example_urls</span>
+<a id="__codelineno-0-254" name="__codelineno-0-254"></a><span class="sd">        &gt;&gt;&gt; for url_pattern in get_url_patterns(example_urls, base_path=&quot;/plugins/example-plugin/&quot;):</span>
+<a id="__codelineno-0-255" name="__codelineno-0-255"></a><span class="sd">        ...     print(url_pattern)</span>
+<a id="__codelineno-0-256" name="__codelineno-0-256"></a><span class="sd">        ...</span>
+<a id="__codelineno-0-257" name="__codelineno-0-257"></a><span class="sd">        /plugins/example-plugin/</span>
+<a id="__codelineno-0-258" name="__codelineno-0-258"></a><span class="sd">        /plugins/example-plugin/config/</span>
+<a id="__codelineno-0-259" name="__codelineno-0-259"></a><span class="sd">        /plugins/example-plugin/models/&lt;uuid:pk&gt;/dynamic-groups/</span>
+<a id="__codelineno-0-260" name="__codelineno-0-260"></a><span class="sd">        /plugins/example-plugin/other-models/&lt;uuid:pk&gt;/dynamic-groups/</span>
+<a id="__codelineno-0-261" name="__codelineno-0-261"></a><span class="sd">        /plugins/example-plugin/docs/</span>
+<a id="__codelineno-0-262" name="__codelineno-0-262"></a><span class="sd">        /plugins/example-plugin/circuits/&lt;uuid:pk&gt;/example-plugin-tab/</span>
+<a id="__codelineno-0-263" name="__codelineno-0-263"></a><span class="sd">        /plugins/example-plugin/devices/&lt;uuid:pk&gt;/example-plugin-tab-1/</span>
+<a id="__codelineno-0-264" name="__codelineno-0-264"></a><span class="sd">        /plugins/example-plugin/devices/&lt;uuid:pk&gt;/example-plugin-tab-2/</span>
+<a id="__codelineno-0-265" name="__codelineno-0-265"></a><span class="sd">        /plugins/example-plugin/override-target/</span>
+<a id="__codelineno-0-266" name="__codelineno-0-266"></a><span class="sd">        /plugins/example-plugin/^models/$</span>
+<a id="__codelineno-0-267" name="__codelineno-0-267"></a><span class="sd">        /plugins/example-plugin/^models/add/$</span>
+<a id="__codelineno-0-268" name="__codelineno-0-268"></a><span class="sd">        /plugins/example-plugin/^models/import/$</span>
+<a id="__codelineno-0-269" name="__codelineno-0-269"></a><span class="sd">        /plugins/example-plugin/^models/edit/$</span>
+<a id="__codelineno-0-270" name="__codelineno-0-270"></a><span class="sd">        /plugins/example-plugin/^models/delete/$</span>
+<a id="__codelineno-0-271" name="__codelineno-0-271"></a><span class="sd">        /plugins/example-plugin/^models/all-names/$</span>
+<a id="__codelineno-0-272" name="__codelineno-0-272"></a><span class="sd">        /plugins/example-plugin/^models/(?P&lt;pk&gt;[^/.]+)/$</span>
+<a id="__codelineno-0-273" name="__codelineno-0-273"></a><span class="sd">        /plugins/example-plugin/^models/(?P&lt;pk&gt;[^/.]+)/delete/$</span>
+<a id="__codelineno-0-274" name="__codelineno-0-274"></a><span class="sd">        /plugins/example-plugin/^models/(?P&lt;pk&gt;[^/.]+)/edit/$</span>
+<a id="__codelineno-0-275" name="__codelineno-0-275"></a><span class="sd">        /plugins/example-plugin/^models/(?P&lt;pk&gt;[^/.]+)/changelog/$</span>
+<a id="__codelineno-0-276" name="__codelineno-0-276"></a><span class="sd">        /plugins/example-plugin/^models/(?P&lt;pk&gt;[^/.]+)/notes/$</span>
+<a id="__codelineno-0-277" name="__codelineno-0-277"></a><span class="sd">        /plugins/example-plugin/^other-models/$</span>
+<a id="__codelineno-0-278" name="__codelineno-0-278"></a><span class="sd">        /plugins/example-plugin/^other-models/add/$</span>
+<a id="__codelineno-0-279" name="__codelineno-0-279"></a><span class="sd">        /plugins/example-plugin/^other-models/edit/$</span>
+<a id="__codelineno-0-280" name="__codelineno-0-280"></a><span class="sd">        /plugins/example-plugin/^other-models/delete/$</span>
+<a id="__codelineno-0-281" name="__codelineno-0-281"></a><span class="sd">        /plugins/example-plugin/^other-models/(?P&lt;pk&gt;[^/.]+)/$</span>
+<a id="__codelineno-0-282" name="__codelineno-0-282"></a><span class="sd">        /plugins/example-plugin/^other-models/(?P&lt;pk&gt;[^/.]+)/delete/$</span>
+<a id="__codelineno-0-283" name="__codelineno-0-283"></a><span class="sd">        /plugins/example-plugin/^other-models/(?P&lt;pk&gt;[^/.]+)/edit/$</span>
+<a id="__codelineno-0-284" name="__codelineno-0-284"></a><span class="sd">        /plugins/example-plugin/^other-models/(?P&lt;pk&gt;[^/.]+)/changelog/$</span>
+<a id="__codelineno-0-285" name="__codelineno-0-285"></a><span class="sd">        /plugins/example-plugin/^other-models/(?P&lt;pk&gt;[^/.]+)/notes/$</span>
+<a id="__codelineno-0-286" name="__codelineno-0-286"></a><span class="sd">    &quot;&quot;&quot;</span>
+<a id="__codelineno-0-287" name="__codelineno-0-287"></a>    <span class="k">if</span> <span class="n">urlconf</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
+<a id="__codelineno-0-288" name="__codelineno-0-288"></a>        <span class="n">urlconf</span> <span class="o">=</span> <span class="n">settings</span><span class="o">.</span><span class="n">ROOT_URLCONF</span>
+<a id="__codelineno-0-289" name="__codelineno-0-289"></a>    <span class="k">if</span> <span class="n">patterns_list</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
+<a id="__codelineno-0-290" name="__codelineno-0-290"></a>        <span class="n">patterns_list</span> <span class="o">=</span> <span class="n">get_resolver</span><span class="p">(</span><span class="n">urlconf</span><span class="p">)</span><span class="o">.</span><span class="n">url_patterns</span>
+<a id="__codelineno-0-291" name="__codelineno-0-291"></a>
+<a id="__codelineno-0-292" name="__codelineno-0-292"></a>    <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">patterns_list</span><span class="p">:</span>
+<a id="__codelineno-0-293" name="__codelineno-0-293"></a>        <span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="n">URLPattern</span><span class="p">):</span>
+<a id="__codelineno-0-294" name="__codelineno-0-294"></a>            <span class="k">yield</span> <span class="n">base_path</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">item</span><span class="o">.</span><span class="n">pattern</span><span class="p">)</span>
+<a id="__codelineno-0-295" name="__codelineno-0-295"></a>        <span class="k">elif</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">item</span><span class="p">,</span> <span class="n">URLResolver</span><span class="p">):</span>
+<a id="__codelineno-0-296" name="__codelineno-0-296"></a>            <span class="c1"># Recurse!</span>
+<a id="__codelineno-0-297" name="__codelineno-0-297"></a>            <span class="k">yield from</span> <span class="n">get_url_patterns</span><span class="p">(</span><span class="n">urlconf</span><span class="p">,</span> <span class="n">item</span><span class="o">.</span><span class="n">url_patterns</span><span class="p">,</span> <span class="n">base_path</span> <span class="o">+</span> <span class="nb">str</span><span class="p">(</span><span class="n">item</span><span class="o">.</span><span class="n">pattern</span><span class="p">))</span>
 </code></pre></div></td></tr></table></div>
           </details>
   </div>