nautobot 1.6.31__py3-none-any.whl → 1.6.32__py3-none-any.whl

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

@@ -869,6 +869,68 @@
 
             
           
+            
+              
+  
+  
+  
+    
+    <li class="md-nav__item md-nav__item--nested">
+      
+      
+      
+      
+      <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_5_7" >
+      
+      
+      
+        <label class="md-nav__link" for="__nav_2_5_7" id="__nav_2_5_7_label" tabindex="0">
+          Security
+          <span class="md-nav__icon md-icon"></span>
+        </label>
+      
+      <nav class="md-nav" data-md-level="3" aria-labelledby="__nav_2_5_7_label" aria-expanded="false">
+        <label class="md-nav__title" for="__nav_2_5_7">
+          <span class="md-nav__icon md-icon"></span>
+          Security
+        </label>
+        <ul class="md-nav__list" data-md-scrollfix>
+          
+            
+              
+  
+  
+  
+    <li class="md-nav__item">
+      <a href="../../../administration/security/index.html" class="md-nav__link">
+        Nautobot Security
+      </a>
+    </li>
+  
+
+            
+          
+            
+              
+  
+  
+  
+    <li class="md-nav__item">
+      <a href="../../../administration/security/notices.html" class="md-nav__link">
+        Notices
+      </a>
+    </li>
+  
+
+            
+          
+        </ul>
+      </nav>
+    </li>
+  
+
+            
+          
         </ul>
       </nav>
     </li>
@@ -4117,21 +4179,7 @@
 
           <details class="quote">
             <summary>Source code in <code>nautobot/utilities/utils.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-771">771</a></span>
-<span class="normal"><a href="#__codelineno-0-772">772</a></span>
-<span class="normal"><a href="#__codelineno-0-773">773</a></span>
-<span class="normal"><a href="#__codelineno-0-774">774</a></span>
-<span class="normal"><a href="#__codelineno-0-775">775</a></span>
-<span class="normal"><a href="#__codelineno-0-776">776</a></span>
-<span class="normal"><a href="#__codelineno-0-777">777</a></span>
-<span class="normal"><a href="#__codelineno-0-778">778</a></span>
-<span class="normal"><a href="#__codelineno-0-779">779</a></span>
-<span class="normal"><a href="#__codelineno-0-780">780</a></span>
-<span class="normal"><a href="#__codelineno-0-781">781</a></span>
-<span class="normal"><a href="#__codelineno-0-782">782</a></span>
-<span class="normal"><a href="#__codelineno-0-783">783</a></span>
-<span class="normal"><a href="#__codelineno-0-784">784</a></span>
-<span class="normal"><a href="#__codelineno-0-785">785</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-785">785</a></span>
 <span class="normal"><a href="#__codelineno-0-786">786</a></span>
 <span class="normal"><a href="#__codelineno-0-787">787</a></span>
 <span class="normal"><a href="#__codelineno-0-788">788</a></span>
@@ -4161,51 +4209,65 @@
 <span class="normal"><a href="#__codelineno-0-812">812</a></span>
 <span class="normal"><a href="#__codelineno-0-813">813</a></span>
 <span class="normal"><a href="#__codelineno-0-814">814</a></span>
