diff options
Diffstat (limited to 'reference/isort/sorting.html')
| -rw-r--r-- | reference/isort/sorting.html | 50 |
1 files changed, 31 insertions, 19 deletions
diff --git a/reference/isort/sorting.html b/reference/isort/sorting.html index 51a33457..55298527 100644 --- a/reference/isort/sorting.html +++ b/reference/isort/sorting.html @@ -1026,6 +1026,13 @@ <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix> <li class="md-nav__item"> + <a href="#variables" class="md-nav__link"> + Variables + </a> + +</li> + + <li class="md-nav__item"> <a href="#functions" class="md-nav__link"> Functions </a> @@ -1346,6 +1353,13 @@ <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix> <li class="md-nav__item"> + <a href="#variables" class="md-nav__link"> + Variables + </a> + +</li> + + <li class="md-nav__item"> <a href="#functions" class="md-nav__link"> Functions </a> @@ -1408,9 +1422,15 @@ <p>None</p> <details class="example"><summary>View Source</summary><div class="codehilite"><pre><span></span><code><span class="kn">import</span> <span class="nn">re</span> -<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">Any</span><span class="p">,</span> <span class="n">Callable</span><span class="p">,</span> <span class="n">Iterable</span><span class="p">,</span> <span class="n">List</span><span class="p">,</span> <span class="n">Optional</span> +<span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">TYPE_CHECKING</span><span class="p">,</span> <span class="n">Any</span><span class="p">,</span> <span class="n">Callable</span><span class="p">,</span> <span class="n">Iterable</span><span class="p">,</span> <span class="n">List</span><span class="p">,</span> <span class="n">Optional</span> + +<span class="k">if</span> <span class="n">TYPE_CHECKING</span><span class="p">:</span> -<span class="kn">from</span> <span class="nn">.settings</span> <span class="kn">import</span> <span class="n">Config</span> + <span class="kn">from</span> <span class="nn">.settings</span> <span class="kn">import</span> <span class="n">Config</span> + +<span class="k">else</span><span class="p">:</span> + + <span class="n">Config</span> <span class="o">=</span> <span class="n">Any</span> <span class="n">_import_line_intro_re</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="s2">"^(?:from|import) "</span><span class="p">)</span> @@ -1586,13 +1606,7 @@ <span class="p">)</span> <span class="o">-></span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]:</span> - <span class="n">sorting_func</span><span class="p">:</span> <span class="n">Callable</span><span class="p">[</span><span class="o">...</span><span class="p">,</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]]</span> <span class="o">=</span> <span class="n">naturally</span> - - <span class="k">if</span> <span class="n">config</span><span class="o">.</span><span class="n">sort_order</span> <span class="o">==</span> <span class="s2">"pythonic"</span><span class="p">:</span> - - <span class="n">sorting_func</span> <span class="o">=</span> <span class="nb">sorted</span> - - <span class="k">return</span> <span class="n">sorting_func</span><span class="p">(</span><span class="n">to_sort</span><span class="p">,</span> <span class="n">key</span><span class="o">=</span><span class="n">key</span><span class="p">,</span> <span class="n">reverse</span><span class="o">=</span><span class="n">reverse</span><span class="p">)</span> + <span class="k">return</span> <span class="n">config</span><span class="o">.</span><span class="n">sorting_function</span><span class="p">(</span><span class="n">to_sort</span><span class="p">,</span> <span class="n">key</span><span class="o">=</span><span class="n">key</span><span class="p">,</span> <span class="n">reverse</span><span class="o">=</span><span class="n">reverse</span><span class="p">)</span> <span class="k">def</span> <span class="nf">naturally</span><span class="p">(</span> @@ -1624,11 +1638,15 @@ </code></pre></div> </details> +<h2 id="variables">Variables</h2> +<div class="codehilite"><pre><span></span><code><span class="n">TYPE_CHECKING</span> +</code></pre></div> + <h2 id="functions">Functions</h2> <h3 id="module_key">module_key</h3> <div class="codehilite"><pre><span></span><code><span class="k">def</span> <span class="nf">module_key</span><span class="p">(</span> <span class="n">module_name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> - <span class="n">config</span><span class="p">:</span> <span class="n">isort</span><span class="o">.</span><span class="n">settings</span><span class="o">.</span><span class="n">Config</span><span class="p">,</span> + <span class="n">config</span><span class="p">:</span> <span class="n">Any</span><span class="p">,</span> <span class="n">sub_imports</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span> <span class="n">ignore_case</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span> <span class="n">section_name</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="n">Any</span><span class="p">,</span> <span class="n">NoneType</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> @@ -1750,7 +1768,7 @@ <h3 id="section_key">section_key</h3> <div class="codehilite"><pre><span></span><code><span class="k">def</span> <span class="nf">section_key</span><span class="p">(</span> <span class="n">line</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> - <span class="n">config</span><span class="p">:</span> <span class="n">isort</span><span class="o">.</span><span class="n">settings</span><span class="o">.</span><span class="n">Config</span> + <span class="n">config</span><span class="p">:</span> <span class="n">Any</span> <span class="p">)</span> <span class="o">-></span> <span class="nb">str</span> </code></pre></div> @@ -1838,7 +1856,7 @@ </details> <h3 id="sort">sort</h3> <div class="codehilite"><pre><span></span><code><span class="k">def</span> <span class="nf">sort</span><span class="p">(</span> - <span class="n">config</span><span class="p">:</span> <span class="n">isort</span><span class="o">.</span><span class="n">settings</span><span class="o">.</span><span class="n">Config</span><span class="p">,</span> + <span class="n">config</span><span class="p">:</span> <span class="n">Any</span><span class="p">,</span> <span class="n">to_sort</span><span class="p">:</span> <span class="n">Iterable</span><span class="p">[</span><span class="nb">str</span><span class="p">],</span> <span class="n">key</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="n">Callable</span><span class="p">[[</span><span class="nb">str</span><span class="p">],</span> <span class="n">Any</span><span class="p">],</span> <span class="n">NoneType</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> <span class="n">reverse</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span> @@ -1857,13 +1875,7 @@ <span class="p">)</span><span class="w"> </span><span class="o">-></span><span class="w"> </span><span class="n">List</span><span class="o">[</span><span class="n">str</span><span class="o">]</span><span class="err">:</span><span class="w"></span> -<span class="w"> </span><span class="nl">sorting_func</span><span class="p">:</span><span class="w"> </span><span class="n">Callable</span><span class="o">[</span><span class="n">..., List[str</span><span class="o">]</span><span class="err">]</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">naturally</span><span class="w"></span> - -<span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="n">config</span><span class="p">.</span><span class="n">sort_order</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="ss">"pythonic"</span><span class="err">:</span><span class="w"></span> - -<span class="w"> </span><span class="n">sorting_func</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">sorted</span><span class="w"></span> - -<span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="n">sorting_func</span><span class="p">(</span><span class="n">to_sort</span><span class="p">,</span><span class="w"> </span><span class="k">key</span><span class="o">=</span><span class="k">key</span><span class="p">,</span><span class="w"> </span><span class="nf">reverse</span><span class="o">=</span><span class="nf">reverse</span><span class="p">)</span><span class="w"></span> +<span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="n">config</span><span class="p">.</span><span class="n">sorting_function</span><span class="p">(</span><span class="n">to_sort</span><span class="p">,</span><span class="w"> </span><span class="k">key</span><span class="o">=</span><span class="k">key</span><span class="p">,</span><span class="w"> </span><span class="nf">reverse</span><span class="o">=</span><span class="nf">reverse</span><span class="p">)</span><span class="w"></span> </code></pre></div> </details> |