diff options
Diffstat (limited to 'reference/isort/exceptions.html')
| -rw-r--r-- | reference/isort/exceptions.html | 3681 |
1 files changed, 3681 insertions, 0 deletions
diff --git a/reference/isort/exceptions.html b/reference/isort/exceptions.html new file mode 100644 index 00000000..e0851e6a --- /dev/null +++ b/reference/isort/exceptions.html @@ -0,0 +1,3681 @@ + +<!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.1.8"> + + + + <title>Exceptions - isort</title> + + + + <link rel="stylesheet" href="../../assets/stylesheets/main.ca7ac06f.min.css"> + + + <link rel="stylesheet" href="../../assets/stylesheets/palette.f1a3b89f.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-isortexceptions" 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"> + + Exceptions + + </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" data-md-state="active" 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> + <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> + </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 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"> + Exceptions + <span class="md-nav__icon md-icon"></span> + </label> + + <a href="exceptions.html" class="md-nav__link md-nav__link--active"> + Exceptions + </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="#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="#assignmentsformatmismatch" class="md-nav__link"> + AssignmentsFormatMismatch + </a> + + <nav class="md-nav" aria-label="AssignmentsFormatMismatch"> + <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="#methods" class="md-nav__link"> + Methods + </a> + +</li> + + <li class="md-nav__item"> + <a href="#with_traceback" class="md-nav__link"> + with_traceback + </a> + +</li> + + </ul> + </nav> + +</li> + + <li class="md-nav__item"> + <a href="#existingsyntaxerrors" class="md-nav__link"> + ExistingSyntaxErrors + </a> + + <nav class="md-nav" aria-label="ExistingSyntaxErrors"> + <ul class="md-nav__list"> + + <li class="md-nav__item"> + <a href="#ancestors-in-mro_1" class="md-nav__link"> + Ancestors (in MRO) + </a> + +</li> + + <li class="md-nav__item"> + <a href="#class-variables_1" class="md-nav__link"> + Class variables + </a> + +</li> + + <li class="md-nav__item"> + <a href="#methods_1" class="md-nav__link"> + Methods + </a> + +</li> + + <li class="md-nav__item"> + <a href="#with_traceback_1" class="md-nav__link"> + with_traceback + </a> + +</li> + + </ul> + </nav> + +</li> + + <li class="md-nav__item"> + <a href="#fileskipcomment" class="md-nav__link"> + FileSkipComment + </a> + + <nav class="md-nav" aria-label="FileSkipComment"> + <ul class="md-nav__list"> + + <li class="md-nav__item"> + <a href="#ancestors-in-mro_2" class="md-nav__link"> + Ancestors (in MRO) + </a> + +</li> + + <li class="md-nav__item"> + <a href="#class-variables_2" class="md-nav__link"> + Class variables + </a> + +</li> + + <li class="md-nav__item"> + <a href="#methods_2" class="md-nav__link"> + Methods + </a> + +</li> + + <li class="md-nav__item"> + <a href="#with_traceback_2" class="md-nav__link"> + with_traceback + </a> + +</li> + + </ul> + </nav> + +</li> + + <li class="md-nav__item"> + <a href="#fileskipsetting" class="md-nav__link"> + FileSkipSetting + </a> + + <nav class="md-nav" aria-label="FileSkipSetting"> + <ul class="md-nav__list"> + + <li class="md-nav__item"> + <a href="#ancestors-in-mro_3" class="md-nav__link"> + Ancestors (in MRO) + </a> + +</li> + + <li class="md-nav__item"> + <a href="#class-variables_3" class="md-nav__link"> + Class variables + </a> + +</li> + + <li class="md-nav__item"> + <a href="#methods_3" class="md-nav__link"> + Methods + </a> + +</li> + + <li class="md-nav__item"> + <a href="#with_traceback_3" class="md-nav__link"> + with_traceback + </a> + +</li> + + </ul> + </nav> + +</li> + + <li class="md-nav__item"> + <a href="#fileskipped" class="md-nav__link"> + FileSkipped + </a> + + <nav class="md-nav" aria-label="FileSkipped"> + <ul class="md-nav__list"> + + <li class="md-nav__item"> + <a href="#ancestors-in-mro_4" class="md-nav__link"> + Ancestors (in MRO) + </a> + +</li> + + <li class="md-nav__item"> + <a href="#descendants" class="md-nav__link"> + Descendants + </a> + +</li> + + <li class="md-nav__item"> + <a href="#class-variables_4" class="md-nav__link"> + Class variables + </a> + +</li> + + <li class="md-nav__item"> + <a href="#methods_4" class="md-nav__link"> + Methods + </a> + +</li> + + <li class="md-nav__item"> + <a href="#with_traceback_4" class="md-nav__link"> + with_traceback + </a> + +</li> + + </ul> + </nav> + +</li> + + <li class="md-nav__item"> + <a href="#formattingplugindoesnotexist" class="md-nav__link"> + FormattingPluginDoesNotExist + </a> + + <nav class="md-nav" aria-label="FormattingPluginDoesNotExist"> + <ul class="md-nav__list"> + + <li class="md-nav__item"> + <a href="#ancestors-in-mro_5" class="md-nav__link"> + Ancestors (in MRO) + </a> + +</li> + + <li class="md-nav__item"> + <a href="#class-variables_5" class="md-nav__link"> + Class variables + </a> + +</li> + + <li class="md-nav__item"> + <a href="#methods_5" class="md-nav__link"> + Methods + </a> + +</li> + + <li class="md-nav__item"> + <a href="#with_traceback_5" class="md-nav__link"> + with_traceback + </a> + +</li> + + </ul> + </nav> + +</li> + + <li class="md-nav__item"> + <a href="#isorterror" class="md-nav__link"> + ISortError + </a> + + <nav class="md-nav" aria-label="ISortError"> + <ul class="md-nav__list"> + + <li class="md-nav__item"> + <a href="#ancestors-in-mro_6" class="md-nav__link"> + Ancestors (in MRO) + </a> + +</li> + + <li class="md-nav__item"> + <a href="#descendants_1" class="md-nav__link"> + Descendants + </a> + +</li> + + <li class="md-nav__item"> + <a href="#class-variables_6" class="md-nav__link"> + Class variables + </a> + +</li> + + <li class="md-nav__item"> + <a href="#methods_6" class="md-nav__link"> + Methods + </a> + +</li> + + <li class="md-nav__item"> + <a href="#with_traceback_6" class="md-nav__link"> + with_traceback + </a> + +</li> + + </ul> + </nav> + +</li> + + <li class="md-nav__item"> + <a href="#introducedsyntaxerrors" class="md-nav__link"> + IntroducedSyntaxErrors + </a> + + <nav class="md-nav" aria-label="IntroducedSyntaxErrors"> + <ul class="md-nav__list"> + + <li class="md-nav__item"> + <a href="#ancestors-in-mro_7" class="md-nav__link"> + Ancestors (in MRO) + </a> + +</li> + + <li class="md-nav__item"> + <a href="#class-variables_7" class="md-nav__link"> + Class variables + </a> + +</li> + + <li class="md-nav__item"> + <a href="#methods_7" class="md-nav__link"> + Methods + </a> + +</li> + + <li class="md-nav__item"> + <a href="#with_traceback_7" class="md-nav__link"> + with_traceback + </a> + +</li> + + </ul> + </nav> + +</li> + + <li class="md-nav__item"> + <a href="#invalidsettingspath" class="md-nav__link"> + InvalidSettingsPath + </a> + + <nav class="md-nav" aria-label="InvalidSettingsPath"> + <ul class="md-nav__list"> + + <li class="md-nav__item"> + <a href="#ancestors-in-mro_8" class="md-nav__link"> + Ancestors (in MRO) + </a> + +</li> + + <li class="md-nav__item"> + <a href="#class-variables_8" class="md-nav__link"> + Class variables + </a> + +</li> + + <li class="md-nav__item"> + <a href="#methods_8" class="md-nav__link"> + Methods + </a> + +</li> + + <li class="md-nav__item"> + <a href="#with_traceback_8" class="md-nav__link"> + with_traceback + </a> + +</li> + + </ul> + </nav> + +</li> + + <li class="md-nav__item"> + <a href="#literalparsingfailure" class="md-nav__link"> + LiteralParsingFailure + </a> + + <nav class="md-nav" aria-label="LiteralParsingFailure"> + <ul class="md-nav__list"> + + <li class="md-nav__item"> + <a href="#ancestors-in-mro_9" class="md-nav__link"> + Ancestors (in MRO) + </a> + +</li> + + <li class="md-nav__item"> + <a href="#class-variables_9" class="md-nav__link"> + Class variables + </a> + +</li> + + <li class="md-nav__item"> + <a href="#methods_9" class="md-nav__link"> + Methods + </a> + +</li> + + <li class="md-nav__item"> + <a href="#with_traceback_9" class="md-nav__link"> + with_traceback + </a> + +</li> + + </ul> + </nav> + +</li> + + <li class="md-nav__item"> + <a href="#literalsorttypemismatch" class="md-nav__link"> + LiteralSortTypeMismatch + </a> + + <nav class="md-nav" aria-label="LiteralSortTypeMismatch"> + <ul class="md-nav__list"> + + <li class="md-nav__item"> + <a href="#ancestors-in-mro_10" class="md-nav__link"> + Ancestors (in MRO) + </a> + +</li> + + <li class="md-nav__item"> + <a href="#class-variables_10" class="md-nav__link"> + Class variables + </a> + +</li> + + <li class="md-nav__item"> + <a href="#methods_10" class="md-nav__link"> + Methods + </a> + +</li> + + <li class="md-nav__item"> + <a href="#with_traceback_10" class="md-nav__link"> + with_traceback + </a> + +</li> + + </ul> + </nav> + +</li> + + <li class="md-nav__item"> + <a href="#missingsection" class="md-nav__link"> + MissingSection + </a> + + <nav class="md-nav" aria-label="MissingSection"> + <ul class="md-nav__list"> + + <li class="md-nav__item"> + <a href="#ancestors-in-mro_11" class="md-nav__link"> + Ancestors (in MRO) + </a> + +</li> + + <li class="md-nav__item"> + <a href="#class-variables_11" class="md-nav__link"> + Class variables + </a> + +</li> + + <li class="md-nav__item"> + <a href="#methods_11" class="md-nav__link"> + Methods + </a> + +</li> + + <li class="md-nav__item"> + <a href="#with_traceback_11" class="md-nav__link"> + with_traceback + </a> + +</li> + + </ul> + </nav> + +</li> + + <li class="md-nav__item"> + <a href="#profiledoesnotexist" class="md-nav__link"> + ProfileDoesNotExist + </a> + + <nav class="md-nav" aria-label="ProfileDoesNotExist"> + <ul class="md-nav__list"> + + <li class="md-nav__item"> + <a href="#ancestors-in-mro_12" class="md-nav__link"> + Ancestors (in MRO) + </a> + +</li> + + <li class="md-nav__item"> + <a href="#class-variables_12" class="md-nav__link"> + Class variables + </a> + +</li> + + <li class="md-nav__item"> + <a href="#methods_12" class="md-nav__link"> + Methods + </a> + +</li> + + <li class="md-nav__item"> + <a href="#with_traceback_12" class="md-nav__link"> + with_traceback + </a> + +</li> + + </ul> + </nav> + +</li> + + <li class="md-nav__item"> + <a href="#unsupportedencoding" class="md-nav__link"> + UnsupportedEncoding + </a> + + <nav class="md-nav" aria-label="UnsupportedEncoding"> + <ul class="md-nav__list"> + + <li class="md-nav__item"> + <a href="#ancestors-in-mro_13" class="md-nav__link"> + Ancestors (in MRO) + </a> + +</li> + + <li class="md-nav__item"> + <a href="#class-variables_13" class="md-nav__link"> + Class variables + </a> + +</li> + + <li class="md-nav__item"> + <a href="#methods_13" class="md-nav__link"> + Methods + </a> + +</li> + + <li class="md-nav__item"> + <a href="#with_traceback_13" class="md-nav__link"> + with_traceback + </a> + +</li> + + </ul> + </nav> + +</li> + + <li class="md-nav__item"> + <a href="#unsupportedsettings" class="md-nav__link"> + UnsupportedSettings + </a> + + <nav class="md-nav" aria-label="UnsupportedSettings"> + <ul class="md-nav__list"> + + <li class="md-nav__item"> + <a href="#ancestors-in-mro_14" class="md-nav__link"> + Ancestors (in MRO) + </a> + +</li> + + <li class="md-nav__item"> + <a href="#class-variables_14" class="md-nav__link"> + Class variables + </a> + +</li> + + <li class="md-nav__item"> + <a href="#methods_14" class="md-nav__link"> + Methods + </a> + +</li> + + <li class="md-nav__item"> + <a href="#with_traceback_14" class="md-nav__link"> + with_traceback + </a> + +</li> + + </ul> + </nav> + +</li> + + </ul> + </nav> + +</li> + + </ul> + +</nav> + + </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"> + <a href="settings.html" class="md-nav__link"> + Settings + </a> + </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/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="#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="#assignmentsformatmismatch" class="md-nav__link"> + AssignmentsFormatMismatch + </a> + + <nav class="md-nav" aria-label="AssignmentsFormatMismatch"> + <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="#methods" class="md-nav__link"> + Methods + </a> + +</li> + + <li class="md-nav__item"> + <a href="#with_traceback" class="md-nav__link"> + with_traceback + </a> + +</li> + + </ul> + </nav> + +</li> + + <li class="md-nav__item"> + <a href="#existingsyntaxerrors" class="md-nav__link"> + ExistingSyntaxErrors + </a> + + <nav class="md-nav" aria-label="ExistingSyntaxErrors"> + <ul class="md-nav__list"> + + <li class="md-nav__item"> + <a href="#ancestors-in-mro_1" class="md-nav__link"> + Ancestors (in MRO) + </a> + +</li> + + <li class="md-nav__item"> + <a href="#class-variables_1" class="md-nav__link"> + Class variables + </a> + +</li> + + <li class="md-nav__item"> + <a href="#methods_1" class="md-nav__link"> + Methods + </a> + +</li> + + <li class="md-nav__item"> + <a href="#with_traceback_1" class="md-nav__link"> + with_traceback + </a> + +</li> + + </ul> + </nav> + +</li> + + <li class="md-nav__item"> + <a href="#fileskipcomment" class="md-nav__link"> + FileSkipComment + </a> + + <nav class="md-nav" aria-label="FileSkipComment"> + <ul class="md-nav__list"> + + <li class="md-nav__item"> + <a href="#ancestors-in-mro_2" class="md-nav__link"> + Ancestors (in MRO) + </a> + +</li> + + <li class="md-nav__item"> + <a href="#class-variables_2" class="md-nav__link"> + Class variables + </a> + +</li> + + <li class="md-nav__item"> + <a href="#methods_2" class="md-nav__link"> + Methods + </a> + +</li> + + <li class="md-nav__item"> + <a href="#with_traceback_2" class="md-nav__link"> + with_traceback + </a> + +</li> + + </ul> + </nav> + +</li> + + <li class="md-nav__item"> + <a href="#fileskipsetting" class="md-nav__link"> + FileSkipSetting + </a> + + <nav class="md-nav" aria-label="FileSkipSetting"> + <ul class="md-nav__list"> + + <li class="md-nav__item"> + <a href="#ancestors-in-mro_3" class="md-nav__link"> + Ancestors (in MRO) + </a> + +</li> + + <li class="md-nav__item"> + <a href="#class-variables_3" class="md-nav__link"> + Class variables + </a> + +</li> + + <li class="md-nav__item"> + <a href="#methods_3" class="md-nav__link"> + Methods + </a> + +</li> + + <li class="md-nav__item"> + <a href="#with_traceback_3" class="md-nav__link"> + with_traceback + </a> + +</li> + + </ul> + </nav> + +</li> + + <li class="md-nav__item"> + <a href="#fileskipped" class="md-nav__link"> + FileSkipped + </a> + + <nav class="md-nav" aria-label="FileSkipped"> + <ul class="md-nav__list"> + + <li class="md-nav__item"> + <a href="#ancestors-in-mro_4" class="md-nav__link"> + Ancestors (in MRO) + </a> + +</li> + + <li class="md-nav__item"> + <a href="#descendants" class="md-nav__link"> + Descendants + </a> + +</li> + + <li class="md-nav__item"> + <a href="#class-variables_4" class="md-nav__link"> + Class variables + </a> + +</li> + + <li class="md-nav__item"> + <a href="#methods_4" class="md-nav__link"> + Methods + </a> + +</li> + + <li class="md-nav__item"> + <a href="#with_traceback_4" class="md-nav__link"> + with_traceback + </a> + +</li> + + </ul> + </nav> + +</li> + + <li class="md-nav__item"> + <a href="#formattingplugindoesnotexist" class="md-nav__link"> + FormattingPluginDoesNotExist + </a> + + <nav class="md-nav" aria-label="FormattingPluginDoesNotExist"> + <ul class="md-nav__list"> + + <li class="md-nav__item"> + <a href="#ancestors-in-mro_5" class="md-nav__link"> + Ancestors (in MRO) + </a> + +</li> + + <li class="md-nav__item"> + <a href="#class-variables_5" class="md-nav__link"> + Class variables + </a> + +</li> + + <li class="md-nav__item"> + <a href="#methods_5" class="md-nav__link"> + Methods + </a> + +</li> + + <li class="md-nav__item"> + <a href="#with_traceback_5" class="md-nav__link"> + with_traceback + </a> + +</li> + + </ul> + </nav> + +</li> + + <li class="md-nav__item"> + <a href="#isorterror" class="md-nav__link"> + ISortError + </a> + + <nav class="md-nav" aria-label="ISortError"> + <ul class="md-nav__list"> + + <li class="md-nav__item"> + <a href="#ancestors-in-mro_6" class="md-nav__link"> + Ancestors (in MRO) + </a> + +</li> + + <li class="md-nav__item"> + <a href="#descendants_1" class="md-nav__link"> + Descendants + </a> + +</li> + + <li class="md-nav__item"> + <a href="#class-variables_6" class="md-nav__link"> + Class variables + </a> + +</li> + + <li class="md-nav__item"> + <a href="#methods_6" class="md-nav__link"> + Methods + </a> + +</li> + + <li class="md-nav__item"> + <a href="#with_traceback_6" class="md-nav__link"> + with_traceback + </a> + +</li> + + </ul> + </nav> + +</li> + + <li class="md-nav__item"> + <a href="#introducedsyntaxerrors" class="md-nav__link"> + IntroducedSyntaxErrors + </a> + + <nav class="md-nav" aria-label="IntroducedSyntaxErrors"> + <ul class="md-nav__list"> + + <li class="md-nav__item"> + <a href="#ancestors-in-mro_7" class="md-nav__link"> + Ancestors (in MRO) + </a> + +</li> + + <li class="md-nav__item"> + <a href="#class-variables_7" class="md-nav__link"> + Class variables + </a> + +</li> + + <li class="md-nav__item"> + <a href="#methods_7" class="md-nav__link"> + Methods + </a> + +</li> + + <li class="md-nav__item"> + <a href="#with_traceback_7" class="md-nav__link"> + with_traceback + </a> + +</li> + + </ul> + </nav> + +</li> + + <li class="md-nav__item"> + <a href="#invalidsettingspath" class="md-nav__link"> + InvalidSettingsPath + </a> + + <nav class="md-nav" aria-label="InvalidSettingsPath"> + <ul class="md-nav__list"> + + <li class="md-nav__item"> + <a href="#ancestors-in-mro_8" class="md-nav__link"> + Ancestors (in MRO) + </a> + +</li> + + <li class="md-nav__item"> + <a href="#class-variables_8" class="md-nav__link"> + Class variables + </a> + +</li> + + <li class="md-nav__item"> + <a href="#methods_8" class="md-nav__link"> + Methods + </a> + +</li> + + <li class="md-nav__item"> + <a href="#with_traceback_8" class="md-nav__link"> + with_traceback + </a> + +</li> + + </ul> + </nav> + +</li> + + <li class="md-nav__item"> + <a href="#literalparsingfailure" class="md-nav__link"> + LiteralParsingFailure + </a> + + <nav class="md-nav" aria-label="LiteralParsingFailure"> + <ul class="md-nav__list"> + + <li class="md-nav__item"> + <a href="#ancestors-in-mro_9" class="md-nav__link"> + Ancestors (in MRO) + </a> + +</li> + + <li class="md-nav__item"> + <a href="#class-variables_9" class="md-nav__link"> + Class variables + </a> + +</li> + + <li class="md-nav__item"> + <a href="#methods_9" class="md-nav__link"> + Methods + </a> + +</li> + + <li class="md-nav__item"> + <a href="#with_traceback_9" class="md-nav__link"> + with_traceback + </a> + +</li> + + </ul> + </nav> + +</li> + + <li class="md-nav__item"> + <a href="#literalsorttypemismatch" class="md-nav__link"> + LiteralSortTypeMismatch + </a> + + <nav class="md-nav" aria-label="LiteralSortTypeMismatch"> + <ul class="md-nav__list"> + + <li class="md-nav__item"> + <a href="#ancestors-in-mro_10" class="md-nav__link"> + Ancestors (in MRO) + </a> + +</li> + + <li class="md-nav__item"> + <a href="#class-variables_10" class="md-nav__link"> + Class variables + </a> + +</li> + + <li class="md-nav__item"> + <a href="#methods_10" class="md-nav__link"> + Methods + </a> + +</li> + + <li class="md-nav__item"> + <a href="#with_traceback_10" class="md-nav__link"> + with_traceback + </a> + +</li> + + </ul> + </nav> + +</li> + + <li class="md-nav__item"> + <a href="#missingsection" class="md-nav__link"> + MissingSection + </a> + + <nav class="md-nav" aria-label="MissingSection"> + <ul class="md-nav__list"> + + <li class="md-nav__item"> + <a href="#ancestors-in-mro_11" class="md-nav__link"> + Ancestors (in MRO) + </a> + +</li> + + <li class="md-nav__item"> + <a href="#class-variables_11" class="md-nav__link"> + Class variables + </a> + +</li> + + <li class="md-nav__item"> + <a href="#methods_11" class="md-nav__link"> + Methods + </a> + +</li> + + <li class="md-nav__item"> + <a href="#with_traceback_11" class="md-nav__link"> + with_traceback + </a> + +</li> + + </ul> + </nav> + +</li> + + <li class="md-nav__item"> + <a href="#profiledoesnotexist" class="md-nav__link"> + ProfileDoesNotExist + </a> + + <nav class="md-nav" aria-label="ProfileDoesNotExist"> + <ul class="md-nav__list"> + + <li class="md-nav__item"> + <a href="#ancestors-in-mro_12" class="md-nav__link"> + Ancestors (in MRO) + </a> + +</li> + + <li class="md-nav__item"> + <a href="#class-variables_12" class="md-nav__link"> + Class variables + </a> + +</li> + + <li class="md-nav__item"> + <a href="#methods_12" class="md-nav__link"> + Methods + </a> + +</li> + + <li class="md-nav__item"> + <a href="#with_traceback_12" class="md-nav__link"> + with_traceback + </a> + +</li> + + </ul> + </nav> + +</li> + + <li class="md-nav__item"> + <a href="#unsupportedencoding" class="md-nav__link"> + UnsupportedEncoding + </a> + + <nav class="md-nav" aria-label="UnsupportedEncoding"> + <ul class="md-nav__list"> + + <li class="md-nav__item"> + <a href="#ancestors-in-mro_13" class="md-nav__link"> + Ancestors (in MRO) + </a> + +</li> + + <li class="md-nav__item"> + <a href="#class-variables_13" class="md-nav__link"> + Class variables + </a> + +</li> + + <li class="md-nav__item"> + <a href="#methods_13" class="md-nav__link"> + Methods + </a> + +</li> + + <li class="md-nav__item"> + <a href="#with_traceback_13" class="md-nav__link"> + with_traceback + </a> + +</li> + + </ul> + </nav> + +</li> + + <li class="md-nav__item"> + <a href="#unsupportedsettings" class="md-nav__link"> + UnsupportedSettings + </a> + + <nav class="md-nav" aria-label="UnsupportedSettings"> + <ul class="md-nav__list"> + + <li class="md-nav__item"> + <a href="#ancestors-in-mro_14" class="md-nav__link"> + Ancestors (in MRO) + </a> + +</li> + + <li class="md-nav__item"> + <a href="#class-variables_14" class="md-nav__link"> + Class variables + </a> + +</li> + + <li class="md-nav__item"> + <a href="#methods_14" class="md-nav__link"> + Methods + </a> + +</li> + + <li class="md-nav__item"> + <a href="#with_traceback_14" class="md-nav__link"> + with_traceback + </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/exceptions.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-isortexceptions">Module isort.exceptions</h1> +<p>All isort specific exception classes should be defined here</p> +<p>None</p> +<details class="example"><summary>View Source</summary><div class="codehilite"><pre><span></span><code><span class="sd">"""All isort specific exception classes should be defined here"""</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="n">Any</span><span class="p">,</span> <span class="n">Dict</span><span class="p">,</span> <span class="n">Union</span> + +<span class="kn">from</span> <span class="nn">.profiles</span> <span class="kn">import</span> <span class="n">profiles</span> + +<span class="k">class</span> <span class="nc">ISortError</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span> + + <span class="sd">"""Base isort exception object from which all isort sourced exceptions should inherit"""</span> + +<span class="k">class</span> <span class="nc">InvalidSettingsPath</span><span class="p">(</span><span class="n">ISortError</span><span class="p">):</span> + + <span class="sd">"""Raised when a settings path is provided that is neither a valid file or directory"""</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_path</span><span class="p">:</span> <span class="nb">str</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="sa">f</span><span class="s2">"isort was told to use the settings_path: </span><span class="si">{</span><span class="n">settings_path</span><span class="si">}</span><span class="s2"> as the base directory or "</span> + + <span class="s2">"file that represents the starting point of config file discovery, but it does not "</span> + + <span class="s2">"exist."</span> + + <span class="p">)</span> + + <span class="bp">self</span><span class="o">.</span><span class="n">settings_path</span> <span class="o">=</span> <span class="n">settings_path</span> + +<span class="k">class</span> <span class="nc">ExistingSyntaxErrors</span><span class="p">(</span><span class="n">ISortError</span><span class="p">):</span> + + <span class="sd">"""Raised when isort is told to sort imports within code that has existing syntax errors"""</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">file_path</span><span class="p">:</span> <span class="nb">str</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="sa">f</span><span class="s2">"isort was told to sort imports within code that contains syntax errors: "</span> + + <span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">file_path</span><span class="si">}</span><span class="s2">."</span> + + <span class="p">)</span> + + <span class="bp">self</span><span class="o">.</span><span class="n">file_path</span> <span class="o">=</span> <span class="n">file_path</span> + +<span class="k">class</span> <span class="nc">IntroducedSyntaxErrors</span><span class="p">(</span><span class="n">ISortError</span><span class="p">):</span> + + <span class="sd">"""Raised when isort has introduced a syntax error in the process of sorting imports"""</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">file_path</span><span class="p">:</span> <span class="nb">str</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="sa">f</span><span class="s2">"isort introduced syntax errors when attempting to sort the imports contained within "</span> + + <span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">file_path</span><span class="si">}</span><span class="s2">."</span> + + <span class="p">)</span> + + <span class="bp">self</span><span class="o">.</span><span class="n">file_path</span> <span class="o">=</span> <span class="n">file_path</span> + +<span class="k">class</span> <span class="nc">FileSkipped</span><span class="p">(</span><span class="n">ISortError</span><span class="p">):</span> + + <span class="sd">"""Should be raised when a file is skipped for any reason"""</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">message</span><span class="p">:</span> <span class="nb">str</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="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">message</span><span class="p">)</span> + + <span class="bp">self</span><span class="o">.</span><span class="n">file_path</span> <span class="o">=</span> <span class="n">file_path</span> + +<span class="k">class</span> <span class="nc">FileSkipComment</span><span class="p">(</span><span class="n">FileSkipped</span><span class="p">):</span> + + <span class="sd">"""Raised when an entire file is skipped due to a isort skip file comment"""</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">file_path</span><span class="p">:</span> <span class="nb">str</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="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">file_path</span><span class="si">}</span><span class="s2"> contains a file skip comment and was skipped."</span><span class="p">,</span> <span class="n">file_path</span><span class="o">=</span><span class="n">file_path</span> + + <span class="p">)</span> + +<span class="k">class</span> <span class="nc">FileSkipSetting</span><span class="p">(</span><span class="n">FileSkipped</span><span class="p">):</span> + + <span class="sd">"""Raised when an entire file is skipped due to provided isort settings"""</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">file_path</span><span class="p">:</span> <span class="nb">str</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="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">file_path</span><span class="si">}</span><span class="s2"> was skipped as it's listed in 'skip' setting"</span> + + <span class="s2">" or matches a glob in 'skip_glob' setting"</span><span class="p">,</span> + + <span class="n">file_path</span><span class="o">=</span><span class="n">file_path</span><span class="p">,</span> + + <span class="p">)</span> + +<span class="k">class</span> <span class="nc">ProfileDoesNotExist</span><span class="p">(</span><span class="n">ISortError</span><span class="p">):</span> + + <span class="sd">"""Raised when a profile is set by the user that doesn't exist"""</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">profile</span><span class="p">:</span> <span class="nb">str</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="sa">f</span><span class="s2">"Specified profile of </span><span class="si">{</span><span class="n">profile</span><span class="si">}</span><span class="s2"> does not exist. "</span> + + <span class="sa">f</span><span class="s2">"Available profiles: </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">profiles</span><span class="p">)</span><span class="si">}</span><span class="s2">."</span> + + <span class="p">)</span> + + <span class="bp">self</span><span class="o">.</span><span class="n">profile</span> <span class="o">=</span> <span class="n">profile</span> + +<span class="k">class</span> <span class="nc">FormattingPluginDoesNotExist</span><span class="p">(</span><span class="n">ISortError</span><span class="p">):</span> + + <span class="sd">"""Raised when a formatting plugin is set by the user that doesn't exist"""</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">formatter</span><span class="p">:</span> <span class="nb">str</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="sa">f</span><span class="s2">"Specified formatting plugin of </span><span class="si">{</span><span class="n">formatter</span><span class="si">}</span><span class="s2"> does not exist. "</span><span class="p">)</span> + + <span class="bp">self</span><span class="o">.</span><span class="n">formatter</span> <span class="o">=</span> <span class="n">formatter</span> + +<span class="k">class</span> <span class="nc">LiteralParsingFailure</span><span class="p">(</span><span class="n">ISortError</span><span class="p">):</span> + + <span class="sd">"""Raised when one of isorts literal sorting comments is used but isort can't parse the</span> + +<span class="sd"> the given data structure.</span> + +<span class="sd"> """</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">code</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">original_error</span><span class="p">:</span> <span class="ne">Exception</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="sa">f</span><span class="s2">"isort failed to parse the given literal </span><span class="si">{</span><span class="n">code</span><span class="si">}</span><span class="s2">. It's important to note "</span> + + <span class="s2">"that isort literal sorting only supports simple literals parsable by "</span> + + <span class="sa">f</span><span class="s2">"ast.literal_eval which gave the exception of </span><span class="si">{</span><span class="n">original_error</span><span class="si">}</span><span class="s2">."</span> + + <span class="p">)</span> + + <span class="bp">self</span><span class="o">.</span><span class="n">code</span> <span class="o">=</span> <span class="n">code</span> + + <span class="bp">self</span><span class="o">.</span><span class="n">original_error</span> <span class="o">=</span> <span class="n">original_error</span> + +<span class="k">class</span> <span class="nc">LiteralSortTypeMismatch</span><span class="p">(</span><span class="n">ISortError</span><span class="p">):</span> + + <span class="sd">"""Raised when an isort literal sorting comment is used, with a type that doesn't match the</span> + +<span class="sd"> supplied data structure's type.</span> + +<span class="sd"> """</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">kind</span><span class="p">:</span> <span class="nb">type</span><span class="p">,</span> <span class="n">expected_kind</span><span class="p">:</span> <span class="nb">type</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="sa">f</span><span class="s2">"isort was told to sort a literal of type </span><span class="si">{</span><span class="n">expected_kind</span><span class="si">}</span><span class="s2"> but was given "</span> + + <span class="sa">f</span><span class="s2">"a literal of type </span><span class="si">{</span><span class="n">kind</span><span class="si">}</span><span class="s2">."</span> + + <span class="p">)</span> + + <span class="bp">self</span><span class="o">.</span><span class="n">kind</span> <span class="o">=</span> <span class="n">kind</span> + + <span class="bp">self</span><span class="o">.</span><span class="n">expected_kind</span> <span class="o">=</span> <span class="n">expected_kind</span> + +<span class="k">class</span> <span class="nc">AssignmentsFormatMismatch</span><span class="p">(</span><span class="n">ISortError</span><span class="p">):</span> + + <span class="sd">"""Raised when isort is told to sort assignments but the format of the assignment section</span> + +<span class="sd"> doesn't match isort's expectation.</span> + +<span class="sd"> """</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">code</span><span class="p">:</span> <span class="nb">str</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="s2">"isort was told to sort a section of assignments, however the given code:</span><span class="se">\n\n</span><span class="s2">"</span> + + <span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">code</span><span class="si">}</span><span class="se">\n\n</span><span class="s2">"</span> + + <span class="s2">"Does not match isort's strict single line formatting requirement for assignment "</span> + + <span class="s2">"sorting:</span><span class="se">\n\n</span><span class="s2">"</span> + + <span class="s2">"</span><span class="si">{variable_name}</span><span class="s2"> = </span><span class="si">{value}</span><span class="se">\n</span><span class="s2">"</span> + + <span class="s2">"</span><span class="si">{variable_name2}</span><span class="s2"> = </span><span class="si">{value2}</span><span class="se">\n</span><span class="s2">"</span> + + <span class="s2">"...</span><span class="se">\n\n</span><span class="s2">"</span> + + <span class="p">)</span> + + <span class="bp">self</span><span class="o">.</span><span class="n">code</span> <span class="o">=</span> <span class="n">code</span> + +<span class="k">class</span> <span class="nc">UnsupportedSettings</span><span class="p">(</span><span class="n">ISortError</span><span class="p">):</span> + + <span class="sd">"""Raised when settings are passed into isort (either from config, CLI, or runtime)</span> + +<span class="sd"> that it doesn't support.</span> + +<span class="sd"> """</span> + + <span class="nd">@staticmethod</span> + + <span class="k">def</span> <span class="nf">_format_option</span><span class="p">(</span><span class="n">name</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">value</span><span class="p">:</span> <span class="n">Any</span><span class="p">,</span> <span class="n">source</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span> + + <span class="k">return</span> <span class="sa">f</span><span class="s2">"</span><span class="se">\t</span><span class="s2">- </span><span class="si">{</span><span class="n">name</span><span class="si">}</span><span class="s2"> = </span><span class="si">{</span><span class="n">value</span><span class="si">}</span><span class="s2"> (source: '</span><span class="si">{</span><span class="n">source</span><span class="si">}</span><span class="s2">')"</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">unsupported_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">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">errors</span> <span class="o">=</span> <span class="s2">"</span><span class="se">\n</span><span class="s2">"</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">_format_option</span><span class="p">(</span><span class="n">name</span><span class="p">,</span> <span class="o">**</span><span class="n">option</span><span class="p">)</span> <span class="k">for</span> <span class="n">name</span><span class="p">,</span> <span class="n">option</span> <span class="ow">in</span> <span class="n">unsupported_settings</span><span class="o">.</span><span class="n">items</span><span class="p">()</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="s2">"isort was provided settings that it doesn't support:</span><span class="se">\n\n</span><span class="s2">"</span> + + <span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">errors</span><span class="si">}</span><span class="se">\n\n</span><span class="s2">"</span> + + <span class="s2">"For a complete and up-to-date listing of supported settings see: "</span> + + <span class="s2">"https://pycqa.github.io/isort/docs/configuration/options/.</span><span class="se">\n</span><span class="s2">"</span> + + <span class="p">)</span> + + <span class="bp">self</span><span class="o">.</span><span class="n">unsupported_settings</span> <span class="o">=</span> <span class="n">unsupported_settings</span> + +<span class="k">class</span> <span class="nc">UnsupportedEncoding</span><span class="p">(</span><span class="n">ISortError</span><span class="p">):</span> + + <span class="sd">"""Raised when isort encounters an encoding error while trying to read a file"""</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">filename</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Path</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="sa">f</span><span class="s2">"Unknown or unsupported encoding in </span><span class="si">{</span><span class="n">filename</span><span class="si">}</span><span class="s2">"</span><span class="p">)</span> + + <span class="bp">self</span><span class="o">.</span><span class="n">filename</span> <span class="o">=</span> <span class="n">filename</span> + +<span class="k">class</span> <span class="nc">MissingSection</span><span class="p">(</span><span class="n">ISortError</span><span class="p">):</span> + + <span class="sd">"""Raised when isort encounters an import that matches a section that is not defined"""</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">import_module</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">section</span><span class="p">:</span> <span class="nb">str</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="sa">f</span><span class="s2">"Found </span><span class="si">{</span><span class="n">import_module</span><span class="si">}</span><span class="s2"> import while parsing, but </span><span class="si">{</span><span class="n">section</span><span class="si">}</span><span class="s2"> was not included "</span> + + <span class="s2">"in the `sections` setting of your config. Please add it before continuing</span><span class="se">\n</span><span class="s2">"</span> + + <span class="s2">"See https://pycqa.github.io/isort/#custom-sections-and-ordering "</span> + + <span class="s2">"for more info."</span> + + <span class="p">)</span> +</code></pre></div> + +</details> +<h2 id="variables">Variables</h2> +<div class="codehilite"><pre><span></span><code><span class="n">profiles</span> +</code></pre></div> + +<h2 id="classes">Classes</h2> +<h3 id="assignmentsformatmismatch">AssignmentsFormatMismatch</h3> +<div class="codehilite"><pre><span></span><code><span class="k">class</span> <span class="nc">AssignmentsFormatMismatch</span><span class="p">(</span> + <span class="n">code</span><span class="p">:</span> <span class="nb">str</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">AssignmentsFormatMismatch</span><span class="p">(</span><span class="n">ISortError</span><span class="p">):</span> + + <span class="sd">"""Raised when isort is told to sort assignments but the format of the assignment section</span> + +<span class="sd"> doesn't match isort's expectation.</span> + +<span class="sd"> """</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">code</span><span class="p">:</span> <span class="nb">str</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="s2">"isort was told to sort a section of assignments, however the given code:</span><span class="se">\n\n</span><span class="s2">"</span> + + <span class="n">f</span><span class="s2">"{code}</span><span class="se">\n\n</span><span class="s2">"</span> + + <span class="s2">"Does not match isort's strict single line formatting requirement for assignment "</span> + + <span class="s2">"sorting:</span><span class="se">\n\n</span><span class="s2">"</span> + + <span class="s2">"{variable_name} = {value}</span><span class="se">\n</span><span class="s2">"</span> + + <span class="s2">"{variable_name2} = {value2}</span><span class="se">\n</span><span class="s2">"</span> + + <span class="s2">"...</span><span class="se">\n\n</span><span class="s2">"</span> + + <span class="p">)</span> + + <span class="bp">self</span><span class="o">.</span><span class="n">code</span> <span class="o">=</span> <span class="n">code</span> +</code></pre></div> + +</details> +<hr /> +<h4 id="ancestors-in-mro">Ancestors (in MRO)</h4> +<ul> +<li>isort.exceptions.ISortError</li> +<li>builtins.Exception</li> +<li>builtins.BaseException</li> +</ul> +<h4 id="class-variables">Class variables</h4> +<div class="codehilite"><pre><span></span><code><span class="n">args</span> +</code></pre></div> + +<h4 id="methods">Methods</h4> +<h4 id="with_traceback">with_traceback</h4> +<div class="codehilite"><pre><span></span><code><span class="k">def</span> <span class="nf">with_traceback</span><span class="p">(</span> + <span class="o">...</span> +<span class="p">)</span> +</code></pre></div> + +<p>Exception.with_traceback(tb) --</p> +<p>set self.<strong>traceback</strong> to tb and return self.</p> +<h3 id="existingsyntaxerrors">ExistingSyntaxErrors</h3> +<div class="codehilite"><pre><span></span><code><span class="k">class</span> <span class="nc">ExistingSyntaxErrors</span><span class="p">(</span> + <span class="n">file_path</span><span class="p">:</span> <span class="nb">str</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">ExistingSyntaxErrors</span>(<span class="n">ISortError</span>): + + <span class="s">"""Raised when isort is told to sort imports within code that has existing syntax errors"""</span> + + <span class="n">def</span> <span class="n">__init__</span>(<span class="nb">self</span>, <span class="n">file_path:</span> <span class="n">str</span>): + + <span class="n">super</span>().<span class="n">__init__</span>( + + <span class="nb">f</span><span class="s">"isort was told to sort imports within code that contains syntax errors: "</span> + + <span class="nb">f</span><span class="s">"{file_path}."</span> + + ) + + <span class="nb">self</span>.<span class="n">file_path</span> = <span class="n">file_path</span> +</code></pre></div> + +</details> +<hr /> +<h4 id="ancestors-in-mro_1">Ancestors (in MRO)</h4> +<ul> +<li>isort.exceptions.ISortError</li> +<li>builtins.Exception</li> +<li>builtins.BaseException</li> +</ul> +<h4 id="class-variables_1">Class variables</h4> +<div class="codehilite"><pre><span></span><code><span class="n">args</span> +</code></pre></div> + +<h4 id="methods_1">Methods</h4> +<h4 id="with_traceback_1">with_traceback</h4> +<div class="codehilite"><pre><span></span><code><span class="k">def</span> <span class="nf">with_traceback</span><span class="p">(</span> + <span class="o">...</span> +<span class="p">)</span> +</code></pre></div> + +<p>Exception.with_traceback(tb) --</p> +<p>set self.<strong>traceback</strong> to tb and return self.</p> +<h3 id="fileskipcomment">FileSkipComment</h3> +<div class="codehilite"><pre><span></span><code><span class="k">class</span> <span class="nc">FileSkipComment</span><span class="p">(</span> + <span class="n">file_path</span><span class="p">:</span> <span class="nb">str</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">FileSkipComment</span>(<span class="n">FileSkipped</span>): + + <span class="s">"""Raised when an entire file is skipped due to a isort skip file comment"""</span> + + <span class="n">def</span> <span class="n">__init__</span>(<span class="nb">self</span>, <span class="n">file_path:</span> <span class="n">str</span>): + + <span class="n">super</span>().<span class="n">__init__</span>( + + <span class="nb">f</span><span class="s">"{file_path} contains a file skip comment and was skipped."</span>, <span class="n">file_path</span>=<span class="n">file_path</span> + + ) +</code></pre></div> + +</details> +<hr /> +<h4 id="ancestors-in-mro_2">Ancestors (in MRO)</h4> +<ul> +<li>isort.exceptions.FileSkipped</li> +<li>isort.exceptions.ISortError</li> +<li>builtins.Exception</li> +<li>builtins.BaseException</li> +</ul> +<h4 id="class-variables_2">Class variables</h4> +<div class="codehilite"><pre><span></span><code><span class="n">args</span> +</code></pre></div> + +<h4 id="methods_2">Methods</h4> +<h4 id="with_traceback_2">with_traceback</h4> +<div class="codehilite"><pre><span></span><code><span class="k">def</span> <span class="nf">with_traceback</span><span class="p">(</span> + <span class="o">...</span> +<span class="p">)</span> +</code></pre></div> + +<p>Exception.with_traceback(tb) --</p> +<p>set self.<strong>traceback</strong> to tb and return self.</p> +<h3 id="fileskipsetting">FileSkipSetting</h3> +<div class="codehilite"><pre><span></span><code><span class="k">class</span> <span class="nc">FileSkipSetting</span><span class="p">(</span> + <span class="n">file_path</span><span class="p">:</span> <span class="nb">str</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">FileSkipSetting</span>(<span class="n">FileSkipped</span>): + + <span class="s">"""Raised when an entire file is skipped due to provided isort settings"""</span> + + <span class="n">def</span> <span class="n">__init__</span>(<span class="nb">self</span>, <span class="n">file_path:</span> <span class="n">str</span>): + + <span class="n">super</span>().<span class="n">__init__</span>( + + <span class="nb">f</span><span class="s">"{file_path} was skipped as it's listed in 'skip' setting"</span> + + <span class="s">" or matches a glob in 'skip_glob' setting"</span>, + + <span class="n">file_path</span>=<span class="n">file_path</span>, + + ) +</code></pre></div> + +</details> +<hr /> +<h4 id="ancestors-in-mro_3">Ancestors (in MRO)</h4> +<ul> +<li>isort.exceptions.FileSkipped</li> +<li>isort.exceptions.ISortError</li> +<li>builtins.Exception</li> +<li>builtins.BaseException</li> +</ul> +<h4 id="class-variables_3">Class variables</h4> +<div class="codehilite"><pre><span></span><code><span class="n">args</span> +</code></pre></div> + +<h4 id="methods_3">Methods</h4> +<h4 id="with_traceback_3">with_traceback</h4> +<div class="codehilite"><pre><span></span><code><span class="k">def</span> <span class="nf">with_traceback</span><span class="p">(</span> + <span class="o">...</span> +<span class="p">)</span> +</code></pre></div> + +<p>Exception.with_traceback(tb) --</p> +<p>set self.<strong>traceback</strong> to tb and return self.</p> +<h3 id="fileskipped">FileSkipped</h3> +<div class="codehilite"><pre><span></span><code><span class="k">class</span> <span class="nc">FileSkipped</span><span class="p">(</span> + <span class="n">message</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> + <span class="n">file_path</span><span class="p">:</span> <span class="nb">str</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">FileSkipped</span>(<span class="n">ISortError</span>): + + <span class="s">"""Should be raised when a file is skipped for any reason"""</span> + + <span class="n">def</span> <span class="n">__init__</span>(<span class="nb">self</span>, <span class="n">message:</span> <span class="n">str</span>, <span class="n">file_path:</span> <span class="n">str</span>): + + <span class="n">super</span>().<span class="n">__init__</span>(<span class="nb">message</span>) + + <span class="nb">self</span>.<span class="n">file_path</span> = <span class="n">file_path</span> +</code></pre></div> + +</details> +<hr /> +<h4 id="ancestors-in-mro_4">Ancestors (in MRO)</h4> +<ul> +<li>isort.exceptions.ISortError</li> +<li>builtins.Exception</li> +<li>builtins.BaseException</li> +</ul> +<h4 id="descendants">Descendants</h4> +<ul> +<li>isort.exceptions.FileSkipComment</li> +<li>isort.exceptions.FileSkipSetting</li> +</ul> +<h4 id="class-variables_4">Class variables</h4> +<div class="codehilite"><pre><span></span><code><span class="n">args</span> +</code></pre></div> + +<h4 id="methods_4">Methods</h4> +<h4 id="with_traceback_4">with_traceback</h4> +<div class="codehilite"><pre><span></span><code><span class="k">def</span> <span class="nf">with_traceback</span><span class="p">(</span> + <span class="o">...</span> +<span class="p">)</span> +</code></pre></div> + +<p>Exception.with_traceback(tb) --</p> +<p>set self.<strong>traceback</strong> to tb and return self.</p> +<h3 id="formattingplugindoesnotexist">FormattingPluginDoesNotExist</h3> +<div class="codehilite"><pre><span></span><code><span class="k">class</span> <span class="nc">FormattingPluginDoesNotExist</span><span class="p">(</span> + <span class="n">formatter</span><span class="p">:</span> <span class="nb">str</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">FormattingPluginDoesNotExist</span>(<span class="n">ISortError</span>): + + <span class="s">"""Raised when a formatting plugin is set by the user that doesn't exist"""</span> + + <span class="n">def</span> <span class="n">__init__</span>(<span class="nb">self</span>, <span class="n">formatter:</span> <span class="n">str</span>): + + <span class="n">super</span>().<span class="n">__init__</span>(<span class="nb">f</span><span class="s">"Specified formatting plugin of {formatter} does not exist. "</span>) + + <span class="nb">self</span>.<span class="nb">formatter</span> = <span class="nb">formatter</span> +</code></pre></div> + +</details> +<hr /> +<h4 id="ancestors-in-mro_5">Ancestors (in MRO)</h4> +<ul> +<li>isort.exceptions.ISortError</li> +<li>builtins.Exception</li> +<li>builtins.BaseException</li> +</ul> +<h4 id="class-variables_5">Class variables</h4> +<div class="codehilite"><pre><span></span><code><span class="n">args</span> +</code></pre></div> + +<h4 id="methods_5">Methods</h4> +<h4 id="with_traceback_5">with_traceback</h4> +<div class="codehilite"><pre><span></span><code><span class="k">def</span> <span class="nf">with_traceback</span><span class="p">(</span> + <span class="o">...</span> +<span class="p">)</span> +</code></pre></div> + +<p>Exception.with_traceback(tb) --</p> +<p>set self.<strong>traceback</strong> to tb and return self.</p> +<h3 id="isorterror">ISortError</h3> +<div class="codehilite"><pre><span></span><code><span class="k">class</span> <span class="nc">ISortError</span><span class="p">(</span> + <span class="o">/</span><span class="p">,</span> + <span class="o">*</span><span class="n">args</span><span class="p">,</span> + <span class="o">**</span><span class="n">kwargs</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">ISortError</span>(<span class="nb">Exception</span>): + + <span class="s">"""Base isort exception object from which all isort sourced exceptions should inherit"""</span> +</code></pre></div> + +</details> +<hr /> +<h4 id="ancestors-in-mro_6">Ancestors (in MRO)</h4> +<ul> +<li>builtins.Exception</li> +<li>builtins.BaseException</li> +</ul> +<h4 id="descendants_1">Descendants</h4> +<ul> +<li>isort.exceptions.InvalidSettingsPath</li> +<li>isort.exceptions.ExistingSyntaxErrors</li> +<li>isort.exceptions.IntroducedSyntaxErrors</li> +<li>isort.exceptions.FileSkipped</li> +<li>isort.exceptions.ProfileDoesNotExist</li> +<li>isort.exceptions.FormattingPluginDoesNotExist</li> +<li>isort.exceptions.LiteralParsingFailure</li> +<li>isort.exceptions.LiteralSortTypeMismatch</li> +<li>isort.exceptions.AssignmentsFormatMismatch</li> +<li>isort.exceptions.UnsupportedSettings</li> +<li>isort.exceptions.UnsupportedEncoding</li> +<li>isort.exceptions.MissingSection</li> +</ul> +<h4 id="class-variables_6">Class variables</h4> +<div class="codehilite"><pre><span></span><code><span class="n">args</span> +</code></pre></div> + +<h4 id="methods_6">Methods</h4> +<h4 id="with_traceback_6">with_traceback</h4> +<div class="codehilite"><pre><span></span><code><span class="k">def</span> <span class="nf">with_traceback</span><span class="p">(</span> + <span class="o">...</span> +<span class="p">)</span> +</code></pre></div> + +<p>Exception.with_traceback(tb) --</p> +<p>set self.<strong>traceback</strong> to tb and return self.</p> +<h3 id="introducedsyntaxerrors">IntroducedSyntaxErrors</h3> +<div class="codehilite"><pre><span></span><code><span class="k">class</span> <span class="nc">IntroducedSyntaxErrors</span><span class="p">(</span> + <span class="n">file_path</span><span class="p">:</span> <span class="nb">str</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">IntroducedSyntaxErrors</span>(<span class="n">ISortError</span>): + + <span class="s">"""Raised when isort has introduced a syntax error in the process of sorting imports"""</span> + + <span class="n">def</span> <span class="n">__init__</span>(<span class="nb">self</span>, <span class="n">file_path:</span> <span class="n">str</span>): + + <span class="n">super</span>().<span class="n">__init__</span>( + + <span class="nb">f</span><span class="s">"isort introduced syntax errors when attempting to sort the imports contained within "</span> + + <span class="nb">f</span><span class="s">"{file_path}."</span> + + ) + + <span class="nb">self</span>.<span class="n">file_path</span> = <span class="n">file_path</span> +</code></pre></div> + +</details> +<hr /> +<h4 id="ancestors-in-mro_7">Ancestors (in MRO)</h4> +<ul> +<li>isort.exceptions.ISortError</li> +<li>builtins.Exception</li> +<li>builtins.BaseException</li> +</ul> +<h4 id="class-variables_7">Class variables</h4> +<div class="codehilite"><pre><span></span><code><span class="n">args</span> +</code></pre></div> + +<h4 id="methods_7">Methods</h4> +<h4 id="with_traceback_7">with_traceback</h4> +<div class="codehilite"><pre><span></span><code><span class="k">def</span> <span class="nf">with_traceback</span><span class="p">(</span> + <span class="o">...</span> +<span class="p">)</span> +</code></pre></div> + +<p>Exception.with_traceback(tb) --</p> +<p>set self.<strong>traceback</strong> to tb and return self.</p> +<h3 id="invalidsettingspath">InvalidSettingsPath</h3> +<div class="codehilite"><pre><span></span><code><span class="k">class</span> <span class="nc">InvalidSettingsPath</span><span class="p">(</span> + <span class="n">settings_path</span><span class="p">:</span> <span class="nb">str</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">InvalidSettingsPath</span>(<span class="n">ISortError</span>): + + <span class="s">"""Raised when a settings path is provided that is neither a valid file or directory"""</span> + + <span class="n">def</span> <span class="n">__init__</span>(<span class="nb">self</span>, <span class="n">settings_path:</span> <span class="n">str</span>): + + <span class="n">super</span>().<span class="n">__init__</span>( + + <span class="nb">f</span><span class="s">"isort was told to use the settings_path: {settings_path} as the base directory or "</span> + + <span class="s">"file that represents the starting point of config file discovery, but it does not "</span> + + <span class="s">"exist."</span> + + ) + + <span class="nb">self</span>.<span class="n">settings_path</span> = <span class="n">settings_path</span> +</code></pre></div> + +</details> +<hr /> +<h4 id="ancestors-in-mro_8">Ancestors (in MRO)</h4> +<ul> +<li>isort.exceptions.ISortError</li> +<li>builtins.Exception</li> +<li>builtins.BaseException</li> +</ul> +<h4 id="class-variables_8">Class variables</h4> +<div class="codehilite"><pre><span></span><code><span class="n">args</span> +</code></pre></div> + +<h4 id="methods_8">Methods</h4> +<h4 id="with_traceback_8">with_traceback</h4> +<div class="codehilite"><pre><span></span><code><span class="k">def</span> <span class="nf">with_traceback</span><span class="p">(</span> + <span class="o">...</span> +<span class="p">)</span> +</code></pre></div> + +<p>Exception.with_traceback(tb) --</p> +<p>set self.<strong>traceback</strong> to tb and return self.</p> +<h3 id="literalparsingfailure">LiteralParsingFailure</h3> +<div class="codehilite"><pre><span></span><code><span class="k">class</span> <span class="nc">LiteralParsingFailure</span><span class="p">(</span> + <span class="n">code</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> + <span class="n">original_error</span><span class="p">:</span> <span class="ne">Exception</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">LiteralParsingFailure</span>(<span class="n">ISortError</span>): + + <span class="s">"""Raised when one of isorts literal sorting comments is used but isort can't parse the</span> + +<span class="s"> the given data structure.</span> + +<span class="s"> """</span> + + <span class="n">def</span> <span class="n">__init__</span>(<span class="nb">self</span>, <span class="n">code:</span> <span class="n">str</span>, <span class="n">original_error:</span> <span class="nb">Exception</span>): + + <span class="n">super</span>().<span class="n">__init__</span>( + + <span class="nb">f</span><span class="s">"isort failed to parse the given literal {code}. It's important to note "</span> + + <span class="s">"that isort literal sorting only supports simple literals parsable by "</span> + + <span class="nb">f</span><span class="s">"ast.literal_eval which gave the exception of {original_error}."</span> + + ) + + <span class="nb">self</span>.<span class="nb">code</span> = <span class="nb">code</span> + + <span class="nb">self</span>.<span class="n">original_error</span> = <span class="n">original_error</span> +</code></pre></div> + +</details> +<hr /> +<h4 id="ancestors-in-mro_9">Ancestors (in MRO)</h4> +<ul> +<li>isort.exceptions.ISortError</li> +<li>builtins.Exception</li> +<li>builtins.BaseException</li> +</ul> +<h4 id="class-variables_9">Class variables</h4> +<div class="codehilite"><pre><span></span><code><span class="n">args</span> +</code></pre></div> + +<h4 id="methods_9">Methods</h4> +<h4 id="with_traceback_9">with_traceback</h4> +<div class="codehilite"><pre><span></span><code><span class="k">def</span> <span class="nf">with_traceback</span><span class="p">(</span> + <span class="o">...</span> +<span class="p">)</span> +</code></pre></div> + +<p>Exception.with_traceback(tb) --</p> +<p>set self.<strong>traceback</strong> to tb and return self.</p> +<h3 id="literalsorttypemismatch">LiteralSortTypeMismatch</h3> +<div class="codehilite"><pre><span></span><code><span class="k">class</span> <span class="nc">LiteralSortTypeMismatch</span><span class="p">(</span> + <span class="n">kind</span><span class="p">:</span> <span class="nb">type</span><span class="p">,</span> + <span class="n">expected_kind</span><span class="p">:</span> <span class="nb">type</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">LiteralSortTypeMismatch</span>(<span class="n">ISortError</span>): + + <span class="s">"""Raised when an isort literal sorting comment is used, with a type that doesn't match the</span> + +<span class="s"> supplied data structure's type.</span> + +<span class="s"> """</span> + + <span class="n">def</span> <span class="n">__init__</span>(<span class="nb">self</span>, <span class="n">kind:</span> <span class="nb">type</span>, <span class="n">expected_kind:</span> <span class="nb">type</span>): + + <span class="n">super</span>().<span class="n">__init__</span>( + + <span class="nb">f</span><span class="s">"isort was told to sort a literal of type {expected_kind} but was given "</span> + + <span class="nb">f</span><span class="s">"a literal of type {kind}."</span> + + ) + + <span class="nb">self</span>.<span class="n">kind</span> = <span class="n">kind</span> + + <span class="nb">self</span>.<span class="n">expected_kind</span> = <span class="n">expected_kind</span> +</code></pre></div> + +</details> +<hr /> +<h4 id="ancestors-in-mro_10">Ancestors (in MRO)</h4> +<ul> +<li>isort.exceptions.ISortError</li> +<li>builtins.Exception</li> +<li>builtins.BaseException</li> +</ul> +<h4 id="class-variables_10">Class variables</h4> +<div class="codehilite"><pre><span></span><code><span class="n">args</span> +</code></pre></div> + +<h4 id="methods_10">Methods</h4> +<h4 id="with_traceback_10">with_traceback</h4> +<div class="codehilite"><pre><span></span><code><span class="k">def</span> <span class="nf">with_traceback</span><span class="p">(</span> + <span class="o">...</span> +<span class="p">)</span> +</code></pre></div> + +<p>Exception.with_traceback(tb) --</p> +<p>set self.<strong>traceback</strong> to tb and return self.</p> +<h3 id="missingsection">MissingSection</h3> +<div class="codehilite"><pre><span></span><code><span class="k">class</span> <span class="nc">MissingSection</span><span class="p">(</span> + <span class="n">import_module</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> + <span class="n">section</span><span class="p">:</span> <span class="nb">str</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="nc">MissingSection</span><span class="p">(</span><span class="n">ISortError</span><span class="p">):</span> + + <span class="sd">"""Raised when isort encounters an import that matches a section that is not defined"""</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">import_module</span><span class="p">:</span> <span class="nb">str</span><span class="p">,</span> <span class="n">section</span><span class="p">:</span> <span class="nb">str</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="sa">f</span><span class="s2">"Found </span><span class="si">{</span><span class="n">import_module</span><span class="si">}</span><span class="s2"> import while parsing, but </span><span class="si">{</span><span class="n">section</span><span class="si">}</span><span class="s2"> was not included "</span> + + <span class="s2">"in the `sections` setting of your config. Please add it before continuing</span><span class="se">\n</span><span class="s2">"</span> + + <span class="s2">"See https://pycqa.github.io/isort/#custom-sections-and-ordering "</span> + + <span class="s2">"for more info."</span> + + <span class="p">)</span> +</code></pre></div> + +</details> +<hr /> +<h4 id="ancestors-in-mro_11">Ancestors (in MRO)</h4> +<ul> +<li>isort.exceptions.ISortError</li> +<li>builtins.Exception</li> +<li>builtins.BaseException</li> +</ul> +<h4 id="class-variables_11">Class variables</h4> +<div class="codehilite"><pre><span></span><code><span class="n">args</span> +</code></pre></div> + +<h4 id="methods_11">Methods</h4> +<h4 id="with_traceback_11">with_traceback</h4> +<div class="codehilite"><pre><span></span><code><span class="k">def</span> <span class="nf">with_traceback</span><span class="p">(</span> + <span class="o">...</span> +<span class="p">)</span> +</code></pre></div> + +<p>Exception.with_traceback(tb) --</p> +<p>set self.<strong>traceback</strong> to tb and return self.</p> +<h3 id="profiledoesnotexist">ProfileDoesNotExist</h3> +<div class="codehilite"><pre><span></span><code><span class="k">class</span> <span class="nc">ProfileDoesNotExist</span><span class="p">(</span> + <span class="n">profile</span><span class="p">:</span> <span class="nb">str</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">ProfileDoesNotExist</span>(<span class="n">ISortError</span>): + + <span class="s">"""Raised when a profile is set by the user that doesn't exist"""</span> + + <span class="n">def</span> <span class="n">__init__</span>(<span class="nb">self</span>, <span class="n">profile:</span> <span class="n">str</span>): + + <span class="n">super</span>().<span class="n">__init__</span>( + + <span class="nb">f</span><span class="s">"Specified profile of {profile} does not exist. "</span> + + <span class="nb">f</span><span class="s">"Available profiles: {','.join(profiles)}."</span> + + ) + + <span class="nb">self</span>.<span class="n">profile</span> = <span class="n">profile</span> +</code></pre></div> + +</details> +<hr /> +<h4 id="ancestors-in-mro_12">Ancestors (in MRO)</h4> +<ul> +<li>isort.exceptions.ISortError</li> +<li>builtins.Exception</li> +<li>builtins.BaseException</li> +</ul> +<h4 id="class-variables_12">Class variables</h4> +<div class="codehilite"><pre><span></span><code><span class="n">args</span> +</code></pre></div> + +<h4 id="methods_12">Methods</h4> +<h4 id="with_traceback_12">with_traceback</h4> +<div class="codehilite"><pre><span></span><code><span class="k">def</span> <span class="nf">with_traceback</span><span class="p">(</span> + <span class="o">...</span> +<span class="p">)</span> +</code></pre></div> + +<p>Exception.with_traceback(tb) --</p> +<p>set self.<strong>traceback</strong> to tb and return self.</p> +<h3 id="unsupportedencoding">UnsupportedEncoding</h3> +<div class="codehilite"><pre><span></span><code><span class="k">class</span> <span class="nc">UnsupportedEncoding</span><span class="p">(</span> + <span class="n">filename</span><span class="p">:</span> <span class="n">Union</span><span class="p">[</span><span class="nb">str</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="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">UnsupportedEncoding</span>(<span class="n">ISortError</span>): + + <span class="s">"""Raised when isort encounters an encoding error while trying to read a file"""</span> + + <span class="n">def</span> <span class="n">__init__</span>(<span class="nb">self</span>, <span class="n">filename:</span> <span class="n">Union</span>[<span class="n">str</span>, <span class="n">Path</span>]): + + <span class="n">super</span>().<span class="n">__init__</span>(<span class="nb">f</span><span class="s">"Unknown or unsupported encoding in {filename}"</span>) + + <span class="nb">self</span>.<span class="nb">filename</span> = <span class="nb">filename</span> +</code></pre></div> + +</details> +<hr /> +<h4 id="ancestors-in-mro_13">Ancestors (in MRO)</h4> +<ul> +<li>isort.exceptions.ISortError</li> +<li>builtins.Exception</li> +<li>builtins.BaseException</li> +</ul> +<h4 id="class-variables_13">Class variables</h4> +<div class="codehilite"><pre><span></span><code><span class="n">args</span> +</code></pre></div> + +<h4 id="methods_13">Methods</h4> +<h4 id="with_traceback_13">with_traceback</h4> +<div class="codehilite"><pre><span></span><code><span class="k">def</span> <span class="nf">with_traceback</span><span class="p">(</span> + <span class="o">...</span> +<span class="p">)</span> +</code></pre></div> + +<p>Exception.with_traceback(tb) --</p> +<p>set self.<strong>traceback</strong> to tb and return self.</p> +<h3 id="unsupportedsettings">UnsupportedSettings</h3> +<div class="codehilite"><pre><span></span><code><span class="k">class</span> <span class="nc">UnsupportedSettings</span><span class="p">(</span> + <span class="n">unsupported_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">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="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="w"> </span><span class="n">UnsupportedSettings</span><span class="p">(</span><span class="n">ISortError</span><span class="p">)</span><span class="err">:</span><span class="w"></span> + +<span class="w"> </span><span class="ss">"""Raised when settings are passed into isort (either from config, CLI, or runtime)</span> + +<span class="ss"> that it doesn't support.</span> + +<span class="ss"> """</span><span class="w"></span> + +<span class="w"> </span><span class="nv">@staticmethod</span><span class="w"></span> + +<span class="w"> </span><span class="n">def</span><span class="w"> </span><span class="n">_format_option</span><span class="p">(</span><span class="nl">name</span><span class="p">:</span><span class="w"> </span><span class="nf">str</span><span class="p">,</span><span class="w"> </span><span class="k">value</span><span class="err">:</span><span class="w"> </span><span class="ow">Any</span><span class="p">,</span><span class="w"> </span><span class="nl">source</span><span class="p">:</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="nf">str</span><span class="err">:</span><span class="w"></span> + +<span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="n">f</span><span class="ss">"\t- {name} = {value} (source: '{source}')"</span><span class="w"></span> + +<span class="w"> </span><span class="n">def</span><span class="w"> </span><span class="n">__init__</span><span class="p">(</span><span class="n">self</span><span class="p">,</span><span class="w"> </span><span class="nl">unsupported_settings</span><span class="p">:</span><span class="w"> </span><span class="n">Dict</span><span class="o">[</span><span class="n">str, Dict[str, str</span><span class="o">]</span><span class="err">]</span><span class="p">)</span><span class="err">:</span><span class="w"></span> + +<span class="w"> </span><span class="n">errors</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="ss">"\n"</span><span class="p">.</span><span class="k">join</span><span class="p">(</span><span class="w"></span> + +<span class="w"> </span><span class="n">self</span><span class="p">.</span><span class="n">_format_option</span><span class="p">(</span><span class="n">name</span><span class="p">,</span><span class="w"> </span><span class="o">**</span><span class="k">option</span><span class="p">)</span><span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="n">name</span><span class="p">,</span><span class="w"> </span><span class="k">option</span><span class="w"> </span><span class="ow">in</span><span class="w"> </span><span class="n">unsupported_settings</span><span class="p">.</span><span class="n">items</span><span class="p">()</span><span class="w"></span> + +<span class="w"> </span><span class="p">)</span><span class="w"></span> + +<span class="w"> </span><span class="n">super</span><span class="p">().</span><span class="n">__init__</span><span class="p">(</span><span class="w"></span> + +<span class="w"> </span><span class="ss">"isort was provided settings that it doesn't support:\n\n"</span><span class="w"></span> + +<span class="w"> </span><span class="n">f</span><span class="ss">"{errors}\n\n"</span><span class="w"></span> + +<span class="w"> </span><span class="ss">"For a complete and up-to-date listing of supported settings see: "</span><span class="w"></span> + +<span class="w"> </span><span class="ss">"https://pycqa.github.io/isort/docs/configuration/options/.\n"</span><span class="w"></span> + +<span class="w"> </span><span class="p">)</span><span class="w"></span> + +<span class="w"> </span><span class="n">self</span><span class="p">.</span><span class="n">unsupported_settings</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">unsupported_settings</span><span class="w"></span> +</code></pre></div> + +</details> +<hr /> +<h4 id="ancestors-in-mro_14">Ancestors (in MRO)</h4> +<ul> +<li>isort.exceptions.ISortError</li> +<li>builtins.Exception</li> +<li>builtins.BaseException</li> +</ul> +<h4 id="class-variables_14">Class variables</h4> +<div class="codehilite"><pre><span></span><code><span class="n">args</span> +</code></pre></div> + +<h4 id="methods_14">Methods</h4> +<h4 id="with_traceback_14">with_traceback</h4> +<div class="codehilite"><pre><span></span><code><span class="k">def</span> <span class="nf">with_traceback</span><span class="p">(</span> + <span class="o">...</span> +<span class="p">)</span> +</code></pre></div> + +<p>Exception.with_traceback(tb) --</p> +<p>set self.<strong>traceback</strong> to tb and return self.</p> + + + + + + + + </article> + </div> + </div> + + </main> + + +<footer class="md-footer"> + + <div class="md-footer-nav"> + <nav class="md-footer-nav__inner md-grid"> + + <a href="core.html" title="Core" 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> + Core + </span> + </div> + </a> + + + <a href="files.html" title="Files" 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> + Files + </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.b0710199.min.js", "version": null}</script> + + + <script src="../../assets/javascripts/bundle.76f349be.min.js"></script> + + + </body> +</html>
\ No newline at end of file |