-<span class="normal"><a href="#__codelineno-0-815">815</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-771" name="__codelineno-0-771"></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-772" name="__codelineno-0-772"></a><span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
-<a id="__codelineno-0-773" name="__codelineno-0-773"></a><span class="sd">    Given a URL pattern, construct a URL string that would match that pattern.</span>
-<a id="__codelineno-0-774" name="__codelineno-0-774"></a>
-<a id="__codelineno-0-775" name="__codelineno-0-775"></a><span class="sd">    Examples:</span>
-<a id="__codelineno-0-776" name="__codelineno-0-776"></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-777" name="__codelineno-0-777"></a><span class="sd">        &#39;/plugins/example-plugin/models/00000000-0000-0000-0000-000000000000/&#39;</span>
-<a id="__codelineno-0-778" name="__codelineno-0-778"></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-779" name="__codelineno-0-779"></a><span class="sd">        &#39;/circuits/circuit-terminations/00000000-0000-0000-0000-000000000000/connect/string/&#39;</span>
-<a id="__codelineno-0-780" name="__codelineno-0-780"></a><span class="sd">    &quot;&quot;&quot;</span>
-<a id="__codelineno-0-781" name="__codelineno-0-781"></a>    <span class="n">url</span> <span class="o">=</span> <span class="n">url_pattern</span>
-<a id="__codelineno-0-782" name="__codelineno-0-782"></a>    <span class="c1"># Fixup tokens in path-style &quot;classic&quot; view URLs:</span>
-<a id="__codelineno-0-783" name="__codelineno-0-783"></a>    <span class="c1"># &quot;/admin/users/user/&lt;id&gt;/password/&quot;</span>
-<a id="__codelineno-0-784" name="__codelineno-0-784"></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-785" name="__codelineno-0-785"></a>    <span class="c1"># &quot;/silk/request/&lt;uuid:request_id&gt;/profile/&lt;int:profile_id&gt;/&quot;</span>
-<a id="__codelineno-0-786" name="__codelineno-0-786"></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-787" name="__codelineno-0-787"></a>    <span class="c1"># &quot;/admin/admin/logentry/&lt;path:object_id&gt;/&quot;</span>
-<a id="__codelineno-0-788" name="__codelineno-0-788"></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-789" name="__codelineno-0-789"></a>    <span class="c1"># &quot;/dcim/sites/&lt;slug:slug&gt;/&quot;</span>
-<a id="__codelineno-0-790" name="__codelineno-0-790"></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-791" name="__codelineno-0-791"></a>    <span class="c1"># &quot;/apps/installed-apps/&lt;str:app&gt;/&quot;</span>
-<a id="__codelineno-0-792" name="__codelineno-0-792"></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-793" name="__codelineno-0-793"></a>    <span class="c1"># &quot;/dcim/locations/&lt;uuid:pk&gt;/&quot;</span>
-<a id="__codelineno-0-794" name="__codelineno-0-794"></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-795" name="__codelineno-0-795"></a>    <span class="c1"># tokens in regexp-style router urls, including REST and NautobotUIViewSet:</span>
-<a id="__codelineno-0-796" name="__codelineno-0-796"></a>    <span class="c1"># &quot;/extras/^external-integrations/(?P&lt;pk&gt;[^/.]+)/$&quot;</span>
-<a id="__codelineno-0-797" name="__codelineno-0-797"></a>    <span class="c1"># &quot;/api/virtualization/^interfaces/(?P&lt;pk&gt;[^/.]+)/$&quot;</span>
-<a id="__codelineno-0-798" name="__codelineno-0-798"></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-799" name="__codelineno-0-799"></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-800" name="__codelineno-0-800"></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-801" name="__codelineno-0-801"></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-802" name="__codelineno-0-802"></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-803" name="__codelineno-0-803"></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-804" name="__codelineno-0-804"></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-805" name="__codelineno-0-805"></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-806" name="__codelineno-0-806"></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-807" name="__codelineno-0-807"></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-808" name="__codelineno-0-808"></a>    <span class="c1"># Fallthru for generic URL parameters</span>
-<a id="__codelineno-0-809" name="__codelineno-0-809"></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-810" name="__codelineno-0-810"></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-811" name="__codelineno-0-811"></a>
-<a id="__codelineno-0-812" name="__codelineno-0-812"></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-813" name="__codelineno-0-813"></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-814" name="__codelineno-0-814"></a>
-<a id="__codelineno-0-815" name="__codelineno-0-815"></a>    <span class="k">return</span> <span class="n">url</span>
+<span class="normal"><a href="#__codelineno-0-815">815</a></span>
+<span class="normal"><a href="#__codelineno-0-816">816</a></span>
+<span class="normal"><a href="#__codelineno-0-817">817</a></span>
+<span class="normal"><a href="#__codelineno-0-818">818</a></span>
+<span class="normal"><a href="#__codelineno-0-819">819</a></span>
+<span class="normal"><a href="#__codelineno-0-820">820</a></span>
+<span class="normal"><a href="#__codelineno-0-821">821</a></span>
+<span class="normal"><a href="#__codelineno-0-822">822</a></span>
+<span class="normal"><a href="#__codelineno-0-823">823</a></span>
+<span class="normal"><a href="#__codelineno-0-824">824</a></span>
+<span class="normal"><a href="#__codelineno-0-825">825</a></span>
+<span class="normal"><a href="#__codelineno-0-826">826</a></span>
+<span class="normal"><a href="#__codelineno-0-827">827</a></span>
+<span class="normal"><a href="#__codelineno-0-828">828</a></span>
+<span class="normal"><a href="#__codelineno-0-829">829</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-785" name="__codelineno-0-785"></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-786" name="__codelineno-0-786"></a><span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
+<a id="__codelineno-0-787" name="__codelineno-0-787"></a><span class="sd">    Given a URL pattern, construct a URL string that would match that pattern.</span>
+<a id="__codelineno-0-788" name="__codelineno-0-788"></a>
+<a id="__codelineno-0-789" name="__codelineno-0-789"></a><span class="sd">    Examples:</span>
+<a id="__codelineno-0-790" name="__codelineno-0-790"></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-791" name="__codelineno-0-791"></a><span class="sd">        &#39;/plugins/example-plugin/models/00000000-0000-0000-0000-000000000000/&#39;</span>
+<a id="__codelineno-0-792" name="__codelineno-0-792"></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-793" name="__codelineno-0-793"></a><span class="sd">        &#39;/circuits/circuit-terminations/00000000-0000-0000-0000-000000000000/connect/string/&#39;</span>
+<a id="__codelineno-0-794" name="__codelineno-0-794"></a><span class="sd">    &quot;&quot;&quot;</span>
+<a id="__codelineno-0-795" name="__codelineno-0-795"></a>    <span class="n">url</span> <span class="o">=</span> <span class="n">url_pattern</span>
+<a id="__codelineno-0-796" name="__codelineno-0-796"></a>    <span class="c1"># Fixup tokens in path-style &quot;classic&quot; view URLs:</span>
+<a id="__codelineno-0-797" name="__codelineno-0-797"></a>    <span class="c1"># &quot;/admin/users/user/&lt;id&gt;/password/&quot;</span>
+<a id="__codelineno-0-798" name="__codelineno-0-798"></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-799" name="__codelineno-0-799"></a>    <span class="c1"># &quot;/silk/request/&lt;uuid:request_id&gt;/profile/&lt;int:profile_id&gt;/&quot;</span>
+<a id="__codelineno-0-800" name="__codelineno-0-800"></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-801" name="__codelineno-0-801"></a>    <span class="c1"># &quot;/admin/admin/logentry/&lt;path:object_id&gt;/&quot;</span>
+<a id="__codelineno-0-802" name="__codelineno-0-802"></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-803" name="__codelineno-0-803"></a>    <span class="c1"># &quot;/dcim/sites/&lt;slug:slug&gt;/&quot;</span>
+<a id="__codelineno-0-804" name="__codelineno-0-804"></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-805" name="__codelineno-0-805"></a>    <span class="c1"># &quot;/apps/installed-apps/&lt;str:app&gt;/&quot;</span>
+<a id="__codelineno-0-806" name="__codelineno-0-806"></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-807" name="__codelineno-0-807"></a>    <span class="c1"># &quot;/dcim/locations/&lt;uuid:pk&gt;/&quot;</span>
+<a id="__codelineno-0-808" name="__codelineno-0-808"></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-809" name="__codelineno-0-809"></a>    <span class="c1"># tokens in regexp-style router urls, including REST and NautobotUIViewSet:</span>
+<a id="__codelineno-0-810" name="__codelineno-0-810"></a>    <span class="c1"># &quot;/extras/^external-integrations/(?P&lt;pk&gt;[^/.]+)/$&quot;</span>
+<a id="__codelineno-0-811" name="__codelineno-0-811"></a>    <span class="c1"># &quot;/api/virtualization/^interfaces/(?P&lt;pk&gt;[^/.]+)/$&quot;</span>
+<a id="__codelineno-0-812" name="__codelineno-0-812"></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-813" name="__codelineno-0-813"></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-814" name="__codelineno-0-814"></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-815" name="__codelineno-0-815"></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-816" name="__codelineno-0-816"></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-817" name="__codelineno-0-817"></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-818" name="__codelineno-0-818"></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-819" name="__codelineno-0-819"></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-820" name="__codelineno-0-820"></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-821" name="__codelineno-0-821"></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-822" name="__codelineno-0-822"></a>    <span class="c1"># Fallthru for generic URL parameters</span>
+<a id="__codelineno-0-823" name="__codelineno-0-823"></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-824" name="__codelineno-0-824"></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-825" name="__codelineno-0-825"></a>
+<a id="__codelineno-0-826" name="__codelineno-0-826"></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-827" name="__codelineno-0-827"></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-828" name="__codelineno-0-828"></a>
+<a id="__codelineno-0-829" name="__codelineno-0-829"></a>    <span class="k">return</span> <span class="n">url</span>
 </code></pre></div></td></tr></table></div>
           </details>
   </div>
