| |
| <!doctype html> |
| <html lang="en" class="no-js"> |
| <head> |
| |
| <meta charset="utf-8"> |
| <meta name="viewport" content="width=device-width,initial-scale=1"> |
| |
| |
| |
| |
| <link rel="icon" href="../../art/logo.png"> |
| <meta name="generator" content="mkdocs-1.2.1, mkdocs-material-7.2.3"> |
| |
| |
| |
| <title>Settings - isort</title> |
| |
| |
| |
| <link rel="stylesheet" href="../../assets/stylesheets/main.f7f47774.min.css"> |
| |
| |
| <link rel="stylesheet" href="../../assets/stylesheets/palette.3f5d1f46.min.css"> |
| |
| |
| |
| |
| |
| |
| |
| <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin> |
| <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback"> |
| <style>:root{--md-text-font-family:"Roboto";--md-code-font-family:"Roboto Mono"}</style> |
| |
| |
| |
| |
| <link rel="stylesheet" href="../../art/stylesheets/extra.css"> |
| |
| |
| |
| |
| |
| |
| |
| </head> |
| |
| |
| |
| |
| |
| |
| |
| <body dir="ltr" data-md-color-scheme="isort" data-md-color-primary="" data-md-color-accent=""> |
| |
| |
| <script>function __prefix(e){return new URL("../..",location).pathname+"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}</script> |
| |
| <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off"> |
| <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off"> |
| <label class="md-overlay" for="__drawer"></label> |
| <div data-md-component="skip"> |
| |
| |
| <a href="#module-isortsettings" class="md-skip"> |
| Skip to content |
| </a> |
| |
| </div> |
| <div data-md-component="announce"> |
| |
| </div> |
| |
| <header class="md-header" data-md-component="header"> |
| <nav class="md-header__inner md-grid" aria-label="Header"> |
| <a href="../../index.html" title="isort" class="md-header__button md-logo" aria-label="isort" data-md-component="logo"> |
| |
| <img src="../../art/logo.png" alt="logo"> |
| |
| </a> |
| <label class="md-header__button md-icon" for="__drawer"> |
| <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg> |
| </label> |
| <div class="md-header__title" data-md-component="header-title"> |
| <div class="md-header__ellipsis"> |
| <div class="md-header__topic"> |
| <span class="md-ellipsis"> |
| isort |
| </span> |
| </div> |
| <div class="md-header__topic" data-md-component="header-topic"> |
| <span class="md-ellipsis"> |
| |
| Settings |
| |
| </span> |
| </div> |
| </div> |
| </div> |
| |
| |
| |
| <label class="md-header__button md-icon" for="__search"> |
| <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg> |
| </label> |
| |
| <div class="md-search" data-md-component="search" role="dialog"> |
| <label class="md-search__overlay" for="__search"></label> |
| <div class="md-search__inner" role="search"> |
| <form class="md-search__form" name="search"> |
| <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required> |
| <label class="md-search__icon md-icon" for="__search"> |
| <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg> |
| <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg> |
| </label> |
| <nav class="md-search__options" aria-label="Search"> |
| |
| <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1"> |
| <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg> |
| </button> |
| </nav> |
| |
| </form> |
| <div class="md-search__output"> |
| <div class="md-search__scrollwrap" data-md-scrollfix> |
| <div class="md-search-result" data-md-component="search-result"> |
| <div class="md-search-result__meta"> |
| Initializing search |
| </div> |
| <ol class="md-search-result__list"></ol> |
| </div> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div class="md-header__source"> |
| |
| <a href="https://github.com/timothycrosley/isort/" title="Go to repository" class="md-source" data-md-component="source"> |
| <div class="md-source__icon md-icon"> |
| |
| <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg> |
| </div> |
| <div class="md-source__repository"> |
| isort |
| </div> |
| </a> |
| </div> |
| |
| </nav> |
| </header> |
| |
| <div class="md-container" data-md-component="container"> |
| |
| |
| |
| |
| <main class="md-main" data-md-component="main"> |
| <div class="md-main__inner md-grid"> |
| |
| |
| |
| <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" > |
| <div class="md-sidebar__scrollwrap"> |
| <div class="md-sidebar__inner"> |
| |
| |
| |
| <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0"> |
| <label class="md-nav__title" for="__drawer"> |
| <a href="../../index.html" title="isort" class="md-nav__button md-logo" aria-label="isort" data-md-component="logo"> |
| |
| <img src="../../art/logo.png" alt="logo"> |
| |
| </a> |
| isort |
| </label> |
| |
| <div class="md-nav__source"> |
| |
| <a href="https://github.com/timothycrosley/isort/" title="Go to repository" class="md-source" data-md-component="source"> |
| <div class="md-source__icon md-icon"> |
| |
| <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg> |
| </div> |
| <div class="md-source__repository"> |
| isort |
| </div> |
| </a> |
| </div> |
| |
| <ul class="md-nav__list" data-md-scrollfix> |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../../index.html" class="md-nav__link"> |
| Home |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../../CHANGELOG.html" class="md-nav__link"> |
| Changelog |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item md-nav__item--nested"> |
| |
| |
| <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" > |
| |
| <label class="md-nav__link" for="__nav_3"> |
| Configuration |
| <span class="md-nav__icon md-icon"></span> |
| </label> |
| <nav class="md-nav" aria-label="Configuration" data-md-level="1"> |
| <label class="md-nav__title" for="__nav_3"> |
| <span class="md-nav__icon md-icon"></span> |
| Configuration |
| </label> |
| <ul class="md-nav__list" data-md-scrollfix> |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../../docs/configuration/action_comments.html" class="md-nav__link"> |
| Action Comments |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../../docs/configuration/add_or_remove_imports.html" class="md-nav__link"> |
| Add Or Remove Imports |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../../docs/configuration/black_compatibility.html" class="md-nav__link"> |
| Black Compatibility |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../../docs/configuration/config_files.html" class="md-nav__link"> |
| Config Files |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../../docs/configuration/custom_sections_and_ordering.html" class="md-nav__link"> |
| Custom Sections And Ordering |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../../docs/configuration/git_hook.html" class="md-nav__link"> |
| Git Hook |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../../docs/configuration/github_action.html" class="md-nav__link"> |
| Github Action |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../../docs/configuration/multi_line_output_modes.html" class="md-nav__link"> |
| Multi Line Output Modes |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../../docs/configuration/options.html" class="md-nav__link"> |
| Options |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../../docs/configuration/pre-commit.html" class="md-nav__link"> |
| Pre Commit |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../../docs/configuration/profiles.html" class="md-nav__link"> |
| Profiles |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../../docs/configuration/setuptools_integration.html" class="md-nav__link"> |
| Setuptools Integration |
| </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_4" type="checkbox" id="__nav_4" > |
| |
| <label class="md-nav__link" for="__nav_4"> |
| Contributing |
| <span class="md-nav__icon md-icon"></span> |
| </label> |
| <nav class="md-nav" aria-label="Contributing" data-md-level="1"> |
| <label class="md-nav__title" for="__nav_4"> |
| <span class="md-nav__icon md-icon"></span> |
| Contributing |
| </label> |
| <ul class="md-nav__list" data-md-scrollfix> |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../../docs/contributing/1.-contributing-guide.html" class="md-nav__link"> |
| 1. Contributing Guide |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../../docs/contributing/2.-coding-standard.html" class="md-nav__link"> |
| 2. Coding Standard |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../../docs/contributing/3.-code-of-conduct.html" class="md-nav__link"> |
| 3. Code Of Conduct |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../../docs/contributing/4.-acknowledgements.html" class="md-nav__link"> |
| 4. Acknowledgements |
| </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_5" type="checkbox" id="__nav_5" > |
| |
| <label class="md-nav__link" for="__nav_5"> |
| 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"> |
| <span class="md-nav__icon md-icon"></span> |
| Major Releases |
| </label> |
| <ul class="md-nav__list" data-md-scrollfix> |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../../docs/major_releases/introducing_isort_5.html" class="md-nav__link"> |
| Introducing Isort 5 |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../../docs/major_releases/release_policy.html" class="md-nav__link"> |
| Release Policy |
| </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"> |
| 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"> |
| <span class="md-nav__icon md-icon"></span> |
| Quick Start |
| </label> |
| <ul class="md-nav__list" data-md-scrollfix> |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../../docs/quick_start/0.-try.html" class="md-nav__link"> |
| 0. Try |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../../docs/quick_start/1.-install.html" class="md-nav__link"> |
| 1. Install |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../../docs/quick_start/2.-cli.html" class="md-nav__link"> |
| 2. Cli |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../../docs/quick_start/3.-api.html" class="md-nav__link"> |
| 3. Api |
| </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_7" type="checkbox" id="__nav_7" > |
| |
| <label class="md-nav__link" for="__nav_7"> |
| 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"> |
| <span class="md-nav__icon md-icon"></span> |
| Upgrade Guides |
| </label> |
| <ul class="md-nav__list" data-md-scrollfix> |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../../docs/upgrade_guides/5.0.0.html" class="md-nav__link"> |
| 5.0.0 |
| </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_8" type="checkbox" id="__nav_8" > |
| |
| <label class="md-nav__link" for="__nav_8"> |
| 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"> |
| <span class="md-nav__icon md-icon"></span> |
| Warning And Error Codes |
| </label> |
| <ul class="md-nav__list" data-md-scrollfix> |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../../docs/warning_and_error_codes/W0500.html" class="md-nav__link"> |
| W0500 |
| </a> |
| </li> |
| |
| |
| |
| </ul> |
| </nav> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item md-nav__item--active md-nav__item--nested"> |
| |
| |
| <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_9" type="checkbox" id="__nav_9" checked> |
| |
| <label class="md-nav__link" for="__nav_9"> |
| 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"> |
| <span class="md-nav__icon md-icon"></span> |
| Reference |
| </label> |
| <ul class="md-nav__list" data-md-scrollfix> |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item md-nav__item--active md-nav__item--nested"> |
| |
| |
| <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_9_1" type="checkbox" id="__nav_9_1" checked> |
| |
| <label class="md-nav__link" for="__nav_9_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"> |
| <span class="md-nav__icon md-icon"></span> |
| Isort |
| </label> |
| <ul class="md-nav__list" data-md-scrollfix> |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="api.html" class="md-nav__link"> |
| API |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="comments.html" class="md-nav__link"> |
| Comments |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="core.html" class="md-nav__link"> |
| Core |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="exceptions.html" class="md-nav__link"> |
| Exceptions |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="files.html" class="md-nav__link"> |
| Files |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="format.html" class="md-nav__link"> |
| Format |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="hooks.html" class="md-nav__link"> |
| Hooks |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="identify.html" class="md-nav__link"> |
| Identify |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="index.html" class="md-nav__link"> |
| Index |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="io.html" class="md-nav__link"> |
| Io |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="literal.html" class="md-nav__link"> |
| Literal |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="logo.html" class="md-nav__link"> |
| Logo |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="main.html" class="md-nav__link"> |
| Main |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="output.html" class="md-nav__link"> |
| Output |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="parse.html" class="md-nav__link"> |
| Parse |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="place.html" class="md-nav__link"> |
| Place |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="profiles.html" class="md-nav__link"> |
| Profiles |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="pylama_isort.html" class="md-nav__link"> |
| Pylama Isort |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="sections.html" class="md-nav__link"> |
| Sections |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item md-nav__item--active"> |
| |
| <input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc"> |
| |
| |
| |
| |
| |
| <label class="md-nav__link md-nav__link--active" for="__toc"> |
| Settings |
| <span class="md-nav__icon md-icon"></span> |
| </label> |
| |
| <a href="settings.html" class="md-nav__link md-nav__link--active"> |
| Settings |
| </a> |
| |
| |
| <nav class="md-nav md-nav--secondary" aria-label="Table of contents"> |
| |
| |
| |
| |
| |
| |
| <label class="md-nav__title" for="__toc"> |
| <span class="md-nav__icon md-icon"></span> |
| Table of contents |
| </label> |
| <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> |
| |
| <nav class="md-nav" aria-label="Functions"> |
| <ul class="md-nav__list"> |
| |
| <li class="md-nav__item"> |
| <a href="#find_all_configs" class="md-nav__link"> |
| find_all_configs |
| </a> |
| |
| </li> |
| |
| </ul> |
| </nav> |
| |
| </li> |
| |
| <li class="md-nav__item"> |
| <a href="#classes" class="md-nav__link"> |
| Classes |
| </a> |
| |
| <nav class="md-nav" aria-label="Classes"> |
| <ul class="md-nav__list"> |
| |
| <li class="md-nav__item"> |
| <a href="#config" class="md-nav__link"> |
| Config |
| </a> |
| |
| <nav class="md-nav" aria-label="Config"> |
| <ul class="md-nav__list"> |
| |
| <li class="md-nav__item"> |
| <a href="#ancestors-in-mro" class="md-nav__link"> |
| Ancestors (in MRO) |
| </a> |
| |
| </li> |
| |
| <li class="md-nav__item"> |
| <a href="#class-variables" class="md-nav__link"> |
| Class variables |
| </a> |
| |
| </li> |
| |
| <li class="md-nav__item"> |
| <a href="#instance-variables" class="md-nav__link"> |
| Instance variables |
| </a> |
| |
| </li> |
| |
| <li class="md-nav__item"> |
| <a href="#methods" class="md-nav__link"> |
| Methods |
| </a> |
| |
| </li> |
| |
| <li class="md-nav__item"> |
| <a href="#is_skipped" class="md-nav__link"> |
| is_skipped |
| </a> |
| |
| </li> |
| |
| <li class="md-nav__item"> |
| <a href="#is_supported_filetype" class="md-nav__link"> |
| is_supported_filetype |
| </a> |
| |
| </li> |
| |
| </ul> |
| </nav> |
| |
| </li> |
| |
| </ul> |
| </nav> |
| |
| </li> |
| |
| </ul> |
| |
| </nav> |
| |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="setuptools_commands.html" class="md-nav__link"> |
| Setuptools Commands |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="sorting.html" class="md-nav__link"> |
| Sorting |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="utils.html" class="md-nav__link"> |
| Utils |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="wrap.html" class="md-nav__link"> |
| Wrap |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="wrap_modes.html" class="md-nav__link"> |
| Wrap Modes |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| <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" > |
| |
| <label class="md-nav__link" for="__nav_9_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"> |
| <span class="md-nav__icon md-icon"></span> |
| Deprecated |
| </label> |
| <ul class="md-nav__list" data-md-scrollfix> |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="deprecated/finders.html" class="md-nav__link"> |
| Finders |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="deprecated/index.html" class="md-nav__link"> |
| Index |
| </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_9_1_27" type="checkbox" id="__nav_9_1_27" > |
| |
| <label class="md-nav__link" for="__nav_9_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"> |
| <span class="md-nav__icon md-icon"></span> |
| Stdlibs |
| </label> |
| <ul class="md-nav__list" data-md-scrollfix> |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="stdlibs/all.html" class="md-nav__link"> |
| All |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="stdlibs/index.html" class="md-nav__link"> |
| Index |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="stdlibs/py2.html" class="md-nav__link"> |
| Py2 |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="stdlibs/py27.html" class="md-nav__link"> |
| Py27 |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="stdlibs/py3.html" class="md-nav__link"> |
| Py3 |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="stdlibs/py310.html" class="md-nav__link"> |
| Py310 |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="stdlibs/py35.html" class="md-nav__link"> |
| Py35 |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="stdlibs/py36.html" class="md-nav__link"> |
| Py36 |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="stdlibs/py37.html" class="md-nav__link"> |
| Py37 |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="stdlibs/py38.html" class="md-nav__link"> |
| Py38 |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="stdlibs/py39.html" class="md-nav__link"> |
| Py39 |
| </a> |
| </li> |
| |
| |
| |
| </ul> |
| </nav> |
| </li> |
| |
| |
| |
| </ul> |
| </nav> |
| </li> |
| |
| |
| |
| </ul> |
| </nav> |
| </li> |
| |
| |
| |
| </ul> |
| </nav> |
| </div> |
| </div> |
| </div> |
| |
| |
| |
| <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" > |
| <div class="md-sidebar__scrollwrap"> |
| <div class="md-sidebar__inner"> |
| |
| <nav class="md-nav md-nav--secondary" aria-label="Table of contents"> |
| |
| |
| |
| |
| |
| |
| <label class="md-nav__title" for="__toc"> |
| <span class="md-nav__icon md-icon"></span> |
| Table of contents |
| </label> |
| <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> |
| |
| <nav class="md-nav" aria-label="Functions"> |
| <ul class="md-nav__list"> |
| |
| <li class="md-nav__item"> |
| <a href="#find_all_configs" class="md-nav__link"> |
| find_all_configs |
| </a> |
| |
| </li> |
| |
| </ul> |
| </nav> |
| |
| </li> |
| |
| <li class="md-nav__item"> |
| <a href="#classes" class="md-nav__link"> |
| Classes |
| </a> |
| |
| <nav class="md-nav" aria-label="Classes"> |
| <ul class="md-nav__list"> |
| |
| <li class="md-nav__item"> |
| <a href="#config" class="md-nav__link"> |
| Config |
| </a> |
| |
| <nav class="md-nav" aria-label="Config"> |
| <ul class="md-nav__list"> |
| |
| <li class="md-nav__item"> |
| <a href="#ancestors-in-mro" class="md-nav__link"> |
| Ancestors (in MRO) |
| </a> |
| |
| </li> |
| |
| <li class="md-nav__item"> |
| <a href="#class-variables" class="md-nav__link"> |
| Class variables |
| </a> |
| |
| </li> |
| |
| <li class="md-nav__item"> |
| <a href="#instance-variables" class="md-nav__link"> |
| Instance variables |
| </a> |
| |
| </li> |
| |
| <li class="md-nav__item"> |
| <a href="#methods" class="md-nav__link"> |
| Methods |
| </a> |
| |
| </li> |
| |
| <li class="md-nav__item"> |
| <a href="#is_skipped" class="md-nav__link"> |
| is_skipped |
| </a> |
| |
| </li> |
| |
| <li class="md-nav__item"> |
| <a href="#is_supported_filetype" class="md-nav__link"> |
| is_supported_filetype |
| </a> |
| |
| </li> |
| |
| </ul> |
| </nav> |
| |
| </li> |
| |
| </ul> |
| </nav> |
| |
| </li> |
| |
| </ul> |
| |
| </nav> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div class="md-content" data-md-component="content"> |
| <article class="md-content__inner md-typeset"> |
| |
| |
| <a href="https://github.com/pycqa/isort/edit/main/reference/isort/settings.md" title="Edit this page" class="md-content__button md-icon"> |
| <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25z"/></svg> |
| </a> |
| |
| |
| <h1 id="module-isortsettings">Module isort.settings</h1> |
| <p>isort/settings.py.</p> |
| <p>Defines how the default settings for isort should be loaded</p> |
| <details class="example"><summary>View Source</summary><div class="codehilite"><pre><span></span><code><span class="sd">"""isort/settings.py.</span> |
| |
| <span class="sd">Defines how the default settings for isort should be loaded</span> |
| |
| <span class="sd">"""</span> |
| |
| <span class="kn">import</span> <span class="nn">configparser</span> |
| |
| <span class="kn">import</span> <span class="nn">fnmatch</span> |
| |
| <span class="kn">import</span> <span class="nn">os</span> |
| |
| <span class="kn">import</span> <span class="nn">posixpath</span> |
| |
| <span class="kn">import</span> <span class="nn">re</span> |
| |
| <span class="kn">import</span> <span class="nn">stat</span> |
| |
| <span class="kn">import</span> <span class="nn">subprocess</span> <span class="c1"># nosec: Needed for gitignore support.</span> |
| |
| <span class="kn">import</span> <span class="nn">sys</span> |
| |
| <span class="kn">from</span> <span class="nn">functools</span> <span class="kn">import</span> <span class="n">lru_cache</span> |
| |
| <span class="kn">from</span> <span class="nn">pathlib</span> <span class="kn">import</span> <span class="n">Path</span> |
| |
| <span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="p">(</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">Dict</span><span class="p">,</span> |
| |
| <span class="n">FrozenSet</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="p">,</span> |
| |
| <span class="n">Pattern</span><span class="p">,</span> |
| |
| <span class="n">Set</span><span class="p">,</span> |
| |
| <span class="n">Tuple</span><span class="p">,</span> |
| |
| <span class="n">Type</span><span class="p">,</span> |
| |
| <span class="n">Union</span><span class="p">,</span> |
| |
| <span class="p">)</span> |
| |
| <span class="kn">from</span> <span class="nn">warnings</span> <span class="kn">import</span> <span class="n">warn</span> |
| |
| <span class="kn">from</span> <span class="nn">.</span> <span class="kn">import</span> <span class="n">sorting</span><span class="p">,</span> <span class="n">stdlibs</span> |
| |
| <span class="kn">from</span> <span class="nn">._future</span> <span class="kn">import</span> <span class="n">dataclass</span><span class="p">,</span> <span class="n">field</span> |
| |
| <span class="kn">from</span> <span class="nn">.exceptions</span> <span class="kn">import</span> <span class="p">(</span> |
| |
| <span class="n">FormattingPluginDoesNotExist</span><span class="p">,</span> |
| |
| <span class="n">InvalidSettingsPath</span><span class="p">,</span> |
| |
| <span class="n">ProfileDoesNotExist</span><span class="p">,</span> |
| |
| <span class="n">SortingFunctionDoesNotExist</span><span class="p">,</span> |
| |
| <span class="n">UnsupportedSettings</span><span class="p">,</span> |
| |
| <span class="p">)</span> |
| |
| <span class="kn">from</span> <span class="nn">.profiles</span> <span class="kn">import</span> <span class="n">profiles</span> |
| |
| <span class="kn">from</span> <span class="nn">.sections</span> <span class="kn">import</span> <span class="n">DEFAULT</span> <span class="k">as</span> <span class="n">SECTION_DEFAULTS</span> |
| |
| <span class="kn">from</span> <span class="nn">.sections</span> <span class="kn">import</span> <span class="n">FIRSTPARTY</span><span class="p">,</span> <span class="n">FUTURE</span><span class="p">,</span> <span class="n">LOCALFOLDER</span><span class="p">,</span> <span class="n">STDLIB</span><span class="p">,</span> <span class="n">THIRDPARTY</span> |
| |
| <span class="kn">from</span> <span class="nn">.utils</span> <span class="kn">import</span> <span class="n">Trie</span> |
| |
| <span class="kn">from</span> <span class="nn">.wrap_modes</span> <span class="kn">import</span> <span class="n">WrapModes</span> |
| |
| <span class="kn">from</span> <span class="nn">.wrap_modes</span> <span class="kn">import</span> <span class="n">from_string</span> <span class="k">as</span> <span class="n">wrap_mode_from_string</span> |
| |
| <span class="k">if</span> <span class="n">TYPE_CHECKING</span><span class="p">:</span> |
| |
| <span class="n">tomli</span><span class="p">:</span> <span class="n">Any</span> |
| |
| <span class="k">else</span><span class="p">:</span> |
| |
| <span class="kn">from</span> <span class="nn">._vendored</span> <span class="kn">import</span> <span class="n">tomli</span> |
| |
| <span class="n">_SHEBANG_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="sa">br</span><span class="s2">"^#!.*\bpython[23w]?\b"</span><span class="p">)</span> |
| |
| <span class="n">CYTHON_EXTENSIONS</span> <span class="o">=</span> <span class="nb">frozenset</span><span class="p">({</span><span class="s2">"pyx"</span><span class="p">,</span> <span class="s2">"pxd"</span><span class="p">})</span> |
| |
| <span class="n">SUPPORTED_EXTENSIONS</span> <span class="o">=</span> <span class="nb">frozenset</span><span class="p">({</span><span class="s2">"py"</span><span class="p">,</span> <span class="s2">"pyi"</span><span class="p">,</span> <span class="o">*</span><span class="n">CYTHON_EXTENSIONS</span><span class="p">})</span> |
| |
| <span class="n">BLOCKED_EXTENSIONS</span> <span class="o">=</span> <span class="nb">frozenset</span><span class="p">({</span><span class="s2">"pex"</span><span class="p">})</span> |
| |
| <span class="n">FILE_SKIP_COMMENTS</span><span class="p">:</span> <span class="n">Tuple</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="o">...</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span> |
| |
| <span class="s2">"isort:"</span> <span class="o">+</span> <span class="s2">"skip_file"</span><span class="p">,</span> |
| |
| <span class="s2">"isort: "</span> <span class="o">+</span> <span class="s2">"skip_file"</span><span class="p">,</span> |
| |
| <span class="p">)</span> <span class="c1"># Concatenated to avoid this file being skipped</span> |
| |
| <span class="n">MAX_CONFIG_SEARCH_DEPTH</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">25</span> <span class="c1"># The number of parent directories to for a config file within</span> |
| |
| <span class="n">STOP_CONFIG_SEARCH_ON_DIRS</span><span class="p">:</span> <span class="n">Tuple</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="o">...</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span><span class="s2">".git"</span><span class="p">,</span> <span class="s2">".hg"</span><span class="p">)</span> |
| |
| <span class="n">VALID_PY_TARGETS</span><span class="p">:</span> <span class="n">Tuple</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="o">...</span><span class="p">]</span> <span class="o">=</span> <span class="nb">tuple</span><span class="p">(</span> |
| |
| <span class="n">target</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s2">"py"</span><span class="p">,</span> <span class="s2">""</span><span class="p">)</span> <span class="k">for</span> <span class="n">target</span> <span class="ow">in</span> <span class="nb">dir</span><span class="p">(</span><span class="n">stdlibs</span><span class="p">)</span> <span class="k">if</span> <span class="ow">not</span> <span class="n">target</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s2">"_"</span><span class="p">)</span> |
| |
| <span class="p">)</span> |
| |
| <span class="n">CONFIG_SOURCES</span><span class="p">:</span> <span class="n">Tuple</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="o">...</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span> |
| |
| <span class="s2">".isort.cfg"</span><span class="p">,</span> |
| |
| <span class="s2">"pyproject.toml"</span><span class="p">,</span> |
| |
| <span class="s2">"setup.cfg"</span><span class="p">,</span> |
| |
| <span class="s2">"tox.ini"</span><span class="p">,</span> |
| |
| <span class="s2">".editorconfig"</span><span class="p">,</span> |
| |
| <span class="p">)</span> |
| |
| <span class="n">DEFAULT_SKIP</span><span class="p">:</span> <span class="n">FrozenSet</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="nb">frozenset</span><span class="p">(</span> |
| |
| <span class="p">{</span> |
| |
| <span class="s2">".venv"</span><span class="p">,</span> |
| |
| <span class="s2">"venv"</span><span class="p">,</span> |
| |
| <span class="s2">".tox"</span><span class="p">,</span> |
| |
| <span class="s2">".eggs"</span><span class="p">,</span> |
| |
| <span class="s2">".git"</span><span class="p">,</span> |
| |
| <span class="s2">".hg"</span><span class="p">,</span> |
| |
| <span class="s2">".mypy_cache"</span><span class="p">,</span> |
| |
| <span class="s2">".nox"</span><span class="p">,</span> |
| |
| <span class="s2">".svn"</span><span class="p">,</span> |
| |
| <span class="s2">".bzr"</span><span class="p">,</span> |
| |
| <span class="s2">"_build"</span><span class="p">,</span> |
| |
| <span class="s2">"buck-out"</span><span class="p">,</span> |
| |
| <span class="s2">"build"</span><span class="p">,</span> |
| |
| <span class="s2">"dist"</span><span class="p">,</span> |
| |
| <span class="s2">".pants.d"</span><span class="p">,</span> |
| |
| <span class="s2">".direnv"</span><span class="p">,</span> |
| |
| <span class="s2">"node_modules"</span><span class="p">,</span> |
| |
| <span class="s2">"__pypackages__"</span><span class="p">,</span> |
| |
| <span class="p">}</span> |
| |
| <span class="p">)</span> |
| |
| <span class="n">CONFIG_SECTIONS</span><span class="p">:</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Tuple</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="o">...</span><span class="p">]]</span> <span class="o">=</span> <span class="p">{</span> |
| |
| <span class="s2">".isort.cfg"</span><span class="p">:</span> <span class="p">(</span><span class="s2">"settings"</span><span class="p">,</span> <span class="s2">"isort"</span><span class="p">),</span> |
| |
| <span class="s2">"pyproject.toml"</span><span class="p">:</span> <span class="p">(</span><span class="s2">"tool.isort"</span><span class="p">,),</span> |
| |
| <span class="s2">"setup.cfg"</span><span class="p">:</span> <span class="p">(</span><span class="s2">"isort"</span><span class="p">,</span> <span class="s2">"tool:isort"</span><span class="p">),</span> |
| |
| <span class="s2">"tox.ini"</span><span class="p">:</span> <span class="p">(</span><span class="s2">"isort"</span><span class="p">,</span> <span class="s2">"tool:isort"</span><span class="p">),</span> |
| |
| <span class="s2">".editorconfig"</span><span class="p">:</span> <span class="p">(</span><span class="s2">"*"</span><span class="p">,</span> <span class="s2">"*.py"</span><span class="p">,</span> <span class="s2">"**.py"</span><span class="p">,</span> <span class="s2">"*.</span><span class="si">{py}</span><span class="s2">"</span><span class="p">),</span> |
| |
| <span class="p">}</span> |
| |
| <span class="n">FALLBACK_CONFIG_SECTIONS</span><span class="p">:</span> <span class="n">Tuple</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="o">...</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span><span class="s2">"isort"</span><span class="p">,</span> <span class="s2">"tool:isort"</span><span class="p">,</span> <span class="s2">"tool.isort"</span><span class="p">)</span> |
| |
| <span class="n">IMPORT_HEADING_PREFIX</span> <span class="o">=</span> <span class="s2">"import_heading_"</span> |
| |
| <span class="n">IMPORT_FOOTER_PREFIX</span> <span class="o">=</span> <span class="s2">"import_footer_"</span> |
| |
| <span class="n">KNOWN_PREFIX</span> <span class="o">=</span> <span class="s2">"known_"</span> |
| |
| <span class="n">KNOWN_SECTION_MAPPING</span><span class="p">:</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="p">{</span> |
| |
| <span class="n">STDLIB</span><span class="p">:</span> <span class="s2">"STANDARD_LIBRARY"</span><span class="p">,</span> |
| |
| <span class="n">FUTURE</span><span class="p">:</span> <span class="s2">"FUTURE_LIBRARY"</span><span class="p">,</span> |
| |
| <span class="n">FIRSTPARTY</span><span class="p">:</span> <span class="s2">"FIRST_PARTY"</span><span class="p">,</span> |
| |
| <span class="n">THIRDPARTY</span><span class="p">:</span> <span class="s2">"THIRD_PARTY"</span><span class="p">,</span> |
| |
| <span class="n">LOCALFOLDER</span><span class="p">:</span> <span class="s2">"LOCAL_FOLDER"</span><span class="p">,</span> |
| |
| <span class="p">}</span> |
| |
| <span class="n">RUNTIME_SOURCE</span> <span class="o">=</span> <span class="s2">"runtime"</span> |
| |
| <span class="n">DEPRECATED_SETTINGS</span> <span class="o">=</span> <span class="p">(</span><span class="s2">"not_skip"</span><span class="p">,</span> <span class="s2">"keep_direct_and_as_imports"</span><span class="p">)</span> |
| |
| <span class="n">_STR_BOOLEAN_MAPPING</span> <span class="o">=</span> <span class="p">{</span> |
| |
| <span class="s2">"y"</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span> |
| |
| <span class="s2">"yes"</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span> |
| |
| <span class="s2">"t"</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span> |
| |
| <span class="s2">"on"</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span> |
| |
| <span class="s2">"1"</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span> |
| |
| <span class="s2">"true"</span><span class="p">:</span> <span class="kc">True</span><span class="p">,</span> |
| |
| <span class="s2">"n"</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span> |
| |
| <span class="s2">"no"</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span> |
| |
| <span class="s2">"f"</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span> |
| |
| <span class="s2">"off"</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span> |
| |
| <span class="s2">"0"</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span> |
| |
| <span class="s2">"false"</span><span class="p">:</span> <span class="kc">False</span><span class="p">,</span> |
| |
| <span class="p">}</span> |
| |
| <span class="nd">@dataclass</span><span class="p">(</span><span class="n">frozen</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> |
| |
| <span class="k">class</span> <span class="nc">_Config</span><span class="p">:</span> |
| |
| <span class="sd">"""Defines the data schema and defaults used for isort configuration.</span> |
| |
| <span class="sd"> NOTE: known lists, such as known_standard_library, are intentionally not complete as they are</span> |
| |
| <span class="sd"> dynamically determined later on.</span> |
| |
| <span class="sd"> """</span> |
| |
| <span class="n">py_version</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">"3"</span> |
| |
| <span class="n">force_to_top</span><span class="p">:</span> <span class="n">FrozenSet</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="nb">frozenset</span><span class="p">()</span> |
| |
| <span class="n">skip</span><span class="p">:</span> <span class="n">FrozenSet</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="n">DEFAULT_SKIP</span> |
| |
| <span class="n">extend_skip</span><span class="p">:</span> <span class="n">FrozenSet</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="nb">frozenset</span><span class="p">()</span> |
| |
| <span class="n">skip_glob</span><span class="p">:</span> <span class="n">FrozenSet</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="nb">frozenset</span><span class="p">()</span> |
| |
| <span class="n">extend_skip_glob</span><span class="p">:</span> <span class="n">FrozenSet</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="nb">frozenset</span><span class="p">()</span> |
| |
| <span class="n">skip_gitignore</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span> |
| |
| <span class="n">line_length</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">79</span> |
| |
| <span class="n">wrap_length</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">0</span> |
| |
| <span class="n">line_ending</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">""</span> |
| |
| <span class="n">sections</span><span class="p">:</span> <span class="n">Tuple</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="o">...</span><span class="p">]</span> <span class="o">=</span> <span class="n">SECTION_DEFAULTS</span> |
| |
| <span class="n">no_sections</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span> |
| |
| <span class="n">known_future_library</span><span class="p">:</span> <span class="n">FrozenSet</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="nb">frozenset</span><span class="p">((</span><span class="s2">"__future__"</span><span class="p">,))</span> |
| |
| <span class="n">known_third_party</span><span class="p">:</span> <span class="n">FrozenSet</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="nb">frozenset</span><span class="p">()</span> |
| |
| <span class="n">known_first_party</span><span class="p">:</span> <span class="n">FrozenSet</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="nb">frozenset</span><span class="p">()</span> |
| |
| <span class="n">known_local_folder</span><span class="p">:</span> <span class="n">FrozenSet</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="nb">frozenset</span><span class="p">()</span> |
| |
| <span class="n">known_standard_library</span><span class="p">:</span> <span class="n">FrozenSet</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="nb">frozenset</span><span class="p">()</span> |
| |
| <span class="n">extra_standard_library</span><span class="p">:</span> <span class="n">FrozenSet</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="nb">frozenset</span><span class="p">()</span> |
| |
| <span class="n">known_other</span><span class="p">:</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">FrozenSet</span><span class="p">[</span><span class="nb">str</span><span class="p">]]</span> <span class="o">=</span> <span class="n">field</span><span class="p">(</span><span class="n">default_factory</span><span class="o">=</span><span class="nb">dict</span><span class="p">)</span> |
| |
| <span class="n">multi_line_output</span><span class="p">:</span> <span class="n">WrapModes</span> <span class="o">=</span> <span class="n">WrapModes</span><span class="o">.</span><span class="n">GRID</span> <span class="c1"># type: ignore</span> |
| |
| <span class="n">forced_separate</span><span class="p">:</span> <span class="n">Tuple</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="o">...</span><span class="p">]</span> <span class="o">=</span> <span class="p">()</span> |
| |
| <span class="n">indent</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">" "</span> <span class="o">*</span> <span class="mi">4</span> |
| |
| <span class="n">comment_prefix</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">" #"</span> |
| |
| <span class="n">length_sort</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span> |
| |
| <span class="n">length_sort_straight</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span> |
| |
| <span class="n">length_sort_sections</span><span class="p">:</span> <span class="n">FrozenSet</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="nb">frozenset</span><span class="p">()</span> |
| |
| <span class="n">add_imports</span><span class="p">:</span> <span class="n">FrozenSet</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="nb">frozenset</span><span class="p">()</span> |
| |
| <span class="n">remove_imports</span><span class="p">:</span> <span class="n">FrozenSet</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="nb">frozenset</span><span class="p">()</span> |
| |
| <span class="n">append_only</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span> |
| |
| <span class="n">reverse_relative</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span> |
| |
| <span class="n">force_single_line</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span> |
| |
| <span class="n">single_line_exclusions</span><span class="p">:</span> <span class="n">Tuple</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="o">...</span><span class="p">]</span> <span class="o">=</span> <span class="p">()</span> |
| |
| <span class="n">default_section</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="n">THIRDPARTY</span> |
| |
| <span class="n">import_headings</span><span class="p">:</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="n">field</span><span class="p">(</span><span class="n">default_factory</span><span class="o">=</span><span class="nb">dict</span><span class="p">)</span> |
| |
| <span class="n">import_footers</span><span class="p">:</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="n">field</span><span class="p">(</span><span class="n">default_factory</span><span class="o">=</span><span class="nb">dict</span><span class="p">)</span> |
| |
| <span class="n">balanced_wrapping</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span> |
| |
| <span class="n">use_parentheses</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span> |
| |
| <span class="n">order_by_type</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span> |
| |
| <span class="n">atomic</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span> |
| |
| <span class="n">lines_before_imports</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="o">-</span><span class="mi">1</span> |
| |
| <span class="n">lines_after_imports</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="o">-</span><span class="mi">1</span> |
| |
| <span class="n">lines_between_sections</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">1</span> |
| |
| <span class="n">lines_between_types</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">0</span> |
| |
| <span class="n">combine_as_imports</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span> |
| |
| <span class="n">combine_star</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span> |
| |
| <span class="n">include_trailing_comma</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span> |
| |
| <span class="n">from_first</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span> |
| |
| <span class="n">verbose</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span> |
| |
| <span class="n">quiet</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span> |
| |
| <span class="n">force_adds</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span> |
| |
| <span class="n">force_alphabetical_sort_within_sections</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span> |
| |
| <span class="n">force_alphabetical_sort</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span> |
| |
| <span class="n">force_grid_wrap</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="mi">0</span> |
| |
| <span class="n">force_sort_within_sections</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span> |
| |
| <span class="n">lexicographical</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span> |
| |
| <span class="n">group_by_package</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span> |
| |
| <span class="n">ignore_whitespace</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span> |
| |
| <span class="n">no_lines_before</span><span class="p">:</span> <span class="n">FrozenSet</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="nb">frozenset</span><span class="p">()</span> |
| |
| <span class="n">no_inline_sort</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span> |
| |
| <span class="n">ignore_comments</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span> |
| |
| <span class="n">case_sensitive</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span> |
| |
| <span class="n">sources</span><span class="p">:</span> <span class="n">Tuple</span><span class="p">[</span><span class="n">Dict</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="o">...</span><span class="p">]</span> <span class="o">=</span> <span class="p">()</span> |
| |
| <span class="n">virtual_env</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">""</span> |
| |
| <span class="n">conda_env</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">""</span> |
| |
| <span class="n">ensure_newline_before_comments</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span> |
| |
| <span class="n">directory</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">""</span> |
| |
| <span class="n">profile</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">""</span> |
| |
| <span class="n">honor_noqa</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span> |
| |
| <span class="n">src_paths</span><span class="p">:</span> <span class="n">Tuple</span><span class="p">[</span><span class="n">Path</span><span class="p">,</span> <span class="o">...</span><span class="p">]</span> <span class="o">=</span> <span class="p">()</span> |
| |
| <span class="n">old_finders</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span> |
| |
| <span class="n">remove_redundant_aliases</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span> |
| |
| <span class="n">float_to_top</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span> |
| |
| <span class="n">filter_files</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span> |
| |
| <span class="n">formatter</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">""</span> |
| |
| <span class="n">formatting_function</span><span class="p">:</span> <span class="n">Optional</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="nb">str</span><span class="p">,</span> <span class="nb">object</span><span class="p">],</span> <span class="nb">str</span><span class="p">]]</span> <span class="o">=</span> <span class="kc">None</span> |
| |
| <span class="n">color_output</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span> |
| |
| <span class="n">treat_comments_as_code</span><span class="p">:</span> <span class="n">FrozenSet</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="nb">frozenset</span><span class="p">()</span> |
| |
| <span class="n">treat_all_comments_as_code</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span> |
| |
| <span class="n">supported_extensions</span><span class="p">:</span> <span class="n">FrozenSet</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="n">SUPPORTED_EXTENSIONS</span> |
| |
| <span class="n">blocked_extensions</span><span class="p">:</span> <span class="n">FrozenSet</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="n">BLOCKED_EXTENSIONS</span> |
| |
| <span class="n">constants</span><span class="p">:</span> <span class="n">FrozenSet</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="nb">frozenset</span><span class="p">()</span> |
| |
| <span class="n">classes</span><span class="p">:</span> <span class="n">FrozenSet</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="nb">frozenset</span><span class="p">()</span> |
| |
| <span class="n">variables</span><span class="p">:</span> <span class="n">FrozenSet</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="nb">frozenset</span><span class="p">()</span> |
| |
| <span class="n">dedup_headings</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span> |
| |
| <span class="n">only_sections</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span> |
| |
| <span class="n">only_modified</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span> |
| |
| <span class="n">combine_straight_imports</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span> |
| |
| <span class="n">auto_identify_namespace_packages</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span> |
| |
| <span class="n">namespace_packages</span><span class="p">:</span> <span class="n">FrozenSet</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> <span class="o">=</span> <span class="nb">frozenset</span><span class="p">()</span> |
| |
| <span class="n">follow_links</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span> |
| |
| <span class="n">indented_import_headings</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">True</span> |
| |
| <span class="n">honor_case_in_force_sorted_sections</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span> |
| |
| <span class="n">sort_relative_in_force_sorted_sections</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span> |
| |
| <span class="n">overwrite_in_place</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span> |
| |
| <span class="n">reverse_sort</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span> |
| |
| <span class="n">star_first</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span> |
| |
| <span class="n">import_dependencies</span> <span class="o">=</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="nb">str</span><span class="p">]</span> |
| |
| <span class="n">git_ignore</span><span class="p">:</span> <span class="n">Dict</span><span class="p">[</span><span class="n">Path</span><span class="p">,</span> <span class="n">Set</span><span class="p">[</span><span class="n">Path</span><span class="p">]]</span> <span class="o">=</span> <span class="n">field</span><span class="p">(</span><span class="n">default_factory</span><span class="o">=</span><span class="nb">dict</span><span class="p">)</span> |
| |
| <span class="n">format_error</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">"</span><span class="si">{error}</span><span class="s2">: </span><span class="si">{message}</span><span class="s2">"</span> |
| |
| <span class="n">format_success</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">"</span><span class="si">{success}</span><span class="s2">: </span><span class="si">{message}</span><span class="s2">"</span> |
| |
| <span class="n">sort_order</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">"natural"</span> |
| |
| <span class="k">def</span> <span class="nf">__post_init__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span> |
| |
| <span class="n">py_version</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">py_version</span> |
| |
| <span class="k">if</span> <span class="n">py_version</span> <span class="o">==</span> <span class="s2">"auto"</span><span class="p">:</span> <span class="c1"># pragma: no cover</span> |
| |
| <span class="k">if</span> <span class="n">sys</span><span class="o">.</span><span class="n">version_info</span><span class="o">.</span><span class="n">major</span> <span class="o">==</span> <span class="mi">2</span> <span class="ow">and</span> <span class="n">sys</span><span class="o">.</span><span class="n">version_info</span><span class="o">.</span><span class="n">minor</span> <span class="o"><=</span> <span class="mi">6</span><span class="p">:</span> |
| |
| <span class="n">py_version</span> <span class="o">=</span> <span class="s2">"2"</span> |
| |
| <span class="k">elif</span> <span class="n">sys</span><span class="o">.</span><span class="n">version_info</span><span class="o">.</span><span class="n">major</span> <span class="o">==</span> <span class="mi">3</span> <span class="ow">and</span> <span class="p">(</span> |
| |
| <span class="n">sys</span><span class="o">.</span><span class="n">version_info</span><span class="o">.</span><span class="n">minor</span> <span class="o"><=</span> <span class="mi">5</span> <span class="ow">or</span> <span class="n">sys</span><span class="o">.</span><span class="n">version_info</span><span class="o">.</span><span class="n">minor</span> <span class="o">>=</span> <span class="mi">10</span> |
| |
| <span class="p">):</span> |
| |
| <span class="n">py_version</span> <span class="o">=</span> <span class="s2">"3"</span> |
| |
| <span class="k">else</span><span class="p">:</span> |
| |
| <span class="n">py_version</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">sys</span><span class="o">.</span><span class="n">version_info</span><span class="o">.</span><span class="n">major</span><span class="si">}{</span><span class="n">sys</span><span class="o">.</span><span class="n">version_info</span><span class="o">.</span><span class="n">minor</span><span class="si">}</span><span class="s2">"</span> |
| |
| <span class="k">if</span> <span class="n">py_version</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">VALID_PY_TARGETS</span><span class="p">:</span> |
| |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span> |
| |
| <span class="sa">f</span><span class="s2">"The python version </span><span class="si">{</span><span class="n">py_version</span><span class="si">}</span><span class="s2"> is not supported. "</span> |
| |
| <span class="s2">"You can set a python version with the -py or --python-version flag. "</span> |
| |
| <span class="sa">f</span><span class="s2">"The following versions are supported: </span><span class="si">{</span><span class="n">VALID_PY_TARGETS</span><span class="si">}</span><span class="s2">"</span> |
| |
| <span class="p">)</span> |
| |
| <span class="k">if</span> <span class="n">py_version</span> <span class="o">!=</span> <span class="s2">"all"</span><span class="p">:</span> |
| |
| <span class="nb">object</span><span class="o">.</span><span class="fm">__setattr__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s2">"py_version"</span><span class="p">,</span> <span class="sa">f</span><span class="s2">"py</span><span class="si">{</span><span class="n">py_version</span><span class="si">}</span><span class="s2">"</span><span class="p">)</span> |
| |
| <span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">known_standard_library</span><span class="p">:</span> |
| |
| <span class="nb">object</span><span class="o">.</span><span class="fm">__setattr__</span><span class="p">(</span> |
| |
| <span class="bp">self</span><span class="p">,</span> <span class="s2">"known_standard_library"</span><span class="p">,</span> <span class="nb">frozenset</span><span class="p">(</span><span class="nb">getattr</span><span class="p">(</span><span class="n">stdlibs</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">py_version</span><span class="p">)</span><span class="o">.</span><span class="n">stdlib</span><span class="p">)</span> |
| |
| <span class="p">)</span> |
| |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">multi_line_output</span> <span class="o">==</span> <span class="n">WrapModes</span><span class="o">.</span><span class="n">VERTICAL_GRID_GROUPED_NO_COMMA</span><span class="p">:</span> <span class="c1"># type: ignore</span> |
| |
| <span class="n">vertical_grid_grouped</span> <span class="o">=</span> <span class="n">WrapModes</span><span class="o">.</span><span class="n">VERTICAL_GRID_GROUPED</span> <span class="c1"># type: ignore</span> |
| |
| <span class="nb">object</span><span class="o">.</span><span class="fm">__setattr__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s2">"multi_line_output"</span><span class="p">,</span> <span class="n">vertical_grid_grouped</span><span class="p">)</span> |
| |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">force_alphabetical_sort</span><span class="p">:</span> |
| |
| <span class="nb">object</span><span class="o">.</span><span class="fm">__setattr__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s2">"force_alphabetical_sort_within_sections"</span><span class="p">,</span> <span class="kc">True</span><span class="p">)</span> |
| |
| <span class="nb">object</span><span class="o">.</span><span class="fm">__setattr__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s2">"no_sections"</span><span class="p">,</span> <span class="kc">True</span><span class="p">)</span> |
| |
| <span class="nb">object</span><span class="o">.</span><span class="fm">__setattr__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s2">"lines_between_types"</span><span class="p">,</span> <span class="mi">1</span><span class="p">)</span> |
| |
| <span class="nb">object</span><span class="o">.</span><span class="fm">__setattr__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s2">"from_first"</span><span class="p">,</span> <span class="kc">True</span><span class="p">)</span> |
| |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">wrap_length</span> <span class="o">></span> <span class="bp">self</span><span class="o">.</span><span class="n">line_length</span><span class="p">:</span> |
| |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span> |
| |
| <span class="s2">"wrap_length must be set lower than or equal to line_length: "</span> |
| |
| <span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">wrap_length</span><span class="si">}</span><span class="s2"> > </span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">line_length</span><span class="si">}</span><span class="s2">."</span> |
| |
| <span class="p">)</span> |
| |
| <span class="k">def</span> <span class="fm">__hash__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="nb">int</span><span class="p">:</span> |
| |
| <span class="k">return</span> <span class="nb">id</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> |
| |
| <span class="n">_DEFAULT_SETTINGS</span> <span class="o">=</span> <span class="p">{</span><span class="o">**</span><span class="nb">vars</span><span class="p">(</span><span class="n">_Config</span><span class="p">()),</span> <span class="s2">"source"</span><span class="p">:</span> <span class="s2">"defaults"</span><span class="p">}</span> |
| |
| <span class="k">class</span> <span class="nc">Config</span><span class="p">(</span><span class="n">_Config</span><span class="p">):</span> |
| |
| <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span> |
| |
| <span class="bp">self</span><span class="p">,</span> |
| |
| <span class="n">settings_file</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">""</span><span class="p">,</span> |
| |
| <span class="n">settings_path</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">""</span><span class="p">,</span> |
| |
| <span class="n">config</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">_Config</span><span class="p">]</span> <span class="o">=</span> <span class="kc">None</span><span class="p">,</span> |
| |
| <span class="o">**</span><span class="n">config_overrides</span><span class="p">:</span> <span class="n">Any</span><span class="p">,</span> |
| |
| <span class="p">):</span> |
| |
| <span class="bp">self</span><span class="o">.</span><span class="n">_known_patterns</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">List</span><span class="p">[</span><span class="n">Tuple</span><span class="p">[</span><span class="n">Pattern</span><span class="p">[</span><span class="nb">str</span><span class="p">],</span> <span class="nb">str</span><span class="p">]]]</span> <span class="o">=</span> <span class="kc">None</span> |
| |
| <span class="bp">self</span><span class="o">.</span><span class="n">_section_comments</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Tuple</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="o">...</span><span class="p">]]</span> <span class="o">=</span> <span class="kc">None</span> |
| |
| <span class="bp">self</span><span class="o">.</span><span class="n">_section_comments_end</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Tuple</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="o">...</span><span class="p">]]</span> <span class="o">=</span> <span class="kc">None</span> |
| |
| <span class="bp">self</span><span class="o">.</span><span class="n">_skips</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">FrozenSet</span><span class="p">[</span><span class="nb">str</span><span class="p">]]</span> <span class="o">=</span> <span class="kc">None</span> |
| |
| <span class="bp">self</span><span class="o">.</span><span class="n">_skip_globs</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">FrozenSet</span><span class="p">[</span><span class="nb">str</span><span class="p">]]</span> <span class="o">=</span> <span class="kc">None</span> |
| |
| <span class="bp">self</span><span class="o">.</span><span class="n">_sorting_function</span><span class="p">:</span> <span class="n">Optional</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="kc">None</span> |
| |
| <span class="k">if</span> <span class="n">config</span><span class="p">:</span> |
| |
| <span class="n">config_vars</span> <span class="o">=</span> <span class="nb">vars</span><span class="p">(</span><span class="n">config</span><span class="p">)</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span> |
| |
| <span class="n">config_vars</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">config_overrides</span><span class="p">)</span> |
| |
| <span class="n">config_vars</span><span class="p">[</span><span class="s2">"py_version"</span><span class="p">]</span> <span class="o">=</span> <span class="n">config_vars</span><span class="p">[</span><span class="s2">"py_version"</span><span class="p">]</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s2">"py"</span><span class="p">,</span> <span class="s2">""</span><span class="p">)</span> |
| |
| <span class="n">config_vars</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s2">"_known_patterns"</span><span class="p">)</span> |
| |
| <span class="n">config_vars</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s2">"_section_comments"</span><span class="p">)</span> |
| |
| <span class="n">config_vars</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s2">"_section_comments_end"</span><span class="p">)</span> |
| |
| <span class="n">config_vars</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s2">"_skips"</span><span class="p">)</span> |
| |
| <span class="n">config_vars</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s2">"_skip_globs"</span><span class="p">)</span> |
| |
| <span class="n">config_vars</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s2">"_sorting_function"</span><span class="p">)</span> |
| |
| <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="o">**</span><span class="n">config_vars</span><span class="p">)</span> <span class="c1"># type: ignore</span> |
| |
| <span class="k">return</span> |
| |
| <span class="c1"># We can't use self.quiet to conditionally show warnings before super.__init__() is called</span> |
| |
| <span class="c1"># at the end of this method. _Config is also frozen so setting self.quiet isn't possible.</span> |
| |
| <span class="c1"># Therefore we extract quiet early here in a variable and use that in warning conditions.</span> |
| |
| <span class="n">quiet</span> <span class="o">=</span> <span class="n">config_overrides</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"quiet"</span><span class="p">,</span> <span class="kc">False</span><span class="p">)</span> |
| |
| <span class="n">sources</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="n">Dict</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="o">=</span> <span class="p">[</span><span class="n">_DEFAULT_SETTINGS</span><span class="p">]</span> |
| |
| <span class="n">config_settings</span><span class="p">:</span> <span class="n">Dict</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">project_root</span><span class="p">:</span> <span class="nb">str</span> |
| |
| <span class="k">if</span> <span class="n">settings_file</span><span class="p">:</span> |
| |
| <span class="n">config_settings</span> <span class="o">=</span> <span class="n">_get_config_data</span><span class="p">(</span> |
| |
| <span class="n">settings_file</span><span class="p">,</span> |
| |
| <span class="n">CONFIG_SECTIONS</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">basename</span><span class="p">(</span><span class="n">settings_file</span><span class="p">),</span> <span class="n">FALLBACK_CONFIG_SECTIONS</span><span class="p">),</span> |
| |
| <span class="p">)</span> |
| |
| <span class="n">project_root</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="n">settings_file</span><span class="p">)</span> |
| |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">config_settings</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">quiet</span><span class="p">:</span> |
| |
| <span class="n">warn</span><span class="p">(</span> |
| |
| <span class="sa">f</span><span class="s2">"A custom settings file was specified: </span><span class="si">{</span><span class="n">settings_file</span><span class="si">}</span><span class="s2"> but no configuration "</span> |
| |
| <span class="s2">"was found inside. This can happen when [settings] is used as the config "</span> |
| |
| <span class="s2">"header instead of [isort]. "</span> |
| |
| <span class="s2">"See: https://pycqa.github.io/isort/docs/configuration/config_files"</span> |
| |
| <span class="s2">"/#custom_config_files for more information."</span> |
| |
| <span class="p">)</span> |
| |
| <span class="k">elif</span> <span class="n">settings_path</span><span class="p">:</span> |
| |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">settings_path</span><span class="p">):</span> |
| |
| <span class="k">raise</span> <span class="n">InvalidSettingsPath</span><span class="p">(</span><span class="n">settings_path</span><span class="p">)</span> |
| |
| <span class="n">settings_path</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">abspath</span><span class="p">(</span><span class="n">settings_path</span><span class="p">)</span> |
| |
| <span class="n">project_root</span><span class="p">,</span> <span class="n">config_settings</span> <span class="o">=</span> <span class="n">_find_config</span><span class="p">(</span><span class="n">settings_path</span><span class="p">)</span> |
| |
| <span class="k">else</span><span class="p">:</span> |
| |
| <span class="n">config_settings</span> <span class="o">=</span> <span class="p">{}</span> |
| |
| <span class="n">project_root</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">getcwd</span><span class="p">()</span> |
| |
| <span class="n">profile_name</span> <span class="o">=</span> <span class="n">config_overrides</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"profile"</span><span class="p">,</span> <span class="n">config_settings</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"profile"</span><span class="p">,</span> <span class="s2">""</span><span class="p">))</span> |
| |
| <span class="n">profile</span><span class="p">:</span> <span class="n">Dict</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="o">=</span> <span class="p">{}</span> |
| |
| <span class="k">if</span> <span class="n">profile_name</span><span class="p">:</span> |
| |
| <span class="k">if</span> <span class="n">profile_name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">profiles</span><span class="p">:</span> |
| |
| <span class="kn">import</span> <span class="nn">pkg_resources</span> |
| |
| <span class="k">for</span> <span class="n">plugin</span> <span class="ow">in</span> <span class="n">pkg_resources</span><span class="o">.</span><span class="n">iter_entry_points</span><span class="p">(</span><span class="s2">"isort.profiles"</span><span class="p">):</span> |
| |
| <span class="n">profiles</span><span class="o">.</span><span class="n">setdefault</span><span class="p">(</span><span class="n">plugin</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">plugin</span><span class="o">.</span><span class="n">load</span><span class="p">())</span> |
| |
| <span class="k">if</span> <span class="n">profile_name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">profiles</span><span class="p">:</span> |
| |
| <span class="k">raise</span> <span class="n">ProfileDoesNotExist</span><span class="p">(</span><span class="n">profile_name</span><span class="p">)</span> |
| |
| <span class="n">profile</span> <span class="o">=</span> <span class="n">profiles</span><span class="p">[</span><span class="n">profile_name</span><span class="p">]</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span> |
| |
| <span class="n">profile</span><span class="p">[</span><span class="s2">"source"</span><span class="p">]</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">profile_name</span><span class="si">}</span><span class="s2"> profile"</span> |
| |
| <span class="n">sources</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">profile</span><span class="p">)</span> |
| |
| <span class="k">if</span> <span class="n">config_settings</span><span class="p">:</span> |
| |
| <span class="n">sources</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">config_settings</span><span class="p">)</span> |
| |
| <span class="k">if</span> <span class="n">config_overrides</span><span class="p">:</span> |
| |
| <span class="n">config_overrides</span><span class="p">[</span><span class="s2">"source"</span><span class="p">]</span> <span class="o">=</span> <span class="n">RUNTIME_SOURCE</span> |
| |
| <span class="n">sources</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">config_overrides</span><span class="p">)</span> |
| |
| <span class="n">combined_config</span> <span class="o">=</span> <span class="p">{</span><span class="o">**</span><span class="n">profile</span><span class="p">,</span> <span class="o">**</span><span class="n">config_settings</span><span class="p">,</span> <span class="o">**</span><span class="n">config_overrides</span><span class="p">}</span> |
| |
| <span class="k">if</span> <span class="s2">"indent"</span> <span class="ow">in</span> <span class="n">combined_config</span><span class="p">:</span> |
| |
| <span class="n">indent</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">combined_config</span><span class="p">[</span><span class="s2">"indent"</span><span class="p">])</span> |
| |
| <span class="k">if</span> <span class="n">indent</span><span class="o">.</span><span class="n">isdigit</span><span class="p">():</span> |
| |
| <span class="n">indent</span> <span class="o">=</span> <span class="s2">" "</span> <span class="o">*</span> <span class="nb">int</span><span class="p">(</span><span class="n">indent</span><span class="p">)</span> |
| |
| <span class="k">else</span><span class="p">:</span> |
| |
| <span class="n">indent</span> <span class="o">=</span> <span class="n">indent</span><span class="o">.</span><span class="n">strip</span><span class="p">(</span><span class="s2">"'"</span><span class="p">)</span><span class="o">.</span><span class="n">strip</span><span class="p">(</span><span class="s1">'"'</span><span class="p">)</span> |
| |
| <span class="k">if</span> <span class="n">indent</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="o">==</span> <span class="s2">"tab"</span><span class="p">:</span> |
| |
| <span class="n">indent</span> <span class="o">=</span> <span class="s2">"</span><span class="se">\t</span><span class="s2">"</span> |
| |
| <span class="n">combined_config</span><span class="p">[</span><span class="s2">"indent"</span><span class="p">]</span> <span class="o">=</span> <span class="n">indent</span> |
| |
| <span class="n">known_other</span> <span class="o">=</span> <span class="p">{}</span> |
| |
| <span class="n">import_headings</span> <span class="o">=</span> <span class="p">{}</span> |
| |
| <span class="n">import_footers</span> <span class="o">=</span> <span class="p">{}</span> |
| |
| <span class="k">for</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span> <span class="ow">in</span> <span class="nb">tuple</span><span class="p">(</span><span class="n">combined_config</span><span class="o">.</span><span class="n">items</span><span class="p">()):</span> |
| |
| <span class="c1"># Collect all known sections beyond those that have direct entries</span> |
| |
| <span class="k">if</span> <span class="n">key</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="n">KNOWN_PREFIX</span><span class="p">)</span> <span class="ow">and</span> <span class="n">key</span> <span class="ow">not</span> <span class="ow">in</span> <span class="p">(</span> |
| |
| <span class="s2">"known_standard_library"</span><span class="p">,</span> |
| |
| <span class="s2">"known_future_library"</span><span class="p">,</span> |
| |
| <span class="s2">"known_third_party"</span><span class="p">,</span> |
| |
| <span class="s2">"known_first_party"</span><span class="p">,</span> |
| |
| <span class="s2">"known_local_folder"</span><span class="p">,</span> |
| |
| <span class="p">):</span> |
| |
| <span class="n">import_heading</span> <span class="o">=</span> <span class="n">key</span><span class="p">[</span><span class="nb">len</span><span class="p">(</span><span class="n">KNOWN_PREFIX</span><span class="p">)</span> <span class="p">:]</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> |
| |
| <span class="n">maps_to_section</span> <span class="o">=</span> <span class="n">import_heading</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span> |
| |
| <span class="n">combined_config</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="n">key</span><span class="p">)</span> |
| |
| <span class="k">if</span> <span class="n">maps_to_section</span> <span class="ow">in</span> <span class="n">KNOWN_SECTION_MAPPING</span><span class="p">:</span> |
| |
| <span class="n">section_name</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"known_</span><span class="si">{</span><span class="n">KNOWN_SECTION_MAPPING</span><span class="p">[</span><span class="n">maps_to_section</span><span class="p">]</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span><span class="si">}</span><span class="s2">"</span> |
| |
| <span class="k">if</span> <span class="n">section_name</span> <span class="ow">in</span> <span class="n">combined_config</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">quiet</span><span class="p">:</span> |
| |
| <span class="n">warn</span><span class="p">(</span> |
| |
| <span class="sa">f</span><span class="s2">"Can't set both </span><span class="si">{</span><span class="n">key</span><span class="si">}</span><span class="s2"> and </span><span class="si">{</span><span class="n">section_name</span><span class="si">}</span><span class="s2"> in the same config file.</span><span class="se">\n</span><span class="s2">"</span> |
| |
| <span class="sa">f</span><span class="s2">"Default to </span><span class="si">{</span><span class="n">section_name</span><span class="si">}</span><span class="s2"> if unsure."</span> |
| |
| <span class="s2">"</span><span class="se">\n\n</span><span class="s2">"</span> |
| |
| <span class="s2">"See: https://pycqa.github.io/isort/"</span> |
| |
| <span class="s2">"#custom-sections-and-ordering."</span> |
| |
| <span class="p">)</span> |
| |
| <span class="k">else</span><span class="p">:</span> |
| |
| <span class="n">combined_config</span><span class="p">[</span><span class="n">section_name</span><span class="p">]</span> <span class="o">=</span> <span class="nb">frozenset</span><span class="p">(</span><span class="n">value</span><span class="p">)</span> |
| |
| <span class="k">else</span><span class="p">:</span> |
| |
| <span class="n">known_other</span><span class="p">[</span><span class="n">import_heading</span><span class="p">]</span> <span class="o">=</span> <span class="nb">frozenset</span><span class="p">(</span><span class="n">value</span><span class="p">)</span> |
| |
| <span class="k">if</span> <span class="n">maps_to_section</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">combined_config</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"sections"</span><span class="p">,</span> <span class="p">())</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">quiet</span><span class="p">:</span> |
| |
| <span class="n">warn</span><span class="p">(</span> |
| |
| <span class="sa">f</span><span class="s2">"`</span><span class="si">{</span><span class="n">key</span><span class="si">}</span><span class="s2">` setting is defined, but </span><span class="si">{</span><span class="n">maps_to_section</span><span class="si">}</span><span class="s2"> is not"</span> |
| |
| <span class="s2">" included in `sections` config option:"</span> |
| |
| <span class="sa">f</span><span class="s2">" </span><span class="si">{</span><span class="n">combined_config</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">'sections'</span><span class="p">,</span> <span class="n">SECTION_DEFAULTS</span><span class="p">)</span><span class="si">}</span><span class="s2">.</span><span class="se">\n\n</span><span class="s2">"</span> |
| |
| <span class="s2">"See: https://pycqa.github.io/isort/"</span> |
| |
| <span class="s2">"#custom-sections-and-ordering."</span> |
| |
| <span class="p">)</span> |
| |
| <span class="k">if</span> <span class="n">key</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="n">IMPORT_HEADING_PREFIX</span><span class="p">):</span> |
| |
| <span class="n">import_headings</span><span class="p">[</span><span class="n">key</span><span class="p">[</span><span class="nb">len</span><span class="p">(</span><span class="n">IMPORT_HEADING_PREFIX</span><span class="p">)</span> <span class="p">:]</span><span class="o">.</span><span class="n">lower</span><span class="p">()]</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span> |
| |
| <span class="k">if</span> <span class="n">key</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="n">IMPORT_FOOTER_PREFIX</span><span class="p">):</span> |
| |
| <span class="n">import_footers</span><span class="p">[</span><span class="n">key</span><span class="p">[</span><span class="nb">len</span><span class="p">(</span><span class="n">IMPORT_FOOTER_PREFIX</span><span class="p">)</span> <span class="p">:]</span><span class="o">.</span><span class="n">lower</span><span class="p">()]</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span> |
| |
| <span class="c1"># Coerce all provided config values into their correct type</span> |
| |
| <span class="n">default_value</span> <span class="o">=</span> <span class="n">_DEFAULT_SETTINGS</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span> |
| |
| <span class="k">if</span> <span class="n">default_value</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span> |
| |
| <span class="k">continue</span> |
| |
| <span class="n">combined_config</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="nb">type</span><span class="p">(</span><span class="n">default_value</span><span class="p">)(</span><span class="n">value</span><span class="p">)</span> |
| |
| <span class="k">for</span> <span class="n">section</span> <span class="ow">in</span> <span class="n">combined_config</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"sections"</span><span class="p">,</span> <span class="p">()):</span> |
| |
| <span class="k">if</span> <span class="n">section</span> <span class="ow">in</span> <span class="n">SECTION_DEFAULTS</span><span class="p">:</span> |
| |
| <span class="k">continue</span> |
| |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">section</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="ow">in</span> <span class="n">known_other</span><span class="p">:</span> |
| |
| <span class="n">config_keys</span> <span class="o">=</span> <span class="s2">", "</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">known_other</span><span class="o">.</span><span class="n">keys</span><span class="p">())</span> |
| |
| <span class="n">warn</span><span class="p">(</span> |
| |
| <span class="sa">f</span><span class="s2">"`sections` setting includes </span><span class="si">{</span><span class="n">section</span><span class="si">}</span><span class="s2">, but no known_</span><span class="si">{</span><span class="n">section</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span><span class="si">}</span><span class="s2"> "</span> |
| |
| <span class="s2">"is defined. "</span> |
| |
| <span class="sa">f</span><span class="s2">"The following known_SECTION config options are defined: </span><span class="si">{</span><span class="n">config_keys</span><span class="si">}</span><span class="s2">."</span> |
| |
| <span class="p">)</span> |
| |
| <span class="k">if</span> <span class="s2">"directory"</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">combined_config</span><span class="p">:</span> |
| |
| <span class="n">combined_config</span><span class="p">[</span><span class="s2">"directory"</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span> |
| |
| <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="n">config_settings</span><span class="p">[</span><span class="s2">"source"</span><span class="p">])</span> |
| |
| <span class="k">if</span> <span class="n">config_settings</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"source"</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span> |
| |
| <span class="k">else</span> <span class="n">os</span><span class="o">.</span><span class="n">getcwd</span><span class="p">()</span> |
| |
| <span class="p">)</span> |
| |
| <span class="n">path_root</span> <span class="o">=</span> <span class="n">Path</span><span class="p">(</span><span class="n">combined_config</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"directory"</span><span class="p">,</span> <span class="n">project_root</span><span class="p">))</span><span class="o">.</span><span class="n">resolve</span><span class="p">()</span> |
| |
| <span class="n">path_root</span> <span class="o">=</span> <span class="n">path_root</span> <span class="k">if</span> <span class="n">path_root</span><span class="o">.</span><span class="n">is_dir</span><span class="p">()</span> <span class="k">else</span> <span class="n">path_root</span><span class="o">.</span><span class="n">parent</span> |
| |
| <span class="k">if</span> <span class="s2">"src_paths"</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">combined_config</span><span class="p">:</span> |
| |
| <span class="n">combined_config</span><span class="p">[</span><span class="s2">"src_paths"</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span><span class="n">path_root</span> <span class="o">/</span> <span class="s2">"src"</span><span class="p">,</span> <span class="n">path_root</span><span class="p">)</span> |
| |
| <span class="k">else</span><span class="p">:</span> |
| |
| <span class="n">src_paths</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="n">Path</span><span class="p">]</span> <span class="o">=</span> <span class="p">[]</span> |
| |
| <span class="k">for</span> <span class="n">src_path</span> <span class="ow">in</span> <span class="n">combined_config</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"src_paths"</span><span class="p">,</span> <span class="p">()):</span> |
| |
| <span class="n">full_paths</span> <span class="o">=</span> <span class="p">(</span> |
| |
| <span class="n">path_root</span><span class="o">.</span><span class="n">glob</span><span class="p">(</span><span class="n">src_path</span><span class="p">)</span> <span class="k">if</span> <span class="s2">"*"</span> <span class="ow">in</span> <span class="nb">str</span><span class="p">(</span><span class="n">src_path</span><span class="p">)</span> <span class="k">else</span> <span class="p">[</span><span class="n">path_root</span> <span class="o">/</span> <span class="n">src_path</span><span class="p">]</span> |
| |
| <span class="p">)</span> |
| |
| <span class="k">for</span> <span class="n">path</span> <span class="ow">in</span> <span class="n">full_paths</span><span class="p">:</span> |
| |
| <span class="k">if</span> <span class="n">path</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">src_paths</span><span class="p">:</span> |
| |
| <span class="n">src_paths</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">path</span><span class="p">)</span> |
| |
| <span class="n">combined_config</span><span class="p">[</span><span class="s2">"src_paths"</span><span class="p">]</span> <span class="o">=</span> <span class="nb">tuple</span><span class="p">(</span><span class="n">src_paths</span><span class="p">)</span> |
| |
| <span class="k">if</span> <span class="s2">"formatter"</span> <span class="ow">in</span> <span class="n">combined_config</span><span class="p">:</span> |
| |
| <span class="kn">import</span> <span class="nn">pkg_resources</span> |
| |
| <span class="k">for</span> <span class="n">plugin</span> <span class="ow">in</span> <span class="n">pkg_resources</span><span class="o">.</span><span class="n">iter_entry_points</span><span class="p">(</span><span class="s2">"isort.formatters"</span><span class="p">):</span> |
| |
| <span class="k">if</span> <span class="n">plugin</span><span class="o">.</span><span class="n">name</span> <span class="o">==</span> <span class="n">combined_config</span><span class="p">[</span><span class="s2">"formatter"</span><span class="p">]:</span> |
| |
| <span class="n">combined_config</span><span class="p">[</span><span class="s2">"formatting_function"</span><span class="p">]</span> <span class="o">=</span> <span class="n">plugin</span><span class="o">.</span><span class="n">load</span><span class="p">()</span> |
| |
| <span class="k">break</span> |
| |
| <span class="k">else</span><span class="p">:</span> |
| |
| <span class="k">raise</span> <span class="n">FormattingPluginDoesNotExist</span><span class="p">(</span><span class="n">combined_config</span><span class="p">[</span><span class="s2">"formatter"</span><span class="p">])</span> |
| |
| <span class="c1"># Remove any config values that are used for creating config object but</span> |
| |
| <span class="c1"># aren't defined in dataclass</span> |
| |
| <span class="n">combined_config</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s2">"source"</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span> |
| |
| <span class="n">combined_config</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s2">"sources"</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span> |
| |
| <span class="n">combined_config</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s2">"runtime_src_paths"</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span> |
| |
| <span class="n">deprecated_options_used</span> <span class="o">=</span> <span class="p">[</span> |
| |
| <span class="n">option</span> <span class="k">for</span> <span class="n">option</span> <span class="ow">in</span> <span class="n">combined_config</span> <span class="k">if</span> <span class="n">option</span> <span class="ow">in</span> <span class="n">DEPRECATED_SETTINGS</span> |
| |
| <span class="p">]</span> |
| |
| <span class="k">if</span> <span class="n">deprecated_options_used</span><span class="p">:</span> |
| |
| <span class="k">for</span> <span class="n">deprecated_option</span> <span class="ow">in</span> <span class="n">deprecated_options_used</span><span class="p">:</span> |
| |
| <span class="n">combined_config</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="n">deprecated_option</span><span class="p">)</span> |
| |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">quiet</span><span class="p">:</span> |
| |
| <span class="n">warn</span><span class="p">(</span> |
| |
| <span class="s2">"W0503: Deprecated config options were used: "</span> |
| |
| <span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="s1">', '</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">deprecated_options_used</span><span class="p">)</span><span class="si">}</span><span class="s2">."</span> |
| |
| <span class="s2">"Please see the 5.0.0 upgrade guide: "</span> |
| |
| <span class="s2">"https://pycqa.github.io/isort/docs/upgrade_guides/5.0.0.html"</span> |
| |
| <span class="p">)</span> |
| |
| <span class="k">if</span> <span class="n">known_other</span><span class="p">:</span> |
| |
| <span class="n">combined_config</span><span class="p">[</span><span class="s2">"known_other"</span><span class="p">]</span> <span class="o">=</span> <span class="n">known_other</span> |
| |
| <span class="k">if</span> <span class="n">import_headings</span><span class="p">:</span> |
| |
| <span class="k">for</span> <span class="n">import_heading_key</span> <span class="ow">in</span> <span class="n">import_headings</span><span class="p">:</span> |
| |
| <span class="n">combined_config</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">IMPORT_HEADING_PREFIX</span><span class="si">}{</span><span class="n">import_heading_key</span><span class="si">}</span><span class="s2">"</span><span class="p">)</span> |
| |
| <span class="n">combined_config</span><span class="p">[</span><span class="s2">"import_headings"</span><span class="p">]</span> <span class="o">=</span> <span class="n">import_headings</span> |
| |
| <span class="k">if</span> <span class="n">import_footers</span><span class="p">:</span> |
| |
| <span class="k">for</span> <span class="n">import_footer_key</span> <span class="ow">in</span> <span class="n">import_footers</span><span class="p">:</span> |
| |
| <span class="n">combined_config</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">IMPORT_FOOTER_PREFIX</span><span class="si">}{</span><span class="n">import_footer_key</span><span class="si">}</span><span class="s2">"</span><span class="p">)</span> |
| |
| <span class="n">combined_config</span><span class="p">[</span><span class="s2">"import_footers"</span><span class="p">]</span> <span class="o">=</span> <span class="n">import_footers</span> |
| |
| <span class="n">unsupported_config_errors</span> <span class="o">=</span> <span class="p">{}</span> |
| |
| <span class="k">for</span> <span class="n">option</span> <span class="ow">in</span> <span class="nb">set</span><span class="p">(</span><span class="n">combined_config</span><span class="o">.</span><span class="n">keys</span><span class="p">())</span><span class="o">.</span><span class="n">difference</span><span class="p">(</span> |
| |
| <span class="nb">getattr</span><span class="p">(</span><span class="n">_Config</span><span class="p">,</span> <span class="s2">"__dataclass_fields__"</span><span class="p">,</span> <span class="p">{})</span><span class="o">.</span><span class="n">keys</span><span class="p">()</span> |
| |
| <span class="p">):</span> |
| |
| <span class="k">for</span> <span class="n">source</span> <span class="ow">in</span> <span class="nb">reversed</span><span class="p">(</span><span class="n">sources</span><span class="p">):</span> |
| |
| <span class="k">if</span> <span class="n">option</span> <span class="ow">in</span> <span class="n">source</span><span class="p">:</span> |
| |
| <span class="n">unsupported_config_errors</span><span class="p">[</span><span class="n">option</span><span class="p">]</span> <span class="o">=</span> <span class="p">{</span> |
| |
| <span class="s2">"value"</span><span class="p">:</span> <span class="n">source</span><span class="p">[</span><span class="n">option</span><span class="p">],</span> |
| |
| <span class="s2">"source"</span><span class="p">:</span> <span class="n">source</span><span class="p">[</span><span class="s2">"source"</span><span class="p">],</span> |
| |
| <span class="p">}</span> |
| |
| <span class="k">if</span> <span class="n">unsupported_config_errors</span><span class="p">:</span> |
| |
| <span class="k">raise</span> <span class="n">UnsupportedSettings</span><span class="p">(</span><span class="n">unsupported_config_errors</span><span class="p">)</span> |
| |
| <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">sources</span><span class="o">=</span><span class="nb">tuple</span><span class="p">(</span><span class="n">sources</span><span class="p">),</span> <span class="o">**</span><span class="n">combined_config</span><span class="p">)</span> <span class="c1"># type: ignore</span> |
| |
| <span class="k">def</span> <span class="nf">is_supported_filetype</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">file_name</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="nb">bool</span><span class="p">:</span> |
| |
| <span class="n">_root</span><span class="p">,</span> <span class="n">ext</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">splitext</span><span class="p">(</span><span class="n">file_name</span><span class="p">)</span> |
| |
| <span class="n">ext</span> <span class="o">=</span> <span class="n">ext</span><span class="o">.</span><span class="n">lstrip</span><span class="p">(</span><span class="s2">"."</span><span class="p">)</span> |
| |
| <span class="k">if</span> <span class="n">ext</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">supported_extensions</span><span class="p">:</span> |
| |
| <span class="k">return</span> <span class="kc">True</span> |
| |
| <span class="k">if</span> <span class="n">ext</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">blocked_extensions</span><span class="p">:</span> |
| |
| <span class="k">return</span> <span class="kc">False</span> |
| |
| <span class="c1"># Skip editor backup files.</span> |
| |
| <span class="k">if</span> <span class="n">file_name</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s2">"~"</span><span class="p">):</span> |
| |
| <span class="k">return</span> <span class="kc">False</span> |
| |
| <span class="k">try</span><span class="p">:</span> |
| |
| <span class="k">if</span> <span class="n">stat</span><span class="o">.</span><span class="n">S_ISFIFO</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">stat</span><span class="p">(</span><span class="n">file_name</span><span class="p">)</span><span class="o">.</span><span class="n">st_mode</span><span class="p">):</span> |
| |
| <span class="k">return</span> <span class="kc">False</span> |
| |
| <span class="k">except</span> <span class="ne">OSError</span><span class="p">:</span> |
| |
| <span class="k">pass</span> |
| |
| <span class="k">try</span><span class="p">:</span> |
| |
| <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">file_name</span><span class="p">,</span> <span class="s2">"rb"</span><span class="p">)</span> <span class="k">as</span> <span class="n">fp</span><span class="p">:</span> |
| |
| <span class="n">line</span> <span class="o">=</span> <span class="n">fp</span><span class="o">.</span><span class="n">readline</span><span class="p">(</span><span class="mi">100</span><span class="p">)</span> |
| |
| <span class="k">except</span> <span class="ne">OSError</span><span class="p">:</span> |
| |
| <span class="k">return</span> <span class="kc">False</span> |
| |
| <span class="k">else</span><span class="p">:</span> |
| |
| <span class="k">return</span> <span class="nb">bool</span><span class="p">(</span><span class="n">_SHEBANG_RE</span><span class="o">.</span><span class="n">match</span><span class="p">(</span><span class="n">line</span><span class="p">))</span> |
| |
| <span class="k">def</span> <span class="nf">_check_folder_gitignore</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">folder</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Path</span><span class="p">]:</span> |
| |
| <span class="n">env</span> <span class="o">=</span> <span class="p">{</span><span class="o">**</span><span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">,</span> <span class="s2">"LANG"</span><span class="p">:</span> <span class="s2">"C.UTF-8"</span><span class="p">}</span> |
| |
| <span class="k">try</span><span class="p">:</span> |
| |
| <span class="n">topfolder_result</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">check_output</span><span class="p">(</span> <span class="c1"># nosec # skipcq: PYL-W1510</span> |
| |
| <span class="p">[</span><span class="s2">"git"</span><span class="p">,</span> <span class="s2">"-C"</span><span class="p">,</span> <span class="n">folder</span><span class="p">,</span> <span class="s2">"rev-parse"</span><span class="p">,</span> <span class="s2">"--show-toplevel"</span><span class="p">],</span> <span class="n">encoding</span><span class="o">=</span><span class="s2">"utf-8"</span><span class="p">,</span> <span class="n">env</span><span class="o">=</span><span class="n">env</span> |
| |
| <span class="p">)</span> |
| |
| <span class="k">except</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">CalledProcessError</span><span class="p">:</span> |
| |
| <span class="k">return</span> <span class="kc">None</span> |
| |
| <span class="n">git_folder</span> <span class="o">=</span> <span class="n">Path</span><span class="p">(</span><span class="n">topfolder_result</span><span class="o">.</span><span class="n">rstrip</span><span class="p">())</span><span class="o">.</span><span class="n">resolve</span><span class="p">()</span> |
| |
| <span class="n">files</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="p">[]</span> |
| |
| <span class="c1"># don't check symlinks; either part of the repo and would be checked</span> |
| |
| <span class="c1"># twice, or is external to the repo and git won't know anything about it</span> |
| |
| <span class="k">for</span> <span class="n">root</span><span class="p">,</span> <span class="n">_dirs</span><span class="p">,</span> <span class="n">git_files</span> <span class="ow">in</span> <span class="n">os</span><span class="o">.</span><span class="n">walk</span><span class="p">(</span><span class="n">git_folder</span><span class="p">,</span> <span class="n">followlinks</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span> |
| |
| <span class="k">if</span> <span class="s2">".git"</span> <span class="ow">in</span> <span class="n">_dirs</span><span class="p">:</span> |
| |
| <span class="n">_dirs</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="s2">".git"</span><span class="p">)</span> |
| |
| <span class="k">for</span> <span class="n">git_file</span> <span class="ow">in</span> <span class="n">git_files</span><span class="p">:</span> |
| |
| <span class="n">files</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">root</span><span class="p">,</span> <span class="n">git_file</span><span class="p">))</span> |
| |
| <span class="n">git_options</span> <span class="o">=</span> <span class="p">[</span><span class="s2">"-C"</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="n">git_folder</span><span class="p">),</span> <span class="s2">"-c"</span><span class="p">,</span> <span class="s2">"core.quotePath="</span><span class="p">]</span> |
| |
| <span class="k">try</span><span class="p">:</span> |
| |
| <span class="n">ignored</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">check_output</span><span class="p">(</span> <span class="c1"># nosec # skipcq: PYL-W1510</span> |
| |
| <span class="p">[</span><span class="s2">"git"</span><span class="p">,</span> <span class="o">*</span><span class="n">git_options</span><span class="p">,</span> <span class="s2">"check-ignore"</span><span class="p">,</span> <span class="s2">"-z"</span><span class="p">,</span> <span class="s2">"--stdin"</span><span class="p">,</span> <span class="s2">"--no-index"</span><span class="p">],</span> |
| |
| <span class="n">encoding</span><span class="o">=</span><span class="s2">"utf-8"</span><span class="p">,</span> |
| |
| <span class="n">env</span><span class="o">=</span><span class="n">env</span><span class="p">,</span> |
| |
| <span class="nb">input</span><span class="o">=</span><span class="s2">"</span><span class="se">\0</span><span class="s2">"</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">files</span><span class="p">),</span> |
| |
| <span class="p">)</span> |
| |
| <span class="k">except</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">CalledProcessError</span><span class="p">:</span> |
| |
| <span class="k">return</span> <span class="kc">None</span> |
| |
| <span class="bp">self</span><span class="o">.</span><span class="n">git_ignore</span><span class="p">[</span><span class="n">git_folder</span><span class="p">]</span> <span class="o">=</span> <span class="p">{</span><span class="n">Path</span><span class="p">(</span><span class="n">f</span><span class="p">)</span> <span class="k">for</span> <span class="n">f</span> <span class="ow">in</span> <span class="n">ignored</span><span class="o">.</span><span class="n">rstrip</span><span class="p">(</span><span class="s2">"</span><span class="se">\0</span><span class="s2">"</span><span class="p">)</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">"</span><span class="se">\0</span><span class="s2">"</span><span class="p">)}</span> |
| |
| <span class="k">return</span> <span class="n">git_folder</span> |
| |
| <span class="k">def</span> <span class="nf">is_skipped</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">file_path</span><span class="p">:</span> <span class="n">Path</span><span class="p">)</span> <span class="o">-></span> <span class="nb">bool</span><span class="p">:</span> |
| |
| <span class="sd">"""Returns True if the file and/or folder should be skipped based on current settings."""</span> |
| |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">directory</span> <span class="ow">and</span> <span class="n">Path</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">directory</span><span class="p">)</span> <span class="ow">in</span> <span class="n">file_path</span><span class="o">.</span><span class="n">resolve</span><span class="p">()</span><span class="o">.</span><span class="n">parents</span><span class="p">:</span> |
| |
| <span class="n">file_name</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">relpath</span><span class="p">(</span><span class="n">file_path</span><span class="o">.</span><span class="n">resolve</span><span class="p">(),</span> <span class="bp">self</span><span class="o">.</span><span class="n">directory</span><span class="p">)</span> |
| |
| <span class="k">else</span><span class="p">:</span> |
| |
| <span class="n">file_name</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">file_path</span><span class="p">)</span> |
| |
| <span class="n">os_path</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">file_path</span><span class="p">)</span> |
| |
| <span class="n">normalized_path</span> <span class="o">=</span> <span class="n">os_path</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s2">"</span><span class="se">\\</span><span class="s2">"</span><span class="p">,</span> <span class="s2">"/"</span><span class="p">)</span> |
| |
| <span class="k">if</span> <span class="n">normalized_path</span><span class="p">[</span><span class="mi">1</span><span class="p">:</span><span class="mi">2</span><span class="p">]</span> <span class="o">==</span> <span class="s2">":"</span><span class="p">:</span> |
| |
| <span class="n">normalized_path</span> <span class="o">=</span> <span class="n">normalized_path</span><span class="p">[</span><span class="mi">2</span><span class="p">:]</span> |
| |
| <span class="k">for</span> <span class="n">skip_path</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">skips</span><span class="p">:</span> |
| |
| <span class="k">if</span> <span class="n">posixpath</span><span class="o">.</span><span class="n">abspath</span><span class="p">(</span><span class="n">normalized_path</span><span class="p">)</span> <span class="o">==</span> <span class="n">posixpath</span><span class="o">.</span><span class="n">abspath</span><span class="p">(</span> |
| |
| <span class="n">skip_path</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s2">"</span><span class="se">\\</span><span class="s2">"</span><span class="p">,</span> <span class="s2">"/"</span><span class="p">)</span> |
| |
| <span class="p">):</span> |
| |
| <span class="k">return</span> <span class="kc">True</span> |
| |
| <span class="n">position</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">file_name</span><span class="p">)</span> |
| |
| <span class="k">while</span> <span class="n">position</span><span class="p">[</span><span class="mi">1</span><span class="p">]:</span> |
| |
| <span class="k">if</span> <span class="n">position</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">skips</span><span class="p">:</span> |
| |
| <span class="k">return</span> <span class="kc">True</span> |
| |
| <span class="n">position</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">position</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span> |
| |
| <span class="k">for</span> <span class="n">sglob</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">skip_globs</span><span class="p">:</span> |
| |
| <span class="k">if</span> <span class="n">fnmatch</span><span class="o">.</span><span class="n">fnmatch</span><span class="p">(</span><span class="n">file_name</span><span class="p">,</span> <span class="n">sglob</span><span class="p">)</span> <span class="ow">or</span> <span class="n">fnmatch</span><span class="o">.</span><span class="n">fnmatch</span><span class="p">(</span><span class="s2">"/"</span> <span class="o">+</span> <span class="n">file_name</span><span class="p">,</span> <span class="n">sglob</span><span class="p">):</span> |
| |
| <span class="k">return</span> <span class="kc">True</span> |
| |
| <span class="k">if</span> <span class="ow">not</span> <span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isfile</span><span class="p">(</span><span class="n">os_path</span><span class="p">)</span> <span class="ow">or</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isdir</span><span class="p">(</span><span class="n">os_path</span><span class="p">)</span> <span class="ow">or</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">islink</span><span class="p">(</span><span class="n">os_path</span><span class="p">)):</span> |
| |
| <span class="k">return</span> <span class="kc">True</span> |
| |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">skip_gitignore</span><span class="p">:</span> |
| |
| <span class="k">if</span> <span class="n">file_path</span><span class="o">.</span><span class="n">name</span> <span class="o">==</span> <span class="s2">".git"</span><span class="p">:</span> <span class="c1"># pragma: no cover</span> |
| |
| <span class="k">return</span> <span class="kc">True</span> |
| |
| <span class="n">git_folder</span> <span class="o">=</span> <span class="kc">None</span> |
| |
| <span class="n">file_paths</span> <span class="o">=</span> <span class="p">[</span><span class="n">file_path</span><span class="p">,</span> <span class="n">file_path</span><span class="o">.</span><span class="n">resolve</span><span class="p">()]</span> |
| |
| <span class="k">for</span> <span class="n">folder</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">git_ignore</span><span class="p">:</span> |
| |
| <span class="k">if</span> <span class="nb">any</span><span class="p">(</span><span class="n">folder</span> <span class="ow">in</span> <span class="n">path</span><span class="o">.</span><span class="n">parents</span> <span class="k">for</span> <span class="n">path</span> <span class="ow">in</span> <span class="n">file_paths</span><span class="p">):</span> |
| |
| <span class="n">git_folder</span> <span class="o">=</span> <span class="n">folder</span> |
| |
| <span class="k">break</span> |
| |
| <span class="k">else</span><span class="p">:</span> |
| |
| <span class="n">git_folder</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_check_folder_gitignore</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">file_path</span><span class="o">.</span><span class="n">parent</span><span class="p">))</span> |
| |
| <span class="k">if</span> <span class="n">git_folder</span> <span class="ow">and</span> <span class="nb">any</span><span class="p">(</span><span class="n">path</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">git_ignore</span><span class="p">[</span><span class="n">git_folder</span><span class="p">]</span> <span class="k">for</span> <span class="n">path</span> <span class="ow">in</span> <span class="n">file_paths</span><span class="p">):</span> |
| |
| <span class="k">return</span> <span class="kc">True</span> |
| |
| <span class="k">return</span> <span class="kc">False</span> |
| |
| <span class="nd">@property</span> |
| |
| <span class="k">def</span> <span class="nf">known_patterns</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">List</span><span class="p">[</span><span class="n">Tuple</span><span class="p">[</span><span class="n">Pattern</span><span class="p">[</span><span class="nb">str</span><span class="p">],</span> <span class="nb">str</span><span class="p">]]:</span> |
| |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_known_patterns</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span> |
| |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_known_patterns</span> |
| |
| <span class="bp">self</span><span class="o">.</span><span class="n">_known_patterns</span> <span class="o">=</span> <span class="p">[]</span> |
| |
| <span class="n">pattern_sections</span> <span class="o">=</span> <span class="p">[</span><span class="n">STDLIB</span><span class="p">]</span> <span class="o">+</span> <span class="p">[</span><span class="n">section</span> <span class="k">for</span> <span class="n">section</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">sections</span> <span class="k">if</span> <span class="n">section</span> <span class="o">!=</span> <span class="n">STDLIB</span><span class="p">]</span> |
| |
| <span class="k">for</span> <span class="n">placement</span> <span class="ow">in</span> <span class="nb">reversed</span><span class="p">(</span><span class="n">pattern_sections</span><span class="p">):</span> |
| |
| <span class="n">known_placement</span> <span class="o">=</span> <span class="n">KNOWN_SECTION_MAPPING</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">placement</span><span class="p">,</span> <span class="n">placement</span><span class="p">)</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> |
| |
| <span class="n">config_key</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">KNOWN_PREFIX</span><span class="si">}{</span><span class="n">known_placement</span><span class="si">}</span><span class="s2">"</span> |
| |
| <span class="n">known_modules</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">config_key</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">known_other</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">known_placement</span><span class="p">,</span> <span class="p">()))</span> |
| |
| <span class="n">extra_modules</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="sa">f</span><span class="s2">"extra_</span><span class="si">{</span><span class="n">known_placement</span><span class="si">}</span><span class="s2">"</span><span class="p">,</span> <span class="p">())</span> |
| |
| <span class="n">all_modules</span> <span class="o">=</span> <span class="nb">set</span><span class="p">(</span><span class="n">extra_modules</span><span class="p">)</span><span class="o">.</span><span class="n">union</span><span class="p">(</span><span class="n">known_modules</span><span class="p">)</span> |
| |
| <span class="n">known_patterns</span> <span class="o">=</span> <span class="p">[</span> |
| |
| <span class="n">pattern</span> |
| |
| <span class="k">for</span> <span class="n">known_pattern</span> <span class="ow">in</span> <span class="n">all_modules</span> |
| |
| <span class="k">for</span> <span class="n">pattern</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_parse_known_pattern</span><span class="p">(</span><span class="n">known_pattern</span><span class="p">)</span> |
| |
| <span class="p">]</span> |
| |
| <span class="k">for</span> <span class="n">known_pattern</span> <span class="ow">in</span> <span class="n">known_patterns</span><span class="p">:</span> |
| |
| <span class="n">regexp</span> <span class="o">=</span> <span class="s2">"^"</span> <span class="o">+</span> <span class="n">known_pattern</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s2">"*"</span><span class="p">,</span> <span class="s2">".*"</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s2">"?"</span><span class="p">,</span> <span class="s2">".?"</span><span class="p">)</span> <span class="o">+</span> <span class="s2">"$"</span> |
| |
| <span class="bp">self</span><span class="o">.</span><span class="n">_known_patterns</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="n">regexp</span><span class="p">),</span> <span class="n">placement</span><span class="p">))</span> |
| |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_known_patterns</span> |
| |
| <span class="nd">@property</span> |
| |
| <span class="k">def</span> <span class="nf">section_comments</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">Tuple</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="o">...</span><span class="p">]:</span> |
| |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_section_comments</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span> |
| |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_section_comments</span> |
| |
| <span class="bp">self</span><span class="o">.</span><span class="n">_section_comments</span> <span class="o">=</span> <span class="nb">tuple</span><span class="p">(</span><span class="sa">f</span><span class="s2">"# </span><span class="si">{</span><span class="n">heading</span><span class="si">}</span><span class="s2">"</span> <span class="k">for</span> <span class="n">heading</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">import_headings</span><span class="o">.</span><span class="n">values</span><span class="p">())</span> |
| |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_section_comments</span> |
| |
| <span class="nd">@property</span> |
| |
| <span class="k">def</span> <span class="nf">section_comments_end</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">Tuple</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="o">...</span><span class="p">]:</span> |
| |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_section_comments_end</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span> |
| |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_section_comments_end</span> |
| |
| <span class="bp">self</span><span class="o">.</span><span class="n">_section_comments_end</span> <span class="o">=</span> <span class="nb">tuple</span><span class="p">(</span><span class="sa">f</span><span class="s2">"# </span><span class="si">{</span><span class="n">footer</span><span class="si">}</span><span class="s2">"</span> <span class="k">for</span> <span class="n">footer</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">import_footers</span><span class="o">.</span><span class="n">values</span><span class="p">())</span> |
| |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_section_comments_end</span> |
| |
| <span class="nd">@property</span> |
| |
| <span class="k">def</span> <span class="nf">skips</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">FrozenSet</span><span class="p">[</span><span class="nb">str</span><span class="p">]:</span> |
| |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_skips</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span> |
| |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_skips</span> |
| |
| <span class="bp">self</span><span class="o">.</span><span class="n">_skips</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">skip</span><span class="o">.</span><span class="n">union</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">extend_skip</span><span class="p">)</span> |
| |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_skips</span> |
| |
| <span class="nd">@property</span> |
| |
| <span class="k">def</span> <span class="nf">skip_globs</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">FrozenSet</span><span class="p">[</span><span class="nb">str</span><span class="p">]:</span> |
| |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_skip_globs</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span> |
| |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_skip_globs</span> |
| |
| <span class="bp">self</span><span class="o">.</span><span class="n">_skip_globs</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">skip_glob</span><span class="o">.</span><span class="n">union</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">extend_skip_glob</span><span class="p">)</span> |
| |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_skip_globs</span> |
| |
| <span class="nd">@property</span> |
| |
| <span class="k">def</span> <span class="nf">sorting_function</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></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="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_sorting_function</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span> |
| |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_sorting_function</span> |
| |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">sort_order</span> <span class="o">==</span> <span class="s2">"natural"</span><span class="p">:</span> |
| |
| <span class="bp">self</span><span class="o">.</span><span class="n">_sorting_function</span> <span class="o">=</span> <span class="n">sorting</span><span class="o">.</span><span class="n">naturally</span> |
| |
| <span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">sort_order</span> <span class="o">==</span> <span class="s2">"native"</span><span class="p">:</span> |
| |
| <span class="bp">self</span><span class="o">.</span><span class="n">_sorting_function</span> <span class="o">=</span> <span class="nb">sorted</span> |
| |
| <span class="k">else</span><span class="p">:</span> |
| |
| <span class="n">available_sort_orders</span> <span class="o">=</span> <span class="p">[</span><span class="s2">"natural"</span><span class="p">,</span> <span class="s2">"native"</span><span class="p">]</span> |
| |
| <span class="kn">import</span> <span class="nn">pkg_resources</span> |
| |
| <span class="k">for</span> <span class="n">sort_plugin</span> <span class="ow">in</span> <span class="n">pkg_resources</span><span class="o">.</span><span class="n">iter_entry_points</span><span class="p">(</span><span class="s2">"isort.sort_function"</span><span class="p">):</span> |
| |
| <span class="n">available_sort_orders</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">sort_plugin</span><span class="o">.</span><span class="n">name</span><span class="p">)</span> |
| |
| <span class="k">if</span> <span class="n">sort_plugin</span><span class="o">.</span><span class="n">name</span> <span class="o">==</span> <span class="bp">self</span><span class="o">.</span><span class="n">sort_order</span><span class="p">:</span> |
| |
| <span class="bp">self</span><span class="o">.</span><span class="n">_sorting_function</span> <span class="o">=</span> <span class="n">sort_plugin</span><span class="o">.</span><span class="n">load</span><span class="p">()</span> |
| |
| <span class="k">break</span> |
| |
| <span class="k">else</span><span class="p">:</span> |
| |
| <span class="k">raise</span> <span class="n">SortingFunctionDoesNotExist</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">sort_order</span><span class="p">,</span> <span class="n">available_sort_orders</span><span class="p">)</span> |
| |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_sorting_function</span> |
| |
| <span class="k">def</span> <span class="nf">_parse_known_pattern</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">pattern</span><span class="p">:</span> <span class="nb">str</span><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="sd">"""Expand pattern if identified as a directory and return found sub packages"""</span> |
| |
| <span class="k">if</span> <span class="n">pattern</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">sep</span><span class="p">):</span> |
| |
| <span class="n">patterns</span> <span class="o">=</span> <span class="p">[</span> |
| |
| <span class="n">filename</span> |
| |
| <span class="k">for</span> <span class="n">filename</span> <span class="ow">in</span> <span class="n">os</span><span class="o">.</span><span class="n">listdir</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">directory</span><span class="p">,</span> <span class="n">pattern</span><span class="p">))</span> |
| |
| <span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isdir</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">directory</span><span class="p">,</span> <span class="n">pattern</span><span class="p">,</span> <span class="n">filename</span><span class="p">))</span> |
| |
| <span class="p">]</span> |
| |
| <span class="k">else</span><span class="p">:</span> |
| |
| <span class="n">patterns</span> <span class="o">=</span> <span class="p">[</span><span class="n">pattern</span><span class="p">]</span> |
| |
| <span class="k">return</span> <span class="n">patterns</span> |
| |
| <span class="k">def</span> <span class="nf">_get_str_to_type_converter</span><span class="p">(</span><span class="n">setting_name</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></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">Type</span><span class="p">[</span><span class="n">Any</span><span class="p">]]:</span> |
| |
| <span class="n">type_converter</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">Type</span><span class="p">[</span><span class="n">Any</span><span class="p">]]</span> <span class="o">=</span> <span class="nb">type</span><span class="p">(</span> |
| |
| <span class="n">_DEFAULT_SETTINGS</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">setting_name</span><span class="p">,</span> <span class="s2">""</span><span class="p">)</span> |
| |
| <span class="p">)</span> |
| |
| <span class="k">if</span> <span class="n">type_converter</span> <span class="o">==</span> <span class="n">WrapModes</span><span class="p">:</span> |
| |
| <span class="n">type_converter</span> <span class="o">=</span> <span class="n">wrap_mode_from_string</span> |
| |
| <span class="k">return</span> <span class="n">type_converter</span> |
| |
| <span class="k">def</span> <span class="nf">_as_list</span><span class="p">(</span><span class="n">value</span><span class="p">:</span> <span class="nb">str</span><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="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">list</span><span class="p">):</span> |
| |
| <span class="k">return</span> <span class="p">[</span><span class="n">item</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span> <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">value</span><span class="p">]</span> |
| |
| <span class="n">filtered</span> <span class="o">=</span> <span class="p">[</span><span class="n">item</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span> <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">value</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s2">"</span><span class="se">\n</span><span class="s2">"</span><span class="p">,</span> <span class="s2">","</span><span class="p">)</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">","</span><span class="p">)</span> <span class="k">if</span> <span class="n">item</span><span class="o">.</span><span class="n">strip</span><span class="p">()]</span> |
| |
| <span class="k">return</span> <span class="n">filtered</span> |
| |
| <span class="k">def</span> <span class="nf">_abspaths</span><span class="p">(</span><span class="n">cwd</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">values</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="o">-></span> <span class="n">Set</span><span class="p">[</span><span class="nb">str</span><span class="p">]:</span> |
| |
| <span class="n">paths</span> <span class="o">=</span> <span class="p">{</span> |
| |
| <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">cwd</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span> |
| |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">value</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">sep</span><span class="p">)</span> <span class="ow">and</span> <span class="n">value</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">sep</span><span class="p">)</span> |
| |
| <span class="k">else</span> <span class="n">value</span> |
| |
| <span class="k">for</span> <span class="n">value</span> <span class="ow">in</span> <span class="n">values</span> |
| |
| <span class="p">}</span> |
| |
| <span class="k">return</span> <span class="n">paths</span> |
| |
| <span class="nd">@lru_cache</span><span class="p">()</span> |
| |
| <span class="k">def</span> <span class="nf">_find_config</span><span class="p">(</span><span class="n">path</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="n">Tuple</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Dict</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">current_directory</span> <span class="o">=</span> <span class="n">path</span> |
| |
| <span class="n">tries</span> <span class="o">=</span> <span class="mi">0</span> |
| |
| <span class="k">while</span> <span class="n">current_directory</span> <span class="ow">and</span> <span class="n">tries</span> <span class="o"><</span> <span class="n">MAX_CONFIG_SEARCH_DEPTH</span><span class="p">:</span> |
| |
| <span class="k">for</span> <span class="n">config_file_name</span> <span class="ow">in</span> <span class="n">CONFIG_SOURCES</span><span class="p">:</span> |
| |
| <span class="n">potential_config_file</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">current_directory</span><span class="p">,</span> <span class="n">config_file_name</span><span class="p">)</span> |
| |
| <span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isfile</span><span class="p">(</span><span class="n">potential_config_file</span><span class="p">):</span> |
| |
| <span class="n">config_data</span><span class="p">:</span> <span class="n">Dict</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="k">try</span><span class="p">:</span> |
| |
| <span class="n">config_data</span> <span class="o">=</span> <span class="n">_get_config_data</span><span class="p">(</span> |
| |
| <span class="n">potential_config_file</span><span class="p">,</span> <span class="n">CONFIG_SECTIONS</span><span class="p">[</span><span class="n">config_file_name</span><span class="p">]</span> |
| |
| <span class="p">)</span> |
| |
| <span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span> |
| |
| <span class="n">warn</span><span class="p">(</span><span class="sa">f</span><span class="s2">"Failed to pull configuration information from </span><span class="si">{</span><span class="n">potential_config_file</span><span class="si">}</span><span class="s2">"</span><span class="p">)</span> |
| |
| <span class="n">config_data</span> <span class="o">=</span> <span class="p">{}</span> |
| |
| <span class="k">if</span> <span class="n">config_data</span><span class="p">:</span> |
| |
| <span class="k">return</span> <span class="p">(</span><span class="n">current_directory</span><span class="p">,</span> <span class="n">config_data</span><span class="p">)</span> |
| |
| <span class="k">for</span> <span class="n">stop_dir</span> <span class="ow">in</span> <span class="n">STOP_CONFIG_SEARCH_ON_DIRS</span><span class="p">:</span> |
| |
| <span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isdir</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">current_directory</span><span class="p">,</span> <span class="n">stop_dir</span><span class="p">)):</span> |
| |
| <span class="k">return</span> <span class="p">(</span><span class="n">current_directory</span><span class="p">,</span> <span class="p">{})</span> |
| |
| <span class="n">new_directory</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">current_directory</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span> |
| |
| <span class="k">if</span> <span class="n">new_directory</span> <span class="o">==</span> <span class="n">current_directory</span><span class="p">:</span> |
| |
| <span class="k">break</span> |
| |
| <span class="n">current_directory</span> <span class="o">=</span> <span class="n">new_directory</span> |
| |
| <span class="n">tries</span> <span class="o">+=</span> <span class="mi">1</span> |
| |
| <span class="k">return</span> <span class="p">(</span><span class="n">path</span><span class="p">,</span> <span class="p">{})</span> |
| |
| <span class="nd">@lru_cache</span><span class="p">()</span> |
| |
| <span class="k">def</span> <span class="nf">find_all_configs</span><span class="p">(</span><span class="n">path</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="n">Trie</span><span class="p">:</span> |
| |
| <span class="sd">"""</span> |
| |
| <span class="sd"> Looks for config files in the path provided and in all of its sub-directories.</span> |
| |
| <span class="sd"> Parses and stores any config file encountered in a trie and returns the root of</span> |
| |
| <span class="sd"> the trie</span> |
| |
| <span class="sd"> """</span> |
| |
| <span class="n">trie_root</span> <span class="o">=</span> <span class="n">Trie</span><span class="p">(</span><span class="s2">"default"</span><span class="p">,</span> <span class="p">{})</span> |
| |
| <span class="k">for</span> <span class="p">(</span><span class="n">dirpath</span><span class="p">,</span> <span class="n">_</span><span class="p">,</span> <span class="n">_</span><span class="p">)</span> <span class="ow">in</span> <span class="n">os</span><span class="o">.</span><span class="n">walk</span><span class="p">(</span><span class="n">path</span><span class="p">):</span> |
| |
| <span class="k">for</span> <span class="n">config_file_name</span> <span class="ow">in</span> <span class="n">CONFIG_SOURCES</span><span class="p">:</span> |
| |
| <span class="n">potential_config_file</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">dirpath</span><span class="p">,</span> <span class="n">config_file_name</span><span class="p">)</span> |
| |
| <span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isfile</span><span class="p">(</span><span class="n">potential_config_file</span><span class="p">):</span> |
| |
| <span class="n">config_data</span><span class="p">:</span> <span class="n">Dict</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="k">try</span><span class="p">:</span> |
| |
| <span class="n">config_data</span> <span class="o">=</span> <span class="n">_get_config_data</span><span class="p">(</span> |
| |
| <span class="n">potential_config_file</span><span class="p">,</span> <span class="n">CONFIG_SECTIONS</span><span class="p">[</span><span class="n">config_file_name</span><span class="p">]</span> |
| |
| <span class="p">)</span> |
| |
| <span class="k">except</span> <span class="ne">Exception</span><span class="p">:</span> |
| |
| <span class="n">warn</span><span class="p">(</span><span class="sa">f</span><span class="s2">"Failed to pull configuration information from </span><span class="si">{</span><span class="n">potential_config_file</span><span class="si">}</span><span class="s2">"</span><span class="p">)</span> |
| |
| <span class="n">config_data</span> <span class="o">=</span> <span class="p">{}</span> |
| |
| <span class="k">if</span> <span class="n">config_data</span><span class="p">:</span> |
| |
| <span class="n">trie_root</span><span class="o">.</span><span class="n">insert</span><span class="p">(</span><span class="n">potential_config_file</span><span class="p">,</span> <span class="n">config_data</span><span class="p">)</span> |
| |
| <span class="k">break</span> |
| |
| <span class="k">return</span> <span class="n">trie_root</span> |
| |
| <span class="nd">@lru_cache</span><span class="p">()</span> |
| |
| <span class="k">def</span> <span class="nf">_get_config_data</span><span class="p">(</span><span class="n">file_path</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">sections</span><span class="p">:</span> <span class="n">Tuple</span><span class="p">[</span><span class="nb">str</span><span class="p">])</span> <span class="o">-></span> <span class="n">Dict</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">settings</span><span class="p">:</span> <span class="n">Dict</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="o">=</span> <span class="p">{}</span> |
| |
| <span class="k">if</span> <span class="n">file_path</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s2">".toml"</span><span class="p">):</span> |
| |
| <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">file_path</span><span class="p">,</span> <span class="s2">"rb"</span><span class="p">)</span> <span class="k">as</span> <span class="n">bin_config_file</span><span class="p">:</span> |
| |
| <span class="n">config</span> <span class="o">=</span> <span class="n">tomli</span><span class="o">.</span><span class="n">load</span><span class="p">(</span><span class="n">bin_config_file</span><span class="p">)</span> |
| |
| <span class="k">for</span> <span class="n">section</span> <span class="ow">in</span> <span class="n">sections</span><span class="p">:</span> |
| |
| <span class="n">config_section</span> <span class="o">=</span> <span class="n">config</span> |
| |
| <span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="n">section</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">"."</span><span class="p">):</span> |
| |
| <span class="n">config_section</span> <span class="o">=</span> <span class="n">config_section</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="p">{})</span> |
| |
| <span class="n">settings</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">config_section</span><span class="p">)</span> |
| |
| <span class="k">else</span><span class="p">:</span> |
| |
| <span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">file_path</span><span class="p">,</span> <span class="n">encoding</span><span class="o">=</span><span class="s2">"utf-8"</span><span class="p">)</span> <span class="k">as</span> <span class="n">config_file</span><span class="p">:</span> |
| |
| <span class="k">if</span> <span class="n">file_path</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s2">".editorconfig"</span><span class="p">):</span> |
| |
| <span class="n">line</span> <span class="o">=</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</span> |
| |
| <span class="n">last_position</span> <span class="o">=</span> <span class="n">config_file</span><span class="o">.</span><span class="n">tell</span><span class="p">()</span> |
| |
| <span class="k">while</span> <span class="n">line</span><span class="p">:</span> |
| |
| <span class="n">line</span> <span class="o">=</span> <span class="n">config_file</span><span class="o">.</span><span class="n">readline</span><span class="p">()</span> |
| |
| <span class="k">if</span> <span class="s2">"["</span> <span class="ow">in</span> <span class="n">line</span><span class="p">:</span> |
| |
| <span class="n">config_file</span><span class="o">.</span><span class="n">seek</span><span class="p">(</span><span class="n">last_position</span><span class="p">)</span> |
| |
| <span class="k">break</span> |
| |
| <span class="n">last_position</span> <span class="o">=</span> <span class="n">config_file</span><span class="o">.</span><span class="n">tell</span><span class="p">()</span> |
| |
| <span class="n">config</span> <span class="o">=</span> <span class="n">configparser</span><span class="o">.</span><span class="n">ConfigParser</span><span class="p">(</span><span class="n">strict</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span> |
| |
| <span class="n">config</span><span class="o">.</span><span class="n">read_file</span><span class="p">(</span><span class="n">config_file</span><span class="p">)</span> |
| |
| <span class="k">for</span> <span class="n">section</span> <span class="ow">in</span> <span class="n">sections</span><span class="p">:</span> |
| |
| <span class="k">if</span> <span class="n">section</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s2">"*.{"</span><span class="p">)</span> <span class="ow">and</span> <span class="n">section</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s2">"}"</span><span class="p">):</span> |
| |
| <span class="n">extension</span> <span class="o">=</span> <span class="n">section</span><span class="p">[</span><span class="nb">len</span><span class="p">(</span><span class="s2">"*.{"</span><span class="p">)</span> <span class="p">:</span> <span class="o">-</span><span class="mi">1</span><span class="p">]</span> |
| |
| <span class="k">for</span> <span class="n">config_key</span> <span class="ow">in</span> <span class="n">config</span><span class="o">.</span><span class="n">keys</span><span class="p">():</span> |
| |
| <span class="k">if</span> <span class="p">(</span> |
| |
| <span class="n">config_key</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="s2">"*.{"</span><span class="p">)</span> |
| |
| <span class="ow">and</span> <span class="n">config_key</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s2">"}"</span><span class="p">)</span> |
| |
| <span class="ow">and</span> <span class="n">extension</span> |
| |
| <span class="ow">in</span> <span class="nb">map</span><span class="p">(</span> |
| |
| <span class="k">lambda</span> <span class="n">text</span><span class="p">:</span> <span class="n">text</span><span class="o">.</span><span class="n">strip</span><span class="p">(),</span> <span class="n">config_key</span><span class="p">[</span><span class="nb">len</span><span class="p">(</span><span class="s2">"*.{"</span><span class="p">)</span> <span class="p">:</span> <span class="o">-</span><span class="mi">1</span><span class="p">]</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">","</span><span class="p">)</span> <span class="c1"># type: ignore # noqa</span> |
| |
| <span class="p">)</span> |
| |
| <span class="p">):</span> |
| |
| <span class="n">settings</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">config</span><span class="o">.</span><span class="n">items</span><span class="p">(</span><span class="n">config_key</span><span class="p">))</span> |
| |
| <span class="k">elif</span> <span class="n">config</span><span class="o">.</span><span class="n">has_section</span><span class="p">(</span><span class="n">section</span><span class="p">):</span> |
| |
| <span class="n">settings</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">config</span><span class="o">.</span><span class="n">items</span><span class="p">(</span><span class="n">section</span><span class="p">))</span> |
| |
| <span class="k">if</span> <span class="n">settings</span><span class="p">:</span> |
| |
| <span class="n">settings</span><span class="p">[</span><span class="s2">"source"</span><span class="p">]</span> <span class="o">=</span> <span class="n">file_path</span> |
| |
| <span class="k">if</span> <span class="n">file_path</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s2">".editorconfig"</span><span class="p">):</span> |
| |
| <span class="n">indent_style</span> <span class="o">=</span> <span class="n">settings</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s2">"indent_style"</span><span class="p">,</span> <span class="s2">""</span><span class="p">)</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span> |
| |
| <span class="n">indent_size</span> <span class="o">=</span> <span class="n">settings</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s2">"indent_size"</span><span class="p">,</span> <span class="s2">""</span><span class="p">)</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span> |
| |
| <span class="k">if</span> <span class="n">indent_size</span> <span class="o">==</span> <span class="s2">"tab"</span><span class="p">:</span> |
| |
| <span class="n">indent_size</span> <span class="o">=</span> <span class="n">settings</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s2">"tab_width"</span><span class="p">,</span> <span class="s2">""</span><span class="p">)</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span> |
| |
| <span class="k">if</span> <span class="n">indent_style</span> <span class="o">==</span> <span class="s2">"space"</span><span class="p">:</span> |
| |
| <span class="n">settings</span><span class="p">[</span><span class="s2">"indent"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">" "</span> <span class="o">*</span> <span class="p">(</span><span class="n">indent_size</span> <span class="ow">and</span> <span class="nb">int</span><span class="p">(</span><span class="n">indent_size</span><span class="p">)</span> <span class="ow">or</span> <span class="mi">4</span><span class="p">)</span> |
| |
| <span class="k">elif</span> <span class="n">indent_style</span> <span class="o">==</span> <span class="s2">"tab"</span><span class="p">:</span> |
| |
| <span class="n">settings</span><span class="p">[</span><span class="s2">"indent"</span><span class="p">]</span> <span class="o">=</span> <span class="s2">"</span><span class="se">\t</span><span class="s2">"</span> <span class="o">*</span> <span class="p">(</span><span class="n">indent_size</span> <span class="ow">and</span> <span class="nb">int</span><span class="p">(</span><span class="n">indent_size</span><span class="p">)</span> <span class="ow">or</span> <span class="mi">1</span><span class="p">)</span> |
| |
| <span class="n">max_line_length</span> <span class="o">=</span> <span class="n">settings</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s2">"max_line_length"</span><span class="p">,</span> <span class="s2">""</span><span class="p">)</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span> |
| |
| <span class="k">if</span> <span class="n">max_line_length</span> <span class="ow">and</span> <span class="p">(</span><span class="n">max_line_length</span> <span class="o">==</span> <span class="s2">"off"</span> <span class="ow">or</span> <span class="n">max_line_length</span><span class="o">.</span><span class="n">isdigit</span><span class="p">()):</span> |
| |
| <span class="n">settings</span><span class="p">[</span><span class="s2">"line_length"</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span> |
| |
| <span class="nb">float</span><span class="p">(</span><span class="s2">"inf"</span><span class="p">)</span> <span class="k">if</span> <span class="n">max_line_length</span> <span class="o">==</span> <span class="s2">"off"</span> <span class="k">else</span> <span class="nb">int</span><span class="p">(</span><span class="n">max_line_length</span><span class="p">)</span> |
| |
| <span class="p">)</span> |
| |
| <span class="n">settings</span> <span class="o">=</span> <span class="p">{</span> |
| |
| <span class="n">key</span><span class="p">:</span> <span class="n">value</span> |
| |
| <span class="k">for</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span> <span class="ow">in</span> <span class="n">settings</span><span class="o">.</span><span class="n">items</span><span class="p">()</span> |
| |
| <span class="k">if</span> <span class="n">key</span> <span class="ow">in</span> <span class="n">_DEFAULT_SETTINGS</span><span class="o">.</span><span class="n">keys</span><span class="p">()</span> <span class="ow">or</span> <span class="n">key</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="n">KNOWN_PREFIX</span><span class="p">)</span> |
| |
| <span class="p">}</span> |
| |
| <span class="k">for</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span> <span class="ow">in</span> <span class="n">settings</span><span class="o">.</span><span class="n">items</span><span class="p">():</span> |
| |
| <span class="n">existing_value_type</span> <span class="o">=</span> <span class="n">_get_str_to_type_converter</span><span class="p">(</span><span class="n">key</span><span class="p">)</span> |
| |
| <span class="k">if</span> <span class="n">existing_value_type</span> <span class="o">==</span> <span class="nb">tuple</span><span class="p">:</span> |
| |
| <span class="n">settings</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="nb">tuple</span><span class="p">(</span><span class="n">_as_list</span><span class="p">(</span><span class="n">value</span><span class="p">))</span> |
| |
| <span class="k">elif</span> <span class="n">existing_value_type</span> <span class="o">==</span> <span class="nb">frozenset</span><span class="p">:</span> |
| |
| <span class="n">settings</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="nb">frozenset</span><span class="p">(</span><span class="n">_as_list</span><span class="p">(</span><span class="n">settings</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">key</span><span class="p">)))</span> <span class="c1"># type: ignore</span> |
| |
| <span class="k">elif</span> <span class="n">existing_value_type</span> <span class="o">==</span> <span class="nb">bool</span><span class="p">:</span> |
| |
| <span class="c1"># Only some configuration formats support native boolean values.</span> |
| |
| <span class="k">if</span> <span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">value</span><span class="p">,</span> <span class="nb">bool</span><span class="p">):</span> |
| |
| <span class="n">value</span> <span class="o">=</span> <span class="n">_as_bool</span><span class="p">(</span><span class="n">value</span><span class="p">)</span> |
| |
| <span class="n">settings</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span> |
| |
| <span class="k">elif</span> <span class="n">key</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="n">KNOWN_PREFIX</span><span class="p">):</span> |
| |
| <span class="n">settings</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="n">_abspaths</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="n">file_path</span><span class="p">),</span> <span class="n">_as_list</span><span class="p">(</span><span class="n">value</span><span class="p">))</span> |
| |
| <span class="k">elif</span> <span class="n">key</span> <span class="o">==</span> <span class="s2">"force_grid_wrap"</span><span class="p">:</span> |
| |
| <span class="k">try</span><span class="p">:</span> |
| |
| <span class="n">result</span> <span class="o">=</span> <span class="n">existing_value_type</span><span class="p">(</span><span class="n">value</span><span class="p">)</span> |
| |
| <span class="k">except</span> <span class="ne">ValueError</span><span class="p">:</span> <span class="c1"># backwards compatibility for true / false force grid wrap</span> |
| |
| <span class="n">result</span> <span class="o">=</span> <span class="mi">0</span> <span class="k">if</span> <span class="n">value</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span> <span class="o">==</span> <span class="s2">"false"</span> <span class="k">else</span> <span class="mi">2</span> |
| |
| <span class="n">settings</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="n">result</span> |
| |
| <span class="k">elif</span> <span class="n">key</span> <span class="o">==</span> <span class="s2">"comment_prefix"</span><span class="p">:</span> |
| |
| <span class="n">settings</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span><span class="o">.</span><span class="n">strip</span><span class="p">(</span><span class="s2">"'"</span><span class="p">)</span><span class="o">.</span><span class="n">strip</span><span class="p">(</span><span class="s1">'"'</span><span class="p">)</span> |
| |
| <span class="k">else</span><span class="p">:</span> |
| |
| <span class="n">settings</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="n">existing_value_type</span><span class="p">(</span><span class="n">value</span><span class="p">)</span> |
| |
| <span class="k">return</span> <span class="n">settings</span> |
| |
| <span class="k">def</span> <span class="nf">_as_bool</span><span class="p">(</span><span class="n">value</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="nb">bool</span><span class="p">:</span> |
| |
| <span class="sd">"""Given a string value that represents True or False, returns the Boolean equivalent.</span> |
| |
| <span class="sd"> Heavily inspired from distutils strtobool.</span> |
| |
| <span class="sd"> """</span> |
| |
| <span class="k">try</span><span class="p">:</span> |
| |
| <span class="k">return</span> <span class="n">_STR_BOOLEAN_MAPPING</span><span class="p">[</span><span class="n">value</span><span class="o">.</span><span class="n">lower</span><span class="p">()]</span> |
| |
| <span class="k">except</span> <span class="ne">KeyError</span><span class="p">:</span> |
| |
| <span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="sa">f</span><span class="s2">"invalid truth value </span><span class="si">{</span><span class="n">value</span><span class="si">}</span><span class="s2">"</span><span class="p">)</span> |
| |
| <span class="n">DEFAULT_CONFIG</span> <span class="o">=</span> <span class="n">Config</span><span class="p">()</span> |
| </code></pre></div> |
| |
| </details> |
| <h2 id="variables">Variables</h2> |
| <div class="codehilite"><pre><span></span><code><span class="n">BLOCKED_EXTENSIONS</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">CONFIG_SECTIONS</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">CONFIG_SOURCES</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">CYTHON_EXTENSIONS</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">DEFAULT_CONFIG</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">DEFAULT_SKIP</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">DEPRECATED_SETTINGS</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">FALLBACK_CONFIG_SECTIONS</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">FILE_SKIP_COMMENTS</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">FIRSTPARTY</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">FUTURE</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">IMPORT_FOOTER_PREFIX</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">IMPORT_HEADING_PREFIX</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">KNOWN_PREFIX</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">KNOWN_SECTION_MAPPING</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">LOCALFOLDER</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">MAX_CONFIG_SEARCH_DEPTH</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">RUNTIME_SOURCE</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">SECTION_DEFAULTS</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">STDLIB</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">STOP_CONFIG_SEARCH_ON_DIRS</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">SUPPORTED_EXTENSIONS</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">THIRDPARTY</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">TYPE_CHECKING</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">VALID_PY_TARGETS</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">profiles</span> |
| </code></pre></div> |
| |
| <h2 id="functions">Functions</h2> |
| <h3 id="find_all_configs">find_all_configs</h3> |
| <div class="codehilite"><pre><span></span><code><span class="k">def</span> <span class="nf">find_all_configs</span><span class="p">(</span> |
| <span class="n">path</span><span class="p">:</span> <span class="nb">str</span> |
| <span class="p">)</span> <span class="o">-></span> <span class="n">isort</span><span class="o">.</span><span class="n">utils</span><span class="o">.</span><span class="n">Trie</span> |
| </code></pre></div> |
| |
| <p>Looks for config files in the path provided and in all of its sub-directories.</p> |
| <p>Parses and stores any config file encountered in a trie and returns the root of |
| the trie</p> |
| <details class="example"><summary>View Source</summary><div class="codehilite"><pre><span></span><code><span class="nv">@lru_cache</span><span class="p">()</span><span class="w"></span> |
| |
| <span class="n">def</span><span class="w"> </span><span class="n">find_all_configs</span><span class="p">(</span><span class="k">path</span><span class="err">:</span><span class="w"> </span><span class="nf">str</span><span class="p">)</span><span class="w"> </span><span class="o">-></span><span class="w"> </span><span class="nl">Trie</span><span class="p">:</span><span class="w"></span> |
| |
| <span class="w"> </span><span class="ss">"""</span> |
| |
| <span class="ss"> Looks for config files in the path provided and in all of its sub-directories.</span> |
| |
| <span class="ss"> Parses and stores any config file encountered in a trie and returns the root of</span> |
| |
| <span class="ss"> the trie</span> |
| |
| <span class="ss"> """</span><span class="w"></span> |
| |
| <span class="w"> </span><span class="n">trie_root</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">Trie</span><span class="p">(</span><span class="ss">"default"</span><span class="p">,</span><span class="w"> </span><span class="err">{}</span><span class="p">)</span><span class="w"></span> |
| |
| <span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="p">(</span><span class="n">dirpath</span><span class="p">,</span><span class="w"> </span><span class="n">_</span><span class="p">,</span><span class="w"> </span><span class="n">_</span><span class="p">)</span><span class="w"> </span><span class="ow">in</span><span class="w"> </span><span class="n">os</span><span class="p">.</span><span class="n">walk</span><span class="p">(</span><span class="k">path</span><span class="p">)</span><span class="err">:</span><span class="w"></span> |
| |
| <span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="n">config_file_name</span><span class="w"> </span><span class="ow">in</span><span class="w"> </span><span class="nl">CONFIG_SOURCES</span><span class="p">:</span><span class="w"></span> |
| |
| <span class="w"> </span><span class="n">potential_config_file</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">os</span><span class="p">.</span><span class="k">path</span><span class="p">.</span><span class="k">join</span><span class="p">(</span><span class="n">dirpath</span><span class="p">,</span><span class="w"> </span><span class="n">config_file_name</span><span class="p">)</span><span class="w"></span> |
| |
| <span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="n">os</span><span class="p">.</span><span class="k">path</span><span class="p">.</span><span class="n">isfile</span><span class="p">(</span><span class="n">potential_config_file</span><span class="p">)</span><span class="err">:</span><span class="w"></span> |
| |
| <span class="w"> </span><span class="nl">config_data</span><span class="p">:</span><span class="w"> </span><span class="n">Dict</span><span class="o">[</span><span class="n">str, Any</span><span class="o">]</span><span class="w"></span> |
| |
| <span class="w"> </span><span class="k">try</span><span class="err">:</span><span class="w"></span> |
| |
| <span class="w"> </span><span class="n">config_data</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">_get_config_data</span><span class="p">(</span><span class="w"></span> |
| |
| <span class="w"> </span><span class="n">potential_config_file</span><span class="p">,</span><span class="w"> </span><span class="n">CONFIG_SECTIONS</span><span class="o">[</span><span class="n">config_file_name</span><span class="o">]</span><span class="w"></span> |
| |
| <span class="w"> </span><span class="p">)</span><span class="w"></span> |
| |
| <span class="w"> </span><span class="ow">except</span><span class="w"> </span><span class="k">Exception</span><span class="err">:</span><span class="w"></span> |
| |
| <span class="w"> </span><span class="n">warn</span><span class="p">(</span><span class="n">f</span><span class="ss">"Failed to pull configuration information from {potential_config_file}"</span><span class="p">)</span><span class="w"></span> |
| |
| <span class="w"> </span><span class="n">config_data</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="err">{}</span><span class="w"></span> |
| |
| <span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="nl">config_data</span><span class="p">:</span><span class="w"></span> |
| |
| <span class="w"> </span><span class="n">trie_root</span><span class="p">.</span><span class="k">insert</span><span class="p">(</span><span class="n">potential_config_file</span><span class="p">,</span><span class="w"> </span><span class="n">config_data</span><span class="p">)</span><span class="w"></span> |
| |
| <span class="w"> </span><span class="k">break</span><span class="w"></span> |
| |
| <span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="n">trie_root</span><span class="w"></span> |
| </code></pre></div> |
| |
| </details> |
| <h2 id="classes">Classes</h2> |
| <h3 id="config">Config</h3> |
| <div class="codehilite"><pre><span></span><code><span class="k">class</span> <span class="nc">Config</span><span class="p">(</span> |
| <span class="n">settings_file</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s1">''</span><span class="p">,</span> |
| <span class="n">settings_path</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s1">''</span><span class="p">,</span> |
| <span class="n">config</span><span class="p">:</span> <span class="n">Optional</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="o">=</span> <span class="kc">None</span><span class="p">,</span> |
| <span class="o">**</span><span class="n">config_overrides</span><span class="p">:</span> <span class="n">Any</span> |
| <span class="p">)</span> |
| </code></pre></div> |
| |
| <details class="example"><summary>View Source</summary><div class="codehilite"><pre><span></span><code><span class="k">class</span> <span class="n">Config</span><span class="p">(</span><span class="n">_Config</span><span class="p">):</span> |
| |
| <span class="n">def</span> <span class="n">__init__</span><span class="p">(</span> |
| |
| <span class="bp">self</span><span class="p">,</span> |
| |
| <span class="n">settings_file</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">""</span><span class="p">,</span> |
| |
| <span class="n">settings_path</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">""</span><span class="p">,</span> |
| |
| <span class="n">config</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">_Config</span><span class="p">]</span> <span class="o">=</span> <span class="n">None</span><span class="p">,</span> |
| |
| <span class="o">**</span><span class="n">config_overrides</span><span class="p">:</span> <span class="n">Any</span><span class="p">,</span> |
| |
| <span class="p">):</span> |
| |
| <span class="bp">self</span><span class="o">.</span><span class="n">_known_patterns</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">List</span><span class="p">[</span><span class="n">Tuple</span><span class="p">[</span><span class="n">Pattern</span><span class="p">[</span><span class="nb">str</span><span class="p">],</span> <span class="nb">str</span><span class="p">]]]</span> <span class="o">=</span> <span class="n">None</span> |
| |
| <span class="bp">self</span><span class="o">.</span><span class="n">_section_comments</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Tuple</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="o">...</span><span class="p">]]</span> <span class="o">=</span> <span class="n">None</span> |
| |
| <span class="bp">self</span><span class="o">.</span><span class="n">_section_comments_end</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Tuple</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="o">...</span><span class="p">]]</span> <span class="o">=</span> <span class="n">None</span> |
| |
| <span class="bp">self</span><span class="o">.</span><span class="n">_skips</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">FrozenSet</span><span class="p">[</span><span class="nb">str</span><span class="p">]]</span> <span class="o">=</span> <span class="n">None</span> |
| |
| <span class="bp">self</span><span class="o">.</span><span class="n">_skip_globs</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">FrozenSet</span><span class="p">[</span><span class="nb">str</span><span class="p">]]</span> <span class="o">=</span> <span class="n">None</span> |
| |
| <span class="bp">self</span><span class="o">.</span><span class="n">_sorting_function</span><span class="p">:</span> <span class="n">Optional</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">None</span> |
| |
| <span class="k">if</span> <span class="n">config</span><span class="p">:</span> |
| |
| <span class="n">config_vars</span> <span class="o">=</span> <span class="n">vars</span><span class="p">(</span><span class="n">config</span><span class="p">)</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span> |
| |
| <span class="n">config_vars</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">config_overrides</span><span class="p">)</span> |
| |
| <span class="n">config_vars</span><span class="p">[</span><span class="s2">"py_version"</span><span class="p">]</span> <span class="o">=</span> <span class="n">config_vars</span><span class="p">[</span><span class="s2">"py_version"</span><span class="p">]</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s2">"py"</span><span class="p">,</span> <span class="s2">""</span><span class="p">)</span> |
| |
| <span class="n">config_vars</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s2">"_known_patterns"</span><span class="p">)</span> |
| |
| <span class="n">config_vars</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s2">"_section_comments"</span><span class="p">)</span> |
| |
| <span class="n">config_vars</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s2">"_section_comments_end"</span><span class="p">)</span> |
| |
| <span class="n">config_vars</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s2">"_skips"</span><span class="p">)</span> |
| |
| <span class="n">config_vars</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s2">"_skip_globs"</span><span class="p">)</span> |
| |
| <span class="n">config_vars</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s2">"_sorting_function"</span><span class="p">)</span> |
| |
| <span class="n">super</span><span class="p">()</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="o">**</span><span class="n">config_vars</span><span class="p">)</span> <span class="c1"># type: ignore</span> |
| |
| <span class="k">return</span> |
| |
| <span class="c1"># We can't use self.quiet to conditionally show warnings before super.__init__() is called</span> |
| |
| <span class="c1"># at the end of this method. _Config is also frozen so setting self.quiet isn't possible.</span> |
| |
| <span class="c1"># Therefore we extract quiet early here in a variable and use that in warning conditions.</span> |
| |
| <span class="n">quiet</span> <span class="o">=</span> <span class="n">config_overrides</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"quiet"</span><span class="p">,</span> <span class="n">False</span><span class="p">)</span> |
| |
| <span class="n">sources</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="n">Dict</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="o">=</span> <span class="p">[</span><span class="n">_DEFAULT_SETTINGS</span><span class="p">]</span> |
| |
| <span class="n">config_settings</span><span class="p">:</span> <span class="n">Dict</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">project_root</span><span class="p">:</span> <span class="nb">str</span> |
| |
| <span class="k">if</span> <span class="n">settings_file</span><span class="p">:</span> |
| |
| <span class="n">config_settings</span> <span class="o">=</span> <span class="n">_get_config_data</span><span class="p">(</span> |
| |
| <span class="n">settings_file</span><span class="p">,</span> |
| |
| <span class="n">CONFIG_SECTIONS</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">basename</span><span class="p">(</span><span class="n">settings_file</span><span class="p">),</span> <span class="n">FALLBACK_CONFIG_SECTIONS</span><span class="p">),</span> |
| |
| <span class="p">)</span> |
| |
| <span class="n">project_root</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="n">settings_file</span><span class="p">)</span> |
| |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">config_settings</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">quiet</span><span class="p">:</span> |
| |
| <span class="n">warn</span><span class="p">(</span> |
| |
| <span class="n">f</span><span class="s2">"A custom settings file was specified: {settings_file} but no configuration "</span> |
| |
| <span class="s2">"was found inside. This can happen when [settings] is used as the config "</span> |
| |
| <span class="s2">"header instead of [isort]. "</span> |
| |
| <span class="s2">"See: https://pycqa.github.io/isort/docs/configuration/config_files"</span> |
| |
| <span class="s2">"/#custom_config_files for more information."</span> |
| |
| <span class="p">)</span> |
| |
| <span class="k">elif</span> <span class="n">settings_path</span><span class="p">:</span> |
| |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">exists</span><span class="p">(</span><span class="n">settings_path</span><span class="p">):</span> |
| |
| <span class="n">raise</span> <span class="n">InvalidSettingsPath</span><span class="p">(</span><span class="n">settings_path</span><span class="p">)</span> |
| |
| <span class="n">settings_path</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">abspath</span><span class="p">(</span><span class="n">settings_path</span><span class="p">)</span> |
| |
| <span class="n">project_root</span><span class="p">,</span> <span class="n">config_settings</span> <span class="o">=</span> <span class="n">_find_config</span><span class="p">(</span><span class="n">settings_path</span><span class="p">)</span> |
| |
| <span class="k">else</span><span class="p">:</span> |
| |
| <span class="n">config_settings</span> <span class="o">=</span> <span class="p">{}</span> |
| |
| <span class="n">project_root</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">getcwd</span><span class="p">()</span> |
| |
| <span class="n">profile_name</span> <span class="o">=</span> <span class="n">config_overrides</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"profile"</span><span class="p">,</span> <span class="n">config_settings</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"profile"</span><span class="p">,</span> <span class="s2">""</span><span class="p">))</span> |
| |
| <span class="n">profile</span><span class="p">:</span> <span class="n">Dict</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="o">=</span> <span class="p">{}</span> |
| |
| <span class="k">if</span> <span class="n">profile_name</span><span class="p">:</span> |
| |
| <span class="k">if</span> <span class="n">profile_name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">profiles</span><span class="p">:</span> |
| |
| <span class="n">import</span> <span class="n">pkg_resources</span> |
| |
| <span class="k">for</span> <span class="n">plugin</span> <span class="ow">in</span> <span class="n">pkg_resources</span><span class="o">.</span><span class="n">iter_entry_points</span><span class="p">(</span><span class="s2">"isort.profiles"</span><span class="p">):</span> |
| |
| <span class="n">profiles</span><span class="o">.</span><span class="n">setdefault</span><span class="p">(</span><span class="n">plugin</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">plugin</span><span class="o">.</span><span class="n">load</span><span class="p">())</span> |
| |
| <span class="k">if</span> <span class="n">profile_name</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">profiles</span><span class="p">:</span> |
| |
| <span class="n">raise</span> <span class="n">ProfileDoesNotExist</span><span class="p">(</span><span class="n">profile_name</span><span class="p">)</span> |
| |
| <span class="n">profile</span> <span class="o">=</span> <span class="n">profiles</span><span class="p">[</span><span class="n">profile_name</span><span class="p">]</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span> |
| |
| <span class="n">profile</span><span class="p">[</span><span class="s2">"source"</span><span class="p">]</span> <span class="o">=</span> <span class="n">f</span><span class="s2">"{profile_name} profile"</span> |
| |
| <span class="n">sources</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">profile</span><span class="p">)</span> |
| |
| <span class="k">if</span> <span class="n">config_settings</span><span class="p">:</span> |
| |
| <span class="n">sources</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">config_settings</span><span class="p">)</span> |
| |
| <span class="k">if</span> <span class="n">config_overrides</span><span class="p">:</span> |
| |
| <span class="n">config_overrides</span><span class="p">[</span><span class="s2">"source"</span><span class="p">]</span> <span class="o">=</span> <span class="n">RUNTIME_SOURCE</span> |
| |
| <span class="n">sources</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">config_overrides</span><span class="p">)</span> |
| |
| <span class="n">combined_config</span> <span class="o">=</span> <span class="p">{</span><span class="o">**</span><span class="n">profile</span><span class="p">,</span> <span class="o">**</span><span class="n">config_settings</span><span class="p">,</span> <span class="o">**</span><span class="n">config_overrides</span><span class="p">}</span> |
| |
| <span class="k">if</span> <span class="s2">"indent"</span> <span class="ow">in</span> <span class="n">combined_config</span><span class="p">:</span> |
| |
| <span class="n">indent</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">combined_config</span><span class="p">[</span><span class="s2">"indent"</span><span class="p">])</span> |
| |
| <span class="k">if</span> <span class="n">indent</span><span class="o">.</span><span class="n">isdigit</span><span class="p">():</span> |
| |
| <span class="n">indent</span> <span class="o">=</span> <span class="s2">" "</span> <span class="o">*</span> <span class="nb nb-Type">int</span><span class="p">(</span><span class="n">indent</span><span class="p">)</span> |
| |
| <span class="k">else</span><span class="p">:</span> |
| |
| <span class="n">indent</span> <span class="o">=</span> <span class="n">indent</span><span class="o">.</span><span class="n">strip</span><span class="p">(</span><span class="s2">"'"</span><span class="p">)</span><span class="o">.</span><span class="n">strip</span><span class="p">(</span><span class="s1">'"'</span><span class="p">)</span> |
| |
| <span class="k">if</span> <span class="n">indent</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="o">==</span> <span class="s2">"tab"</span><span class="p">:</span> |
| |
| <span class="n">indent</span> <span class="o">=</span> <span class="s2">"</span><span class="se">\t</span><span class="s2">"</span> |
| |
| <span class="n">combined_config</span><span class="p">[</span><span class="s2">"indent"</span><span class="p">]</span> <span class="o">=</span> <span class="n">indent</span> |
| |
| <span class="n">known_other</span> <span class="o">=</span> <span class="p">{}</span> |
| |
| <span class="n">import_headings</span> <span class="o">=</span> <span class="p">{}</span> |
| |
| <span class="n">import_footers</span> <span class="o">=</span> <span class="p">{}</span> |
| |
| <span class="k">for</span> <span class="n">key</span><span class="p">,</span> <span class="n">value</span> <span class="ow">in</span> <span class="n">tuple</span><span class="p">(</span><span class="n">combined_config</span><span class="o">.</span><span class="n">items</span><span class="p">()):</span> |
| |
| <span class="c1"># Collect all known sections beyond those that have direct entries</span> |
| |
| <span class="k">if</span> <span class="n">key</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="n">KNOWN_PREFIX</span><span class="p">)</span> <span class="ow">and</span> <span class="n">key</span> <span class="ow">not</span> <span class="ow">in</span> <span class="p">(</span> |
| |
| <span class="s2">"known_standard_library"</span><span class="p">,</span> |
| |
| <span class="s2">"known_future_library"</span><span class="p">,</span> |
| |
| <span class="s2">"known_third_party"</span><span class="p">,</span> |
| |
| <span class="s2">"known_first_party"</span><span class="p">,</span> |
| |
| <span class="s2">"known_local_folder"</span><span class="p">,</span> |
| |
| <span class="p">):</span> |
| |
| <span class="n">import_heading</span> <span class="o">=</span> <span class="n">key</span><span class="p">[</span><span class="n">len</span><span class="p">(</span><span class="n">KNOWN_PREFIX</span><span class="p">)</span> <span class="p">:]</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> |
| |
| <span class="n">maps_to_section</span> <span class="o">=</span> <span class="n">import_heading</span><span class="o">.</span><span class="n">upper</span><span class="p">()</span> |
| |
| <span class="n">combined_config</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="n">key</span><span class="p">)</span> |
| |
| <span class="k">if</span> <span class="n">maps_to_section</span> <span class="ow">in</span> <span class="n">KNOWN_SECTION_MAPPING</span><span class="p">:</span> |
| |
| <span class="n">section_name</span> <span class="o">=</span> <span class="n">f</span><span class="s2">"known_{KNOWN_SECTION_MAPPING[maps_to_section].lower()}"</span> |
| |
| <span class="k">if</span> <span class="n">section_name</span> <span class="ow">in</span> <span class="n">combined_config</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">quiet</span><span class="p">:</span> |
| |
| <span class="n">warn</span><span class="p">(</span> |
| |
| <span class="n">f</span><span class="s2">"Can't set both {key} and {section_name} in the same config file.</span><span class="se">\n</span><span class="s2">"</span> |
| |
| <span class="n">f</span><span class="s2">"Default to {section_name} if unsure."</span> |
| |
| <span class="s2">"</span><span class="se">\n\n</span><span class="s2">"</span> |
| |
| <span class="s2">"See: https://pycqa.github.io/isort/"</span> |
| |
| <span class="s2">"#custom-sections-and-ordering."</span> |
| |
| <span class="p">)</span> |
| |
| <span class="k">else</span><span class="p">:</span> |
| |
| <span class="n">combined_config</span><span class="p">[</span><span class="n">section_name</span><span class="p">]</span> <span class="o">=</span> <span class="n">frozenset</span><span class="p">(</span><span class="n">value</span><span class="p">)</span> |
| |
| <span class="k">else</span><span class="p">:</span> |
| |
| <span class="n">known_other</span><span class="p">[</span><span class="n">import_heading</span><span class="p">]</span> <span class="o">=</span> <span class="n">frozenset</span><span class="p">(</span><span class="n">value</span><span class="p">)</span> |
| |
| <span class="k">if</span> <span class="n">maps_to_section</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">combined_config</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"sections"</span><span class="p">,</span> <span class="p">())</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">quiet</span><span class="p">:</span> |
| |
| <span class="n">warn</span><span class="p">(</span> |
| |
| <span class="n">f</span><span class="s2">"`{key}` setting is defined, but {maps_to_section} is not"</span> |
| |
| <span class="s2">" included in `sections` config option:"</span> |
| |
| <span class="n">f</span><span class="s2">" {combined_config.get('sections', SECTION_DEFAULTS)}.</span><span class="se">\n\n</span><span class="s2">"</span> |
| |
| <span class="s2">"See: https://pycqa.github.io/isort/"</span> |
| |
| <span class="s2">"#custom-sections-and-ordering."</span> |
| |
| <span class="p">)</span> |
| |
| <span class="k">if</span> <span class="n">key</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="n">IMPORT_HEADING_PREFIX</span><span class="p">):</span> |
| |
| <span class="n">import_headings</span><span class="p">[</span><span class="n">key</span><span class="p">[</span><span class="n">len</span><span class="p">(</span><span class="n">IMPORT_HEADING_PREFIX</span><span class="p">)</span> <span class="p">:]</span><span class="o">.</span><span class="n">lower</span><span class="p">()]</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span> |
| |
| <span class="k">if</span> <span class="n">key</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="n">IMPORT_FOOTER_PREFIX</span><span class="p">):</span> |
| |
| <span class="n">import_footers</span><span class="p">[</span><span class="n">key</span><span class="p">[</span><span class="n">len</span><span class="p">(</span><span class="n">IMPORT_FOOTER_PREFIX</span><span class="p">)</span> <span class="p">:]</span><span class="o">.</span><span class="n">lower</span><span class="p">()]</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">value</span><span class="p">)</span> |
| |
| <span class="c1"># Coerce all provided config values into their correct type</span> |
| |
| <span class="n">default_value</span> <span class="o">=</span> <span class="n">_DEFAULT_SETTINGS</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">key</span><span class="p">,</span> <span class="n">None</span><span class="p">)</span> |
| |
| <span class="k">if</span> <span class="n">default_value</span> <span class="k">is</span> <span class="n">None</span><span class="p">:</span> |
| |
| <span class="k">continue</span> |
| |
| <span class="n">combined_config</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="n">type</span><span class="p">(</span><span class="n">default_value</span><span class="p">)(</span><span class="n">value</span><span class="p">)</span> |
| |
| <span class="k">for</span> <span class="n">section</span> <span class="ow">in</span> <span class="n">combined_config</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"sections"</span><span class="p">,</span> <span class="p">()):</span> |
| |
| <span class="k">if</span> <span class="n">section</span> <span class="ow">in</span> <span class="n">SECTION_DEFAULTS</span><span class="p">:</span> |
| |
| <span class="k">continue</span> |
| |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">section</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> <span class="ow">in</span> <span class="n">known_other</span><span class="p">:</span> |
| |
| <span class="n">config_keys</span> <span class="o">=</span> <span class="s2">", "</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">known_other</span><span class="o">.</span><span class="n">keys</span><span class="p">())</span> |
| |
| <span class="n">warn</span><span class="p">(</span> |
| |
| <span class="n">f</span><span class="s2">"`sections` setting includes {section}, but no known_{section.lower()} "</span> |
| |
| <span class="s2">"is defined. "</span> |
| |
| <span class="n">f</span><span class="s2">"The following known_SECTION config options are defined: {config_keys}."</span> |
| |
| <span class="p">)</span> |
| |
| <span class="k">if</span> <span class="s2">"directory"</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">combined_config</span><span class="p">:</span> |
| |
| <span class="n">combined_config</span><span class="p">[</span><span class="s2">"directory"</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span> |
| |
| <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="n">config_settings</span><span class="p">[</span><span class="s2">"source"</span><span class="p">])</span> |
| |
| <span class="k">if</span> <span class="n">config_settings</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"source"</span><span class="p">,</span> <span class="n">None</span><span class="p">)</span> |
| |
| <span class="k">else</span> <span class="n">os</span><span class="o">.</span><span class="n">getcwd</span><span class="p">()</span> |
| |
| <span class="p">)</span> |
| |
| <span class="n">path_root</span> <span class="o">=</span> <span class="n">Path</span><span class="p">(</span><span class="n">combined_config</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"directory"</span><span class="p">,</span> <span class="n">project_root</span><span class="p">))</span><span class="o">.</span><span class="n">resolve</span><span class="p">()</span> |
| |
| <span class="n">path_root</span> <span class="o">=</span> <span class="n">path_root</span> <span class="k">if</span> <span class="n">path_root</span><span class="o">.</span><span class="n">is_dir</span><span class="p">()</span> <span class="k">else</span> <span class="n">path_root</span><span class="o">.</span><span class="n">parent</span> |
| |
| <span class="k">if</span> <span class="s2">"src_paths"</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">combined_config</span><span class="p">:</span> |
| |
| <span class="n">combined_config</span><span class="p">[</span><span class="s2">"src_paths"</span><span class="p">]</span> <span class="o">=</span> <span class="p">(</span><span class="n">path_root</span> <span class="o">/</span> <span class="s2">"src"</span><span class="p">,</span> <span class="n">path_root</span><span class="p">)</span> |
| |
| <span class="k">else</span><span class="p">:</span> |
| |
| <span class="n">src_paths</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="n">Path</span><span class="p">]</span> <span class="o">=</span> <span class="p">[]</span> |
| |
| <span class="k">for</span> <span class="n">src_path</span> <span class="ow">in</span> <span class="n">combined_config</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"src_paths"</span><span class="p">,</span> <span class="p">()):</span> |
| |
| <span class="n">full_paths</span> <span class="o">=</span> <span class="p">(</span> |
| |
| <span class="n">path_root</span><span class="o">.</span><span class="n">glob</span><span class="p">(</span><span class="n">src_path</span><span class="p">)</span> <span class="k">if</span> <span class="s2">"*"</span> <span class="ow">in</span> <span class="nb">str</span><span class="p">(</span><span class="n">src_path</span><span class="p">)</span> <span class="k">else</span> <span class="p">[</span><span class="n">path_root</span> <span class="o">/</span> <span class="n">src_path</span><span class="p">]</span> |
| |
| <span class="p">)</span> |
| |
| <span class="k">for</span> <span class="n">path</span> <span class="ow">in</span> <span class="n">full_paths</span><span class="p">:</span> |
| |
| <span class="k">if</span> <span class="n">path</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">src_paths</span><span class="p">:</span> |
| |
| <span class="n">src_paths</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">path</span><span class="p">)</span> |
| |
| <span class="n">combined_config</span><span class="p">[</span><span class="s2">"src_paths"</span><span class="p">]</span> <span class="o">=</span> <span class="n">tuple</span><span class="p">(</span><span class="n">src_paths</span><span class="p">)</span> |
| |
| <span class="k">if</span> <span class="s2">"formatter"</span> <span class="ow">in</span> <span class="n">combined_config</span><span class="p">:</span> |
| |
| <span class="n">import</span> <span class="n">pkg_resources</span> |
| |
| <span class="k">for</span> <span class="n">plugin</span> <span class="ow">in</span> <span class="n">pkg_resources</span><span class="o">.</span><span class="n">iter_entry_points</span><span class="p">(</span><span class="s2">"isort.formatters"</span><span class="p">):</span> |
| |
| <span class="k">if</span> <span class="n">plugin</span><span class="o">.</span><span class="n">name</span> <span class="o">==</span> <span class="n">combined_config</span><span class="p">[</span><span class="s2">"formatter"</span><span class="p">]:</span> |
| |
| <span class="n">combined_config</span><span class="p">[</span><span class="s2">"formatting_function"</span><span class="p">]</span> <span class="o">=</span> <span class="n">plugin</span><span class="o">.</span><span class="n">load</span><span class="p">()</span> |
| |
| <span class="k">break</span> |
| |
| <span class="k">else</span><span class="p">:</span> |
| |
| <span class="n">raise</span> <span class="n">FormattingPluginDoesNotExist</span><span class="p">(</span><span class="n">combined_config</span><span class="p">[</span><span class="s2">"formatter"</span><span class="p">])</span> |
| |
| <span class="c1"># Remove any config values that are used for creating config object but</span> |
| |
| <span class="c1"># aren't defined in dataclass</span> |
| |
| <span class="n">combined_config</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s2">"source"</span><span class="p">,</span> <span class="n">None</span><span class="p">)</span> |
| |
| <span class="n">combined_config</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s2">"sources"</span><span class="p">,</span> <span class="n">None</span><span class="p">)</span> |
| |
| <span class="n">combined_config</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="s2">"runtime_src_paths"</span><span class="p">,</span> <span class="n">None</span><span class="p">)</span> |
| |
| <span class="n">deprecated_options_used</span> <span class="o">=</span> <span class="p">[</span> |
| |
| <span class="n">option</span> <span class="k">for</span> <span class="n">option</span> <span class="ow">in</span> <span class="n">combined_config</span> <span class="k">if</span> <span class="n">option</span> <span class="ow">in</span> <span class="n">DEPRECATED_SETTINGS</span> |
| |
| <span class="p">]</span> |
| |
| <span class="k">if</span> <span class="n">deprecated_options_used</span><span class="p">:</span> |
| |
| <span class="k">for</span> <span class="n">deprecated_option</span> <span class="ow">in</span> <span class="n">deprecated_options_used</span><span class="p">:</span> |
| |
| <span class="n">combined_config</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="n">deprecated_option</span><span class="p">)</span> |
| |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">quiet</span><span class="p">:</span> |
| |
| <span class="n">warn</span><span class="p">(</span> |
| |
| <span class="s2">"W0503: Deprecated config options were used: "</span> |
| |
| <span class="n">f</span><span class="s2">"{', '.join(deprecated_options_used)}."</span> |
| |
| <span class="s2">"Please see the 5.0.0 upgrade guide: "</span> |
| |
| <span class="s2">"https://pycqa.github.io/isort/docs/upgrade_guides/5.0.0.html"</span> |
| |
| <span class="p">)</span> |
| |
| <span class="k">if</span> <span class="n">known_other</span><span class="p">:</span> |
| |
| <span class="n">combined_config</span><span class="p">[</span><span class="s2">"known_other"</span><span class="p">]</span> <span class="o">=</span> <span class="n">known_other</span> |
| |
| <span class="k">if</span> <span class="n">import_headings</span><span class="p">:</span> |
| |
| <span class="k">for</span> <span class="n">import_heading_key</span> <span class="ow">in</span> <span class="n">import_headings</span><span class="p">:</span> |
| |
| <span class="n">combined_config</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="n">f</span><span class="s2">"{IMPORT_HEADING_PREFIX}{import_heading_key}"</span><span class="p">)</span> |
| |
| <span class="n">combined_config</span><span class="p">[</span><span class="s2">"import_headings"</span><span class="p">]</span> <span class="o">=</span> <span class="n">import_headings</span> |
| |
| <span class="k">if</span> <span class="n">import_footers</span><span class="p">:</span> |
| |
| <span class="k">for</span> <span class="n">import_footer_key</span> <span class="ow">in</span> <span class="n">import_footers</span><span class="p">:</span> |
| |
| <span class="n">combined_config</span><span class="o">.</span><span class="n">pop</span><span class="p">(</span><span class="n">f</span><span class="s2">"{IMPORT_FOOTER_PREFIX}{import_footer_key}"</span><span class="p">)</span> |
| |
| <span class="n">combined_config</span><span class="p">[</span><span class="s2">"import_footers"</span><span class="p">]</span> <span class="o">=</span> <span class="n">import_footers</span> |
| |
| <span class="n">unsupported_config_errors</span> <span class="o">=</span> <span class="p">{}</span> |
| |
| <span class="k">for</span> <span class="n">option</span> <span class="ow">in</span> <span class="n">set</span><span class="p">(</span><span class="n">combined_config</span><span class="o">.</span><span class="n">keys</span><span class="p">())</span><span class="o">.</span><span class="n">difference</span><span class="p">(</span> |
| |
| <span class="n">getattr</span><span class="p">(</span><span class="n">_Config</span><span class="p">,</span> <span class="s2">"__dataclass_fields__"</span><span class="p">,</span> <span class="p">{})</span><span class="o">.</span><span class="n">keys</span><span class="p">()</span> |
| |
| <span class="p">):</span> |
| |
| <span class="k">for</span> <span class="n">source</span> <span class="ow">in</span> <span class="n">reversed</span><span class="p">(</span><span class="n">sources</span><span class="p">):</span> |
| |
| <span class="k">if</span> <span class="n">option</span> <span class="ow">in</span> <span class="n">source</span><span class="p">:</span> |
| |
| <span class="n">unsupported_config_errors</span><span class="p">[</span><span class="n">option</span><span class="p">]</span> <span class="o">=</span> <span class="p">{</span> |
| |
| <span class="s2">"value"</span><span class="p">:</span> <span class="n">source</span><span class="p">[</span><span class="n">option</span><span class="p">],</span> |
| |
| <span class="s2">"source"</span><span class="p">:</span> <span class="n">source</span><span class="p">[</span><span class="s2">"source"</span><span class="p">],</span> |
| |
| <span class="p">}</span> |
| |
| <span class="k">if</span> <span class="n">unsupported_config_errors</span><span class="p">:</span> |
| |
| <span class="n">raise</span> <span class="n">UnsupportedSettings</span><span class="p">(</span><span class="n">unsupported_config_errors</span><span class="p">)</span> |
| |
| <span class="n">super</span><span class="p">()</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="n">sources</span><span class="o">=</span><span class="n">tuple</span><span class="p">(</span><span class="n">sources</span><span class="p">),</span> <span class="o">**</span><span class="n">combined_config</span><span class="p">)</span> <span class="c1"># type: ignore</span> |
| |
| <span class="n">def</span> <span class="n">is_supported_filetype</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">file_name</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="nb nb-Type">bool</span><span class="p">:</span> |
| |
| <span class="n">_root</span><span class="p">,</span> <span class="n">ext</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">splitext</span><span class="p">(</span><span class="n">file_name</span><span class="p">)</span> |
| |
| <span class="n">ext</span> <span class="o">=</span> <span class="n">ext</span><span class="o">.</span><span class="n">lstrip</span><span class="p">(</span><span class="s2">"."</span><span class="p">)</span> |
| |
| <span class="k">if</span> <span class="n">ext</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">supported_extensions</span><span class="p">:</span> |
| |
| <span class="k">return</span> <span class="n">True</span> |
| |
| <span class="k">if</span> <span class="n">ext</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">blocked_extensions</span><span class="p">:</span> |
| |
| <span class="k">return</span> <span class="n">False</span> |
| |
| <span class="c1"># Skip editor backup files.</span> |
| |
| <span class="k">if</span> <span class="n">file_name</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s2">"~"</span><span class="p">):</span> |
| |
| <span class="k">return</span> <span class="n">False</span> |
| |
| <span class="n">try</span><span class="p">:</span> |
| |
| <span class="k">if</span> <span class="n">stat</span><span class="o">.</span><span class="n">S_ISFIFO</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">stat</span><span class="p">(</span><span class="n">file_name</span><span class="p">)</span><span class="o">.</span><span class="n">st_mode</span><span class="p">):</span> |
| |
| <span class="k">return</span> <span class="n">False</span> |
| |
| <span class="n">except</span> <span class="n">OSError</span><span class="p">:</span> |
| |
| <span class="k">pass</span> |
| |
| <span class="n">try</span><span class="p">:</span> |
| |
| <span class="n">with</span> <span class="n">open</span><span class="p">(</span><span class="n">file_name</span><span class="p">,</span> <span class="s2">"rb"</span><span class="p">)</span> <span class="k">as</span> <span class="n">fp</span><span class="p">:</span> |
| |
| <span class="n">line</span> <span class="o">=</span> <span class="n">fp</span><span class="o">.</span><span class="n">readline</span><span class="p">(</span><span class="mi">100</span><span class="p">)</span> |
| |
| <span class="n">except</span> <span class="n">OSError</span><span class="p">:</span> |
| |
| <span class="k">return</span> <span class="n">False</span> |
| |
| <span class="k">else</span><span class="p">:</span> |
| |
| <span class="k">return</span> <span class="nb nb-Type">bool</span><span class="p">(</span><span class="n">_SHEBANG_RE</span><span class="o">.</span><span class="k">match</span><span class="p">(</span><span class="n">line</span><span class="p">))</span> |
| |
| <span class="n">def</span> <span class="n">_check_folder_gitignore</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">folder</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="n">Optional</span><span class="p">[</span><span class="n">Path</span><span class="p">]:</span> |
| |
| <span class="n">env</span> <span class="o">=</span> <span class="p">{</span><span class="o">**</span><span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">,</span> <span class="s2">"LANG"</span><span class="p">:</span> <span class="s2">"C.UTF-8"</span><span class="p">}</span> |
| |
| <span class="n">try</span><span class="p">:</span> |
| |
| <span class="n">topfolder_result</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">check_output</span><span class="p">(</span> <span class="c1"># nosec # skipcq: PYL-W1510</span> |
| |
| <span class="p">[</span><span class="s2">"git"</span><span class="p">,</span> <span class="s2">"-C"</span><span class="p">,</span> <span class="n">folder</span><span class="p">,</span> <span class="s2">"rev-parse"</span><span class="p">,</span> <span class="s2">"--show-toplevel"</span><span class="p">],</span> <span class="n">encoding</span><span class="o">=</span><span class="s2">"utf-8"</span><span class="p">,</span> <span class="n">env</span><span class="o">=</span><span class="n">env</span> |
| |
| <span class="p">)</span> |
| |
| <span class="n">except</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">CalledProcessError</span><span class="p">:</span> |
| |
| <span class="k">return</span> <span class="n">None</span> |
| |
| <span class="n">git_folder</span> <span class="o">=</span> <span class="n">Path</span><span class="p">(</span><span class="n">topfolder_result</span><span class="o">.</span><span class="n">rstrip</span><span class="p">())</span><span class="o">.</span><span class="n">resolve</span><span class="p">()</span> |
| |
| <span class="n">files</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="p">[]</span> |
| |
| <span class="c1"># don't check symlinks; either part of the repo and would be checked</span> |
| |
| <span class="c1"># twice, or is external to the repo and git won't know anything about it</span> |
| |
| <span class="k">for</span> <span class="n">root</span><span class="p">,</span> <span class="n">_dirs</span><span class="p">,</span> <span class="n">git_files</span> <span class="ow">in</span> <span class="n">os</span><span class="o">.</span><span class="n">walk</span><span class="p">(</span><span class="n">git_folder</span><span class="p">,</span> <span class="n">followlinks</span><span class="o">=</span><span class="n">False</span><span class="p">):</span> |
| |
| <span class="k">if</span> <span class="s2">".git"</span> <span class="ow">in</span> <span class="n">_dirs</span><span class="p">:</span> |
| |
| <span class="n">_dirs</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="s2">".git"</span><span class="p">)</span> |
| |
| <span class="k">for</span> <span class="n">git_file</span> <span class="ow">in</span> <span class="n">git_files</span><span class="p">:</span> |
| |
| <span class="n">files</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">root</span><span class="p">,</span> <span class="n">git_file</span><span class="p">))</span> |
| |
| <span class="n">git_options</span> <span class="o">=</span> <span class="p">[</span><span class="s2">"-C"</span><span class="p">,</span> <span class="nb">str</span><span class="p">(</span><span class="n">git_folder</span><span class="p">),</span> <span class="s2">"-c"</span><span class="p">,</span> <span class="s2">"core.quotePath="</span><span class="p">]</span> |
| |
| <span class="n">try</span><span class="p">:</span> |
| |
| <span class="n">ignored</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">check_output</span><span class="p">(</span> <span class="c1"># nosec # skipcq: PYL-W1510</span> |
| |
| <span class="p">[</span><span class="s2">"git"</span><span class="p">,</span> <span class="o">*</span><span class="n">git_options</span><span class="p">,</span> <span class="s2">"check-ignore"</span><span class="p">,</span> <span class="s2">"-z"</span><span class="p">,</span> <span class="s2">"--stdin"</span><span class="p">,</span> <span class="s2">"--no-index"</span><span class="p">],</span> |
| |
| <span class="n">encoding</span><span class="o">=</span><span class="s2">"utf-8"</span><span class="p">,</span> |
| |
| <span class="n">env</span><span class="o">=</span><span class="n">env</span><span class="p">,</span> |
| |
| <span class="n">input</span><span class="o">=</span><span class="s2">"</span><span class="se">\0</span><span class="s2">"</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">files</span><span class="p">),</span> |
| |
| <span class="p">)</span> |
| |
| <span class="n">except</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">CalledProcessError</span><span class="p">:</span> |
| |
| <span class="k">return</span> <span class="n">None</span> |
| |
| <span class="bp">self</span><span class="o">.</span><span class="n">git_ignore</span><span class="p">[</span><span class="n">git_folder</span><span class="p">]</span> <span class="o">=</span> <span class="p">{</span><span class="n">Path</span><span class="p">(</span><span class="n">f</span><span class="p">)</span> <span class="k">for</span> <span class="n">f</span> <span class="ow">in</span> <span class="n">ignored</span><span class="o">.</span><span class="n">rstrip</span><span class="p">(</span><span class="s2">"</span><span class="se">\0</span><span class="s2">"</span><span class="p">)</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">"</span><span class="se">\0</span><span class="s2">"</span><span class="p">)}</span> |
| |
| <span class="k">return</span> <span class="n">git_folder</span> |
| |
| <span class="n">def</span> <span class="n">is_skipped</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">file_path</span><span class="p">:</span> <span class="n">Path</span><span class="p">)</span> <span class="o">-></span> <span class="nb nb-Type">bool</span><span class="p">:</span> |
| |
| <span class="sd">"""Returns True if the file and/or folder should be skipped based on current settings."""</span> |
| |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">directory</span> <span class="ow">and</span> <span class="n">Path</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">directory</span><span class="p">)</span> <span class="ow">in</span> <span class="n">file_path</span><span class="o">.</span><span class="n">resolve</span><span class="p">()</span><span class="o">.</span><span class="n">parents</span><span class="p">:</span> |
| |
| <span class="n">file_name</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">relpath</span><span class="p">(</span><span class="n">file_path</span><span class="o">.</span><span class="n">resolve</span><span class="p">(),</span> <span class="bp">self</span><span class="o">.</span><span class="n">directory</span><span class="p">)</span> |
| |
| <span class="k">else</span><span class="p">:</span> |
| |
| <span class="n">file_name</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">file_path</span><span class="p">)</span> |
| |
| <span class="n">os_path</span> <span class="o">=</span> <span class="nb">str</span><span class="p">(</span><span class="n">file_path</span><span class="p">)</span> |
| |
| <span class="n">normalized_path</span> <span class="o">=</span> <span class="n">os_path</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s2">"</span><span class="se">\\</span><span class="s2">"</span><span class="p">,</span> <span class="s2">"/"</span><span class="p">)</span> |
| |
| <span class="k">if</span> <span class="n">normalized_path</span><span class="p">[</span><span class="mi">1</span><span class="p">:</span><span class="mi">2</span><span class="p">]</span> <span class="o">==</span> <span class="s2">":"</span><span class="p">:</span> |
| |
| <span class="n">normalized_path</span> <span class="o">=</span> <span class="n">normalized_path</span><span class="p">[</span><span class="mi">2</span><span class="p">:]</span> |
| |
| <span class="k">for</span> <span class="n">skip_path</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">skips</span><span class="p">:</span> |
| |
| <span class="k">if</span> <span class="n">posixpath</span><span class="o">.</span><span class="n">abspath</span><span class="p">(</span><span class="n">normalized_path</span><span class="p">)</span> <span class="o">==</span> <span class="n">posixpath</span><span class="o">.</span><span class="n">abspath</span><span class="p">(</span> |
| |
| <span class="n">skip_path</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s2">"</span><span class="se">\\</span><span class="s2">"</span><span class="p">,</span> <span class="s2">"/"</span><span class="p">)</span> |
| |
| <span class="p">):</span> |
| |
| <span class="k">return</span> <span class="n">True</span> |
| |
| <span class="n">position</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">file_name</span><span class="p">)</span> |
| |
| <span class="k">while</span> <span class="n">position</span><span class="p">[</span><span class="mi">1</span><span class="p">]:</span> |
| |
| <span class="k">if</span> <span class="n">position</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">skips</span><span class="p">:</span> |
| |
| <span class="k">return</span> <span class="n">True</span> |
| |
| <span class="n">position</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="n">position</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span> |
| |
| <span class="k">for</span> <span class="n">sglob</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">skip_globs</span><span class="p">:</span> |
| |
| <span class="k">if</span> <span class="n">fnmatch</span><span class="o">.</span><span class="n">fnmatch</span><span class="p">(</span><span class="n">file_name</span><span class="p">,</span> <span class="n">sglob</span><span class="p">)</span> <span class="ow">or</span> <span class="n">fnmatch</span><span class="o">.</span><span class="n">fnmatch</span><span class="p">(</span><span class="s2">"/"</span> <span class="o">+</span> <span class="n">file_name</span><span class="p">,</span> <span class="n">sglob</span><span class="p">):</span> |
| |
| <span class="k">return</span> <span class="n">True</span> |
| |
| <span class="k">if</span> <span class="ow">not</span> <span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isfile</span><span class="p">(</span><span class="n">os_path</span><span class="p">)</span> <span class="ow">or</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isdir</span><span class="p">(</span><span class="n">os_path</span><span class="p">)</span> <span class="ow">or</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">islink</span><span class="p">(</span><span class="n">os_path</span><span class="p">)):</span> |
| |
| <span class="k">return</span> <span class="n">True</span> |
| |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">skip_gitignore</span><span class="p">:</span> |
| |
| <span class="k">if</span> <span class="n">file_path</span><span class="o">.</span><span class="n">name</span> <span class="o">==</span> <span class="s2">".git"</span><span class="p">:</span> <span class="c1"># pragma: no cover</span> |
| |
| <span class="k">return</span> <span class="n">True</span> |
| |
| <span class="n">git_folder</span> <span class="o">=</span> <span class="n">None</span> |
| |
| <span class="n">file_paths</span> <span class="o">=</span> <span class="p">[</span><span class="n">file_path</span><span class="p">,</span> <span class="n">file_path</span><span class="o">.</span><span class="n">resolve</span><span class="p">()]</span> |
| |
| <span class="k">for</span> <span class="n">folder</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">git_ignore</span><span class="p">:</span> |
| |
| <span class="k">if</span> <span class="n">any</span><span class="p">(</span><span class="n">folder</span> <span class="ow">in</span> <span class="n">path</span><span class="o">.</span><span class="n">parents</span> <span class="k">for</span> <span class="n">path</span> <span class="ow">in</span> <span class="n">file_paths</span><span class="p">):</span> |
| |
| <span class="n">git_folder</span> <span class="o">=</span> <span class="n">folder</span> |
| |
| <span class="k">break</span> |
| |
| <span class="k">else</span><span class="p">:</span> |
| |
| <span class="n">git_folder</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_check_folder_gitignore</span><span class="p">(</span><span class="nb">str</span><span class="p">(</span><span class="n">file_path</span><span class="o">.</span><span class="n">parent</span><span class="p">))</span> |
| |
| <span class="k">if</span> <span class="n">git_folder</span> <span class="ow">and</span> <span class="n">any</span><span class="p">(</span><span class="n">path</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">git_ignore</span><span class="p">[</span><span class="n">git_folder</span><span class="p">]</span> <span class="k">for</span> <span class="n">path</span> <span class="ow">in</span> <span class="n">file_paths</span><span class="p">):</span> |
| |
| <span class="k">return</span> <span class="n">True</span> |
| |
| <span class="k">return</span> <span class="n">False</span> |
| |
| <span class="err">@</span><span class="n">property</span> |
| |
| <span class="n">def</span> <span class="n">known_patterns</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">List</span><span class="p">[</span><span class="n">Tuple</span><span class="p">[</span><span class="n">Pattern</span><span class="p">[</span><span class="nb">str</span><span class="p">],</span> <span class="nb">str</span><span class="p">]]:</span> |
| |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_known_patterns</span> <span class="k">is</span> <span class="ow">not</span> <span class="n">None</span><span class="p">:</span> |
| |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_known_patterns</span> |
| |
| <span class="bp">self</span><span class="o">.</span><span class="n">_known_patterns</span> <span class="o">=</span> <span class="p">[]</span> |
| |
| <span class="n">pattern_sections</span> <span class="o">=</span> <span class="p">[</span><span class="n">STDLIB</span><span class="p">]</span> <span class="o">+</span> <span class="p">[</span><span class="n">section</span> <span class="k">for</span> <span class="n">section</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">sections</span> <span class="k">if</span> <span class="n">section</span> <span class="o">!=</span> <span class="n">STDLIB</span><span class="p">]</span> |
| |
| <span class="k">for</span> <span class="n">placement</span> <span class="ow">in</span> <span class="n">reversed</span><span class="p">(</span><span class="n">pattern_sections</span><span class="p">):</span> |
| |
| <span class="n">known_placement</span> <span class="o">=</span> <span class="n">KNOWN_SECTION_MAPPING</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">placement</span><span class="p">,</span> <span class="n">placement</span><span class="p">)</span><span class="o">.</span><span class="n">lower</span><span class="p">()</span> |
| |
| <span class="n">config_key</span> <span class="o">=</span> <span class="n">f</span><span class="s2">"{KNOWN_PREFIX}{known_placement}"</span> |
| |
| <span class="n">known_modules</span> <span class="o">=</span> <span class="n">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">config_key</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">known_other</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">known_placement</span><span class="p">,</span> <span class="p">()))</span> |
| |
| <span class="n">extra_modules</span> <span class="o">=</span> <span class="n">getattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">f</span><span class="s2">"extra_{known_placement}"</span><span class="p">,</span> <span class="p">())</span> |
| |
| <span class="n">all_modules</span> <span class="o">=</span> <span class="n">set</span><span class="p">(</span><span class="n">extra_modules</span><span class="p">)</span><span class="o">.</span><span class="n">union</span><span class="p">(</span><span class="n">known_modules</span><span class="p">)</span> |
| |
| <span class="n">known_patterns</span> <span class="o">=</span> <span class="p">[</span> |
| |
| <span class="n">pattern</span> |
| |
| <span class="k">for</span> <span class="n">known_pattern</span> <span class="ow">in</span> <span class="n">all_modules</span> |
| |
| <span class="k">for</span> <span class="n">pattern</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_parse_known_pattern</span><span class="p">(</span><span class="n">known_pattern</span><span class="p">)</span> |
| |
| <span class="p">]</span> |
| |
| <span class="k">for</span> <span class="n">known_pattern</span> <span class="ow">in</span> <span class="n">known_patterns</span><span class="p">:</span> |
| |
| <span class="n">regexp</span> <span class="o">=</span> <span class="s2">"^"</span> <span class="o">+</span> <span class="n">known_pattern</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s2">"*"</span><span class="p">,</span> <span class="s2">".*"</span><span class="p">)</span><span class="o">.</span><span class="n">replace</span><span class="p">(</span><span class="s2">"?"</span><span class="p">,</span> <span class="s2">".?"</span><span class="p">)</span> <span class="o">+</span> <span class="s2">"$"</span> |
| |
| <span class="bp">self</span><span class="o">.</span><span class="n">_known_patterns</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="n">regexp</span><span class="p">),</span> <span class="n">placement</span><span class="p">))</span> |
| |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_known_patterns</span> |
| |
| <span class="err">@</span><span class="n">property</span> |
| |
| <span class="n">def</span> <span class="n">section_comments</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">Tuple</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="o">...</span><span class="p">]:</span> |
| |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_section_comments</span> <span class="k">is</span> <span class="ow">not</span> <span class="n">None</span><span class="p">:</span> |
| |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_section_comments</span> |
| |
| <span class="bp">self</span><span class="o">.</span><span class="n">_section_comments</span> <span class="o">=</span> <span class="n">tuple</span><span class="p">(</span><span class="n">f</span><span class="s2">"# {heading}"</span> <span class="k">for</span> <span class="n">heading</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">import_headings</span><span class="o">.</span><span class="n">values</span><span class="p">())</span> |
| |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_section_comments</span> |
| |
| <span class="err">@</span><span class="n">property</span> |
| |
| <span class="n">def</span> <span class="n">section_comments_end</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">Tuple</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="o">...</span><span class="p">]:</span> |
| |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_section_comments_end</span> <span class="k">is</span> <span class="ow">not</span> <span class="n">None</span><span class="p">:</span> |
| |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_section_comments_end</span> |
| |
| <span class="bp">self</span><span class="o">.</span><span class="n">_section_comments_end</span> <span class="o">=</span> <span class="n">tuple</span><span class="p">(</span><span class="n">f</span><span class="s2">"# {footer}"</span> <span class="k">for</span> <span class="n">footer</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">import_footers</span><span class="o">.</span><span class="n">values</span><span class="p">())</span> |
| |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_section_comments_end</span> |
| |
| <span class="err">@</span><span class="n">property</span> |
| |
| <span class="n">def</span> <span class="n">skips</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">FrozenSet</span><span class="p">[</span><span class="nb">str</span><span class="p">]:</span> |
| |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_skips</span> <span class="k">is</span> <span class="ow">not</span> <span class="n">None</span><span class="p">:</span> |
| |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_skips</span> |
| |
| <span class="bp">self</span><span class="o">.</span><span class="n">_skips</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">skip</span><span class="o">.</span><span class="n">union</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">extend_skip</span><span class="p">)</span> |
| |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_skips</span> |
| |
| <span class="err">@</span><span class="n">property</span> |
| |
| <span class="n">def</span> <span class="n">skip_globs</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="n">FrozenSet</span><span class="p">[</span><span class="nb">str</span><span class="p">]:</span> |
| |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_skip_globs</span> <span class="k">is</span> <span class="ow">not</span> <span class="n">None</span><span class="p">:</span> |
| |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_skip_globs</span> |
| |
| <span class="bp">self</span><span class="o">.</span><span class="n">_skip_globs</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">skip_glob</span><span class="o">.</span><span class="n">union</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">extend_skip_glob</span><span class="p">)</span> |
| |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_skip_globs</span> |
| |
| <span class="err">@</span><span class="n">property</span> |
| |
| <span class="n">def</span> <span class="n">sorting_function</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></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="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">_sorting_function</span> <span class="k">is</span> <span class="ow">not</span> <span class="n">None</span><span class="p">:</span> |
| |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_sorting_function</span> |
| |
| <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">sort_order</span> <span class="o">==</span> <span class="s2">"natural"</span><span class="p">:</span> |
| |
| <span class="bp">self</span><span class="o">.</span><span class="n">_sorting_function</span> <span class="o">=</span> <span class="n">sorting</span><span class="o">.</span><span class="n">naturally</span> |
| |
| <span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">sort_order</span> <span class="o">==</span> <span class="s2">"native"</span><span class="p">:</span> |
| |
| <span class="bp">self</span><span class="o">.</span><span class="n">_sorting_function</span> <span class="o">=</span> <span class="n">sorted</span> |
| |
| <span class="k">else</span><span class="p">:</span> |
| |
| <span class="n">available_sort_orders</span> <span class="o">=</span> <span class="p">[</span><span class="s2">"natural"</span><span class="p">,</span> <span class="s2">"native"</span><span class="p">]</span> |
| |
| <span class="n">import</span> <span class="n">pkg_resources</span> |
| |
| <span class="k">for</span> <span class="n">sort_plugin</span> <span class="ow">in</span> <span class="n">pkg_resources</span><span class="o">.</span><span class="n">iter_entry_points</span><span class="p">(</span><span class="s2">"isort.sort_function"</span><span class="p">):</span> |
| |
| <span class="n">available_sort_orders</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">sort_plugin</span><span class="o">.</span><span class="n">name</span><span class="p">)</span> |
| |
| <span class="k">if</span> <span class="n">sort_plugin</span><span class="o">.</span><span class="n">name</span> <span class="o">==</span> <span class="bp">self</span><span class="o">.</span><span class="n">sort_order</span><span class="p">:</span> |
| |
| <span class="bp">self</span><span class="o">.</span><span class="n">_sorting_function</span> <span class="o">=</span> <span class="n">sort_plugin</span><span class="o">.</span><span class="n">load</span><span class="p">()</span> |
| |
| <span class="k">break</span> |
| |
| <span class="k">else</span><span class="p">:</span> |
| |
| <span class="n">raise</span> <span class="n">SortingFunctionDoesNotExist</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">sort_order</span><span class="p">,</span> <span class="n">available_sort_orders</span><span class="p">)</span> |
| |
| <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_sorting_function</span> |
| |
| <span class="n">def</span> <span class="n">_parse_known_pattern</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">pattern</span><span class="p">:</span> <span class="nb">str</span><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="sd">"""Expand pattern if identified as a directory and return found sub packages"""</span> |
| |
| <span class="k">if</span> <span class="n">pattern</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">sep</span><span class="p">):</span> |
| |
| <span class="n">patterns</span> <span class="o">=</span> <span class="p">[</span> |
| |
| <span class="n">filename</span> |
| |
| <span class="k">for</span> <span class="n">filename</span> <span class="ow">in</span> <span class="n">os</span><span class="o">.</span><span class="n">listdir</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">directory</span><span class="p">,</span> <span class="n">pattern</span><span class="p">))</span> |
| |
| <span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isdir</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">directory</span><span class="p">,</span> <span class="n">pattern</span><span class="p">,</span> <span class="n">filename</span><span class="p">))</span> |
| |
| <span class="p">]</span> |
| |
| <span class="k">else</span><span class="p">:</span> |
| |
| <span class="n">patterns</span> <span class="o">=</span> <span class="p">[</span><span class="n">pattern</span><span class="p">]</span> |
| |
| <span class="k">return</span> <span class="n">patterns</span> |
| </code></pre></div> |
| |
| </details> |
| <hr /> |
| <h4 id="ancestors-in-mro">Ancestors (in MRO)</h4> |
| <ul> |
| <li>isort.settings._Config</li> |
| </ul> |
| <h4 id="class-variables">Class variables</h4> |
| <div class="codehilite"><pre><span></span><code><span class="n">add_imports</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">append_only</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">atomic</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">auto_identify_namespace_packages</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">balanced_wrapping</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">blocked_extensions</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">case_sensitive</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">classes</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">color_output</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">combine_as_imports</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">combine_star</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">combine_straight_imports</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">comment_prefix</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">conda_env</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">constants</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">dedup_headings</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">default_section</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">directory</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">ensure_newline_before_comments</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">extend_skip</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">extend_skip_glob</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">extra_standard_library</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">filter_files</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">float_to_top</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">follow_links</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">force_adds</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">force_alphabetical_sort</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">force_alphabetical_sort_within_sections</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">force_grid_wrap</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">force_single_line</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">force_sort_within_sections</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">force_to_top</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">forced_separate</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">format_error</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">format_success</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">formatter</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">formatting_function</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">from_first</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">group_by_package</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">honor_case_in_force_sorted_sections</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">honor_noqa</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">ignore_comments</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">ignore_whitespace</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">import_dependencies</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">include_trailing_comma</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">indent</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">indented_import_headings</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">known_first_party</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">known_future_library</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">known_local_folder</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">known_standard_library</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">known_third_party</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">length_sort</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">length_sort_sections</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">length_sort_straight</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">lexicographical</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">line_ending</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">line_length</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">lines_after_imports</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">lines_before_imports</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">lines_between_sections</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">lines_between_types</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">multi_line_output</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">namespace_packages</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">no_inline_sort</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">no_lines_before</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">no_sections</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">old_finders</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">only_modified</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">only_sections</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">order_by_type</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">overwrite_in_place</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">profile</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">py_version</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">quiet</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">remove_imports</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">remove_redundant_aliases</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">reverse_relative</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">reverse_sort</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">sections</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">single_line_exclusions</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">skip</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">skip_gitignore</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">skip_glob</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">sort_order</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">sort_relative_in_force_sorted_sections</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">sources</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">src_paths</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">star_first</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">supported_extensions</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">treat_all_comments_as_code</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">treat_comments_as_code</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">use_parentheses</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">variables</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">verbose</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">virtual_env</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">wrap_length</span> |
| </code></pre></div> |
| |
| <h4 id="instance-variables">Instance variables</h4> |
| <div class="codehilite"><pre><span></span><code><span class="n">known_patterns</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">section_comments</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">section_comments_end</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">skip_globs</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">skips</span> |
| </code></pre></div> |
| |
| <div class="codehilite"><pre><span></span><code><span class="n">sorting_function</span> |
| </code></pre></div> |
| |
| <h4 id="methods">Methods</h4> |
| <h4 id="is_skipped">is_skipped</h4> |
| <div class="codehilite"><pre><span></span><code><span class="k">def</span> <span class="nf">is_skipped</span><span class="p">(</span> |
| <span class="bp">self</span><span class="p">,</span> |
| <span class="n">file_path</span><span class="p">:</span> <span class="n">pathlib</span><span class="o">.</span><span class="n">Path</span> |
| <span class="p">)</span> <span class="o">-></span> <span class="nb">bool</span> |
| </code></pre></div> |
| |
| <p>Returns True if the file and/or folder should be skipped based on current settings.</p> |
| <details class="example"><summary>View Source</summary><div class="codehilite"><pre><span></span><code><span class="w"> </span><span class="n">def</span><span class="w"> </span><span class="n">is_skipped</span><span class="p">(</span><span class="n">self</span><span class="p">,</span><span class="w"> </span><span class="nl">file_path</span><span class="p">:</span><span class="w"> </span><span class="k">Path</span><span class="p">)</span><span class="w"> </span><span class="o">-></span><span class="w"> </span><span class="nl">bool</span><span class="p">:</span><span class="w"></span> |
| |
| <span class="w"> </span><span class="ss">"""Returns True if the file and/or folder should be skipped based on current settings."""</span><span class="w"></span> |
| |
| <span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="n">self</span><span class="p">.</span><span class="n">directory</span><span class="w"> </span><span class="ow">and</span><span class="w"> </span><span class="k">Path</span><span class="p">(</span><span class="n">self</span><span class="p">.</span><span class="n">directory</span><span class="p">)</span><span class="w"> </span><span class="ow">in</span><span class="w"> </span><span class="n">file_path</span><span class="p">.</span><span class="n">resolve</span><span class="p">().</span><span class="nl">parents</span><span class="p">:</span><span class="w"></span> |
| |
| <span class="w"> </span><span class="nf">file_name</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">os</span><span class="p">.</span><span class="k">path</span><span class="p">.</span><span class="n">relpath</span><span class="p">(</span><span class="n">file_path</span><span class="p">.</span><span class="n">resolve</span><span class="p">(),</span><span class="w"> </span><span class="n">self</span><span class="p">.</span><span class="n">directory</span><span class="p">)</span><span class="w"></span> |
| |
| <span class="w"> </span><span class="k">else</span><span class="err">:</span><span class="w"></span> |
| |
| <span class="w"> </span><span class="nf">file_name</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">str</span><span class="p">(</span><span class="n">file_path</span><span class="p">)</span><span class="w"></span> |
| |
| <span class="w"> </span><span class="n">os_path</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nf">str</span><span class="p">(</span><span class="n">file_path</span><span class="p">)</span><span class="w"></span> |
| |
| <span class="w"> </span><span class="n">normalized_path</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">os_path</span><span class="p">.</span><span class="nf">replace</span><span class="p">(</span><span class="ss">"\\"</span><span class="p">,</span><span class="w"> </span><span class="ss">"/"</span><span class="p">)</span><span class="w"></span> |
| |
| <span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="n">normalized_path</span><span class="o">[</span><span class="n">1:2</span><span class="o">]</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="ss">":"</span><span class="err">:</span><span class="w"></span> |
| |
| <span class="w"> </span><span class="n">normalized_path</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">normalized_path</span><span class="o">[</span><span class="n">2:</span><span class="o">]</span><span class="w"></span> |
| |
| <span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="n">skip_path</span><span class="w"> </span><span class="ow">in</span><span class="w"> </span><span class="n">self</span><span class="p">.</span><span class="nl">skips</span><span class="p">:</span><span class="w"></span> |
| |
| <span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="n">posixpath</span><span class="p">.</span><span class="n">abspath</span><span class="p">(</span><span class="n">normalized_path</span><span class="p">)</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="n">posixpath</span><span class="p">.</span><span class="n">abspath</span><span class="p">(</span><span class="w"></span> |
| |
| <span class="w"> </span><span class="n">skip_path</span><span class="p">.</span><span class="nf">replace</span><span class="p">(</span><span class="ss">"\\"</span><span class="p">,</span><span class="w"> </span><span class="ss">"/"</span><span class="p">)</span><span class="w"></span> |
| |
| <span class="w"> </span><span class="p">)</span><span class="err">:</span><span class="w"></span> |
| |
| <span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="k">True</span><span class="w"></span> |
| |
| <span class="w"> </span><span class="k">position</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">os</span><span class="p">.</span><span class="k">path</span><span class="p">.</span><span class="n">split</span><span class="p">(</span><span class="nf">file_name</span><span class="p">)</span><span class="w"></span> |
| |
| <span class="w"> </span><span class="k">while</span><span class="w"> </span><span class="k">position</span><span class="o">[</span><span class="n">1</span><span class="o">]</span><span class="err">:</span><span class="w"></span> |
| |
| <span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="k">position</span><span class="o">[</span><span class="n">1</span><span class="o">]</span><span class="w"> </span><span class="ow">in</span><span class="w"> </span><span class="n">self</span><span class="p">.</span><span class="nl">skips</span><span class="p">:</span><span class="w"></span> |
| |
| <span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="k">True</span><span class="w"></span> |
| |
| <span class="w"> </span><span class="k">position</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">os</span><span class="p">.</span><span class="k">path</span><span class="p">.</span><span class="n">split</span><span class="p">(</span><span class="k">position</span><span class="o">[</span><span class="n">0</span><span class="o">]</span><span class="p">)</span><span class="w"></span> |
| |
| <span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="n">sglob</span><span class="w"> </span><span class="ow">in</span><span class="w"> </span><span class="n">self</span><span class="p">.</span><span class="nl">skip_globs</span><span class="p">:</span><span class="w"></span> |
| |
| <span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="n">fnmatch</span><span class="p">.</span><span class="n">fnmatch</span><span class="p">(</span><span class="nf">file_name</span><span class="p">,</span><span class="w"> </span><span class="n">sglob</span><span class="p">)</span><span class="w"> </span><span class="ow">or</span><span class="w"> </span><span class="n">fnmatch</span><span class="p">.</span><span class="n">fnmatch</span><span class="p">(</span><span class="ss">"/"</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="nf">file_name</span><span class="p">,</span><span class="w"> </span><span class="n">sglob</span><span class="p">)</span><span class="err">:</span><span class="w"></span> |
| |
| <span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="k">True</span><span class="w"></span> |
| |
| <span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="ow">not</span><span class="w"> </span><span class="p">(</span><span class="n">os</span><span class="p">.</span><span class="k">path</span><span class="p">.</span><span class="n">isfile</span><span class="p">(</span><span class="n">os_path</span><span class="p">)</span><span class="w"> </span><span class="ow">or</span><span class="w"> </span><span class="n">os</span><span class="p">.</span><span class="k">path</span><span class="p">.</span><span class="n">isdir</span><span class="p">(</span><span class="n">os_path</span><span class="p">)</span><span class="w"> </span><span class="ow">or</span><span class="w"> </span><span class="n">os</span><span class="p">.</span><span class="k">path</span><span class="p">.</span><span class="n">islink</span><span class="p">(</span><span class="n">os_path</span><span class="p">))</span><span class="err">:</span><span class="w"></span> |
| |
| <span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="k">True</span><span class="w"></span> |
| |
| <span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="n">self</span><span class="p">.</span><span class="nl">skip_gitignore</span><span class="p">:</span><span class="w"></span> |
| |
| <span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="n">file_path</span><span class="p">.</span><span class="n">name</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="ss">".git"</span><span class="err">:</span><span class="w"> </span><span class="err">#</span><span class="w"> </span><span class="nl">pragma</span><span class="p">:</span><span class="w"> </span><span class="k">no</span><span class="w"> </span><span class="n">cover</span><span class="w"></span> |
| |
| <span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="k">True</span><span class="w"></span> |
| |
| <span class="w"> </span><span class="n">git_folder</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">None</span><span class="w"></span> |
| |
| <span class="w"> </span><span class="n">file_paths</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="o">[</span><span class="n">file_path, file_path.resolve()</span><span class="o">]</span><span class="w"></span> |
| |
| <span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="n">folder</span><span class="w"> </span><span class="ow">in</span><span class="w"> </span><span class="n">self</span><span class="p">.</span><span class="nl">git_ignore</span><span class="p">:</span><span class="w"></span> |
| |
| <span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="ow">any</span><span class="p">(</span><span class="n">folder</span><span class="w"> </span><span class="ow">in</span><span class="w"> </span><span class="k">path</span><span class="p">.</span><span class="n">parents</span><span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="k">path</span><span class="w"> </span><span class="ow">in</span><span class="w"> </span><span class="n">file_paths</span><span class="p">)</span><span class="err">:</span><span class="w"></span> |
| |
| <span class="w"> </span><span class="n">git_folder</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">folder</span><span class="w"></span> |
| |
| <span class="w"> </span><span class="k">break</span><span class="w"></span> |
| |
| <span class="w"> </span><span class="k">else</span><span class="err">:</span><span class="w"></span> |
| |
| <span class="w"> </span><span class="n">git_folder</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">self</span><span class="p">.</span><span class="n">_check_folder_gitignore</span><span class="p">(</span><span class="nf">str</span><span class="p">(</span><span class="n">file_path</span><span class="p">.</span><span class="n">parent</span><span class="p">))</span><span class="w"></span> |
| |
| <span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="n">git_folder</span><span class="w"> </span><span class="ow">and</span><span class="w"> </span><span class="ow">any</span><span class="p">(</span><span class="k">path</span><span class="w"> </span><span class="ow">in</span><span class="w"> </span><span class="n">self</span><span class="p">.</span><span class="n">git_ignore</span><span class="o">[</span><span class="n">git_folder</span><span class="o">]</span><span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="k">path</span><span class="w"> </span><span class="ow">in</span><span class="w"> </span><span class="n">file_paths</span><span class="p">)</span><span class="err">:</span><span class="w"></span> |
| |
| <span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="k">True</span><span class="w"></span> |
| |
| <span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="k">False</span><span class="w"></span> |
| </code></pre></div> |
| |
| </details> |
| <h4 id="is_supported_filetype">is_supported_filetype</h4> |
| <div class="codehilite"><pre><span></span><code><span class="k">def</span> <span class="nf">is_supported_filetype</span><span class="p">(</span> |
| <span class="bp">self</span><span class="p">,</span> |
| <span class="n">file_name</span><span class="p">:</span> <span class="nb">str</span> |
| <span class="p">)</span> <span class="o">-></span> <span class="nb">bool</span> |
| </code></pre></div> |
| |
| <details class="example"><summary>View Source</summary><div class="codehilite"><pre><span></span><code> <span class="n">def</span> <span class="n">is_supported_filetype</span><span class="p">(</span><span class="kr">self</span><span class="p">,</span> <span class="n">file_name</span><span class="o">:</span> <span class="n">str</span><span class="p">)</span> <span class="o">-></span> <span class="n">bool</span><span class="o">:</span> |
| |
| <span class="n">_root</span><span class="p">,</span> <span class="n">ext</span> <span class="o">=</span> <span class="n">os</span><span class="p">.</span><span class="n">path</span><span class="p">.</span><span class="n">splitext</span><span class="p">(</span><span class="n">file_name</span><span class="p">)</span> |
| |
| <span class="n">ext</span> <span class="o">=</span> <span class="n">ext</span><span class="p">.</span><span class="n">lstrip</span><span class="p">(</span><span class="s">"."</span><span class="p">)</span> |
| |
| <span class="nf">if</span> <span class="n">ext</span> <span class="kr">in</span> <span class="kr">self</span><span class="p">.</span><span class="n">supported_extensions</span><span class="o">:</span> |
| |
| <span class="kr">return</span> <span class="kr">True</span> |
| |
| <span class="nf">if</span> <span class="n">ext</span> <span class="kr">in</span> <span class="kr">self</span><span class="p">.</span><span class="n">blocked_extensions</span><span class="o">:</span> |
| |
| <span class="kr">return</span> <span class="kr">False</span> |
| |
| <span class="err">#</span> <span class="kr">Skip</span> <span class="n">editor</span> <span class="n">backup</span> <span class="n">files</span><span class="p">.</span> |
| |
| <span class="nf">if</span> <span class="n">file_name</span><span class="p">.</span><span class="kd">ends</span><span class="n">with</span><span class="p">(</span><span class="s">"~"</span><span class="p">)</span><span class="o">:</span> |
| |
| <span class="kr">return</span> <span class="kr">False</span> |
| |
| <span class="n">try</span><span class="o">:</span> |
| |
| <span class="nf">if</span> <span class="n">stat</span><span class="p">.</span><span class="n">S_ISFIFO</span><span class="p">(</span><span class="n">os</span><span class="p">.</span><span class="n">stat</span><span class="p">(</span><span class="n">file_name</span><span class="p">).</span><span class="n">st_mode</span><span class="p">)</span><span class="o">:</span> |
| |
| <span class="kr">return</span> <span class="kr">False</span> |
| |
| <span class="kr">except</span> <span class="n">OSError</span><span class="o">:</span> |
| |
| <span class="n">pass</span> |
| |
| <span class="n">try</span><span class="o">:</span> |
| |
| <span class="n">with</span> <span class="n">open</span><span class="p">(</span><span class="n">file_name</span><span class="p">,</span> <span class="s">"rb"</span><span class="p">)</span> <span class="kr">as</span> <span class="n">fp</span><span class="o">:</span> |
| |
| <span class="n">line</span> <span class="o">=</span> <span class="n">fp</span><span class="p">.</span><span class="n">readline</span><span class="p">(</span><span class="mi">100</span><span class="p">)</span> |
| |
| <span class="kr">except</span> <span class="n">OSError</span><span class="o">:</span> |
| |
| <span class="kr">return</span> <span class="kr">False</span> |
| |
| <span class="n">else</span><span class="o">:</span> |
| |
| <span class="kr">return</span> <span class="n">bool</span><span class="p">(</span><span class="n">_SHEBANG_RE</span><span class="p">.</span><span class="n">match</span><span class="p">(</span><span class="n">line</span><span class="p">))</span> |
| </code></pre></div> |
| |
| </details> |
| |
| |
| |
| |
| |
| |
| |
| </article> |
| </div> |
| </div> |
| |
| </main> |
| |
| |
| <footer class="md-footer"> |
| |
| <div class="md-footer-nav"> |
| <nav class="md-footer-nav__inner md-grid"> |
| |
| <a href="sections.html" title="Sections" class="md-flex md-footer-nav__link md-footer-nav__link--prev" rel="prev"> |
| <div class="md-flex__cell md-flex__cell--shrink"> |
| <i class="md-icon md-icon--arrow-back md-footer-nav__button"></i> |
| </div> |
| <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title"> |
| <span class="md-flex__ellipsis"> |
| <span class="md-footer-nav__direction"> |
| Previous |
| </span> |
| Sections |
| </span> |
| </div> |
| </a> |
| |
| |
| <a href="setuptools_commands.html" title="Setuptools Commands" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next"> |
| <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title"> |
| <span class="md-flex__ellipsis"> |
| <span class="md-footer-nav__direction"> |
| Next |
| </span> |
| Setuptools Commands |
| </span> |
| </div> |
| <div class="md-flex__cell md-flex__cell--shrink"> |
| <i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i> |
| </div> |
| </a> |
| |
| </nav> |
| </div> |
| |
| <div class="md-footer-meta md-typeset"> |
| <div class="md-footer-meta__inner md-grid"> |
| <div class="md-footer-copyright"> |
| |
| Powered by |
| <a href="http://timothycrosley.github.io/portray">portray.</a> |
| You too can |
| <a href="http://timothycrosley.github.io/portray"> |
| portray</a> |
| your Python project well using automatic documentation. |
| </div> |
| |
| </div> |
| </div> |
| </footer> |
| |
| </div> |
| <div class="md-dialog" data-md-component="dialog"> |
| <div class="md-dialog__inner md-typeset"></div> |
| </div> |
| <script id="__config" type="application/json">{"base": "../..", "features": [], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing", "select.version.title": "Select version"}, "search": "../../assets/javascripts/workers/search.709b4209.min.js", "version": null}</script> |
| |
| |
| <script src="../../assets/javascripts/bundle.29db7785.min.js"></script> |
| |
| |
| </body> |
| </html> |
