diff options
Diffstat (limited to 'docs/configuration/options.html')
-rw-r--r-- | docs/configuration/options.html | 301 |
1 files changed, 185 insertions, 116 deletions
diff --git a/docs/configuration/options.html b/docs/configuration/options.html index 44d054a1..bed51378 100644 --- a/docs/configuration/options.html +++ b/docs/configuration/options.html @@ -1052,6 +1052,13 @@ </li> <li class="md-nav__item"> + <a href="#split-on-trailing-comma" class="md-nav__link"> + Split on Trailing Comma + </a> + +</li> + + <li class="md-nav__item"> <a href="#from-first" class="md-nav__link"> From First </a> @@ -1810,11 +1817,53 @@ <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" > <label class="md-nav__link" for="__nav_5"> + Howto + <span class="md-nav__icon md-icon"></span> + </label> + <nav class="md-nav" aria-label="Howto" data-md-level="1"> + <label class="md-nav__title" for="__nav_5"> + <span class="md-nav__icon md-icon"></span> + Howto + </label> + <ul class="md-nav__list" data-md-scrollfix> + + + + + + <li class="md-nav__item"> + <a href="../howto/shared_profiles.html" class="md-nav__link"> + Shared Profiles + </a> + </li> + + + + </ul> + </nav> + </li> + + + + + + + + + + + + <li class="md-nav__item md-nav__item--nested"> + + + <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" > + + <label class="md-nav__link" for="__nav_6"> Major Releases <span class="md-nav__icon md-icon"></span> </label> <nav class="md-nav" aria-label="Major Releases" data-md-level="1"> - <label class="md-nav__title" for="__nav_5"> + <label class="md-nav__title" for="__nav_6"> <span class="md-nav__icon md-icon"></span> Major Releases </label> @@ -1861,14 +1910,14 @@ <li class="md-nav__item md-nav__item--nested"> - <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" > + <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" > - <label class="md-nav__link" for="__nav_6"> + <label class="md-nav__link" for="__nav_7"> Quick Start <span class="md-nav__icon md-icon"></span> </label> <nav class="md-nav" aria-label="Quick Start" data-md-level="1"> - <label class="md-nav__title" for="__nav_6"> + <label class="md-nav__title" for="__nav_7"> <span class="md-nav__icon md-icon"></span> Quick Start </label> @@ -1939,14 +1988,14 @@ <li class="md-nav__item md-nav__item--nested"> - <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" > + <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_8" type="checkbox" id="__nav_8" > - <label class="md-nav__link" for="__nav_7"> + <label class="md-nav__link" for="__nav_8"> Upgrade Guides <span class="md-nav__icon md-icon"></span> </label> <nav class="md-nav" aria-label="Upgrade Guides" data-md-level="1"> - <label class="md-nav__title" for="__nav_7"> + <label class="md-nav__title" for="__nav_8"> <span class="md-nav__icon md-icon"></span> Upgrade Guides </label> @@ -1981,14 +2030,14 @@ <li class="md-nav__item md-nav__item--nested"> - <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_8" type="checkbox" id="__nav_8" > + <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_9" type="checkbox" id="__nav_9" > - <label class="md-nav__link" for="__nav_8"> + <label class="md-nav__link" for="__nav_9"> Warning And Error Codes <span class="md-nav__icon md-icon"></span> </label> <nav class="md-nav" aria-label="Warning And Error Codes" data-md-level="1"> - <label class="md-nav__title" for="__nav_8"> + <label class="md-nav__title" for="__nav_9"> <span class="md-nav__icon md-icon"></span> Warning And Error Codes </label> @@ -2023,14 +2072,14 @@ <li class="md-nav__item md-nav__item--nested"> - <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_9" type="checkbox" id="__nav_9" > + <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_10" type="checkbox" id="__nav_10" > - <label class="md-nav__link" for="__nav_9"> + <label class="md-nav__link" for="__nav_10"> Reference <span class="md-nav__icon md-icon"></span> </label> <nav class="md-nav" aria-label="Reference" data-md-level="1"> - <label class="md-nav__title" for="__nav_9"> + <label class="md-nav__title" for="__nav_10"> <span class="md-nav__icon md-icon"></span> Reference </label> @@ -2044,14 +2093,14 @@ <li class="md-nav__item md-nav__item--nested"> - <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_9_1" type="checkbox" id="__nav_9_1" > + <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_10_1" type="checkbox" id="__nav_10_1" > - <label class="md-nav__link" for="__nav_9_1"> + <label class="md-nav__link" for="__nav_10_1"> Isort <span class="md-nav__icon md-icon"></span> </label> <nav class="md-nav" aria-label="Isort" data-md-level="2"> - <label class="md-nav__title" for="__nav_9_1"> + <label class="md-nav__title" for="__nav_10_1"> <span class="md-nav__icon md-icon"></span> Isort </label> @@ -2365,14 +2414,14 @@ <li class="md-nav__item md-nav__item--nested"> - <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_9_1_26" type="checkbox" id="__nav_9_1_26" > + <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_10_1_26" type="checkbox" id="__nav_10_1_26" > - <label class="md-nav__link" for="__nav_9_1_26"> + <label class="md-nav__link" for="__nav_10_1_26"> Deprecated <span class="md-nav__icon md-icon"></span> </label> <nav class="md-nav" aria-label="Deprecated" data-md-level="3"> - <label class="md-nav__title" for="__nav_9_1_26"> + <label class="md-nav__title" for="__nav_10_1_26"> <span class="md-nav__icon md-icon"></span> Deprecated </label> @@ -2416,14 +2465,14 @@ <li class="md-nav__item md-nav__item--nested"> - <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_9_1_27" type="checkbox" id="__nav_9_1_27" > + <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_10_1_27" type="checkbox" id="__nav_10_1_27" > - <label class="md-nav__link" for="__nav_9_1_27"> + <label class="md-nav__link" for="__nav_10_1_27"> Stdlibs <span class="md-nav__icon md-icon"></span> </label> <nav class="md-nav" aria-label="Stdlibs" data-md-level="3"> - <label class="md-nav__title" for="__nav_9_1_27"> + <label class="md-nav__title" for="__nav_10_1_27"> <span class="md-nav__icon md-icon"></span> Stdlibs </label> @@ -2506,8 +2555,8 @@ <li class="md-nav__item"> - <a href="../../reference/isort/stdlibs/py35.html" class="md-nav__link"> - Py35 + <a href="../../reference/isort/stdlibs/py311.html" class="md-nav__link"> + Py311 </a> </li> @@ -3274,6 +3323,13 @@ </li> <li class="md-nav__item"> + <a href="#split-on-trailing-comma" class="md-nav__link"> + Split on Trailing Comma + </a> + +</li> + + <li class="md-nav__item"> <a href="#from-first" class="md-nav__link"> From First </a> @@ -3926,13 +3982,13 @@ profiles</a>.</p> </ul> <p><strong>Examples:</strong></p> <h3 id="example-isortcfg">Example <code>.isort.cfg</code></h3> -<div class="codehilite"><pre><span></span><code><span class="k">[settings]</span> -<span class="na">py_version</span><span class="o">=</span><span class="s">39</span> +<div class="codehilite"><pre><span></span><code><span class="k">[settings]</span><span class="w"></span> +<span class="na">py_version</span><span class="o">=</span><span class="s">39</span><span class="w"></span> </code></pre></div> <h3 id="example-pyprojecttoml">Example <code>pyproject.toml</code></h3> -<div class="codehilite"><pre><span></span><code><span class="k">[tool.isort]</span> -<span class="na">py_version</span><span class="o">=</span><span class="s">39</span> +<div class="codehilite"><pre><span></span><code><span class="k">[tool.isort]</span><span class="w"></span> +<span class="na">py_version</span><span class="o">=</span><span class="s">39</span><span class="w"></span> </code></pre></div> <h3 id="example-cli-usage">Example cli usage</h3> @@ -3961,13 +4017,13 @@ profiles</a>.</p> </ul> <p><strong>Examples:</strong></p> <h3 id="example-isortcfg_1">Example <code>.isort.cfg</code></h3> -<div class="codehilite"><pre><span></span><code><span class="k">[settings]</span> -<span class="na">skip</span><span class="o">=</span><span class="s">.gitignore,.dockerignore</span> +<div class="codehilite"><pre><span></span><code><span class="k">[settings]</span><span class="w"></span> +<span class="na">skip</span><span class="o">=</span><span class="s">.gitignore,.dockerignore</span><span class="w"></span> </code></pre></div> <h3 id="example-pyprojecttoml_1">Example <code>pyproject.toml</code></h3> -<div class="codehilite"><pre><span></span><code><span class="k">[tool.isort]</span> -<span class="na">skip</span> <span class="o">=</span> <span class="s">[".gitignore", ".dockerignore"]</span> +<div class="codehilite"><pre><span></span><code><span class="k">[tool.isort]</span><span class="w"></span> +<span class="na">skip</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">[".gitignore", ".dockerignore"]</span><span class="w"></span> </code></pre></div> <h2 id="extend-skip">Extend Skip</h2> @@ -3982,13 +4038,13 @@ profiles</a>.</p> </ul> <p><strong>Examples:</strong></p> <h3 id="example-isortcfg_2">Example <code>.isort.cfg</code></h3> -<div class="codehilite"><pre><span></span><code><span class="k">[settings]</span> -<span class="na">extend_skip</span><span class="o">=</span><span class="s">.md,.json</span> +<div class="codehilite"><pre><span></span><code><span class="k">[settings]</span><span class="w"></span> +<span class="na">extend_skip</span><span class="o">=</span><span class="s">.md,.json</span><span class="w"></span> </code></pre></div> <h3 id="example-pyprojecttoml_2">Example <code>pyproject.toml</code></h3> -<div class="codehilite"><pre><span></span><code><span class="k">[tool.isort]</span> -<span class="na">extend_skip</span> <span class="o">=</span> <span class="s">[".md", ".json"]</span> +<div class="codehilite"><pre><span></span><code><span class="k">[tool.isort]</span><span class="w"></span> +<span class="na">extend_skip</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">[".md", ".json"]</span><span class="w"></span> </code></pre></div> <h2 id="skip-glob">Skip Glob</h2> @@ -4004,13 +4060,13 @@ profiles</a>.</p> </ul> <p><strong>Examples:</strong></p> <h3 id="example-isortcfg_3">Example <code>.isort.cfg</code></h3> -<div class="codehilite"><pre><span></span><code><span class="k">[settings]</span> -<span class="na">skip_glob</span><span class="o">=</span><span class="s">docs/*</span> +<div class="codehilite"><pre><span></span><code><span class="k">[settings]</span><span class="w"></span> +<span class="na">skip_glob</span><span class="o">=</span><span class="s">docs/*</span><span class="w"></span> </code></pre></div> <h3 id="example-pyprojecttoml_3">Example <code>pyproject.toml</code></h3> -<div class="codehilite"><pre><span></span><code><span class="k">[tool.isort]</span> -<span class="na">skip_glob</span> <span class="o">=</span> <span class="s">["docs/*"]</span> +<div class="codehilite"><pre><span></span><code><span class="k">[tool.isort]</span><span class="w"></span> +<span class="na">skip_glob</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">["docs/*"]</span><span class="w"></span> </code></pre></div> <h2 id="extend-skip-glob">Extend Skip Glob</h2> @@ -4025,13 +4081,13 @@ profiles</a>.</p> </ul> <p><strong>Examples:</strong></p> <h3 id="example-isortcfg_4">Example <code>.isort.cfg</code></h3> -<div class="codehilite"><pre><span></span><code><span class="k">[settings]</span> -<span class="na">extend_skip_glob</span><span class="o">=</span><span class="s">my_*_module.py,test/*</span> +<div class="codehilite"><pre><span></span><code><span class="k">[settings]</span><span class="w"></span> +<span class="na">extend_skip_glob</span><span class="o">=</span><span class="s">my_*_module.py,test/*</span><span class="w"></span> </code></pre></div> <h3 id="example-pyprojecttoml_4">Example <code>pyproject.toml</code></h3> -<div class="codehilite"><pre><span></span><code><span class="k">[tool.isort]</span> -<span class="na">extend_skip_glob</span> <span class="o">=</span> <span class="s">["my_*_module.py", "test/*"]</span> +<div class="codehilite"><pre><span></span><code><span class="k">[tool.isort]</span><span class="w"></span> +<span class="na">extend_skip_glob</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">["my_*_module.py", "test/*"]</span><span class="w"></span> </code></pre></div> <h2 id="skip-gitignore">Skip Gitignore</h2> @@ -4124,13 +4180,13 @@ NOTE: wrap_length must be LOWER than or equal to line_length.</p> </ul> <p><strong>Examples:</strong></p> <h3 id="example-isortcfg_5">Example <code>.isort.cfg</code></h3> -<div class="codehilite"><pre><span></span><code><span class="k">[settings]</span> -<span class="na">known_third_party</span><span class="o">=</span><span class="s">my_module1,my_module2</span> +<div class="codehilite"><pre><span></span><code><span class="k">[settings]</span><span class="w"></span> +<span class="na">known_third_party</span><span class="o">=</span><span class="s">my_module1,my_module2</span><span class="w"></span> </code></pre></div> <h3 id="example-pyprojecttoml_5">Example <code>pyproject.toml</code></h3> -<div class="codehilite"><pre><span></span><code><span class="k">[tool.isort]</span> -<span class="na">known_third_party</span> <span class="o">=</span> <span class="s">["my_module1", "my_module2"]</span> +<div class="codehilite"><pre><span></span><code><span class="k">[tool.isort]</span><span class="w"></span> +<span class="na">known_third_party</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">["my_module1", "my_module2"]</span><span class="w"></span> </code></pre></div> <h2 id="known-first-party">Known First Party</h2> @@ -4146,13 +4202,13 @@ NOTE: wrap_length must be LOWER than or equal to line_length.</p> </ul> <p><strong>Examples:</strong></p> <h3 id="example-isortcfg_6">Example <code>.isort.cfg</code></h3> -<div class="codehilite"><pre><span></span><code><span class="k">[settings]</span> -<span class="na">known_first_party</span><span class="o">=</span><span class="s">my_module1,my_module2</span> +<div class="codehilite"><pre><span></span><code><span class="k">[settings]</span><span class="w"></span> +<span class="na">known_first_party</span><span class="o">=</span><span class="s">my_module1,my_module2</span><span class="w"></span> </code></pre></div> <h3 id="example-pyprojecttoml_6">Example <code>pyproject.toml</code></h3> -<div class="codehilite"><pre><span></span><code><span class="k">[tool.isort]</span> -<span class="na">known_first_party</span> <span class="o">=</span> <span class="s">["my_module1", "my_module2"]</span> +<div class="codehilite"><pre><span></span><code><span class="k">[tool.isort]</span><span class="w"></span> +<span class="na">known_first_party</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">["my_module1", "my_module2"]</span><span class="w"></span> </code></pre></div> <h2 id="known-local-folder">Known Local Folder</h2> @@ -4167,13 +4223,13 @@ NOTE: wrap_length must be LOWER than or equal to line_length.</p> </ul> <p><strong>Examples:</strong></p> <h3 id="example-isortcfg_7">Example <code>.isort.cfg</code></h3> -<div class="codehilite"><pre><span></span><code><span class="k">[settings]</span> -<span class="na">known_local_folder</span><span class="o">=</span><span class="s">my_module1,my_module2</span> +<div class="codehilite"><pre><span></span><code><span class="k">[settings]</span><span class="w"></span> +<span class="na">known_local_folder</span><span class="o">=</span><span class="s">my_module1,my_module2</span><span class="w"></span> </code></pre></div> <h3 id="example-pyprojecttoml_7">Example <code>pyproject.toml</code></h3> -<div class="codehilite"><pre><span></span><code><span class="k">[tool.isort]</span> -<span class="na">known_local_folder</span> <span class="o">=</span> <span class="s">["my_module1", "my_module2"]</span> +<div class="codehilite"><pre><span></span><code><span class="k">[tool.isort]</span><span class="w"></span> +<span class="na">known_local_folder</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">["my_module1", "my_module2"]</span><span class="w"></span> </code></pre></div> <h2 id="known-standard-library">Known Standard Library</h2> @@ -4189,13 +4245,13 @@ NOTE: wrap_length must be LOWER than or equal to line_length.</p> </ul> <p><strong>Examples:</strong></p> <h3 id="example-isortcfg_8">Example <code>.isort.cfg</code></h3> -<div class="codehilite"><pre><span></span><code><span class="k">[settings]</span> -<span class="na">known_standard_library</span><span class="o">=</span><span class="s">my_module1,my_module2</span> +<div class="codehilite"><pre><span></span><code><span class="k">[settings]</span><span class="w"></span> +<span class="na">known_standard_library</span><span class="o">=</span><span class="s">my_module1,my_module2</span><span class="w"></span> </code></pre></div> <h3 id="example-pyprojecttoml_8">Example <code>pyproject.toml</code></h3> -<div class="codehilite"><pre><span></span><code><span class="k">[tool.isort]</span> -<span class="na">known_standard_library</span> <span class="o">=</span> <span class="s">["my_module1", "my_module2"]</span> +<div class="codehilite"><pre><span></span><code><span class="k">[tool.isort]</span><span class="w"></span> +<span class="na">known_standard_library</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">["my_module1", "my_module2"]</span><span class="w"></span> </code></pre></div> <h2 id="extra-standard-library">Extra Standard Library</h2> @@ -4210,13 +4266,13 @@ NOTE: wrap_length must be LOWER than or equal to line_length.</p> </ul> <p><strong>Examples:</strong></p> <h3 id="example-isortcfg_9">Example <code>.isort.cfg</code></h3> -<div class="codehilite"><pre><span></span><code><span class="k">[settings]</span> -<span class="na">extra_standard_library</span><span class="o">=</span><span class="s">my_module1,my_module2</span> +<div class="codehilite"><pre><span></span><code><span class="k">[settings]</span><span class="w"></span> +<span class="na">extra_standard_library</span><span class="o">=</span><span class="s">my_module1,my_module2</span><span class="w"></span> </code></pre></div> <h3 id="example-pyprojecttoml_9">Example <code>pyproject.toml</code></h3> -<div class="codehilite"><pre><span></span><code><span class="k">[tool.isort]</span> -<span class="na">extra_standard_library</span> <span class="o">=</span> <span class="s">["my_module1", "my_module2"]</span> +<div class="codehilite"><pre><span></span><code><span class="k">[tool.isort]</span><span class="w"></span> +<span class="na">extra_standard_library</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">["my_module1", "my_module2"]</span><span class="w"></span> </code></pre></div> <h2 id="known-other">Known Other</h2> @@ -4228,15 +4284,15 @@ NOTE: wrap_length must be LOWER than or equal to line_length.</p> <strong>CLI Flags:</strong> <strong>Not Supported</strong></p> <p><strong>Examples:</strong></p> <h3 id="example-isortcfg_10">Example <code>.isort.cfg</code></h3> -<div class="codehilite"><pre><span></span><code><span class="k">[settings]</span> -<span class="na">sections</span><span class="o">=</span><span class="s">FUTURE,STDLIB,THIRDPARTY,AIRFLOW,FIRSTPARTY,LOCALFOLDER</span> -<span class="na">known_airflow</span><span class="o">=</span><span class="s">airflow</span> +<div class="codehilite"><pre><span></span><code><span class="k">[settings]</span><span class="w"></span> +<span class="na">sections</span><span class="o">=</span><span class="s">FUTURE,STDLIB,THIRDPARTY,AIRFLOW,FIRSTPARTY,LOCALFOLDER</span><span class="w"></span> +<span class="na">known_airflow</span><span class="o">=</span><span class="s">airflow</span><span class="w"></span> </code></pre></div> <h3 id="example-pyprojecttoml_10">Example <code>pyproject.toml</code></h3> -<div class="codehilite"><pre><span></span><code><span class="k">[tool.isort]</span> -<span class="na">sections</span> <span class="o">=</span> <span class="s">['FUTURE', 'STDLIB', 'THIRDPARTY', 'AIRFLOW', 'FIRSTPARTY', 'LOCALFOLDER']</span> -<span class="na">known_airflow</span> <span class="o">=</span> <span class="s">['airflow']</span> +<div class="codehilite"><pre><span></span><code><span class="k">[tool.isort]</span><span class="w"></span> +<span class="na">sections</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">['FUTURE', 'STDLIB', 'THIRDPARTY', 'AIRFLOW', 'FIRSTPARTY', 'LOCALFOLDER']</span><span class="w"></span> +<span class="na">known_airflow</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">['airflow']</span><span class="w"></span> </code></pre></div> <h2 id="multi-line-output">Multi Line Output</h2> @@ -4252,13 +4308,13 @@ NOTE: wrap_length must be LOWER than or equal to line_length.</p> </ul> <p><strong>Examples:</strong></p> <h3 id="example-isortcfg_11">Example <code>.isort.cfg</code></h3> -<div class="codehilite"><pre><span></span><code><span class="k">[settings]</span> -<span class="na">multi_line_output</span><span class="o">=</span><span class="s">3</span> +<div class="codehilite"><pre><span></span><code><span class="k">[settings]</span><span class="w"></span> +<span class="na">multi_line_output</span><span class="o">=</span><span class="s">3</span><span class="w"></span> </code></pre></div> <h3 id="example-pyprojecttoml_11">Example <code>pyproject.toml</code></h3> -<div class="codehilite"><pre><span></span><code><span class="k">[tool.isort]</span> -<span class="na">multi_line_output</span> <span class="o">=</span> <span class="s">3</span> +<div class="codehilite"><pre><span></span><code><span class="k">[tool.isort]</span><span class="w"></span> +<span class="na">multi_line_output</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">3</span><span class="w"></span> </code></pre></div> <h2 id="forced-separate">Forced Separate</h2> @@ -4270,13 +4326,13 @@ NOTE: wrap_length must be LOWER than or equal to line_length.</p> <strong>CLI Flags:</strong> <strong>Not Supported</strong></p> <p><strong>Examples:</strong></p> <h3 id="example-isortcfg_12">Example <code>.isort.cfg</code></h3> -<div class="codehilite"><pre><span></span><code><span class="k">[settings]</span> -<span class="na">forced_separate</span><span class="o">=</span><span class="s">glob_exp1,glob_exp2</span> +<div class="codehilite"><pre><span></span><code><span class="k">[settings]</span><span class="w"></span> +<span class="na">forced_separate</span><span class="o">=</span><span class="s">glob_exp1,glob_exp2</span><span class="w"></span> </code></pre></div> <h3 id="example-pyprojecttoml_12">Example <code>pyproject.toml</code></h3> -<div class="codehilite"><pre><span></span><code><span class="k">[tool.isort]</span> -<span class="na">forced_separate</span> <span class="o">=</span> <span class="s">["glob_exp1", "glob_exp2"]</span> +<div class="codehilite"><pre><span></span><code><span class="k">[tool.isort]</span><span class="w"></span> +<span class="na">forced_separate</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">["glob_exp1", "glob_exp2"]</span><span class="w"></span> </code></pre></div> <h2 id="indent">Indent</h2> @@ -4328,13 +4384,13 @@ NOTE: wrap_length must be LOWER than or equal to line_length.</p> <strong>CLI Flags:</strong> <strong>Not Supported</strong></p> <p><strong>Examples:</strong></p> <h3 id="example-isortcfg_13">Example <code>.isort.cfg</code></h3> -<div class="codehilite"><pre><span></span><code><span class="k">[settings]</span> -<span class="na">length_sort_sections</span><span class="o">=</span><span class="s">future,stdlib</span> +<div class="codehilite"><pre><span></span><code><span class="k">[settings]</span><span class="w"></span> +<span class="na">length_sort_sections</span><span class="o">=</span><span class="s">future,stdlib</span><span class="w"></span> </code></pre></div> <h3 id="example-pyprojecttoml_13">Example <code>pyproject.toml</code></h3> -<div class="codehilite"><pre><span></span><code><span class="k">[tool.isort]</span> -<span class="na">length_sort_sections</span> <span class="o">=</span> <span class="s">["future", "stdlib"]</span> +<div class="codehilite"><pre><span></span><code><span class="k">[tool.isort]</span><span class="w"></span> +<span class="na">length_sort_sections</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">["future", "stdlib"]</span><span class="w"></span> </code></pre></div> <h2 id="add-imports">Add Imports</h2> @@ -4350,13 +4406,13 @@ NOTE: wrap_length must be LOWER than or equal to line_length.</p> </ul> <p><strong>Examples:</strong></p> <h3 id="example-isortcfg_14">Example <code>.isort.cfg</code></h3> -<div class="codehilite"><pre><span></span><code><span class="k">[settings]</span> -<span class="na">add_imports</span><span class="o">=</span><span class="s">import os,import json</span> +<div class="codehilite"><pre><span></span><code><span class="k">[settings]</span><span class="w"></span> +<span class="na">add_imports</span><span class="o">=</span><span class="s">import os,import json</span><span class="w"></span> </code></pre></div> <h3 id="example-pyprojecttoml_14">Example <code>pyproject.toml</code></h3> -<div class="codehilite"><pre><span></span><code><span class="k">[tool.isort]</span> -<span class="na">add_imports</span> <span class="o">=</span> <span class="s">["import os", "import json"]</span> +<div class="codehilite"><pre><span></span><code><span class="k">[tool.isort]</span><span class="w"></span> +<span class="na">add_imports</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">["import os", "import json"]</span><span class="w"></span> </code></pre></div> <h2 id="remove-imports">Remove Imports</h2> @@ -4372,13 +4428,13 @@ NOTE: wrap_length must be LOWER than or equal to line_length.</p> </ul> <p><strong>Examples:</strong></p> <h3 id="example-isortcfg_15">Example <code>.isort.cfg</code></h3> -<div class="codehilite"><pre><span></span><code><span class="k">[settings]</span> -<span class="na">remove_imports</span><span class="o">=</span><span class="s">os,json</span> +<div class="codehilite"><pre><span></span><code><span class="k">[settings]</span><span class="w"></span> +<span class="na">remove_imports</span><span class="o">=</span><span class="s">os,json</span><span class="w"></span> </code></pre></div> <h3 id="example-pyprojecttoml_15">Example <code>pyproject.toml</code></h3> -<div class="codehilite"><pre><span></span><code><span class="k">[tool.isort]</span> -<span class="na">remove_imports</span> <span class="o">=</span> <span class="s">["os", "json"]</span> +<div class="codehilite"><pre><span></span><code><span class="k">[tool.isort]</span><span class="w"></span> +<span class="na">remove_imports</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">["os", "json"]</span><span class="w"></span> </code></pre></div> <h2 id="append-only">Append Only</h2> @@ -4427,13 +4483,13 @@ NOTE: wrap_length must be LOWER than or equal to line_length.</p> </ul> <p><strong>Examples:</strong></p> <h3 id="example-isortcfg_16">Example <code>.isort.cfg</code></h3> -<div class="codehilite"><pre><span></span><code><span class="k">[settings]</span> -<span class="na">single_line_exclusions</span><span class="o">=</span><span class="s">os,json</span> +<div class="codehilite"><pre><span></span><code><span class="k">[settings]</span><span class="w"></span> +<span class="na">single_line_exclusions</span><span class="o">=</span><span class="s">os,json</span><span class="w"></span> </code></pre></div> <h3 id="example-pyprojecttoml_16">Example <code>pyproject.toml</code></h3> -<div class="codehilite"><pre><span></span><code><span class="k">[tool.isort]</span> -<span class="na">single_line_exclusions</span> <span class="o">=</span> <span class="s">["os", "json"]</span> +<div class="codehilite"><pre><span></span><code><span class="k">[tool.isort]</span><span class="w"></span> +<span class="na">single_line_exclusions</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">["os", "json"]</span><span class="w"></span> </code></pre></div> <h2 id="default-section">Default Section</h2> @@ -4473,7 +4529,7 @@ NOTE: wrap_length must be LOWER than or equal to line_length.</p> <li>--balanced</li> </ul> <h2 id="use-parentheses">Use Parentheses</h2> -<p>Use parentheses for line continuation on length limit instead of slashes. <strong>NOTE</strong>: This is separate from wrap modes, and only affects how individual lines that are too long get continued, not sections of multiple imports.</p> +<p>Use parentheses for line continuation on length limit instead of backslashes. <strong>NOTE</strong>: This is separate from wrap modes, and only affects how individual lines that are too long get continued, not sections of multiple imports.</p> <p><strong>Type:</strong> Bool<br /> <strong>Default:</strong> <code>False</code><br /> <strong>Config default:</strong> <code>false</code><br /> @@ -4580,6 +4636,16 @@ NOTE: wrap_length must be LOWER than or equal to line_length.</p> <li>--tc</li> <li>--trailing-comma</li> </ul> +<h2 id="split-on-trailing-comma">Split on Trailing Comma</h2> +<p>Split imports list followed by a trailing comma into VERTICAL_HANGING_INDENT mode. This follows Black style magic comma.</p> +<p><strong>Type:</strong> Bool<br /> +<strong>Default:</strong> <code>False</code><br /> +<strong>Config default:</strong> <code>false</code><br /> +<strong>Python & Config File Name:</strong> split_on_trailing_comma +<strong>CLI Flags:</strong></p> +<ul> +<li>--split-on-trailing-comma</li> +</ul> <h2 id="from-first">From First</h2> <p>Switches the typical ordering preference, showing from imports first then straight ones.</p> <p><strong>Type:</strong> Bool<br /> @@ -4706,13 +4772,13 @@ NOTE: wrap_length must be LOWER than or equal to line_length.</p> </ul> <p><strong>Examples:</strong></p> <h3 id="example-isortcfg_17">Example <code>.isort.cfg</code></h3> -<div class="codehilite"><pre><span></span><code><span class="k">[settings]</span> -<span class="na">no_lines_before</span><span class="o">=</span><span class="s">future,stdlib</span> +<div class="codehilite"><pre><span></span><code><span class="k">[settings]</span><span class="w"></span> +<span class="na">no_lines_before</span><span class="o">=</span><span class="s">future,stdlib</span><span class="w"></span> </code></pre></div> <h3 id="example-pyprojecttoml_17">Example <code>pyproject.toml</code></h3> -<div class="codehilite"><pre><span></span><code><span class="k">[tool.isort]</span> -<span class="na">no_lines_before</span> <span class="o">=</span> <span class="s">["future", "stdlib"]</span> +<div class="codehilite"><pre><span></span><code><span class="k">[tool.isort]</span><span class="w"></span> +<span class="na">no_lines_before</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">["future", "stdlib"]</span><span class="w"></span> </code></pre></div> <h2 id="no-inline-sort">No Inline Sort</h2> @@ -4775,7 +4841,10 @@ NOTE: wrap_length must be LOWER than or equal to line_length.</p> <li>--ensure-newline-before-comments</li> </ul> <h2 id="profile">Profile</h2> -<p>Base profile type to use for configuration. Profiles include: black, django, pycharm, google, open_stack, plone, attrs, hug, wemake, appnexus. As well as any shared profiles.</p> +<p>Base profile type to use for configuration. Profiles include: black, django, +pycharm, google, open_stack, plone, attrs, hug, wemake, appnexus. As well as +any <a href="https://pycqa.github.io/isort/docs/howto/shared_profiles.html">shared +profiles</a>.</p> <p><strong>Type:</strong> String<br /> <strong>Default:</strong> <code></code><br /> <strong>Config default:</strong> <code></code><br /> @@ -4807,13 +4876,13 @@ NOTE: wrap_length must be LOWER than or equal to line_length.</p> </ul> <p><strong>Examples:</strong></p> <h3 id="example-isortcfg_18">Example <code>.isort.cfg</code></h3> -<div class="codehilite"><pre><span></span><code><span class="k">[settings]</span> -<span class="na">src_paths</span> <span class="o">=</span> <span class="s">src,tests</span> +<div class="codehilite"><pre><span></span><code><span class="k">[settings]</span><span class="w"></span> +<span class="na">src_paths</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">src,tests</span><span class="w"></span> </code></pre></div> <h3 id="example-pyprojecttoml_18">Example <code>pyproject.toml</code></h3> -<div class="codehilite"><pre><span></span><code><span class="k">[tool.isort]</span> -<span class="na">src_paths</span> <span class="o">=</span> <span class="s">["src", "tests"]</span> +<div class="codehilite"><pre><span></span><code><span class="k">[tool.isort]</span><span class="w"></span> +<span class="na">src_paths</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">["src", "tests"]</span><span class="w"></span> </code></pre></div> <h2 id="old-finders">Old Finders</h2> @@ -4898,13 +4967,13 @@ This can be an excellent shortcut for collecting imports every once in a while w </ul> <p><strong>Examples:</strong></p> <h3 id="example-isortcfg_19">Example <code>.isort.cfg</code></h3> -<div class="codehilite"><pre><span></span><code><span class="k">[settings]</span> -<span class="na">treat_comments_as_code</span> <span class="o">=</span> <span class="s"># my comment 1, # my other comment</span> +<div class="codehilite"><pre><span></span><code><span class="k">[settings]</span><span class="w"></span> +<span class="na">treat_comments_as_code</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s"># my comment 1, # my other comment</span><span class="w"></span> </code></pre></div> <h3 id="example-pyprojecttoml_19">Example <code>pyproject.toml</code></h3> -<div class="codehilite"><pre><span></span><code><span class="k">[tool.isort]</span> -<span class="na">treat_comments_as_code</span> <span class="o">=</span> <span class="s">["# my comment 1", "# my other comment"]</span> +<div class="codehilite"><pre><span></span><code><span class="k">[tool.isort]</span><span class="w"></span> +<span class="na">treat_comments_as_code</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">["# my comment 1", "# my other comment"]</span><span class="w"></span> </code></pre></div> <h2 id="treat-all-comments-as-code">Treat All Comments As Code</h2> @@ -4931,13 +5000,13 @@ This can be an excellent shortcut for collecting imports every once in a while w </ul> <p><strong>Examples:</strong></p> <h3 id="example-isortcfg_20">Example <code>.isort.cfg</code></h3> -<div class="codehilite"><pre><span></span><code><span class="k">[settings]</span> -<span class="na">supported_extensions</span><span class="o">=</span><span class="s">pyw,ext</span> +<div class="codehilite"><pre><span></span><code><span class="k">[settings]</span><span class="w"></span> +<span class="na">supported_extensions</span><span class="o">=</span><span class="s">pyw,ext</span><span class="w"></span> </code></pre></div> <h3 id="example-pyprojecttoml_20">Example <code>pyproject.toml</code></h3> -<div class="codehilite"><pre><span></span><code><span class="k">[tool.isort]</span> -<span class="na">supported_extensions</span> <span class="o">=</span> <span class="s">["pyw", "ext"]</span> +<div class="codehilite"><pre><span></span><code><span class="k">[tool.isort]</span><span class="w"></span> +<span class="na">supported_extensions</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">["pyw", "ext"]</span><span class="w"></span> </code></pre></div> <h2 id="blocked-extensions">Blocked Extensions</h2> @@ -4952,13 +5021,13 @@ This can be an excellent shortcut for collecting imports every once in a while w </ul> <p><strong>Examples:</strong></p> <h3 id="example-isortcfg_21">Example <code>.isort.cfg</code></h3> -<div class="codehilite"><pre><span></span><code><span class="k">[settings]</span> -<span class="na">blocked_extensions</span><span class="o">=</span><span class="s">pyw,pyc</span> +<div class="codehilite"><pre><span></span><code><span class="k">[settings]</span><span class="w"></span> +<span class="na">blocked_extensions</span><span class="o">=</span><span class="s">pyw,pyc</span><span class="w"></span> </code></pre></div> <h3 id="example-pyprojecttoml_21">Example <code>pyproject.toml</code></h3> -<div class="codehilite"><pre><span></span><code><span class="k">[tool.isort]</span> -<span class="na">blocked_extensions</span> <span class="o">=</span> <span class="s">["pyw", "pyc"]</span> +<div class="codehilite"><pre><span></span><code><span class="k">[tool.isort]</span><span class="w"></span> +<span class="na">blocked_extensions</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="s">["pyw", "pyc"]</span><span class="w"></span> </code></pre></div> <h2 id="constants">Constants</h2> |