@@ -4364,21 +4426,7 @@ Default if unspecified is the string <code>"/"</code>.</p>
 
           <details class="quote">
             <summary>Source code in <code>nautobot/utilities/utils.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-696">696</a></span>
-<span class="normal"><a href="#__codelineno-0-697">697</a></span>
-<span class="normal"><a href="#__codelineno-0-698">698</a></span>
-<span class="normal"><a href="#__codelineno-0-699">699</a></span>
-<span class="normal"><a href="#__codelineno-0-700">700</a></span>
-<span class="normal"><a href="#__codelineno-0-701">701</a></span>
-<span class="normal"><a href="#__codelineno-0-702">702</a></span>
-<span class="normal"><a href="#__codelineno-0-703">703</a></span>
-<span class="normal"><a href="#__codelineno-0-704">704</a></span>
-<span class="normal"><a href="#__codelineno-0-705">705</a></span>
-<span class="normal"><a href="#__codelineno-0-706">706</a></span>
-<span class="normal"><a href="#__codelineno-0-707">707</a></span>
-<span class="normal"><a href="#__codelineno-0-708">708</a></span>
-<span class="normal"><a href="#__codelineno-0-709">709</a></span>
-<span class="normal"><a href="#__codelineno-0-710">710</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-710">710</a></span>
 <span class="normal"><a href="#__codelineno-0-711">711</a></span>
 <span class="normal"><a href="#__codelineno-0-712">712</a></span>
 <span class="normal"><a href="#__codelineno-0-713">713</a></span>
@@ -4436,79 +4484,93 @@ Default if unspecified is the string <code>"/"</code>.</p>
 <span class="normal"><a href="#__codelineno-0-765">765</a></span>
 <span class="normal"><a href="#__codelineno-0-766">766</a></span>
 <span class="normal"><a href="#__codelineno-0-767">767</a></span>
-<span class="normal"><a href="#__codelineno-0-768">768</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-696" name="__codelineno-0-696"></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-697" name="__codelineno-0-697"></a><span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
-<a id="__codelineno-0-698" name="__codelineno-0-698"></a><span class="sd">    Recursively yield a list of registered URL patterns.</span>
-<a id="__codelineno-0-699" name="__codelineno-0-699"></a>
-<a id="__codelineno-0-700" name="__codelineno-0-700"></a><span class="sd">    Args:</span>
-<a id="__codelineno-0-701" name="__codelineno-0-701"></a><span class="sd">        urlconf (URLConf): Python module such as `nautobot.core.urls`.</span>
-<a id="__codelineno-0-702" name="__codelineno-0-702"></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-703" name="__codelineno-0-703"></a><span class="sd">        patterns_list (list): Used in recursion. Generally can be omitted on initial call.</span>
-<a id="__codelineno-0-704" name="__codelineno-0-704"></a><span class="sd">            Default if unspecified is the `url_patterns` attribute of the given `urlconf` module.</span>
-<a id="__codelineno-0-705" name="__codelineno-0-705"></a><span class="sd">        base_path (str): String to prepend to all URL patterns yielded.</span>
-<a id="__codelineno-0-706" name="__codelineno-0-706"></a><span class="sd">            Default if unspecified is the string `&quot;/&quot;`.</span>
-<a id="__codelineno-0-707" name="__codelineno-0-707"></a>
-<a id="__codelineno-0-708" name="__codelineno-0-708"></a><span class="sd">    Yields:</span>
-<a id="__codelineno-0-709" name="__codelineno-0-709"></a><span class="sd">        (str): Each URL pattern defined in the given urlconf and its descendants</span>
-<a id="__codelineno-0-710" name="__codelineno-0-710"></a>
-<a id="__codelineno-0-711" name="__codelineno-0-711"></a><span class="sd">    Examples:</span>
-<a id="__codelineno-0-712" name="__codelineno-0-712"></a><span class="sd">        &gt;&gt;&gt; generator = get_url_patterns()</span>
-<a id="__codelineno-0-713" name="__codelineno-0-713"></a><span class="sd">        &gt;&gt;&gt; next(generator)</span>
-<a id="__codelineno-0-714" name="__codelineno-0-714"></a><span class="sd">        &#39;/&#39;</span>
-<a id="__codelineno-0-715" name="__codelineno-0-715"></a><span class="sd">        &gt;&gt;&gt; next(generator)</span>
-<a id="__codelineno-0-716" name="__codelineno-0-716"></a><span class="sd">        &#39;/search/&#39;</span>
-<a id="__codelineno-0-717" name="__codelineno-0-717"></a><span class="sd">        &gt;&gt;&gt; next(generator)</span>
-<a id="__codelineno-0-718" name="__codelineno-0-718"></a><span class="sd">        &#39;/login/&#39;</span>
-<a id="__codelineno-0-719" name="__codelineno-0-719"></a><span class="sd">        &gt;&gt;&gt; next(generator)</span>
-<a id="__codelineno-0-720" name="__codelineno-0-720"></a><span class="sd">        &#39;/logout/&#39;</span>
-<a id="__codelineno-0-721" name="__codelineno-0-721"></a><span class="sd">        &gt;&gt;&gt; next(generator)</span>
-<a id="__codelineno-0-722" name="__codelineno-0-722"></a><span class="sd">        &#39;/circuits/circuits/&lt;uuid:pk&gt;/terminations/swap/&#39;</span>
-<a id="__codelineno-0-723" name="__codelineno-0-723"></a>
-<a id="__codelineno-0-724" name="__codelineno-0-724"></a><span class="sd">        &gt;&gt;&gt; import example_plugin.urls as example_urls</span>
-<a id="__codelineno-0-725" name="__codelineno-0-725"></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-726" name="__codelineno-0-726"></a><span class="sd">        ...     print(url_pattern)</span>
-<a id="__codelineno-0-727" name="__codelineno-0-727"></a><span class="sd">        ...</span>
-<a id="__codelineno-0-728" name="__codelineno-0-728"></a><span class="sd">        /plugins/example-plugin/</span>
-<a id="__codelineno-0-729" name="__codelineno-0-729"></a><span class="sd">        /plugins/example-plugin/config/</span>
-<a id="__codelineno-0-730" name="__codelineno-0-730"></a><span class="sd">        /plugins/example-plugin/models/&lt;uuid:pk&gt;/dynamic-groups/</span>
-<a id="__codelineno-0-731" name="__codelineno-0-731"></a><span class="sd">        /plugins/example-plugin/other-models/&lt;uuid:pk&gt;/dynamic-groups/</span>
-<a id="__codelineno-0-732" name="__codelineno-0-732"></a><span class="sd">        /plugins/example-plugin/docs/</span>
-<a id="__codelineno-0-733" name="__codelineno-0-733"></a><span class="sd">        /plugins/example-plugin/circuits/&lt;uuid:pk&gt;/example-plugin-tab/</span>
-<a id="__codelineno-0-734" name="__codelineno-0-734"></a><span class="sd">        /plugins/example-plugin/devices/&lt;uuid:pk&gt;/example-plugin-tab-1/</span>
-<a id="__codelineno-0-735" name="__codelineno-0-735"></a><span class="sd">        /plugins/example-plugin/devices/&lt;uuid:pk&gt;/example-plugin-tab-2/</span>
-<a id="__codelineno-0-736" name="__codelineno-0-736"></a><span class="sd">        /plugins/example-plugin/override-target/</span>
-<a id="__codelineno-0-737" name="__codelineno-0-737"></a><span class="sd">        /plugins/example-plugin/^models/$</span>
-<a id="__codelineno-0-738" name="__codelineno-0-738"></a><span class="sd">        /plugins/example-plugin/^models/add/$</span>
-<a id="__codelineno-0-739" name="__codelineno-0-739"></a><span class="sd">        /plugins/example-plugin/^models/import/$</span>
-<a id="__codelineno-0-740" name="__codelineno-0-740"></a><span class="sd">        /plugins/example-plugin/^models/edit/$</span>
-<a id="__codelineno-0-741" name="__codelineno-0-741"></a><span class="sd">        /plugins/example-plugin/^models/delete/$</span>
-<a id="__codelineno-0-742" name="__codelineno-0-742"></a><span class="sd">        /plugins/example-plugin/^models/all-names/$</span>
-<a id="__codelineno-0-743" name="__codelineno-0-743"></a><span class="sd">        /plugins/example-plugin/^models/(?P&lt;pk&gt;[^/.]+)/$</span>
-<a id="__codelineno-0-744" name="__codelineno-0-744"></a><span class="sd">        /plugins/example-plugin/^models/(?P&lt;pk&gt;[^/.]+)/delete/$</span>
-<a id="__codelineno-0-745" name="__codelineno-0-745"></a><span class="sd">        /plugins/example-plugin/^models/(?P&lt;pk&gt;[^/.]+)/edit/$</span>
-<a id="__codelineno-0-746" name="__codelineno-0-746"></a><span class="sd">        /plugins/example-plugin/^models/(?P&lt;pk&gt;[^/.]+)/changelog/$</span>
-<a id="__codelineno-0-747" name="__codelineno-0-747"></a><span class="sd">        /plugins/example-plugin/^models/(?P&lt;pk&gt;[^/.]+)/notes/$</span>
-<a id="__codelineno-0-748" name="__codelineno-0-748"></a><span class="sd">        /plugins/example-plugin/^other-models/$</span>
-<a id="__codelineno-0-749" name="__codelineno-0-749"></a><span class="sd">        /plugins/example-plugin/^other-models/add/$</span>
-<a id="__codelineno-0-750" name="__codelineno-0-750"></a><span class="sd">        /plugins/example-plugin/^other-models/edit/$</span>
-<a id="__codelineno-0-751" name="__codelineno-0-751"></a><span class="sd">        /plugins/example-plugin/^other-models/delete/$</span>
-<a id="__codelineno-0-752" name="__codelineno-0-752"></a><span class="sd">        /plugins/example-plugin/^other-models/(?P&lt;pk&gt;[^/.]+)/$</span>
-<a id="__codelineno-0-753" name="__codelineno-0-753"></a><span class="sd">        /plugins/example-plugin/^other-models/(?P&lt;pk&gt;[^/.]+)/delete/$</span>
-<a id="__codelineno-0-754" name="__codelineno-0-754"></a><span class="sd">        /plugins/example-plugin/^other-models/(?P&lt;pk&gt;[^/.]+)/edit/$</span>
-<a id="__codelineno-0-755" name="__codelineno-0-755"></a><span class="sd">        /plugins/example-plugin/^other-models/(?P&lt;pk&gt;[^/.]+)/changelog/$</span>
-<a id="__codelineno-0-756" name="__codelineno-0-756"></a><span class="sd">        /plugins/example-plugin/^other-models/(?P&lt;pk&gt;[^/.]+)/notes/$</span>
-<a id="__codelineno-0-757" name="__codelineno-0-757"></a><span class="sd">    &quot;&quot;&quot;</span>
-<a id="__codelineno-0-758" name="__codelineno-0-758"></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-759" name="__codelineno-0-759"></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-760" name="__codelineno-0-760"></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-761" name="__codelineno-0-761"></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-762" name="__codelineno-0-762"></a>
-<a id="__codelineno-0-763" name="__codelineno-0-763"></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-764" name="__codelineno-0-764"></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-765" name="__codelineno-0-765"></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-766" name="__codelineno-0-766"></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-767" name="__codelineno-0-767"></a>            <span class="c1"># Recurse!</span>
-<a id="__codelineno-0-768" name="__codelineno-0-768"></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>
+<span class="normal"><a href="#__codelineno-0-768">768</a></span>
+<span class="normal"><a href="#__codelineno-0-769">769</a></span>
+<span class="normal"><a href="#__codelineno-0-770">770</a></span>
+<span class="normal"><a href="#__codelineno-0-771">771</a></span>
+<span class="normal"><a href="#__codelineno-0-772">772</a></span>
+<span class="normal"><a href="#__codelineno-0-773">773</a></span>
+<span class="normal"><a href="#__codelineno-0-774">774</a></span>
+<span class="normal"><a href="#__codelineno-0-775">775</a></span>
+<span class="normal"><a href="#__codelineno-0-776">776</a></span>
+<span class="normal"><a href="#__codelineno-0-777">777</a></span>
+<span class="normal"><a href="#__codelineno-0-778">778</a></span>
+<span class="normal"><a href="#__codelineno-0-779">779</a></span>
+<span class="normal"><a href="#__codelineno-0-780">780</a></span>
+<span class="normal"><a href="#__codelineno-0-781">781</a></span>
+<span class="normal"><a href="#__codelineno-0-782">782</a></span></pre></div></td><td class="code"><div><pre><span></span><code><a id="__codelineno-0-710" name="__codelineno-0-710"></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-711" name="__codelineno-0-711"></a><span class="w">    </span><span class="sd">&quot;&quot;&quot;</span>
+<a id="__codelineno-0-712" name="__codelineno-0-712"></a><span class="sd">    Recursively yield a list of registered URL patterns.</span>
+<a id="__codelineno-0-713" name="__codelineno-0-713"></a>
+<a id="__codelineno-0-714" name="__codelineno-0-714"></a><span class="sd">    Args:</span>
+<a id="__codelineno-0-715" name="__codelineno-0-715"></a><span class="sd">        urlconf (URLConf): Python module such as `nautobot.core.urls`.</span>
+<a id="__codelineno-0-716" name="__codelineno-0-716"></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-717" name="__codelineno-0-717"></a><span class="sd">        patterns_list (list): Used in recursion. Generally can be omitted on initial call.</span>
+<a id="__codelineno-0-718" name="__codelineno-0-718"></a><span class="sd">            Default if unspecified is the `url_patterns` attribute of the given `urlconf` module.</span>
+<a id="__codelineno-0-719" name="__codelineno-0-719"></a><span class="sd">        base_path (str): String to prepend to all URL patterns yielded.</span>
+<a id="__codelineno-0-720" name="__codelineno-0-720"></a><span class="sd">            Default if unspecified is the string `&quot;/&quot;`.</span>
+<a id="__codelineno-0-721" name="__codelineno-0-721"></a>
+<a id="__codelineno-0-722" name="__codelineno-0-722"></a><span class="sd">    Yields:</span>
+<a id="__codelineno-0-723" name="__codelineno-0-723"></a><span class="sd">        (str): Each URL pattern defined in the given urlconf and its descendants</span>
+<a id="__codelineno-0-724" name="__codelineno-0-724"></a>
+<a id="__codelineno-0-725" name="__codelineno-0-725"></a><span class="sd">    Examples:</span>
+<a id="__codelineno-0-726" name="__codelineno-0-726"></a><span class="sd">        &gt;&gt;&gt; generator = get_url_patterns()</span>
+<a id="__codelineno-0-727" name="__codelineno-0-727"></a><span class="sd">        &gt;&gt;&gt; next(generator)</span>
+<a id="__codelineno-0-728" name="__codelineno-0-728"></a><span class="sd">        &#39;/&#39;</span>
+<a id="__codelineno-0-729" name="__codelineno-0-729"></a><span class="sd">        &gt;&gt;&gt; next(generator)</span>
+<a id="__codelineno-0-730" name="__codelineno-0-730"></a><span class="sd">        &#39;/search/&#39;</span>
+<a id="__codelineno-0-731" name="__codelineno-0-731"></a><span class="sd">        &gt;&gt;&gt; next(generator)</span>
+<a id="__codelineno-0-732" name="__codelineno-0-732"></a><span class="sd">        &#39;/login/&#39;</span>
+<a id="__codelineno-0-733" name="__codelineno-0-733"></a><span class="sd">        &gt;&gt;&gt; next(generator)</span>
+<a id="__codelineno-0-734" name="__codelineno-0-734"></a><span class="sd">        &#39;/logout/&#39;</span>
+<a id="__codelineno-0-735" name="__codelineno-0-735"></a><span class="sd">        &gt;&gt;&gt; next(generator)</span>
+<a id="__codelineno-0-736" name="__codelineno-0-736"></a><span class="sd">        &#39;/circuits/circuits/&lt;uuid:pk&gt;/terminations/swap/&#39;</span>
+<a id="__codelineno-0-737" name="__codelineno-0-737"></a>
+<a id="__codelineno-0-738" name="__codelineno-0-738"></a><span class="sd">        &gt;&gt;&gt; import example_plugin.urls as example_urls</span>
+<a id="__codelineno-0-739" name="__codelineno-0-739"></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-740" name="__codelineno-0-740"></a><span class="sd">        ...     print(url_pattern)</span>
+<a id="__codelineno-0-741" name="__codelineno-0-741"></a><span class="sd">        ...</span>
+<a id="__codelineno-0-742" name="__codelineno-0-742"></a><span class="sd">        /plugins/example-plugin/</span>
+<a id="__codelineno-0-743" name="__codelineno-0-743"></a><span class="sd">        /plugins/example-plugin/config/</span>
+<a id="__codelineno-0-744" name="__codelineno-0-744"></a><span class="sd">        /plugins/example-plugin/models/&lt;uuid:pk&gt;/dynamic-groups/</span>
+<a id="__codelineno-0-745" name="__codelineno-0-745"></a><span class="sd">        /plugins/example-plugin/other-models/&lt;uuid:pk&gt;/dynamic-groups/</span>
+<a id="__codelineno-0-746" name="__codelineno-0-746"></a><span class="sd">        /plugins/example-plugin/docs/</span>
+<a id="__codelineno-0-747" name="__codelineno-0-747"></a><span class="sd">        /plugins/example-plugin/circuits/&lt;uuid:pk&gt;/example-plugin-tab/</span>
+<a id="__codelineno-0-748" name="__codelineno-0-748"></a><span class="sd">        /plugins/example-plugin/devices/&lt;uuid:pk&gt;/example-plugin-tab-1/</span>
+<a id="__codelineno-0-749" name="__codelineno-0-749"></a><span class="sd">        /plugins/example-plugin/devices/&lt;uuid:pk&gt;/example-plugin-tab-2/</span>
+<a id="__codelineno-0-750" name="__codelineno-0-750"></a><span class="sd">        /plugins/example-plugin/override-target/</span>
+<a id="__codelineno-0-751" name="__codelineno-0-751"></a><span class="sd">        /plugins/example-plugin/^models/$</span>
+<a id="__codelineno-0-752" name="__codelineno-0-752"></a><span class="sd">        /plugins/example-plugin/^models/add/$</span>
+<a id="__codelineno-0-753" name="__codelineno-0-753"></a><span class="sd">        /plugins/example-plugin/^models/import/$</span>
+<a id="__codelineno-0-754" name="__codelineno-0-754"></a><span class="sd">        /plugins/example-plugin/^models/edit/$</span>
+<a id="__codelineno-0-755" name="__codelineno-0-755"></a><span class="sd">        /plugins/example-plugin/^models/delete/$</span>
+<a id="__codelineno-0-756" name="__codelineno-0-756"></a><span class="sd">        /plugins/example-plugin/^models/all-names/$</span>
+<a id="__codelineno-0-757" name="__codelineno-0-757"></a><span class="sd">        /plugins/example-plugin/^models/(?P&lt;pk&gt;[^/.]+)/$</span>
+<a id="__codelineno-0-758" name="__codelineno-0-758"></a><span class="sd">        /plugins/example-plugin/^models/(?P&lt;pk&gt;[^/.]+)/delete/$</span>
+<a id="__codelineno-0-759" name="__codelineno-0-759"></a><span class="sd">        /plugins/example-plugin/^models/(?P&lt;pk&gt;[^/.]+)/edit/$</span>
+<a id="__codelineno-0-760" name="__codelineno-0-760"></a><span class="sd">        /plugins/example-plugin/^models/(?P&lt;pk&gt;[^/.]+)/changelog/$</span>
+<a id="__codelineno-0-761" name="__codelineno-0-761"></a><span class="sd">        /plugins/example-plugin/^models/(?P&lt;pk&gt;[^/.]+)/notes/$</span>
+<a id="__codelineno-0-762" name="__codelineno-0-762"></a><span class="sd">        /plugins/example-plugin/^other-models/$</span>
+<a id="__codelineno-0-763" name="__codelineno-0-763"></a><span class="sd">        /plugins/example-plugin/^other-models/add/$</span>
+<a id="__codelineno-0-764" name="__codelineno-0-764"></a><span class="sd">        /plugins/example-plugin/^other-models/edit/$</span>
+<a id="__codelineno-0-765" name="__codelineno-0-765"></a><span class="sd">        /plugins/example-plugin/^other-models/delete/$</span>
+<a id="__codelineno-0-766" name="__codelineno-0-766"></a><span class="sd">        /plugins/example-plugin/^other-models/(?P&lt;pk&gt;[^/.]+)/$</span>
+<a id="__codelineno-0-767" name="__codelineno-0-767"></a><span class="sd">        /plugins/example-plugin/^other-models/(?P&lt;pk&gt;[^/.]+)/delete/$</span>
+<a id="__codelineno-0-768" name="__codelineno-0-768"></a><span class="sd">        /plugins/example-plugin/^other-models/(?P&lt;pk&gt;[^/.]+)/edit/$</span>
+<a id="__codelineno-0-769" name="__codelineno-0-769"></a><span class="sd">        /plugins/example-plugin/^other-models/(?P&lt;pk&gt;[^/.]+)/changelog/$</span>
+<a id="__codelineno-0-770" name="__codelineno-0-770"></a><span class="sd">        /plugins/example-plugin/^other-models/(?P&lt;pk&gt;[^/.]+)/notes/$</span>
+<a id="__codelineno-0-771" name="__codelineno-0-771"></a><span class="sd">    &quot;&quot;&quot;</span>
+<a id="__codelineno-0-772" name="__codelineno-0-772"></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-773" name="__codelineno-0-773"></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-774" name="__codelineno-0-774"></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-775" name="__codelineno-0-775"></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-776" name="__codelineno-0-776"></a>
+<a id="__codelineno-0-777" name="__codelineno-0-777"></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-778" name="__codelineno-0-778"></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-779" name="__codelineno-0-779"></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-780" name="__codelineno-0-780"></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-781" name="__codelineno-0-781"></a>            <span class="c1"># Recurse!</span>
+<a id="__codelineno-0-782" name="__codelineno-0-782"></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>