diff options
Diffstat (limited to 'reference/isort/deprecated/finders/index.html')
| -rw-r--r-- | reference/isort/deprecated/finders/index.html | 4018 |
1 files changed, 4018 insertions, 0 deletions
diff --git a/reference/isort/deprecated/finders/index.html b/reference/isort/deprecated/finders/index.html new file mode 100644 index 00000000..626ab411 --- /dev/null +++ b/reference/isort/deprecated/finders/index.html @@ -0,0 +1,4018 @@ + +<!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.2, mkdocs-material-7.2.2"> + + + + <title>Finders - isort</title> + + + + <link rel="stylesheet" href="../../../../assets/stylesheets/main.1118c9be.min.css"> + + + <link rel="stylesheet" href="../../../../assets/stylesheets/palette.ba0d045b.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-isortdeprecatedfinders" 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="../../../.." 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"> + + Finders + + </span> + </div> + </div> + </div> + + + + <label class="md-header__button md-icon" for="__search"> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg> + </label> + +<div class="md-search" data-md-component="search" role="dialog"> + <label class="md-search__overlay" for="__search"></label> + <div class="md-search__inner" role="search"> + <form class="md-search__form" name="search"> + <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required> + <label class="md-search__icon md-icon" for="__search"> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg> + </label> + <nav class="md-search__options" aria-label="Search"> + + <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1"> + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg> + </button> + </nav> + + </form> + <div class="md-search__output"> + <div class="md-search__scrollwrap" data-md-scrollfix> + <div class="md-search-result" data-md-component="search-result"> + <div class="md-search-result__meta"> + Initializing search + </div> + <ol class="md-search-result__list"></ol> + </div> + </div> + </div> + </div> +</div> + + + <div class="md-header__source"> + +<a href="https://github.com/timothycrosley/isort/" title="Go to repository" class="md-source" data-md-component="source"> + <div class="md-source__icon md-icon"> + + <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg> + </div> + <div class="md-source__repository"> + isort + </div> +</a> + </div> + + </nav> +</header> + + <div class="md-container" data-md-component="container"> + + + + + <main class="md-main" data-md-component="main"> + <div class="md-main__inner md-grid"> + + + + <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" > + <div class="md-sidebar__scrollwrap"> + <div class="md-sidebar__inner"> + + + +<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0"> + <label class="md-nav__title" for="__drawer"> + <a href="../../../.." 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="../../../.." class="md-nav__link"> + Home + </a> + </li> + + + + + + + + + + + <li class="md-nav__item"> + <a href="../../../../CHANGELOG/" 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/" class="md-nav__link"> + Action Comments + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../../../../docs/configuration/add_or_remove_imports/" class="md-nav__link"> + Add Or Remove Imports + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../../../../docs/configuration/black_compatibility/" class="md-nav__link"> + Black Compatibility + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../../../../docs/configuration/config_files/" class="md-nav__link"> + Config Files + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../../../../docs/configuration/custom_sections_and_ordering/" class="md-nav__link"> + Custom Sections And Ordering + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../../../../docs/configuration/git_hook/" class="md-nav__link"> + Git Hook + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../../../../docs/configuration/github_action/" class="md-nav__link"> + Github Action + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../../../../docs/configuration/multi_line_output_modes/" class="md-nav__link"> + Multi Line Output Modes + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../../../../docs/configuration/options/" class="md-nav__link"> + Options + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../../../../docs/configuration/pre-commit/" class="md-nav__link"> + Pre Commit + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../../../../docs/configuration/profiles/" class="md-nav__link"> + Profiles + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../../../../docs/configuration/setuptools_integration/" 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/" class="md-nav__link"> + 1. Contributing Guide + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../../../../docs/contributing/2.-coding-standard/" class="md-nav__link"> + 2. Coding Standard + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../../../../docs/contributing/3.-code-of-conduct/" class="md-nav__link"> + 3. Code Of Conduct + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../../../../docs/contributing/4.-acknowledgements/" 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/" class="md-nav__link"> + Introducing Isort 5 + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../../../../docs/major_releases/release_policy/" 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/" class="md-nav__link"> + 0. Try + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../../../../docs/quick_start/1.-install/" class="md-nav__link"> + 1. Install + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../../../../docs/quick_start/2.-cli/" class="md-nav__link"> + 2. Cli + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../../../../docs/quick_start/3.-api/" 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/" 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/" 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/" class="md-nav__link"> + API + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../../comments/" class="md-nav__link"> + Comments + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../../core/" class="md-nav__link"> + Core + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../../exceptions/" class="md-nav__link"> + Exceptions + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../../files/" class="md-nav__link"> + Files + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../../format/" class="md-nav__link"> + Format + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../../hooks/" class="md-nav__link"> + Hooks + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../../identify/" class="md-nav__link"> + Identify + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../../" class="md-nav__link"> + Index + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../../io/" class="md-nav__link"> + Io + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../../literal/" class="md-nav__link"> + Literal + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../../logo/" class="md-nav__link"> + Logo + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../../main/" class="md-nav__link"> + Main + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../../output/" class="md-nav__link"> + Output + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../../parse/" class="md-nav__link"> + Parse + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../../place/" class="md-nav__link"> + Place + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../../profiles/" class="md-nav__link"> + Profiles + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../../pylama_isort/" class="md-nav__link"> + Pylama Isort + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../../sections/" class="md-nav__link"> + Sections + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../../settings/" class="md-nav__link"> + Settings + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../../setuptools_commands/" class="md-nav__link"> + Setuptools Commands + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../../sorting/" class="md-nav__link"> + Sorting + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../../utils/" class="md-nav__link"> + Utils + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../../wrap/" class="md-nav__link"> + Wrap + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../../wrap_modes/" class="md-nav__link"> + Wrap Modes + </a> + </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_1_26" type="checkbox" id="__nav_9_1_26" checked> + + <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 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"> + Finders + <span class="md-nav__icon md-icon"></span> + </label> + + <a href="./" class="md-nav__link md-nav__link--active"> + Finders + </a> + + +<nav class="md-nav md-nav--secondary" aria-label="Table of contents"> + + + + + + + <label class="md-nav__title" for="__toc"> + <span class="md-nav__icon md-icon"></span> + Table of contents + </label> + <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix> + + <li class="md-nav__item"> + <a href="#variables" class="md-nav__link"> + Variables + </a> + +</li> + + <li class="md-nav__item"> + <a href="#functions" class="md-nav__link"> + Functions + </a> + + <nav class="md-nav" aria-label="Functions"> + <ul class="md-nav__list"> + + <li class="md-nav__item"> + <a href="#chdir" class="md-nav__link"> + chdir + </a> + +</li> + + </ul> + </nav> + +</li> + + <li class="md-nav__item"> + <a href="#classes" class="md-nav__link"> + Classes + </a> + + <nav class="md-nav" aria-label="Classes"> + <ul class="md-nav__list"> + + <li class="md-nav__item"> + <a href="#basefinder" class="md-nav__link"> + BaseFinder + </a> + + <nav class="md-nav" aria-label="BaseFinder"> + <ul class="md-nav__list"> + + <li class="md-nav__item"> + <a href="#descendants" class="md-nav__link"> + Descendants + </a> + +</li> + + <li class="md-nav__item"> + <a href="#methods" class="md-nav__link"> + Methods + </a> + +</li> + + <li class="md-nav__item"> + <a href="#find" class="md-nav__link"> + find + </a> + +</li> + + </ul> + </nav> + +</li> + + <li class="md-nav__item"> + <a href="#defaultfinder" class="md-nav__link"> + DefaultFinder + </a> + + <nav class="md-nav" aria-label="DefaultFinder"> + <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="#methods_1" class="md-nav__link"> + Methods + </a> + +</li> + + <li class="md-nav__item"> + <a href="#find_1" class="md-nav__link"> + find + </a> + +</li> + + </ul> + </nav> + +</li> + + <li class="md-nav__item"> + <a href="#findersmanager" class="md-nav__link"> + FindersManager + </a> + + <nav class="md-nav" aria-label="FindersManager"> + <ul class="md-nav__list"> + + <li class="md-nav__item"> + <a href="#methods_2" class="md-nav__link"> + Methods + </a> + +</li> + + <li class="md-nav__item"> + <a href="#find_2" class="md-nav__link"> + find + </a> + +</li> + + </ul> + </nav> + +</li> + + <li class="md-nav__item"> + <a href="#forcedseparatefinder" class="md-nav__link"> + ForcedSeparateFinder + </a> + + <nav class="md-nav" aria-label="ForcedSeparateFinder"> + <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="#methods_3" class="md-nav__link"> + Methods + </a> + +</li> + + <li class="md-nav__item"> + <a href="#find_3" class="md-nav__link"> + find + </a> + +</li> + + </ul> + </nav> + +</li> + + <li class="md-nav__item"> + <a href="#knownpatternfinder" class="md-nav__link"> + KnownPatternFinder + </a> + + <nav class="md-nav" aria-label="KnownPatternFinder"> + <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="#methods_4" class="md-nav__link"> + Methods + </a> + +</li> + + <li class="md-nav__item"> + <a href="#find_4" class="md-nav__link"> + find + </a> + +</li> + + </ul> + </nav> + +</li> + + <li class="md-nav__item"> + <a href="#localfinder" class="md-nav__link"> + LocalFinder + </a> + + <nav class="md-nav" aria-label="LocalFinder"> + <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="#methods_5" class="md-nav__link"> + Methods + </a> + +</li> + + <li class="md-nav__item"> + <a href="#find_5" class="md-nav__link"> + find + </a> + +</li> + + </ul> + </nav> + +</li> + + <li class="md-nav__item"> + <a href="#pathfinder" class="md-nav__link"> + PathFinder + </a> + + <nav class="md-nav" aria-label="PathFinder"> + <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="#methods_6" class="md-nav__link"> + Methods + </a> + +</li> + + <li class="md-nav__item"> + <a href="#find_6" class="md-nav__link"> + find + </a> + +</li> + + </ul> + </nav> + +</li> + + <li class="md-nav__item"> + <a href="#pipfilefinder" class="md-nav__link"> + PipfileFinder + </a> + + <nav class="md-nav" aria-label="PipfileFinder"> + <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" 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="#find_7" class="md-nav__link"> + find + </a> + +</li> + + </ul> + </nav> + +</li> + + <li class="md-nav__item"> + <a href="#reqsbasefinder" class="md-nav__link"> + ReqsBaseFinder + </a> + + <nav class="md-nav" aria-label="ReqsBaseFinder"> + <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_1" 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="#find_8" class="md-nav__link"> + find + </a> + +</li> + + </ul> + </nav> + +</li> + + <li class="md-nav__item"> + <a href="#requirementsfinder" class="md-nav__link"> + RequirementsFinder + </a> + + <nav class="md-nav" aria-label="RequirementsFinder"> + <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_2" 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="#find_9" class="md-nav__link"> + find + </a> + +</li> + + </ul> + </nav> + +</li> + + </ul> + </nav> + +</li> + + </ul> + +</nav> + + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../" 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/" class="md-nav__link"> + All + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../../stdlibs/" class="md-nav__link"> + Index + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../../stdlibs/py2/" class="md-nav__link"> + Py2 + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../../stdlibs/py27/" class="md-nav__link"> + Py27 + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../../stdlibs/py3/" class="md-nav__link"> + Py3 + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../../stdlibs/py35/" class="md-nav__link"> + Py35 + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../../stdlibs/py36/" class="md-nav__link"> + Py36 + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../../stdlibs/py37/" class="md-nav__link"> + Py37 + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../../stdlibs/py38/" class="md-nav__link"> + Py38 + </a> + </li> + + + + + + + + <li class="md-nav__item"> + <a href="../../stdlibs/py39/" class="md-nav__link"> + Py39 + </a> + </li> + + + + </ul> + </nav> + </li> + + + + </ul> + </nav> + </li> + + + + </ul> + </nav> + </li> + + + + </ul> +</nav> + </div> + </div> + </div> + + + + <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" > + <div class="md-sidebar__scrollwrap"> + <div class="md-sidebar__inner"> + +<nav class="md-nav md-nav--secondary" aria-label="Table of contents"> + + + + + + + <label class="md-nav__title" for="__toc"> + <span class="md-nav__icon md-icon"></span> + Table of contents + </label> + <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix> + + <li class="md-nav__item"> + <a href="#variables" class="md-nav__link"> + Variables + </a> + +</li> + + <li class="md-nav__item"> + <a href="#functions" class="md-nav__link"> + Functions + </a> + + <nav class="md-nav" aria-label="Functions"> + <ul class="md-nav__list"> + + <li class="md-nav__item"> + <a href="#chdir" class="md-nav__link"> + chdir + </a> + +</li> + + </ul> + </nav> + +</li> + + <li class="md-nav__item"> + <a href="#classes" class="md-nav__link"> + Classes + </a> + + <nav class="md-nav" aria-label="Classes"> + <ul class="md-nav__list"> + + <li class="md-nav__item"> + <a href="#basefinder" class="md-nav__link"> + BaseFinder + </a> + + <nav class="md-nav" aria-label="BaseFinder"> + <ul class="md-nav__list"> + + <li class="md-nav__item"> + <a href="#descendants" class="md-nav__link"> + Descendants + </a> + +</li> + + <li class="md-nav__item"> + <a href="#methods" class="md-nav__link"> + Methods + </a> + +</li> + + <li class="md-nav__item"> + <a href="#find" class="md-nav__link"> + find + </a> + +</li> + + </ul> + </nav> + +</li> + + <li class="md-nav__item"> + <a href="#defaultfinder" class="md-nav__link"> + DefaultFinder + </a> + + <nav class="md-nav" aria-label="DefaultFinder"> + <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="#methods_1" class="md-nav__link"> + Methods + </a> + +</li> + + <li class="md-nav__item"> + <a href="#find_1" class="md-nav__link"> + find + </a> + +</li> + + </ul> + </nav> + +</li> + + <li class="md-nav__item"> + <a href="#findersmanager" class="md-nav__link"> + FindersManager + </a> + + <nav class="md-nav" aria-label="FindersManager"> + <ul class="md-nav__list"> + + <li class="md-nav__item"> + <a href="#methods_2" class="md-nav__link"> + Methods + </a> + +</li> + + <li class="md-nav__item"> + <a href="#find_2" class="md-nav__link"> + find + </a> + +</li> + + </ul> + </nav> + +</li> + + <li class="md-nav__item"> + <a href="#forcedseparatefinder" class="md-nav__link"> + ForcedSeparateFinder + </a> + + <nav class="md-nav" aria-label="ForcedSeparateFinder"> + <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="#methods_3" class="md-nav__link"> + Methods + </a> + +</li> + + <li class="md-nav__item"> + <a href="#find_3" class="md-nav__link"> + find + </a> + +</li> + + </ul> + </nav> + +</li> + + <li class="md-nav__item"> + <a href="#knownpatternfinder" class="md-nav__link"> + KnownPatternFinder + </a> + + <nav class="md-nav" aria-label="KnownPatternFinder"> + <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="#methods_4" class="md-nav__link"> + Methods + </a> + +</li> + + <li class="md-nav__item"> + <a href="#find_4" class="md-nav__link"> + find + </a> + +</li> + + </ul> + </nav> + +</li> + + <li class="md-nav__item"> + <a href="#localfinder" class="md-nav__link"> + LocalFinder + </a> + + <nav class="md-nav" aria-label="LocalFinder"> + <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="#methods_5" class="md-nav__link"> + Methods + </a> + +</li> + + <li class="md-nav__item"> + <a href="#find_5" class="md-nav__link"> + find + </a> + +</li> + + </ul> + </nav> + +</li> + + <li class="md-nav__item"> + <a href="#pathfinder" class="md-nav__link"> + PathFinder + </a> + + <nav class="md-nav" aria-label="PathFinder"> + <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="#methods_6" class="md-nav__link"> + Methods + </a> + +</li> + + <li class="md-nav__item"> + <a href="#find_6" class="md-nav__link"> + find + </a> + +</li> + + </ul> + </nav> + +</li> + + <li class="md-nav__item"> + <a href="#pipfilefinder" class="md-nav__link"> + PipfileFinder + </a> + + <nav class="md-nav" aria-label="PipfileFinder"> + <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" 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="#find_7" class="md-nav__link"> + find + </a> + +</li> + + </ul> + </nav> + +</li> + + <li class="md-nav__item"> + <a href="#reqsbasefinder" class="md-nav__link"> + ReqsBaseFinder + </a> + + <nav class="md-nav" aria-label="ReqsBaseFinder"> + <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_1" 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="#find_8" class="md-nav__link"> + find + </a> + +</li> + + </ul> + </nav> + +</li> + + <li class="md-nav__item"> + <a href="#requirementsfinder" class="md-nav__link"> + RequirementsFinder + </a> + + <nav class="md-nav" aria-label="RequirementsFinder"> + <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_2" 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="#find_9" class="md-nav__link"> + find + </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/deprecated/finders.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-isortdeprecatedfinders">Module isort.deprecated.finders</h1> +<p>Finders try to find right section for passed module name</p> +<p>None</p> +<details class="example"><summary>View Source</summary><div class="codehilite"><pre><span></span><code><span class="s2">"""Finders try to find right section for passed module name"""</span> + +<span class="s s-Atom">import</span> <span class="s s-Atom">importlib</span><span class="p">.</span><span class="s s-Atom">machinery</span> + +<span class="s s-Atom">import</span> <span class="s s-Atom">inspect</span> + +<span class="s s-Atom">import</span> <span class="s s-Atom">os</span> + +<span class="s s-Atom">import</span> <span class="s s-Atom">os</span><span class="p">.</span><span class="s s-Atom">path</span> + +<span class="s s-Atom">import</span> <span class="s s-Atom">re</span> + +<span class="s s-Atom">import</span> <span class="s s-Atom">sys</span> + +<span class="s s-Atom">import</span> <span class="s s-Atom">sysconfig</span> + +<span class="s s-Atom">from</span> <span class="s s-Atom">abc</span> <span class="s s-Atom">import</span> <span class="nv">ABCMeta</span><span class="p">,</span> <span class="s s-Atom">abstractmethod</span> + +<span class="s s-Atom">from</span> <span class="s s-Atom">contextlib</span> <span class="s s-Atom">import</span> <span class="s s-Atom">contextmanager</span> + +<span class="s s-Atom">from</span> <span class="s s-Atom">fnmatch</span> <span class="s s-Atom">import</span> <span class="s s-Atom">fnmatch</span> + +<span class="s s-Atom">from</span> <span class="s s-Atom">functools</span> <span class="s s-Atom">import</span> <span class="s s-Atom">lru_cache</span> + +<span class="s s-Atom">from</span> <span class="s s-Atom">glob</span> <span class="s s-Atom">import</span> <span class="s s-Atom">glob</span> + +<span class="s s-Atom">from</span> <span class="s s-Atom">pathlib</span> <span class="s s-Atom">import</span> <span class="nv">Path</span> + +<span class="s s-Atom">from</span> <span class="s s-Atom">typing</span> <span class="s s-Atom">import</span> <span class="nv">Dict</span><span class="p">,</span> <span class="nv">Iterable</span><span class="p">,</span> <span class="nv">Iterator</span><span class="p">,</span> <span class="nv">List</span><span class="p">,</span> <span class="nv">Optional</span><span class="p">,</span> <span class="nv">Pattern</span><span class="p">,</span> <span class="nv">Sequence</span><span class="p">,</span> <span class="nv">Tuple</span><span class="p">,</span> <span class="nv">Type</span> + +<span class="s s-Atom">from</span> <span class="s s-Atom">isort</span> <span class="s s-Atom">import</span> <span class="s s-Atom">sections</span> + +<span class="s s-Atom">from</span> <span class="s s-Atom">isort</span><span class="p">.</span><span class="s s-Atom">settings</span> <span class="s s-Atom">import</span> <span class="nv">KNOWN_SECTION_MAPPING</span><span class="p">,</span> <span class="nv">Config</span> + +<span class="s s-Atom">from</span> <span class="s s-Atom">isort</span><span class="p">.</span><span class="s s-Atom">utils</span> <span class="s s-Atom">import</span> <span class="s s-Atom">exists_case_sensitive</span> + +<span class="nn">try</span><span class="p">:</span> + + <span class="s s-Atom">from</span> <span class="s s-Atom">pipreqs</span> <span class="s s-Atom">import</span> <span class="s s-Atom">pipreqs</span> <span class="s s-Atom">#</span> <span class="nn">type</span><span class="p">:</span> <span class="s s-Atom">ignore</span> + +<span class="s s-Atom">except</span> <span class="nv">ImportError</span><span class="s s-Atom">:</span> + + <span class="s s-Atom">pipreqs</span> <span class="o">=</span> <span class="nv">None</span> + +<span class="nn">try</span><span class="p">:</span> + + <span class="s s-Atom">from</span> <span class="s s-Atom">pip_api</span> <span class="s s-Atom">import</span> <span class="s s-Atom">parse_requirements</span> <span class="s s-Atom">#</span> <span class="nn">type</span><span class="p">:</span> <span class="s s-Atom">ignore</span> + +<span class="s s-Atom">except</span> <span class="nv">ImportError</span><span class="s s-Atom">:</span> + + <span class="s s-Atom">parse_requirements</span> <span class="o">=</span> <span class="nv">None</span> + +<span class="nn">try</span><span class="p">:</span> + + <span class="s s-Atom">from</span> <span class="s s-Atom">requirementslib</span> <span class="s s-Atom">import</span> <span class="nv">Pipfile</span> <span class="s s-Atom">#</span> <span class="nn">type</span><span class="p">:</span> <span class="s s-Atom">ignore</span> + +<span class="s s-Atom">except</span> <span class="nv">ImportError</span><span class="s s-Atom">:</span> + + <span class="nv">Pipfile</span> <span class="o">=</span> <span class="nv">None</span> + +<span class="s s-Atom">@contextmanager</span> + +<span class="s s-Atom">def</span> <span class="nf">chdir</span><span class="p">(</span><span class="nn">path</span><span class="p">:</span> <span class="s s-Atom">str</span><span class="p">)</span> <span class="s s-Atom">-></span> <span class="nv">Iterator</span><span class="p">[</span><span class="nv">None</span><span class="p">]</span><span class="s s-Atom">:</span> + + <span class="s2">"""Context manager for changing dir and restoring previous workdir after exit."""</span> + + <span class="s s-Atom">curdir</span> <span class="o">=</span> <span class="s s-Atom">os</span><span class="p">.</span><span class="nf">getcwd</span><span class="p">()</span> + + <span class="s s-Atom">os</span><span class="p">.</span><span class="nf">chdir</span><span class="p">(</span><span class="s s-Atom">path</span><span class="p">)</span> + + <span class="nn">try</span><span class="p">:</span> + + <span class="s s-Atom">yield</span> + + <span class="nn">finally</span><span class="p">:</span> + + <span class="s s-Atom">os</span><span class="p">.</span><span class="nf">chdir</span><span class="p">(</span><span class="s s-Atom">curdir</span><span class="p">)</span> + +<span class="s s-Atom">class</span> <span class="nv">BaseFinder</span><span class="p">(</span><span class="s s-Atom">metaclass</span><span class="o">=</span><span class="nv">ABCMeta</span><span class="p">)</span><span class="s s-Atom">:</span> + + <span class="s s-Atom">def</span> <span class="k">__</span><span class="nf">init__</span><span class="p">(</span><span class="s s-Atom">self</span><span class="p">,</span> <span class="nn">config</span><span class="p">:</span> <span class="nv">Config</span><span class="p">)</span> <span class="s s-Atom">-></span> <span class="nv">None</span><span class="s s-Atom">:</span> + + <span class="s s-Atom">self</span><span class="p">.</span><span class="s s-Atom">config</span> <span class="o">=</span> <span class="s s-Atom">config</span> + + <span class="s s-Atom">@abstractmethod</span> + + <span class="s s-Atom">def</span> <span class="nf">find</span><span class="p">(</span><span class="s s-Atom">self</span><span class="p">,</span> <span class="s s-Atom">module_name:</span> <span class="s s-Atom">str</span><span class="p">)</span> <span class="s s-Atom">-></span> <span class="nv">Optional</span><span class="p">[</span><span class="s s-Atom">str</span><span class="p">]</span><span class="s s-Atom">:</span> + + <span class="s s-Atom">raise</span> <span class="nv">NotImplementedError</span> + +<span class="s s-Atom">class</span> <span class="nv">ForcedSeparateFinder</span><span class="p">(</span><span class="nv">BaseFinder</span><span class="p">)</span><span class="s s-Atom">:</span> + + <span class="s s-Atom">def</span> <span class="nf">find</span><span class="p">(</span><span class="s s-Atom">self</span><span class="p">,</span> <span class="s s-Atom">module_name:</span> <span class="s s-Atom">str</span><span class="p">)</span> <span class="s s-Atom">-></span> <span class="nv">Optional</span><span class="p">[</span><span class="s s-Atom">str</span><span class="p">]</span><span class="s s-Atom">:</span> + + <span class="s s-Atom">for</span> <span class="s s-Atom">forced_separate</span> <span class="s s-Atom">in</span> <span class="s s-Atom">self</span><span class="p">.</span><span class="s s-Atom">config</span><span class="p">.</span><span class="s s-Atom">forced_separate:</span> + + <span class="s s-Atom">#</span> <span class="nv">Ensure</span> <span class="s s-Atom">all</span> <span class="s s-Atom">forced_separate</span> <span class="s s-Atom">patterns</span> <span class="s s-Atom">will</span> <span class="s s-Atom">match</span> <span class="s s-Atom">to</span> <span class="s s-Atom">end</span> <span class="s s-Atom">of</span> <span class="s s-Atom">string</span> + + <span class="s s-Atom">path_glob</span> <span class="o">=</span> <span class="s s-Atom">forced_separate</span> + + <span class="s s-Atom">if</span> <span class="o">not</span> <span class="s s-Atom">forced_separate</span><span class="p">.</span><span class="nf">endswith</span><span class="p">(</span><span class="s2">"*"</span><span class="p">)</span><span class="s s-Atom">:</span> + + <span class="s s-Atom">path_glob</span> <span class="o">=</span> <span class="s2">"%s*"</span> <span class="c1">% forced_separate</span> + + <span class="s s-Atom">if</span> <span class="nf">fnmatch</span><span class="p">(</span><span class="s s-Atom">module_name</span><span class="p">,</span> <span class="s s-Atom">path_glob</span><span class="p">)</span> <span class="s s-Atom">or</span> <span class="nf">fnmatch</span><span class="p">(</span><span class="s s-Atom">module_name</span><span class="p">,</span> <span class="s2">"."</span> <span class="o">+</span> <span class="s s-Atom">path_glob</span><span class="p">)</span><span class="s s-Atom">:</span> + + <span class="s s-Atom">return</span> <span class="s s-Atom">forced_separate</span> + + <span class="s s-Atom">return</span> <span class="nv">None</span> + +<span class="s s-Atom">class</span> <span class="nv">LocalFinder</span><span class="p">(</span><span class="nv">BaseFinder</span><span class="p">)</span><span class="s s-Atom">:</span> + + <span class="s s-Atom">def</span> <span class="nf">find</span><span class="p">(</span><span class="s s-Atom">self</span><span class="p">,</span> <span class="s s-Atom">module_name:</span> <span class="s s-Atom">str</span><span class="p">)</span> <span class="s s-Atom">-></span> <span class="nv">Optional</span><span class="p">[</span><span class="s s-Atom">str</span><span class="p">]</span><span class="s s-Atom">:</span> + + <span class="s s-Atom">if</span> <span class="s s-Atom">module_name</span><span class="p">.</span><span class="nf">startswith</span><span class="p">(</span><span class="s2">"."</span><span class="p">)</span><span class="s s-Atom">:</span> + + <span class="s s-Atom">return</span> <span class="s2">"LOCALFOLDER"</span> + + <span class="s s-Atom">return</span> <span class="nv">None</span> + +<span class="s s-Atom">class</span> <span class="nv">KnownPatternFinder</span><span class="p">(</span><span class="nv">BaseFinder</span><span class="p">)</span><span class="s s-Atom">:</span> + + <span class="s s-Atom">def</span> <span class="k">__</span><span class="nf">init__</span><span class="p">(</span><span class="s s-Atom">self</span><span class="p">,</span> <span class="nn">config</span><span class="p">:</span> <span class="nv">Config</span><span class="p">)</span> <span class="s s-Atom">-></span> <span class="nv">None</span><span class="s s-Atom">:</span> + + <span class="nf">super</span><span class="p">().</span><span class="k">__</span><span class="nf">init__</span><span class="p">(</span><span class="s s-Atom">config</span><span class="p">)</span> + + <span class="s s-Atom">self</span><span class="p">.</span><span class="s s-Atom">known_patterns:</span> <span class="nv">List</span><span class="p">[</span><span class="nv">Tuple</span><span class="p">[</span><span class="nv">Pattern</span><span class="p">[</span><span class="s s-Atom">str</span><span class="p">],</span> <span class="s s-Atom">str</span><span class="p">]]</span> <span class="o">=</span> <span class="p">[]</span> + + <span class="s s-Atom">for</span> <span class="s s-Atom">placement</span> <span class="s s-Atom">in</span> <span class="nf">reversed</span><span class="p">(</span><span class="s s-Atom">config</span><span class="p">.</span><span class="s s-Atom">sections</span><span class="p">)</span><span class="s s-Atom">:</span> + + <span class="s s-Atom">known_placement</span> <span class="o">=</span> <span class="nv">KNOWN_SECTION_MAPPING</span><span class="p">.</span><span class="nf">get</span><span class="p">(</span><span class="s s-Atom">placement</span><span class="p">,</span> <span class="s s-Atom">placement</span><span class="p">).</span><span class="nf">lower</span><span class="p">()</span> + + <span class="s s-Atom">config_key</span> <span class="o">=</span> <span class="s s-Atom">f</span><span class="s2">"known_{known_placement}"</span> + + <span class="s s-Atom">known_patterns</span> <span class="o">=</span> <span class="nf">list</span><span class="p">(</span> + + <span class="nf">getattr</span><span class="p">(</span><span class="s s-Atom">self</span><span class="p">.</span><span class="s s-Atom">config</span><span class="p">,</span> <span class="s s-Atom">config_key</span><span class="p">,</span> <span class="s s-Atom">self</span><span class="p">.</span><span class="s s-Atom">config</span><span class="p">.</span><span class="s s-Atom">known_other</span><span class="p">.</span><span class="nf">get</span><span class="p">(</span><span class="s s-Atom">known_placement</span><span class="p">,</span> <span class="p">[]))</span> + + <span class="p">)</span> + + <span class="s s-Atom">known_patterns</span> <span class="o">=</span> <span class="p">[</span> + + <span class="s s-Atom">pattern</span> + + <span class="s s-Atom">for</span> <span class="s s-Atom">known_pattern</span> <span class="s s-Atom">in</span> <span class="s s-Atom">known_patterns</span> + + <span class="s s-Atom">for</span> <span class="s s-Atom">pattern</span> <span class="s s-Atom">in</span> <span class="s s-Atom">self</span><span class="p">.</span><span class="k">_</span><span class="nf">parse_known_pattern</span><span class="p">(</span><span class="s s-Atom">known_pattern</span><span class="p">)</span> + + <span class="p">]</span> + + <span class="s s-Atom">for</span> <span class="s s-Atom">known_pattern</span> <span class="s s-Atom">in</span> <span class="s s-Atom">known_patterns:</span> + + <span class="s s-Atom">regexp</span> <span class="o">=</span> <span class="s2">"^"</span> <span class="o">+</span> <span class="s s-Atom">known_pattern</span><span class="p">.</span><span class="nf">replace</span><span class="p">(</span><span class="s2">"*"</span><span class="p">,</span> <span class="s2">".*"</span><span class="p">).</span><span class="nf">replace</span><span class="p">(</span><span class="s2">"?"</span><span class="p">,</span> <span class="s2">".?"</span><span class="p">)</span> <span class="o">+</span> <span class="s2">"$"</span> + + <span class="s s-Atom">self</span><span class="p">.</span><span class="s s-Atom">known_patterns</span><span class="p">.</span><span class="nf">append</span><span class="p">((</span><span class="s s-Atom">re</span><span class="p">.</span><span class="nf">compile</span><span class="p">(</span><span class="s s-Atom">regexp</span><span class="p">),</span> <span class="s s-Atom">placement</span><span class="p">))</span> + + <span class="s s-Atom">def</span> <span class="k">_</span><span class="nf">parse_known_pattern</span><span class="p">(</span><span class="s s-Atom">self</span><span class="p">,</span> <span class="nn">pattern</span><span class="p">:</span> <span class="s s-Atom">str</span><span class="p">)</span> <span class="s s-Atom">-></span> <span class="nv">List</span><span class="p">[</span><span class="s s-Atom">str</span><span class="p">]</span><span class="s s-Atom">:</span> + + <span class="s2">"""Expand pattern if identified as a directory and return found sub packages"""</span> + + <span class="s s-Atom">if</span> <span class="s s-Atom">pattern</span><span class="p">.</span><span class="nf">endswith</span><span class="p">(</span><span class="s s-Atom">os</span><span class="p">.</span><span class="s s-Atom">path</span><span class="p">.</span><span class="s s-Atom">sep</span><span class="p">)</span><span class="s s-Atom">:</span> + + <span class="s s-Atom">patterns</span> <span class="o">=</span> <span class="p">[</span> + + <span class="s s-Atom">filename</span> + + <span class="s s-Atom">for</span> <span class="s s-Atom">filename</span> <span class="s s-Atom">in</span> <span class="s s-Atom">os</span><span class="p">.</span><span class="nf">listdir</span><span class="p">(</span><span class="s s-Atom">os</span><span class="p">.</span><span class="s s-Atom">path</span><span class="p">.</span><span class="nf">join</span><span class="p">(</span><span class="s s-Atom">self</span><span class="p">.</span><span class="s s-Atom">config</span><span class="p">.</span><span class="s s-Atom">directory</span><span class="p">,</span> <span class="s s-Atom">pattern</span><span class="p">))</span> + + <span class="s s-Atom">if</span> <span class="s s-Atom">os</span><span class="p">.</span><span class="s s-Atom">path</span><span class="p">.</span><span class="nf">isdir</span><span class="p">(</span><span class="s s-Atom">os</span><span class="p">.</span><span class="s s-Atom">path</span><span class="p">.</span><span class="nf">join</span><span class="p">(</span><span class="s s-Atom">self</span><span class="p">.</span><span class="s s-Atom">config</span><span class="p">.</span><span class="s s-Atom">directory</span><span class="p">,</span> <span class="s s-Atom">pattern</span><span class="p">,</span> <span class="s s-Atom">filename</span><span class="p">))</span> + + <span class="p">]</span> + + <span class="nn">else</span><span class="p">:</span> + + <span class="s s-Atom">patterns</span> <span class="o">=</span> <span class="p">[</span><span class="s s-Atom">pattern</span><span class="p">]</span> + + <span class="s s-Atom">return</span> <span class="s s-Atom">patterns</span> + + <span class="s s-Atom">def</span> <span class="nf">find</span><span class="p">(</span><span class="s s-Atom">self</span><span class="p">,</span> <span class="s s-Atom">module_name:</span> <span class="s s-Atom">str</span><span class="p">)</span> <span class="s s-Atom">-></span> <span class="nv">Optional</span><span class="p">[</span><span class="s s-Atom">str</span><span class="p">]</span><span class="s s-Atom">:</span> + + <span class="s s-Atom">#</span> <span class="nv">Try</span> <span class="s s-Atom">to</span> <span class="s s-Atom">find</span> <span class="s s-Atom">most</span> <span class="s s-Atom">specific</span> <span class="s s-Atom">placement</span> <span class="s s-Atom">instruction</span> <span class="nf">match</span> <span class="p">(</span><span class="s s-Atom">if</span> <span class="s s-Atom">any</span><span class="p">)</span> + + <span class="s s-Atom">parts</span> <span class="o">=</span> <span class="s s-Atom">module_name</span><span class="p">.</span><span class="nf">split</span><span class="p">(</span><span class="s2">"."</span><span class="p">)</span> + + <span class="s s-Atom">module_names_to_check</span> <span class="o">=</span> <span class="p">(</span><span class="s2">"."</span><span class="p">.</span><span class="nf">join</span><span class="p">(</span><span class="s s-Atom">parts</span><span class="p">[</span><span class="s s-Atom">:first_k</span><span class="p">])</span> <span class="s s-Atom">for</span> <span class="s s-Atom">first_k</span> <span class="s s-Atom">in</span> <span class="nf">range</span><span class="p">(</span><span class="nf">len</span><span class="p">(</span><span class="s s-Atom">parts</span><span class="p">),</span> <span class="mi">0</span><span class="p">,</span> <span class="o">-</span><span class="mi">1</span><span class="p">))</span> + + <span class="s s-Atom">for</span> <span class="s s-Atom">module_name_to_check</span> <span class="s s-Atom">in</span> <span class="s s-Atom">module_names_to_check:</span> + + <span class="s s-Atom">for</span> <span class="s s-Atom">pattern</span><span class="p">,</span> <span class="s s-Atom">placement</span> <span class="s s-Atom">in</span> <span class="s s-Atom">self</span><span class="p">.</span><span class="s s-Atom">known_patterns:</span> + + <span class="s s-Atom">if</span> <span class="s s-Atom">pattern</span><span class="p">.</span><span class="nf">match</span><span class="p">(</span><span class="s s-Atom">module_name_to_check</span><span class="p">)</span><span class="s s-Atom">:</span> + + <span class="s s-Atom">return</span> <span class="s s-Atom">placement</span> + + <span class="s s-Atom">return</span> <span class="nv">None</span> + +<span class="s s-Atom">class</span> <span class="nv">PathFinder</span><span class="p">(</span><span class="nv">BaseFinder</span><span class="p">)</span><span class="s s-Atom">:</span> + + <span class="s s-Atom">def</span> <span class="k">__</span><span class="nf">init__</span><span class="p">(</span><span class="s s-Atom">self</span><span class="p">,</span> <span class="nn">config</span><span class="p">:</span> <span class="nv">Config</span><span class="p">,</span> <span class="nn">path</span><span class="p">:</span> <span class="s s-Atom">str</span> <span class="o">=</span> <span class="s2">"."</span><span class="p">)</span> <span class="s s-Atom">-></span> <span class="nv">None</span><span class="s s-Atom">:</span> + + <span class="nf">super</span><span class="p">().</span><span class="k">__</span><span class="nf">init__</span><span class="p">(</span><span class="s s-Atom">config</span><span class="p">)</span> + + <span class="s s-Atom">#</span> <span class="s s-Atom">restore</span> <span class="s s-Atom">the</span> <span class="s s-Atom">original</span> <span class="s s-Atom">import</span> <span class="nf">path</span> <span class="p">(</span><span class="s s-Atom">i</span><span class="p">.</span><span class="s s-Atom">e</span><span class="p">.</span> <span class="o">not</span> <span class="s s-Atom">the</span> <span class="s s-Atom">path</span> <span class="s s-Atom">to</span> <span class="s s-Atom">bin</span><span class="o">/</span><span class="s s-Atom">isort</span><span class="p">)</span> + + <span class="s s-Atom">root_dir</span> <span class="o">=</span> <span class="s s-Atom">os</span><span class="p">.</span><span class="s s-Atom">path</span><span class="p">.</span><span class="nf">abspath</span><span class="p">(</span><span class="s s-Atom">path</span><span class="p">)</span> + + <span class="s s-Atom">src_dir</span> <span class="o">=</span> <span class="s s-Atom">f</span><span class="s2">"{root_dir}/src"</span> + + <span class="s s-Atom">self</span><span class="p">.</span><span class="s s-Atom">paths</span> <span class="o">=</span> <span class="p">[</span><span class="s s-Atom">root_dir</span><span class="p">,</span> <span class="s s-Atom">src_dir</span><span class="p">]</span> + + <span class="s s-Atom">#</span> <span class="s s-Atom">virtual</span> <span class="s s-Atom">env</span> + + <span class="s s-Atom">self</span><span class="p">.</span><span class="s s-Atom">virtual_env</span> <span class="o">=</span> <span class="s s-Atom">self</span><span class="p">.</span><span class="s s-Atom">config</span><span class="p">.</span><span class="s s-Atom">virtual_env</span> <span class="s s-Atom">or</span> <span class="s s-Atom">os</span><span class="p">.</span><span class="s s-Atom">environ</span><span class="p">.</span><span class="nf">get</span><span class="p">(</span><span class="s2">"VIRTUAL_ENV"</span><span class="p">)</span> + + <span class="s s-Atom">if</span> <span class="s s-Atom">self</span><span class="p">.</span><span class="s s-Atom">virtual_env:</span> + + <span class="s s-Atom">self</span><span class="p">.</span><span class="s s-Atom">virtual_env</span> <span class="o">=</span> <span class="s s-Atom">os</span><span class="p">.</span><span class="s s-Atom">path</span><span class="p">.</span><span class="nf">realpath</span><span class="p">(</span><span class="s s-Atom">self</span><span class="p">.</span><span class="s s-Atom">virtual_env</span><span class="p">)</span> + + <span class="s s-Atom">self</span><span class="p">.</span><span class="s s-Atom">virtual_env_src</span> <span class="o">=</span> <span class="s2">""</span> + + <span class="s s-Atom">if</span> <span class="s s-Atom">self</span><span class="p">.</span><span class="s s-Atom">virtual_env:</span> + + <span class="s s-Atom">self</span><span class="p">.</span><span class="s s-Atom">virtual_env_src</span> <span class="o">=</span> <span class="s s-Atom">f</span><span class="s2">"{self.virtual_env}/src/"</span> + + <span class="s s-Atom">for</span> <span class="s s-Atom">venv_path</span> <span class="s s-Atom">in</span> <span class="nf">glob</span><span class="p">(</span><span class="s s-Atom">f</span><span class="s2">"{self.virtual_env}/lib/python*/site-packages"</span><span class="p">)</span><span class="s s-Atom">:</span> + + <span class="s s-Atom">if</span> <span class="s s-Atom">venv_path</span> <span class="o">not</span> <span class="s s-Atom">in</span> <span class="s s-Atom">self</span><span class="p">.</span><span class="nn">paths</span><span class="p">:</span> + + <span class="s s-Atom">self</span><span class="p">.</span><span class="s s-Atom">paths</span><span class="p">.</span><span class="nf">append</span><span class="p">(</span><span class="s s-Atom">venv_path</span><span class="p">)</span> + + <span class="s s-Atom">for</span> <span class="s s-Atom">nested_venv_path</span> <span class="s s-Atom">in</span> <span class="nf">glob</span><span class="p">(</span><span class="s s-Atom">f</span><span class="s2">"{self.virtual_env}/lib/python*/*/site-packages"</span><span class="p">)</span><span class="s s-Atom">:</span> + + <span class="s s-Atom">if</span> <span class="s s-Atom">nested_venv_path</span> <span class="o">not</span> <span class="s s-Atom">in</span> <span class="s s-Atom">self</span><span class="p">.</span><span class="nn">paths</span><span class="p">:</span> + + <span class="s s-Atom">self</span><span class="p">.</span><span class="s s-Atom">paths</span><span class="p">.</span><span class="nf">append</span><span class="p">(</span><span class="s s-Atom">nested_venv_path</span><span class="p">)</span> + + <span class="s s-Atom">for</span> <span class="s s-Atom">venv_src_path</span> <span class="s s-Atom">in</span> <span class="nf">glob</span><span class="p">(</span><span class="s s-Atom">f</span><span class="s2">"{self.virtual_env}/src/*"</span><span class="p">)</span><span class="s s-Atom">:</span> + + <span class="s s-Atom">if</span> <span class="s s-Atom">os</span><span class="p">.</span><span class="s s-Atom">path</span><span class="p">.</span><span class="nf">isdir</span><span class="p">(</span><span class="s s-Atom">venv_src_path</span><span class="p">)</span><span class="s s-Atom">:</span> + + <span class="s s-Atom">self</span><span class="p">.</span><span class="s s-Atom">paths</span><span class="p">.</span><span class="nf">append</span><span class="p">(</span><span class="s s-Atom">venv_src_path</span><span class="p">)</span> + + <span class="s s-Atom">#</span> <span class="s s-Atom">conda</span> + + <span class="s s-Atom">self</span><span class="p">.</span><span class="s s-Atom">conda_env</span> <span class="o">=</span> <span class="s s-Atom">self</span><span class="p">.</span><span class="s s-Atom">config</span><span class="p">.</span><span class="s s-Atom">conda_env</span> <span class="s s-Atom">or</span> <span class="s s-Atom">os</span><span class="p">.</span><span class="s s-Atom">environ</span><span class="p">.</span><span class="nf">get</span><span class="p">(</span><span class="s2">"CONDA_PREFIX"</span><span class="p">)</span> <span class="s s-Atom">or</span> <span class="s2">""</span> + + <span class="s s-Atom">if</span> <span class="s s-Atom">self</span><span class="p">.</span><span class="s s-Atom">conda_env:</span> + + <span class="s s-Atom">self</span><span class="p">.</span><span class="s s-Atom">conda_env</span> <span class="o">=</span> <span class="s s-Atom">os</span><span class="p">.</span><span class="s s-Atom">path</span><span class="p">.</span><span class="nf">realpath</span><span class="p">(</span><span class="s s-Atom">self</span><span class="p">.</span><span class="s s-Atom">conda_env</span><span class="p">)</span> + + <span class="s s-Atom">for</span> <span class="s s-Atom">conda_path</span> <span class="s s-Atom">in</span> <span class="nf">glob</span><span class="p">(</span><span class="s s-Atom">f</span><span class="s2">"{self.conda_env}/lib/python*/site-packages"</span><span class="p">)</span><span class="s s-Atom">:</span> + + <span class="s s-Atom">if</span> <span class="s s-Atom">conda_path</span> <span class="o">not</span> <span class="s s-Atom">in</span> <span class="s s-Atom">self</span><span class="p">.</span><span class="nn">paths</span><span class="p">:</span> + + <span class="s s-Atom">self</span><span class="p">.</span><span class="s s-Atom">paths</span><span class="p">.</span><span class="nf">append</span><span class="p">(</span><span class="s s-Atom">conda_path</span><span class="p">)</span> + + <span class="s s-Atom">for</span> <span class="s s-Atom">nested_conda_path</span> <span class="s s-Atom">in</span> <span class="nf">glob</span><span class="p">(</span><span class="s s-Atom">f</span><span class="s2">"{self.conda_env}/lib/python*/*/site-packages"</span><span class="p">)</span><span class="s s-Atom">:</span> + + <span class="s s-Atom">if</span> <span class="s s-Atom">nested_conda_path</span> <span class="o">not</span> <span class="s s-Atom">in</span> <span class="s s-Atom">self</span><span class="p">.</span><span class="nn">paths</span><span class="p">:</span> + + <span class="s s-Atom">self</span><span class="p">.</span><span class="s s-Atom">paths</span><span class="p">.</span><span class="nf">append</span><span class="p">(</span><span class="s s-Atom">nested_conda_path</span><span class="p">)</span> + + <span class="s s-Atom">#</span> <span class="s s-Atom">handle</span> <span class="s s-Atom">case</span><span class="o">-</span><span class="s s-Atom">insensitive</span> <span class="s s-Atom">paths</span> <span class="s s-Atom">on</span> <span class="s s-Atom">windows</span> + + <span class="s s-Atom">self</span><span class="p">.</span><span class="s s-Atom">stdlib_lib_prefix</span> <span class="o">=</span> <span class="s s-Atom">os</span><span class="p">.</span><span class="s s-Atom">path</span><span class="p">.</span><span class="nf">normcase</span><span class="p">(</span><span class="s s-Atom">sysconfig</span><span class="p">.</span><span class="nf">get_paths</span><span class="p">()[</span><span class="s2">"stdlib"</span><span class="p">])</span> + + <span class="s s-Atom">if</span> <span class="s s-Atom">self</span><span class="p">.</span><span class="s s-Atom">stdlib_lib_prefix</span> <span class="o">not</span> <span class="s s-Atom">in</span> <span class="s s-Atom">self</span><span class="p">.</span><span class="nn">paths</span><span class="p">:</span> + + <span class="s s-Atom">self</span><span class="p">.</span><span class="s s-Atom">paths</span><span class="p">.</span><span class="nf">append</span><span class="p">(</span><span class="s s-Atom">self</span><span class="p">.</span><span class="s s-Atom">stdlib_lib_prefix</span><span class="p">)</span> + + <span class="s s-Atom">#</span> <span class="s s-Atom">add</span> <span class="s s-Atom">system</span> <span class="s s-Atom">paths</span> + + <span class="s s-Atom">for</span> <span class="s s-Atom">system_path</span> <span class="s s-Atom">in</span> <span class="s s-Atom">sys</span><span class="p">.</span><span class="s s-Atom">path</span><span class="p">[</span><span class="mi">1</span><span class="s s-Atom">:</span><span class="p">]</span><span class="s s-Atom">:</span> + + <span class="s s-Atom">if</span> <span class="s s-Atom">system_path</span> <span class="o">not</span> <span class="s s-Atom">in</span> <span class="s s-Atom">self</span><span class="p">.</span><span class="nn">paths</span><span class="p">:</span> + + <span class="s s-Atom">self</span><span class="p">.</span><span class="s s-Atom">paths</span><span class="p">.</span><span class="nf">append</span><span class="p">(</span><span class="s s-Atom">system_path</span><span class="p">)</span> + + <span class="s s-Atom">def</span> <span class="nf">find</span><span class="p">(</span><span class="s s-Atom">self</span><span class="p">,</span> <span class="s s-Atom">module_name:</span> <span class="s s-Atom">str</span><span class="p">)</span> <span class="s s-Atom">-></span> <span class="nv">Optional</span><span class="p">[</span><span class="s s-Atom">str</span><span class="p">]</span><span class="s s-Atom">:</span> + + <span class="s s-Atom">for</span> <span class="s s-Atom">prefix</span> <span class="s s-Atom">in</span> <span class="s s-Atom">self</span><span class="p">.</span><span class="nn">paths</span><span class="p">:</span> + + <span class="s s-Atom">package_path</span> <span class="o">=</span> <span class="s2">"/"</span><span class="p">.</span><span class="nf">join</span><span class="p">((</span><span class="s s-Atom">prefix</span><span class="p">,</span> <span class="s s-Atom">module_name</span><span class="p">.</span><span class="nf">split</span><span class="p">(</span><span class="s2">"."</span><span class="p">)[</span><span class="mi">0</span><span class="p">]))</span> + + <span class="s s-Atom">path_obj</span> <span class="o">=</span> <span class="nv">Path</span><span class="p">(</span><span class="s s-Atom">package_path</span><span class="p">).</span><span class="nf">resolve</span><span class="p">()</span> + + <span class="s s-Atom">is_module</span> <span class="o">=</span> <span class="p">(</span> + + <span class="nf">exists_case_sensitive</span><span class="p">(</span><span class="s s-Atom">package_path</span> <span class="o">+</span> <span class="s2">".py"</span><span class="p">)</span> + + <span class="s s-Atom">or</span> <span class="nf">any</span><span class="p">(</span> + + <span class="nf">exists_case_sensitive</span><span class="p">(</span><span class="s s-Atom">package_path</span> <span class="o">+</span> <span class="s s-Atom">ext_suffix</span><span class="p">)</span> + + <span class="s s-Atom">for</span> <span class="s s-Atom">ext_suffix</span> <span class="s s-Atom">in</span> <span class="s s-Atom">importlib</span><span class="p">.</span><span class="s s-Atom">machinery</span><span class="p">.</span><span class="nv">EXTENSION_SUFFIXES</span> + + <span class="p">)</span> + + <span class="s s-Atom">or</span> <span class="nf">exists_case_sensitive</span><span class="p">(</span><span class="s s-Atom">package_path</span> <span class="o">+</span> <span class="s2">"/__init__.py"</span><span class="p">)</span> + + <span class="p">)</span> + + <span class="s s-Atom">is_package</span> <span class="o">=</span> <span class="nf">exists_case_sensitive</span><span class="p">(</span><span class="s s-Atom">package_path</span><span class="p">)</span> <span class="s s-Atom">and</span> <span class="s s-Atom">os</span><span class="p">.</span><span class="s s-Atom">path</span><span class="p">.</span><span class="nf">isdir</span><span class="p">(</span><span class="s s-Atom">package_path</span><span class="p">)</span> + + <span class="s s-Atom">if</span> <span class="s s-Atom">is_module</span> <span class="s s-Atom">or</span> <span class="s s-Atom">is_package:</span> + + <span class="nf">if</span> <span class="p">(</span> + + <span class="s2">"site-packages"</span> <span class="s s-Atom">in</span> <span class="s s-Atom">prefix</span> + + <span class="s s-Atom">or</span> <span class="s2">"dist-packages"</span> <span class="s s-Atom">in</span> <span class="s s-Atom">prefix</span> + + <span class="nf">or</span> <span class="p">(</span><span class="s s-Atom">self</span><span class="p">.</span><span class="s s-Atom">virtual_env</span> <span class="s s-Atom">and</span> <span class="s s-Atom">self</span><span class="p">.</span><span class="s s-Atom">virtual_env_src</span> <span class="s s-Atom">in</span> <span class="s s-Atom">prefix</span><span class="p">)</span> + + <span class="p">)</span><span class="s s-Atom">:</span> + + <span class="s s-Atom">return</span> <span class="s s-Atom">sections</span><span class="p">.</span><span class="nv">THIRDPARTY</span> + + <span class="s s-Atom">if</span> <span class="s s-Atom">os</span><span class="p">.</span><span class="s s-Atom">path</span><span class="p">.</span><span class="nf">normcase</span><span class="p">(</span><span class="s s-Atom">prefix</span><span class="p">)</span> <span class="o">==</span> <span class="s s-Atom">self</span><span class="p">.</span><span class="s s-Atom">stdlib_lib_prefix:</span> + + <span class="s s-Atom">return</span> <span class="s s-Atom">sections</span><span class="p">.</span><span class="nv">STDLIB</span> + + <span class="s s-Atom">if</span> <span class="s s-Atom">self</span><span class="p">.</span><span class="s s-Atom">conda_env</span> <span class="s s-Atom">and</span> <span class="s s-Atom">self</span><span class="p">.</span><span class="s s-Atom">conda_env</span> <span class="s s-Atom">in</span> <span class="nn">prefix</span><span class="p">:</span> + + <span class="s s-Atom">return</span> <span class="s s-Atom">sections</span><span class="p">.</span><span class="nv">THIRDPARTY</span> + + <span class="s s-Atom">for</span> <span class="s s-Atom">src_path</span> <span class="s s-Atom">in</span> <span class="s s-Atom">self</span><span class="p">.</span><span class="s s-Atom">config</span><span class="p">.</span><span class="s s-Atom">src_paths:</span> + + <span class="s s-Atom">if</span> <span class="s s-Atom">src_path</span> <span class="s s-Atom">in</span> <span class="s s-Atom">path_obj</span><span class="p">.</span><span class="s s-Atom">parents</span> <span class="s s-Atom">and</span> <span class="o">not</span> <span class="s s-Atom">self</span><span class="p">.</span><span class="s s-Atom">config</span><span class="p">.</span><span class="nf">is_skipped</span><span class="p">(</span><span class="s s-Atom">path_obj</span><span class="p">)</span><span class="s s-Atom">:</span> + + <span class="s s-Atom">return</span> <span class="s s-Atom">sections</span><span class="p">.</span><span class="nv">FIRSTPARTY</span> + + <span class="s s-Atom">if</span> <span class="s s-Atom">os</span><span class="p">.</span><span class="s s-Atom">path</span><span class="p">.</span><span class="nf">normcase</span><span class="p">(</span><span class="s s-Atom">prefix</span><span class="p">).</span><span class="nf">startswith</span><span class="p">(</span><span class="s s-Atom">self</span><span class="p">.</span><span class="s s-Atom">stdlib_lib_prefix</span><span class="p">)</span><span class="s s-Atom">:</span> + + <span class="s s-Atom">return</span> <span class="s s-Atom">sections</span><span class="p">.</span><span class="nv">STDLIB</span> <span class="s s-Atom">#</span> <span class="nn">pragma</span><span class="p">:</span> <span class="s s-Atom">no</span> <span class="s s-Atom">cover</span> <span class="o">-</span> <span class="s s-Atom">edge</span> <span class="s s-Atom">case</span> <span class="s s-Atom">for</span> <span class="s s-Atom">one</span> <span class="nv">OS</span><span class="p">.</span> <span class="nv">Hard</span> <span class="s s-Atom">to</span> <span class="s s-Atom">test</span><span class="p">.</span> + + <span class="s s-Atom">return</span> <span class="s s-Atom">self</span><span class="p">.</span><span class="s s-Atom">config</span><span class="p">.</span><span class="s s-Atom">default_section</span> + + <span class="s s-Atom">return</span> <span class="nv">None</span> + +<span class="s s-Atom">class</span> <span class="nv">ReqsBaseFinder</span><span class="p">(</span><span class="nv">BaseFinder</span><span class="p">)</span><span class="s s-Atom">:</span> + + <span class="s s-Atom">enabled</span> <span class="o">=</span> <span class="nv">False</span> + + <span class="s s-Atom">def</span> <span class="k">__</span><span class="nf">init__</span><span class="p">(</span><span class="s s-Atom">self</span><span class="p">,</span> <span class="nn">config</span><span class="p">:</span> <span class="nv">Config</span><span class="p">,</span> <span class="nn">path</span><span class="p">:</span> <span class="s s-Atom">str</span> <span class="o">=</span> <span class="s2">"."</span><span class="p">)</span> <span class="s s-Atom">-></span> <span class="nv">None</span><span class="s s-Atom">:</span> + + <span class="nf">super</span><span class="p">().</span><span class="k">__</span><span class="nf">init__</span><span class="p">(</span><span class="s s-Atom">config</span><span class="p">)</span> + + <span class="s s-Atom">self</span><span class="p">.</span><span class="s s-Atom">path</span> <span class="o">=</span> <span class="s s-Atom">path</span> + + <span class="s s-Atom">if</span> <span class="s s-Atom">self</span><span class="p">.</span><span class="nn">enabled</span><span class="p">:</span> + + <span class="s s-Atom">self</span><span class="p">.</span><span class="s s-Atom">mapping</span> <span class="o">=</span> <span class="s s-Atom">self</span><span class="p">.</span><span class="k">_</span><span class="nf">load_mapping</span><span class="p">()</span> + + <span class="s s-Atom">self</span><span class="p">.</span><span class="s s-Atom">names</span> <span class="o">=</span> <span class="s s-Atom">self</span><span class="p">.</span><span class="k">_</span><span class="nf">load_names</span><span class="p">()</span> + + <span class="s s-Atom">@abstractmethod</span> + + <span class="s s-Atom">def</span> <span class="k">_</span><span class="nf">get_names</span><span class="p">(</span><span class="s s-Atom">self</span><span class="p">,</span> <span class="nn">path</span><span class="p">:</span> <span class="s s-Atom">str</span><span class="p">)</span> <span class="s s-Atom">-></span> <span class="nv">Iterator</span><span class="p">[</span><span class="s s-Atom">str</span><span class="p">]</span><span class="s s-Atom">:</span> + + <span class="s s-Atom">raise</span> <span class="nv">NotImplementedError</span> + + <span class="s s-Atom">@abstractmethod</span> + + <span class="s s-Atom">def</span> <span class="k">_</span><span class="nf">get_files_from_dir</span><span class="p">(</span><span class="s s-Atom">self</span><span class="p">,</span> <span class="nn">path</span><span class="p">:</span> <span class="s s-Atom">str</span><span class="p">)</span> <span class="s s-Atom">-></span> <span class="nv">Iterator</span><span class="p">[</span><span class="s s-Atom">str</span><span class="p">]</span><span class="s s-Atom">:</span> + + <span class="s s-Atom">raise</span> <span class="nv">NotImplementedError</span> + + <span class="s s-Atom">@staticmethod</span> + + <span class="s s-Atom">def</span> <span class="k">_</span><span class="nf">load_mapping</span><span class="p">()</span> <span class="s s-Atom">-></span> <span class="nv">Optional</span><span class="p">[</span><span class="nv">Dict</span><span class="p">[</span><span class="s s-Atom">str</span><span class="p">,</span> <span class="s s-Atom">str</span><span class="p">]]</span><span class="s s-Atom">:</span> + + <span class="s2">"""Return list of mappings `package_name -> module_name`</span> + +<span class="s2"> Example:</span> + +<span class="s2"> django-haystack -> haystack</span> + +<span class="s2"> """</span> + + <span class="s s-Atom">if</span> <span class="o">not</span> <span class="nn">pipreqs</span><span class="p">:</span> + + <span class="s s-Atom">return</span> <span class="nv">None</span> + + <span class="s s-Atom">path</span> <span class="o">=</span> <span class="s s-Atom">os</span><span class="p">.</span><span class="s s-Atom">path</span><span class="p">.</span><span class="nf">dirname</span><span class="p">(</span><span class="s s-Atom">inspect</span><span class="p">.</span><span class="nf">getfile</span><span class="p">(</span><span class="s s-Atom">pipreqs</span><span class="p">))</span> + + <span class="s s-Atom">path</span> <span class="o">=</span> <span class="s s-Atom">os</span><span class="p">.</span><span class="s s-Atom">path</span><span class="p">.</span><span class="nf">join</span><span class="p">(</span><span class="s s-Atom">path</span><span class="p">,</span> <span class="s2">"mapping"</span><span class="p">)</span> + + <span class="s s-Atom">with</span> <span class="nf">open</span><span class="p">(</span><span class="s s-Atom">path</span><span class="p">)</span> <span class="s s-Atom">as</span> <span class="nn">f</span><span class="p">:</span> + + <span class="nn">mappings</span><span class="p">:</span> <span class="nv">Dict</span><span class="p">[</span><span class="s s-Atom">str</span><span class="p">,</span> <span class="s s-Atom">str</span><span class="p">]</span> <span class="o">=</span> <span class="p">{}</span> <span class="s s-Atom">#</span> <span class="s s-Atom">pypi_name:</span> <span class="s s-Atom">import_name</span> + + <span class="s s-Atom">for</span> <span class="s s-Atom">line</span> <span class="s s-Atom">in</span> <span class="nn">f</span><span class="p">:</span> + + <span class="s s-Atom">import_name</span><span class="p">,</span> <span class="k">_</span><span class="p">,</span> <span class="s s-Atom">pypi_name</span> <span class="o">=</span> <span class="s s-Atom">line</span><span class="p">.</span><span class="nf">strip</span><span class="p">().</span><span class="nf">partition</span><span class="p">(</span><span class="s2">":"</span><span class="p">)</span> + + <span class="s s-Atom">mappings</span><span class="p">[</span><span class="s s-Atom">pypi_name</span><span class="p">]</span> <span class="o">=</span> <span class="s s-Atom">import_name</span> + + <span class="s s-Atom">return</span> <span class="s s-Atom">mappings</span> + + <span class="s s-Atom">#</span> <span class="s s-Atom">return</span> <span class="nf">dict</span><span class="p">(</span><span class="nf">tuple</span><span class="p">(</span><span class="s s-Atom">line</span><span class="p">.</span><span class="nf">strip</span><span class="p">().</span><span class="nf">split</span><span class="p">(</span><span class="s2">":"</span><span class="p">)[</span><span class="s s-Atom">::-</span><span class="mi">1</span><span class="p">])</span> <span class="s s-Atom">for</span> <span class="s s-Atom">line</span> <span class="s s-Atom">in</span> <span class="s s-Atom">f</span><span class="p">)</span> + + <span class="s s-Atom">def</span> <span class="k">_</span><span class="nf">load_names</span><span class="p">(</span><span class="s s-Atom">self</span><span class="p">)</span> <span class="s s-Atom">-></span> <span class="nv">List</span><span class="p">[</span><span class="s s-Atom">str</span><span class="p">]</span><span class="s s-Atom">:</span> + + <span class="s2">"""Return list of thirdparty modules from requirements"""</span> + + <span class="s s-Atom">names</span> <span class="o">=</span> <span class="p">[]</span> + + <span class="s s-Atom">for</span> <span class="s s-Atom">path</span> <span class="s s-Atom">in</span> <span class="s s-Atom">self</span><span class="p">.</span><span class="k">_</span><span class="nf">get_files</span><span class="p">()</span><span class="s s-Atom">:</span> + + <span class="s s-Atom">for</span> <span class="s s-Atom">name</span> <span class="s s-Atom">in</span> <span class="s s-Atom">self</span><span class="p">.</span><span class="k">_</span><span class="nf">get_names</span><span class="p">(</span><span class="s s-Atom">path</span><span class="p">)</span><span class="s s-Atom">:</span> + + <span class="s s-Atom">names</span><span class="p">.</span><span class="nf">append</span><span class="p">(</span><span class="s s-Atom">self</span><span class="p">.</span><span class="k">_</span><span class="nf">normalize_name</span><span class="p">(</span><span class="s s-Atom">name</span><span class="p">))</span> + + <span class="s s-Atom">return</span> <span class="s s-Atom">names</span> + + <span class="s s-Atom">@staticmethod</span> + + <span class="s s-Atom">def</span> <span class="k">_</span><span class="nf">get_parents</span><span class="p">(</span><span class="nn">path</span><span class="p">:</span> <span class="s s-Atom">str</span><span class="p">)</span> <span class="s s-Atom">-></span> <span class="nv">Iterator</span><span class="p">[</span><span class="s s-Atom">str</span><span class="p">]</span><span class="s s-Atom">:</span> + + <span class="s s-Atom">prev</span> <span class="o">=</span> <span class="s2">""</span> + + <span class="s s-Atom">while</span> <span class="s s-Atom">path</span> <span class="p">!</span><span class="o">=</span> <span class="nn">prev</span><span class="p">:</span> + + <span class="s s-Atom">prev</span> <span class="o">=</span> <span class="s s-Atom">path</span> + + <span class="s s-Atom">yield</span> <span class="s s-Atom">path</span> + + <span class="s s-Atom">path</span> <span class="o">=</span> <span class="s s-Atom">os</span><span class="p">.</span><span class="s s-Atom">path</span><span class="p">.</span><span class="nf">dirname</span><span class="p">(</span><span class="s s-Atom">path</span><span class="p">)</span> + + <span class="s s-Atom">def</span> <span class="k">_</span><span class="nf">get_files</span><span class="p">(</span><span class="s s-Atom">self</span><span class="p">)</span> <span class="s s-Atom">-></span> <span class="nv">Iterator</span><span class="p">[</span><span class="s s-Atom">str</span><span class="p">]</span><span class="s s-Atom">:</span> + + <span class="s2">"""Return paths to all requirements files"""</span> + + <span class="s s-Atom">path</span> <span class="o">=</span> <span class="s s-Atom">os</span><span class="p">.</span><span class="s s-Atom">path</span><span class="p">.</span><span class="nf">abspath</span><span class="p">(</span><span class="s s-Atom">self</span><span class="p">.</span><span class="s s-Atom">path</span><span class="p">)</span> + + <span class="s s-Atom">if</span> <span class="s s-Atom">os</span><span class="p">.</span><span class="s s-Atom">path</span><span class="p">.</span><span class="nf">isfile</span><span class="p">(</span><span class="s s-Atom">path</span><span class="p">)</span><span class="s s-Atom">:</span> + + <span class="s s-Atom">path</span> <span class="o">=</span> <span class="s s-Atom">os</span><span class="p">.</span><span class="s s-Atom">path</span><span class="p">.</span><span class="nf">dirname</span><span class="p">(</span><span class="s s-Atom">path</span><span class="p">)</span> + + <span class="s s-Atom">for</span> <span class="s s-Atom">path</span> <span class="s s-Atom">in</span> <span class="s s-Atom">self</span><span class="p">.</span><span class="k">_</span><span class="nf">get_parents</span><span class="p">(</span><span class="s s-Atom">path</span><span class="p">)</span><span class="s s-Atom">:</span> + + <span class="s s-Atom">yield</span> <span class="s s-Atom">from</span> <span class="s s-Atom">self</span><span class="p">.</span><span class="k">_</span><span class="nf">get_files_from_dir</span><span class="p">(</span><span class="s s-Atom">path</span><span class="p">)</span> + + <span class="s s-Atom">def</span> <span class="k">_</span><span class="nf">normalize_name</span><span class="p">(</span><span class="s s-Atom">self</span><span class="p">,</span> <span class="nn">name</span><span class="p">:</span> <span class="s s-Atom">str</span><span class="p">)</span> <span class="s s-Atom">-></span> <span class="nn">str</span><span class="p">:</span> + + <span class="s2">"""Convert package name to module name</span> + +<span class="s2"> Examples:</span> + +<span class="s2"> Django -> django</span> + +<span class="s2"> django-haystack -> django_haystack</span> + +<span class="s2"> Flask-RESTFul -> flask_restful</span> + +<span class="s2"> """</span> + + <span class="s s-Atom">if</span> <span class="s s-Atom">self</span><span class="p">.</span><span class="nn">mapping</span><span class="p">:</span> + + <span class="s s-Atom">name</span> <span class="o">=</span> <span class="s s-Atom">self</span><span class="p">.</span><span class="s s-Atom">mapping</span><span class="p">.</span><span class="nf">get</span><span class="p">(</span><span class="s s-Atom">name</span><span class="p">.</span><span class="nf">replace</span><span class="p">(</span><span class="s2">"-"</span><span class="p">,</span> <span class="s2">"_"</span><span class="p">),</span> <span class="s s-Atom">name</span><span class="p">)</span> + + <span class="s s-Atom">return</span> <span class="s s-Atom">name</span><span class="p">.</span><span class="nf">lower</span><span class="p">().</span><span class="nf">replace</span><span class="p">(</span><span class="s2">"-"</span><span class="p">,</span> <span class="s2">"_"</span><span class="p">)</span> + + <span class="s s-Atom">def</span> <span class="nf">find</span><span class="p">(</span><span class="s s-Atom">self</span><span class="p">,</span> <span class="s s-Atom">module_name:</span> <span class="s s-Atom">str</span><span class="p">)</span> <span class="s s-Atom">-></span> <span class="nv">Optional</span><span class="p">[</span><span class="s s-Atom">str</span><span class="p">]</span><span class="s s-Atom">:</span> + + <span class="s s-Atom">#</span> <span class="s s-Atom">required</span> <span class="s s-Atom">lib</span> <span class="o">not</span> <span class="s s-Atom">installed</span> <span class="s s-Atom">yet</span> + + <span class="s s-Atom">if</span> <span class="o">not</span> <span class="s s-Atom">self</span><span class="p">.</span><span class="nn">enabled</span><span class="p">:</span> + + <span class="s s-Atom">return</span> <span class="nv">None</span> + + <span class="s s-Atom">module_name</span><span class="p">,</span> <span class="k">_</span><span class="s s-Atom">sep</span><span class="p">,</span> <span class="k">_</span><span class="s s-Atom">submodules</span> <span class="o">=</span> <span class="s s-Atom">module_name</span><span class="p">.</span><span class="nf">partition</span><span class="p">(</span><span class="s2">"."</span><span class="p">)</span> + + <span class="s s-Atom">module_name</span> <span class="o">=</span> <span class="s s-Atom">module_name</span><span class="p">.</span><span class="nf">lower</span><span class="p">()</span> + + <span class="s s-Atom">if</span> <span class="o">not</span> <span class="s s-Atom">module_name:</span> + + <span class="s s-Atom">return</span> <span class="nv">None</span> + + <span class="s s-Atom">for</span> <span class="s s-Atom">name</span> <span class="s s-Atom">in</span> <span class="s s-Atom">self</span><span class="p">.</span><span class="nn">names</span><span class="p">:</span> + + <span class="s s-Atom">if</span> <span class="s s-Atom">module_name</span> <span class="o">==</span> <span class="nn">name</span><span class="p">:</span> + + <span class="s s-Atom">return</span> <span class="s s-Atom">sections</span><span class="p">.</span><span class="nv">THIRDPARTY</span> + + <span class="s s-Atom">return</span> <span class="nv">None</span> + +<span class="s s-Atom">class</span> <span class="nv">RequirementsFinder</span><span class="p">(</span><span class="nv">ReqsBaseFinder</span><span class="p">)</span><span class="s s-Atom">:</span> + + <span class="s s-Atom">exts</span> <span class="o">=</span> <span class="p">(</span><span class="s2">".txt"</span><span class="p">,</span> <span class="s2">".in"</span><span class="p">)</span> + + <span class="s s-Atom">enabled</span> <span class="o">=</span> <span class="nf">bool</span><span class="p">(</span><span class="s s-Atom">parse_requirements</span><span class="p">)</span> + + <span class="s s-Atom">def</span> <span class="k">_</span><span class="nf">get_files_from_dir</span><span class="p">(</span><span class="s s-Atom">self</span><span class="p">,</span> <span class="nn">path</span><span class="p">:</span> <span class="s s-Atom">str</span><span class="p">)</span> <span class="s s-Atom">-></span> <span class="nv">Iterator</span><span class="p">[</span><span class="s s-Atom">str</span><span class="p">]</span><span class="s s-Atom">:</span> + + <span class="s2">"""Return paths to requirements files from passed dir."""</span> + + <span class="s s-Atom">yield</span> <span class="s s-Atom">from</span> <span class="s s-Atom">self</span><span class="p">.</span><span class="k">_</span><span class="nf">get_files_from_dir_cached</span><span class="p">(</span><span class="s s-Atom">path</span><span class="p">)</span> + + <span class="s s-Atom">@classmethod</span> + + <span class="s s-Atom">@</span><span class="nf">lru_cache</span><span class="p">(</span><span class="s s-Atom">maxsize</span><span class="o">=</span><span class="mi">16</span><span class="p">)</span> + + <span class="s s-Atom">def</span> <span class="k">_</span><span class="nf">get_files_from_dir_cached</span><span class="p">(</span><span class="s s-Atom">cls</span><span class="p">,</span> <span class="nn">path</span><span class="p">:</span> <span class="s s-Atom">str</span><span class="p">)</span> <span class="s s-Atom">-></span> <span class="nv">List</span><span class="p">[</span><span class="s s-Atom">str</span><span class="p">]</span><span class="s s-Atom">:</span> + + <span class="s s-Atom">results</span> <span class="o">=</span> <span class="p">[]</span> + + <span class="s s-Atom">for</span> <span class="s s-Atom">fname</span> <span class="s s-Atom">in</span> <span class="s s-Atom">os</span><span class="p">.</span><span class="nf">listdir</span><span class="p">(</span><span class="s s-Atom">path</span><span class="p">)</span><span class="s s-Atom">:</span> + + <span class="s s-Atom">if</span> <span class="s2">"requirements"</span> <span class="o">not</span> <span class="s s-Atom">in</span> <span class="nn">fname</span><span class="p">:</span> + + <span class="s s-Atom">continue</span> + + <span class="s s-Atom">full_path</span> <span class="o">=</span> <span class="s s-Atom">os</span><span class="p">.</span><span class="s s-Atom">path</span><span class="p">.</span><span class="nf">join</span><span class="p">(</span><span class="s s-Atom">path</span><span class="p">,</span> <span class="s s-Atom">fname</span><span class="p">)</span> + + <span class="s s-Atom">#</span> <span class="o">*</span><span class="s s-Atom">requirements*/*.</span><span class="p">{</span><span class="s s-Atom">txt</span><span class="p">,</span><span class="s s-Atom">in</span><span class="p">}</span> + + <span class="s s-Atom">if</span> <span class="s s-Atom">os</span><span class="p">.</span><span class="s s-Atom">path</span><span class="p">.</span><span class="nf">isdir</span><span class="p">(</span><span class="s s-Atom">full_path</span><span class="p">)</span><span class="s s-Atom">:</span> + + <span class="s s-Atom">for</span> <span class="s s-Atom">subfile_name</span> <span class="s s-Atom">in</span> <span class="s s-Atom">os</span><span class="p">.</span><span class="nf">listdir</span><span class="p">(</span><span class="s s-Atom">full_path</span><span class="p">)</span><span class="s s-Atom">:</span> + + <span class="s s-Atom">for</span> <span class="s s-Atom">ext</span> <span class="s s-Atom">in</span> <span class="s s-Atom">cls</span><span class="p">.</span><span class="nn">exts</span><span class="p">:</span> + + <span class="s s-Atom">if</span> <span class="s s-Atom">subfile_name</span><span class="p">.</span><span class="nf">endswith</span><span class="p">(</span><span class="s s-Atom">ext</span><span class="p">)</span><span class="s s-Atom">:</span> + + <span class="s s-Atom">results</span><span class="p">.</span><span class="nf">append</span><span class="p">(</span><span class="s s-Atom">os</span><span class="p">.</span><span class="s s-Atom">path</span><span class="p">.</span><span class="nf">join</span><span class="p">(</span><span class="s s-Atom">full_path</span><span class="p">,</span> <span class="s s-Atom">subfile_name</span><span class="p">))</span> + + <span class="s s-Atom">continue</span> + + <span class="s s-Atom">#</span> <span class="o">*</span><span class="s s-Atom">requirements*.</span><span class="p">{</span><span class="s s-Atom">txt</span><span class="p">,</span><span class="s s-Atom">in</span><span class="p">}</span> + + <span class="s s-Atom">if</span> <span class="s s-Atom">os</span><span class="p">.</span><span class="s s-Atom">path</span><span class="p">.</span><span class="nf">isfile</span><span class="p">(</span><span class="s s-Atom">full_path</span><span class="p">)</span><span class="s s-Atom">:</span> + + <span class="s s-Atom">for</span> <span class="s s-Atom">ext</span> <span class="s s-Atom">in</span> <span class="s s-Atom">cls</span><span class="p">.</span><span class="nn">exts</span><span class="p">:</span> + + <span class="s s-Atom">if</span> <span class="s s-Atom">fname</span><span class="p">.</span><span class="nf">endswith</span><span class="p">(</span><span class="s s-Atom">ext</span><span class="p">)</span><span class="s s-Atom">:</span> + + <span class="s s-Atom">results</span><span class="p">.</span><span class="nf">append</span><span class="p">(</span><span class="s s-Atom">full_path</span><span class="p">)</span> + + <span class="s s-Atom">break</span> + + <span class="s s-Atom">return</span> <span class="s s-Atom">results</span> + + <span class="s s-Atom">def</span> <span class="k">_</span><span class="nf">get_names</span><span class="p">(</span><span class="s s-Atom">self</span><span class="p">,</span> <span class="nn">path</span><span class="p">:</span> <span class="s s-Atom">str</span><span class="p">)</span> <span class="s s-Atom">-></span> <span class="nv">Iterator</span><span class="p">[</span><span class="s s-Atom">str</span><span class="p">]</span><span class="s s-Atom">:</span> + + <span class="s2">"""Load required packages from path to requirements file"""</span> + + <span class="s s-Atom">yield</span> <span class="s s-Atom">from</span> <span class="s s-Atom">self</span><span class="p">.</span><span class="k">_</span><span class="nf">get_names_cached</span><span class="p">(</span><span class="s s-Atom">path</span><span class="p">)</span> + + <span class="s s-Atom">@classmethod</span> + + <span class="s s-Atom">@</span><span class="nf">lru_cache</span><span class="p">(</span><span class="s s-Atom">maxsize</span><span class="o">=</span><span class="mi">16</span><span class="p">)</span> + + <span class="s s-Atom">def</span> <span class="k">_</span><span class="nf">get_names_cached</span><span class="p">(</span><span class="s s-Atom">cls</span><span class="p">,</span> <span class="nn">path</span><span class="p">:</span> <span class="s s-Atom">str</span><span class="p">)</span> <span class="s s-Atom">-></span> <span class="nv">List</span><span class="p">[</span><span class="s s-Atom">str</span><span class="p">]</span><span class="s s-Atom">:</span> + + <span class="s s-Atom">result</span> <span class="o">=</span> <span class="p">[]</span> + + <span class="s s-Atom">with</span> <span class="nf">chdir</span><span class="p">(</span><span class="s s-Atom">os</span><span class="p">.</span><span class="s s-Atom">path</span><span class="p">.</span><span class="nf">dirname</span><span class="p">(</span><span class="s s-Atom">path</span><span class="p">))</span><span class="s s-Atom">:</span> + + <span class="s s-Atom">requirements</span> <span class="o">=</span> <span class="nf">parse_requirements</span><span class="p">(</span><span class="s s-Atom">path</span><span class="p">)</span> + + <span class="s s-Atom">for</span> <span class="s s-Atom">req</span> <span class="s s-Atom">in</span> <span class="s s-Atom">requirements</span><span class="p">.</span><span class="nf">values</span><span class="p">()</span><span class="s s-Atom">:</span> + + <span class="s s-Atom">if</span> <span class="s s-Atom">req</span><span class="p">.</span><span class="nn">name</span><span class="p">:</span> + + <span class="s s-Atom">result</span><span class="p">.</span><span class="nf">append</span><span class="p">(</span><span class="s s-Atom">req</span><span class="p">.</span><span class="s s-Atom">name</span><span class="p">)</span> + + <span class="s s-Atom">return</span> <span class="s s-Atom">result</span> + +<span class="s s-Atom">class</span> <span class="nv">PipfileFinder</span><span class="p">(</span><span class="nv">ReqsBaseFinder</span><span class="p">)</span><span class="s s-Atom">:</span> + + <span class="s s-Atom">enabled</span> <span class="o">=</span> <span class="nf">bool</span><span class="p">(</span><span class="nv">Pipfile</span><span class="p">)</span> + + <span class="s s-Atom">def</span> <span class="k">_</span><span class="nf">get_names</span><span class="p">(</span><span class="s s-Atom">self</span><span class="p">,</span> <span class="nn">path</span><span class="p">:</span> <span class="s s-Atom">str</span><span class="p">)</span> <span class="s s-Atom">-></span> <span class="nv">Iterator</span><span class="p">[</span><span class="s s-Atom">str</span><span class="p">]</span><span class="s s-Atom">:</span> + + <span class="s s-Atom">with</span> <span class="nf">chdir</span><span class="p">(</span><span class="s s-Atom">path</span><span class="p">)</span><span class="s s-Atom">:</span> + + <span class="s s-Atom">project</span> <span class="o">=</span> <span class="nv">Pipfile</span><span class="p">.</span><span class="nf">load</span><span class="p">(</span><span class="s s-Atom">path</span><span class="p">)</span> + + <span class="s s-Atom">for</span> <span class="s s-Atom">req</span> <span class="s s-Atom">in</span> <span class="s s-Atom">project</span><span class="p">.</span><span class="nn">packages</span><span class="p">:</span> + + <span class="s s-Atom">yield</span> <span class="s s-Atom">req</span><span class="p">.</span><span class="s s-Atom">name</span> + + <span class="s s-Atom">def</span> <span class="k">_</span><span class="nf">get_files_from_dir</span><span class="p">(</span><span class="s s-Atom">self</span><span class="p">,</span> <span class="nn">path</span><span class="p">:</span> <span class="s s-Atom">str</span><span class="p">)</span> <span class="s s-Atom">-></span> <span class="nv">Iterator</span><span class="p">[</span><span class="s s-Atom">str</span><span class="p">]</span><span class="s s-Atom">:</span> + + <span class="s s-Atom">if</span> <span class="s2">"Pipfile"</span> <span class="s s-Atom">in</span> <span class="s s-Atom">os</span><span class="p">.</span><span class="nf">listdir</span><span class="p">(</span><span class="s s-Atom">path</span><span class="p">)</span><span class="s s-Atom">:</span> + + <span class="s s-Atom">yield</span> <span class="s s-Atom">path</span> + +<span class="s s-Atom">class</span> <span class="nv">DefaultFinder</span><span class="p">(</span><span class="nv">BaseFinder</span><span class="p">)</span><span class="s s-Atom">:</span> + + <span class="s s-Atom">def</span> <span class="nf">find</span><span class="p">(</span><span class="s s-Atom">self</span><span class="p">,</span> <span class="s s-Atom">module_name:</span> <span class="s s-Atom">str</span><span class="p">)</span> <span class="s s-Atom">-></span> <span class="nv">Optional</span><span class="p">[</span><span class="s s-Atom">str</span><span class="p">]</span><span class="s s-Atom">:</span> + + <span class="s s-Atom">return</span> <span class="s s-Atom">self</span><span class="p">.</span><span class="s s-Atom">config</span><span class="p">.</span><span class="s s-Atom">default_section</span> + +<span class="s s-Atom">class</span> <span class="nv">FindersManager</span><span class="s s-Atom">:</span> + + <span class="k">_</span><span class="s s-Atom">default_finders_classes:</span> <span class="nv">Sequence</span><span class="p">[</span><span class="nv">Type</span><span class="p">[</span><span class="nv">BaseFinder</span><span class="p">]]</span> <span class="o">=</span> <span class="p">(</span> + + <span class="nv">ForcedSeparateFinder</span><span class="p">,</span> + + <span class="nv">LocalFinder</span><span class="p">,</span> + + <span class="nv">KnownPatternFinder</span><span class="p">,</span> + + <span class="nv">PathFinder</span><span class="p">,</span> + + <span class="nv">PipfileFinder</span><span class="p">,</span> + + <span class="nv">RequirementsFinder</span><span class="p">,</span> + + <span class="nv">DefaultFinder</span><span class="p">,</span> + + <span class="p">)</span> + + <span class="s s-Atom">def</span> <span class="k">__</span><span class="nf">init__</span><span class="p">(</span> + + <span class="s s-Atom">self</span><span class="p">,</span> <span class="nn">config</span><span class="p">:</span> <span class="nv">Config</span><span class="p">,</span> <span class="s s-Atom">finder_classes:</span> <span class="nv">Optional</span><span class="p">[</span><span class="nv">Iterable</span><span class="p">[</span><span class="nv">Type</span><span class="p">[</span><span class="nv">BaseFinder</span><span class="p">]]]</span> <span class="o">=</span> <span class="nv">None</span> + + <span class="p">)</span> <span class="s s-Atom">-></span> <span class="nv">None</span><span class="s s-Atom">:</span> + + <span class="s s-Atom">self</span><span class="p">.</span><span class="nn">verbose</span><span class="p">:</span> <span class="s s-Atom">bool</span> <span class="o">=</span> <span class="s s-Atom">config</span><span class="p">.</span><span class="s s-Atom">verbose</span> + + <span class="s s-Atom">if</span> <span class="s s-Atom">finder_classes</span> <span class="o">is</span> <span class="nv">None</span><span class="s s-Atom">:</span> + + <span class="s s-Atom">finder_classes</span> <span class="o">=</span> <span class="s s-Atom">self</span><span class="p">.</span><span class="k">_</span><span class="s s-Atom">default_finders_classes</span> + + <span class="nn">finders</span><span class="p">:</span> <span class="nv">List</span><span class="p">[</span><span class="nv">BaseFinder</span><span class="p">]</span> <span class="o">=</span> <span class="p">[]</span> + + <span class="s s-Atom">for</span> <span class="s s-Atom">finder_cls</span> <span class="s s-Atom">in</span> <span class="s s-Atom">finder_classes:</span> + + <span class="nn">try</span><span class="p">:</span> + + <span class="s s-Atom">finders</span><span class="p">.</span><span class="nf">append</span><span class="p">(</span><span class="nf">finder_cls</span><span class="p">(</span><span class="s s-Atom">config</span><span class="p">))</span> + + <span class="s s-Atom">except</span> <span class="nv">Exception</span> <span class="s s-Atom">as</span> <span class="nn">exception</span><span class="p">:</span> + + <span class="s s-Atom">#</span> <span class="s s-Atom">if</span> <span class="s s-Atom">one</span> <span class="s s-Atom">finder</span> <span class="s s-Atom">fails</span> <span class="s s-Atom">to</span> <span class="s s-Atom">instantiate</span> <span class="s s-Atom">isort</span> <span class="s s-Atom">can</span> <span class="s s-Atom">continue</span> <span class="s s-Atom">using</span> <span class="s s-Atom">the</span> <span class="s s-Atom">rest</span> + + <span class="s s-Atom">if</span> <span class="s s-Atom">self</span><span class="p">.</span><span class="nn">verbose</span><span class="p">:</span> + + <span class="nf">print</span><span class="p">(</span> + + <span class="p">(</span> + + <span class="s s-Atom">f</span><span class="s2">"{finder_cls.__name__} encountered an error ({exception}) during "</span> + + <span class="s2">"instantiation and cannot be used"</span> + + <span class="p">)</span> + + <span class="p">)</span> + + <span class="s s-Atom">self</span><span class="p">.</span><span class="nn">finders</span><span class="p">:</span> <span class="nv">Tuple</span><span class="p">[</span><span class="nv">BaseFinder</span><span class="p">,</span> <span class="p">...]</span> <span class="o">=</span> <span class="nf">tuple</span><span class="p">(</span><span class="s s-Atom">finders</span><span class="p">)</span> + + <span class="s s-Atom">def</span> <span class="nf">find</span><span class="p">(</span><span class="s s-Atom">self</span><span class="p">,</span> <span class="s s-Atom">module_name:</span> <span class="s s-Atom">str</span><span class="p">)</span> <span class="s s-Atom">-></span> <span class="nv">Optional</span><span class="p">[</span><span class="s s-Atom">str</span><span class="p">]</span><span class="s s-Atom">:</span> + + <span class="s s-Atom">for</span> <span class="s s-Atom">finder</span> <span class="s s-Atom">in</span> <span class="s s-Atom">self</span><span class="p">.</span><span class="nn">finders</span><span class="p">:</span> + + <span class="nn">try</span><span class="p">:</span> + + <span class="s s-Atom">section</span> <span class="o">=</span> <span class="s s-Atom">finder</span><span class="p">.</span><span class="nf">find</span><span class="p">(</span><span class="s s-Atom">module_name</span><span class="p">)</span> + + <span class="s s-Atom">if</span> <span class="s s-Atom">section</span> <span class="o">is</span> <span class="o">not</span> <span class="nv">None</span><span class="s s-Atom">:</span> + + <span class="s s-Atom">return</span> <span class="s s-Atom">section</span> + + <span class="s s-Atom">except</span> <span class="nv">Exception</span> <span class="s s-Atom">as</span> <span class="nn">exception</span><span class="p">:</span> + + <span class="s s-Atom">#</span> <span class="s s-Atom">isort</span> <span class="s s-Atom">has</span> <span class="s s-Atom">to</span> <span class="s s-Atom">be</span> <span class="s s-Atom">able</span> <span class="s s-Atom">to</span> <span class="s s-Atom">keep</span> <span class="s s-Atom">trying</span> <span class="s s-Atom">to</span> <span class="s s-Atom">identify</span> <span class="s s-Atom">the</span> <span class="s s-Atom">correct</span> + + <span class="s s-Atom">#</span> <span class="s s-Atom">import</span> <span class="s s-Atom">section</span> <span class="s s-Atom">even</span> <span class="s s-Atom">if</span> <span class="s s-Atom">one</span> <span class="s s-Atom">approach</span> <span class="s s-Atom">fails</span> + + <span class="s s-Atom">if</span> <span class="s s-Atom">self</span><span class="p">.</span><span class="nn">verbose</span><span class="p">:</span> + + <span class="nf">print</span><span class="p">(</span> + + <span class="s s-Atom">f</span><span class="s2">"{finder.__class__.__name__} encountered an error ({exception}) while "</span> + + <span class="s s-Atom">f</span><span class="s2">"trying to identify the {module_name} module"</span> + + <span class="p">)</span> + + <span class="s s-Atom">return</span> <span class="nv">None</span> +</code></pre></div> + +</details> +<h2 id="variables">Variables</h2> +<div class="codehilite"><pre><span></span><code><span class="n">KNOWN_SECTION_MAPPING</span> +</code></pre></div> + +<h2 id="functions">Functions</h2> +<h3 id="chdir">chdir</h3> +<div class="codehilite"><pre><span></span><code><span class="k">def</span> <span class="nf">chdir</span><span class="p">(</span> + <span class="n">path</span><span class="p">:</span> <span class="nb">str</span> +<span class="p">)</span> <span class="o">-></span> <span class="n">Iterator</span><span class="p">[</span><span class="n">NoneType</span><span class="p">]</span> +</code></pre></div> + +<p>Context manager for changing dir and restoring previous workdir after exit.</p> +<details class="example"><summary>View Source</summary><div class="codehilite"><pre><span></span><code><span class="nv">@contextmanager</span><span class="w"></span> + +<span class="n">def</span><span class="w"> </span><span class="n">chdir</span><span class="p">(</span><span class="k">path</span><span class="err">:</span><span class="w"> </span><span class="nf">str</span><span class="p">)</span><span class="w"> </span><span class="o">-></span><span class="w"> </span><span class="n">Iterator</span><span class="o">[</span><span class="n">None</span><span class="o">]</span><span class="err">:</span><span class="w"></span> + +<span class="w"> </span><span class="ss">"""Context manager for changing dir and restoring previous workdir after exit."""</span><span class="w"></span> + +<span class="w"> </span><span class="n">curdir</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">os</span><span class="p">.</span><span class="n">getcwd</span><span class="p">()</span><span class="w"></span> + +<span class="w"> </span><span class="n">os</span><span class="p">.</span><span class="n">chdir</span><span class="p">(</span><span class="k">path</span><span class="p">)</span><span class="w"></span> + +<span class="w"> </span><span class="k">try</span><span class="err">:</span><span class="w"></span> + +<span class="w"> </span><span class="n">yield</span><span class="w"></span> + +<span class="w"> </span><span class="nl">finally</span><span class="p">:</span><span class="w"></span> + +<span class="w"> </span><span class="n">os</span><span class="p">.</span><span class="n">chdir</span><span class="p">(</span><span class="n">curdir</span><span class="p">)</span><span class="w"></span> +</code></pre></div> + +</details> +<h2 id="classes">Classes</h2> +<h3 id="basefinder">BaseFinder</h3> +<div class="codehilite"><pre><span></span><code><span class="k">class</span> <span class="nc">BaseFinder</span><span class="p">(</span> + <span class="n">config</span><span class="p">:</span> <span class="n">isort</span><span class="o">.</span><span class="n">settings</span><span class="o">.</span><span class="n">Config</span> +<span class="p">)</span> +</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">BaseFinder</span><span class="p">(</span><span class="n">metaclass</span><span class="o">=</span><span class="n">ABCMeta</span><span class="p">)</span><span class="err">:</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">config</span><span class="p">:</span><span class="w"> </span><span class="n">Config</span><span class="p">)</span><span class="w"> </span><span class="o">-></span><span class="w"> </span><span class="k">None</span><span class="err">:</span><span class="w"></span> + +<span class="w"> </span><span class="n">self</span><span class="p">.</span><span class="n">config</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">config</span><span class="w"></span> + +<span class="w"> </span><span class="nv">@abstractmethod</span><span class="w"></span> + +<span class="w"> </span><span class="n">def</span><span class="w"> </span><span class="n">find</span><span class="p">(</span><span class="n">self</span><span class="p">,</span><span class="w"> </span><span class="nl">module_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="o">-></span><span class="w"> </span><span class="n">Optional</span><span class="o">[</span><span class="n">str</span><span class="o">]</span><span class="err">:</span><span class="w"></span> + +<span class="w"> </span><span class="n">raise</span><span class="w"> </span><span class="n">NotImplementedError</span><span class="w"></span> +</code></pre></div> + +</details> +<hr /> +<h4 id="descendants">Descendants</h4> +<ul> +<li>isort.deprecated.finders.ForcedSeparateFinder</li> +<li>isort.deprecated.finders.LocalFinder</li> +<li>isort.deprecated.finders.KnownPatternFinder</li> +<li>isort.deprecated.finders.PathFinder</li> +<li>isort.deprecated.finders.ReqsBaseFinder</li> +<li>isort.deprecated.finders.DefaultFinder</li> +</ul> +<h4 id="methods">Methods</h4> +<h4 id="find">find</h4> +<div class="codehilite"><pre><span></span><code><span class="k">def</span> <span class="nf">find</span><span class="p">(</span> + <span class="bp">self</span><span class="p">,</span> + <span class="n">module_name</span><span class="p">:</span> <span class="nb">str</span> +<span class="p">)</span> <span class="o">-></span> <span class="n">Optional</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="w"> </span><span class="nv">@abstractmethod</span><span class="w"></span> + +<span class="w"> </span><span class="n">def</span><span class="w"> </span><span class="n">find</span><span class="p">(</span><span class="n">self</span><span class="p">,</span><span class="w"> </span><span class="nl">module_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="o">-></span><span class="w"> </span><span class="n">Optional</span><span class="o">[</span><span class="n">str</span><span class="o">]</span><span class="err">:</span><span class="w"></span> + +<span class="w"> </span><span class="n">raise</span><span class="w"> </span><span class="n">NotImplementedError</span><span class="w"></span> +</code></pre></div> + +</details> +<h3 id="defaultfinder">DefaultFinder</h3> +<div class="codehilite"><pre><span></span><code><span class="k">class</span> <span class="nc">DefaultFinder</span><span class="p">(</span> + <span class="n">config</span><span class="p">:</span> <span class="n">isort</span><span class="o">.</span><span class="n">settings</span><span class="o">.</span><span class="n">Config</span> +<span class="p">)</span> +</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">DefaultFinder</span><span class="p">(</span><span class="n">BaseFinder</span><span class="p">)</span><span class="err">:</span><span class="w"></span> + +<span class="w"> </span><span class="n">def</span><span class="w"> </span><span class="n">find</span><span class="p">(</span><span class="n">self</span><span class="p">,</span><span class="w"> </span><span class="nl">module_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="o">-></span><span class="w"> </span><span class="n">Optional</span><span class="o">[</span><span class="n">str</span><span class="o">]</span><span class="err">:</span><span class="w"></span> + +<span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="n">self</span><span class="p">.</span><span class="n">config</span><span class="p">.</span><span class="n">default_section</span><span class="w"></span> +</code></pre></div> + +</details> +<hr /> +<h4 id="ancestors-in-mro">Ancestors (in MRO)</h4> +<ul> +<li>isort.deprecated.finders.BaseFinder</li> +</ul> +<h4 id="methods_1">Methods</h4> +<h4 id="find_1">find</h4> +<div class="codehilite"><pre><span></span><code><span class="k">def</span> <span class="nf">find</span><span class="p">(</span> + <span class="bp">self</span><span class="p">,</span> + <span class="n">module_name</span><span class="p">:</span> <span class="nb">str</span> +<span class="p">)</span> <span class="o">-></span> <span class="n">Optional</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="w"> </span><span class="n">def</span><span class="w"> </span><span class="n">find</span><span class="p">(</span><span class="n">self</span><span class="p">,</span><span class="w"> </span><span class="nl">module_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="o">-></span><span class="w"> </span><span class="n">Optional</span><span class="o">[</span><span class="n">str</span><span class="o">]</span><span class="err">:</span><span class="w"></span> + +<span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="n">self</span><span class="p">.</span><span class="n">config</span><span class="p">.</span><span class="n">default_section</span><span class="w"></span> +</code></pre></div> + +</details> +<h3 id="findersmanager">FindersManager</h3> +<div class="codehilite"><pre><span></span><code><span class="k">class</span> <span class="nc">FindersManager</span><span class="p">(</span> + <span class="n">config</span><span class="p">:</span> <span class="n">isort</span><span class="o">.</span><span class="n">settings</span><span class="o">.</span><span class="n">Config</span><span class="p">,</span> + <span class="n">finder_classes</span><span class="p">:</span> <span class="n">Optional</span><span class="p">[</span><span class="n">Iterable</span><span class="p">[</span><span class="n">Type</span><span class="p">[</span><span class="n">isort</span><span class="o">.</span><span class="n">deprecated</span><span class="o">.</span><span class="n">finders</span><span class="o">.</span><span class="n">BaseFinder</span><span class="p">]]]</span> <span class="o">=</span> <span class="kc">None</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="nl">FindersManager</span><span class="p">:</span><span class="w"></span> + +<span class="w"> </span><span class="nl">_default_finders_classes</span><span class="p">:</span><span class="w"> </span><span class="k">Sequence</span><span class="o">[</span><span class="n">Type[BaseFinder</span><span class="o">]</span><span class="err">]</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">(</span><span class="w"></span> + +<span class="w"> </span><span class="n">ForcedSeparateFinder</span><span class="p">,</span><span class="w"></span> + +<span class="w"> </span><span class="n">LocalFinder</span><span class="p">,</span><span class="w"></span> + +<span class="w"> </span><span class="n">KnownPatternFinder</span><span class="p">,</span><span class="w"></span> + +<span class="w"> </span><span class="n">PathFinder</span><span class="p">,</span><span class="w"></span> + +<span class="w"> </span><span class="n">PipfileFinder</span><span class="p">,</span><span class="w"></span> + +<span class="w"> </span><span class="n">RequirementsFinder</span><span class="p">,</span><span class="w"></span> + +<span class="w"> </span><span class="n">DefaultFinder</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">def</span><span class="w"> </span><span class="n">__init__</span><span class="p">(</span><span class="w"></span> + +<span class="w"> </span><span class="n">self</span><span class="p">,</span><span class="w"> </span><span class="nl">config</span><span class="p">:</span><span class="w"> </span><span class="n">Config</span><span class="p">,</span><span class="w"> </span><span class="nl">finder_classes</span><span class="p">:</span><span class="w"> </span><span class="n">Optional</span><span class="o">[</span><span class="n">Iterable[Type[BaseFinder</span><span class="o">]</span><span class="err">]]</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">None</span><span class="w"></span> + +<span class="w"> </span><span class="p">)</span><span class="w"> </span><span class="o">-></span><span class="w"> </span><span class="k">None</span><span class="err">:</span><span class="w"></span> + +<span class="w"> </span><span class="n">self</span><span class="p">.</span><span class="nl">verbose</span><span class="p">:</span><span class="w"> </span><span class="n">bool</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">config</span><span class="p">.</span><span class="n">verbose</span><span class="w"></span> + +<span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="n">finder_classes</span><span class="w"> </span><span class="k">is</span><span class="w"> </span><span class="k">None</span><span class="err">:</span><span class="w"></span> + +<span class="w"> </span><span class="n">finder_classes</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">self</span><span class="p">.</span><span class="n">_default_finders_classes</span><span class="w"></span> + +<span class="w"> </span><span class="nl">finders</span><span class="p">:</span><span class="w"> </span><span class="n">List</span><span class="o">[</span><span class="n">BaseFinder</span><span class="o">]</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="err">[]</span><span class="w"></span> + +<span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="n">finder_cls</span><span class="w"> </span><span class="ow">in</span><span class="w"> </span><span class="nl">finder_classes</span><span class="p">:</span><span class="w"></span> + +<span class="w"> </span><span class="k">try</span><span class="err">:</span><span class="w"></span> + +<span class="w"> </span><span class="n">finders</span><span class="p">.</span><span class="n">append</span><span class="p">(</span><span class="n">finder_cls</span><span class="p">(</span><span class="n">config</span><span class="p">))</span><span class="w"></span> + +<span class="w"> </span><span class="ow">except</span><span class="w"> </span><span class="k">Exception</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="k">exception</span><span class="err">:</span><span class="w"></span> + +<span class="w"> </span><span class="err">#</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="n">one</span><span class="w"> </span><span class="n">finder</span><span class="w"> </span><span class="n">fails</span><span class="w"> </span><span class="k">to</span><span class="w"> </span><span class="n">instantiate</span><span class="w"> </span><span class="n">isort</span><span class="w"> </span><span class="n">can</span><span class="w"> </span><span class="k">continue</span><span class="w"> </span><span class="k">using</span><span class="w"> </span><span class="n">the</span><span class="w"> </span><span class="n">rest</span><span class="w"></span> + +<span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="n">self</span><span class="p">.</span><span class="nl">verbose</span><span class="p">:</span><span class="w"></span> + +<span class="w"> </span><span class="k">print</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">f</span><span class="ss">"{finder_cls.__name__} encountered an error ({exception}) during "</span><span class="w"></span> + +<span class="w"> </span><span class="ss">"instantiation and cannot be used"</span><span class="w"></span> + +<span class="w"> </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">self</span><span class="p">.</span><span class="nl">finders</span><span class="p">:</span><span class="w"> </span><span class="n">Tuple</span><span class="o">[</span><span class="n">BaseFinder, ...</span><span class="o">]</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">tuple</span><span class="p">(</span><span class="n">finders</span><span class="p">)</span><span class="w"></span> + +<span class="w"> </span><span class="n">def</span><span class="w"> </span><span class="n">find</span><span class="p">(</span><span class="n">self</span><span class="p">,</span><span class="w"> </span><span class="nl">module_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="o">-></span><span class="w"> </span><span class="n">Optional</span><span class="o">[</span><span class="n">str</span><span class="o">]</span><span class="err">:</span><span class="w"></span> + +<span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="n">finder</span><span class="w"> </span><span class="ow">in</span><span class="w"> </span><span class="n">self</span><span class="p">.</span><span class="nl">finders</span><span class="p">:</span><span class="w"></span> + +<span class="w"> </span><span class="k">try</span><span class="err">:</span><span class="w"></span> + +<span class="w"> </span><span class="k">section</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">finder</span><span class="p">.</span><span class="n">find</span><span class="p">(</span><span class="n">module_name</span><span class="p">)</span><span class="w"></span> + +<span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="k">section</span><span class="w"> </span><span class="k">is</span><span class="w"> </span><span class="ow">not</span><span class="w"> </span><span class="k">None</span><span class="err">:</span><span class="w"></span> + +<span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="k">section</span><span class="w"></span> + +<span class="w"> </span><span class="ow">except</span><span class="w"> </span><span class="k">Exception</span><span class="w"> </span><span class="k">as</span><span class="w"> </span><span class="k">exception</span><span class="err">:</span><span class="w"></span> + +<span class="w"> </span><span class="err">#</span><span class="w"> </span><span class="n">isort</span><span class="w"> </span><span class="n">has</span><span class="w"> </span><span class="k">to</span><span class="w"> </span><span class="n">be</span><span class="w"> </span><span class="n">able</span><span class="w"> </span><span class="k">to</span><span class="w"> </span><span class="n">keep</span><span class="w"> </span><span class="n">trying</span><span class="w"> </span><span class="k">to</span><span class="w"> </span><span class="n">identify</span><span class="w"> </span><span class="n">the</span><span class="w"> </span><span class="n">correct</span><span class="w"></span> + +<span class="w"> </span><span class="err">#</span><span class="w"> </span><span class="n">import</span><span class="w"> </span><span class="k">section</span><span class="w"> </span><span class="n">even</span><span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="n">one</span><span class="w"> </span><span class="n">approach</span><span class="w"> </span><span class="n">fails</span><span class="w"></span> + +<span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="n">self</span><span class="p">.</span><span class="nl">verbose</span><span class="p">:</span><span class="w"></span> + +<span class="w"> </span><span class="k">print</span><span class="p">(</span><span class="w"></span> + +<span class="w"> </span><span class="n">f</span><span class="ss">"{finder.__class__.__name__} encountered an error ({exception}) while "</span><span class="w"></span> + +<span class="w"> </span><span class="n">f</span><span class="ss">"trying to identify the {module_name} module"</span><span class="w"></span> + +<span class="w"> </span><span class="p">)</span><span class="w"></span> + +<span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="k">None</span><span class="w"></span> +</code></pre></div> + +</details> +<hr /> +<h4 id="methods_2">Methods</h4> +<h4 id="find_2">find</h4> +<div class="codehilite"><pre><span></span><code><span class="k">def</span> <span class="nf">find</span><span class="p">(</span> + <span class="bp">self</span><span class="p">,</span> + <span class="n">module_name</span><span class="p">:</span> <span class="nb">str</span> +<span class="p">)</span> <span class="o">-></span> <span class="n">Optional</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">def</span> <span class="nf">find</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">module_name</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]:</span> + + <span class="k">for</span> <span class="n">finder</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">finders</span><span class="p">:</span> + + <span class="k">try</span><span class="p">:</span> + + <span class="n">section</span> <span class="o">=</span> <span class="n">finder</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="n">module_name</span><span class="p">)</span> + + <span class="k">if</span> <span class="n">section</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span> + + <span class="k">return</span> <span class="n">section</span> + + <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">exception</span><span class="p">:</span> + + <span class="c1"># isort has to be able to keep trying to identify the correct</span> + + <span class="c1"># import section even if one approach fails</span> + + <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">verbose</span><span class="p">:</span> + + <span class="nb">print</span><span class="p">(</span> + + <span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">finder</span><span class="o">.</span><span class="vm">__class__</span><span class="o">.</span><span class="vm">__name__</span><span class="si">}</span><span class="s2"> encountered an error (</span><span class="si">{</span><span class="n">exception</span><span class="si">}</span><span class="s2">) while "</span> + + <span class="sa">f</span><span class="s2">"trying to identify the </span><span class="si">{</span><span class="n">module_name</span><span class="si">}</span><span class="s2"> module"</span> + + <span class="p">)</span> + + <span class="k">return</span> <span class="kc">None</span> +</code></pre></div> + +</details> +<h3 id="forcedseparatefinder">ForcedSeparateFinder</h3> +<div class="codehilite"><pre><span></span><code><span class="k">class</span> <span class="nc">ForcedSeparateFinder</span><span class="p">(</span> + <span class="n">config</span><span class="p">:</span> <span class="n">isort</span><span class="o">.</span><span class="n">settings</span><span class="o">.</span><span class="n">Config</span> +<span class="p">)</span> +</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">ForcedSeparateFinder</span><span class="p">(</span><span class="n">BaseFinder</span><span class="p">)</span><span class="err">:</span><span class="w"></span> + +<span class="w"> </span><span class="n">def</span><span class="w"> </span><span class="n">find</span><span class="p">(</span><span class="n">self</span><span class="p">,</span><span class="w"> </span><span class="nl">module_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="o">-></span><span class="w"> </span><span class="n">Optional</span><span class="o">[</span><span class="n">str</span><span class="o">]</span><span class="err">:</span><span class="w"></span> + +<span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="n">forced_separate</span><span class="w"> </span><span class="ow">in</span><span class="w"> </span><span class="n">self</span><span class="p">.</span><span class="n">config</span><span class="p">.</span><span class="nl">forced_separate</span><span class="p">:</span><span class="w"></span> + +<span class="w"> </span><span class="err">#</span><span class="w"> </span><span class="n">Ensure</span><span class="w"> </span><span class="ow">all</span><span class="w"> </span><span class="n">forced_separate</span><span class="w"> </span><span class="n">patterns</span><span class="w"> </span><span class="n">will</span><span class="w"> </span><span class="k">match</span><span class="w"> </span><span class="k">to</span><span class="w"> </span><span class="k">end</span><span class="w"> </span><span class="k">of</span><span class="w"> </span><span class="n">string</span><span class="w"></span> + +<span class="w"> </span><span class="n">path_glob</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">forced_separate</span><span class="w"></span> + +<span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="ow">not</span><span class="w"> </span><span class="n">forced_separate</span><span class="p">.</span><span class="n">endswith</span><span class="p">(</span><span class="ss">"*"</span><span class="p">)</span><span class="err">:</span><span class="w"></span> + +<span class="w"> </span><span class="n">path_glob</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="ss">"%s*"</span><span class="w"> </span><span class="o">%</span><span class="w"> </span><span class="n">forced_separate</span><span class="w"></span> + +<span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="n">fnmatch</span><span class="p">(</span><span class="n">module_name</span><span class="p">,</span><span class="w"> </span><span class="n">path_glob</span><span class="p">)</span><span class="w"> </span><span class="ow">or</span><span class="w"> </span><span class="n">fnmatch</span><span class="p">(</span><span class="n">module_name</span><span class="p">,</span><span class="w"> </span><span class="ss">"."</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="n">path_glob</span><span class="p">)</span><span class="err">:</span><span class="w"></span> + +<span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="n">forced_separate</span><span class="w"></span> + +<span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="k">None</span><span class="w"></span> +</code></pre></div> + +</details> +<hr /> +<h4 id="ancestors-in-mro_1">Ancestors (in MRO)</h4> +<ul> +<li>isort.deprecated.finders.BaseFinder</li> +</ul> +<h4 id="methods_3">Methods</h4> +<h4 id="find_3">find</h4> +<div class="codehilite"><pre><span></span><code><span class="k">def</span> <span class="nf">find</span><span class="p">(</span> + <span class="bp">self</span><span class="p">,</span> + <span class="n">module_name</span><span class="p">:</span> <span class="nb">str</span> +<span class="p">)</span> <span class="o">-></span> <span class="n">Optional</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="w"> </span><span class="n">def</span><span class="w"> </span><span class="n">find</span><span class="p">(</span><span class="n">self</span><span class="p">,</span><span class="w"> </span><span class="nl">module_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="o">-></span><span class="w"> </span><span class="n">Optional</span><span class="o">[</span><span class="n">str</span><span class="o">]</span><span class="err">:</span><span class="w"></span> + +<span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="n">forced_separate</span><span class="w"> </span><span class="ow">in</span><span class="w"> </span><span class="n">self</span><span class="p">.</span><span class="n">config</span><span class="p">.</span><span class="nl">forced_separate</span><span class="p">:</span><span class="w"></span> + +<span class="w"> </span><span class="err">#</span><span class="w"> </span><span class="n">Ensure</span><span class="w"> </span><span class="ow">all</span><span class="w"> </span><span class="n">forced_separate</span><span class="w"> </span><span class="n">patterns</span><span class="w"> </span><span class="n">will</span><span class="w"> </span><span class="k">match</span><span class="w"> </span><span class="k">to</span><span class="w"> </span><span class="k">end</span><span class="w"> </span><span class="k">of</span><span class="w"> </span><span class="n">string</span><span class="w"></span> + +<span class="w"> </span><span class="n">path_glob</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">forced_separate</span><span class="w"></span> + +<span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="ow">not</span><span class="w"> </span><span class="n">forced_separate</span><span class="p">.</span><span class="n">endswith</span><span class="p">(</span><span class="ss">"*"</span><span class="p">)</span><span class="err">:</span><span class="w"></span> + +<span class="w"> </span><span class="n">path_glob</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="ss">"%s*"</span><span class="w"> </span><span class="o">%</span><span class="w"> </span><span class="n">forced_separate</span><span class="w"></span> + +<span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="n">fnmatch</span><span class="p">(</span><span class="n">module_name</span><span class="p">,</span><span class="w"> </span><span class="n">path_glob</span><span class="p">)</span><span class="w"> </span><span class="ow">or</span><span class="w"> </span><span class="n">fnmatch</span><span class="p">(</span><span class="n">module_name</span><span class="p">,</span><span class="w"> </span><span class="ss">"."</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="n">path_glob</span><span class="p">)</span><span class="err">:</span><span class="w"></span> + +<span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="n">forced_separate</span><span class="w"></span> + +<span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="k">None</span><span class="w"></span> +</code></pre></div> + +</details> +<h3 id="knownpatternfinder">KnownPatternFinder</h3> +<div class="codehilite"><pre><span></span><code><span class="k">class</span> <span class="nc">KnownPatternFinder</span><span class="p">(</span> + <span class="n">config</span><span class="p">:</span> <span class="n">isort</span><span class="o">.</span><span class="n">settings</span><span class="o">.</span><span class="n">Config</span> +<span class="p">)</span> +</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">KnownPatternFinder</span><span class="p">(</span><span class="n">BaseFinder</span><span class="p">)</span><span class="err">:</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">config</span><span class="p">:</span><span class="w"> </span><span class="n">Config</span><span class="p">)</span><span class="w"> </span><span class="o">-></span><span class="w"> </span><span class="k">None</span><span class="err">:</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="n">config</span><span class="p">)</span><span class="w"></span> + +<span class="w"> </span><span class="n">self</span><span class="p">.</span><span class="nl">known_patterns</span><span class="p">:</span><span class="w"> </span><span class="n">List</span><span class="o">[</span><span class="n">Tuple[Pattern[str</span><span class="o">]</span><span class="p">,</span><span class="w"> </span><span class="nf">str</span><span class="err">]]</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="err">[]</span><span class="w"></span> + +<span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="n">placement</span><span class="w"> </span><span class="ow">in</span><span class="w"> </span><span class="n">reversed</span><span class="p">(</span><span class="n">config</span><span class="p">.</span><span class="n">sections</span><span class="p">)</span><span class="err">:</span><span class="w"></span> + +<span class="w"> </span><span class="n">known_placement</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">KNOWN_SECTION_MAPPING</span><span class="p">.</span><span class="k">get</span><span class="p">(</span><span class="n">placement</span><span class="p">,</span><span class="w"> </span><span class="n">placement</span><span class="p">).</span><span class="nf">lower</span><span class="p">()</span><span class="w"></span> + +<span class="w"> </span><span class="n">config_key</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">f</span><span class="ss">"known_{known_placement}"</span><span class="w"></span> + +<span class="w"> </span><span class="n">known_patterns</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">list</span><span class="p">(</span><span class="w"></span> + +<span class="w"> </span><span class="n">getattr</span><span class="p">(</span><span class="n">self</span><span class="p">.</span><span class="n">config</span><span class="p">,</span><span class="w"> </span><span class="n">config_key</span><span class="p">,</span><span class="w"> </span><span class="n">self</span><span class="p">.</span><span class="n">config</span><span class="p">.</span><span class="n">known_other</span><span class="p">.</span><span class="k">get</span><span class="p">(</span><span class="n">known_placement</span><span class="p">,</span><span class="w"> </span><span class="err">[]</span><span class="p">))</span><span class="w"></span> + +<span class="w"> </span><span class="p">)</span><span class="w"></span> + +<span class="w"> </span><span class="n">known_patterns</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="o">[</span><span class="n"></span> + +<span class="n"> pattern</span> + +<span class="n"> for known_pattern in known_patterns</span> + +<span class="n"> for pattern in self._parse_known_pattern(known_pattern)</span> + +<span class="n"> </span><span class="o">]</span><span class="w"></span> + +<span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="n">known_pattern</span><span class="w"> </span><span class="ow">in</span><span class="w"> </span><span class="nl">known_patterns</span><span class="p">:</span><span class="w"></span> + +<span class="w"> </span><span class="n">regexp</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="ss">"^"</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="n">known_pattern</span><span class="p">.</span><span class="nf">replace</span><span class="p">(</span><span class="ss">"*"</span><span class="p">,</span><span class="w"> </span><span class="ss">".*"</span><span class="p">).</span><span class="nf">replace</span><span class="p">(</span><span class="ss">"?"</span><span class="p">,</span><span class="w"> </span><span class="ss">".?"</span><span class="p">)</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="ss">"$"</span><span class="w"></span> + +<span class="w"> </span><span class="n">self</span><span class="p">.</span><span class="n">known_patterns</span><span class="p">.</span><span class="n">append</span><span class="p">((</span><span class="n">re</span><span class="p">.</span><span class="n">compile</span><span class="p">(</span><span class="n">regexp</span><span class="p">),</span><span class="w"> </span><span class="n">placement</span><span class="p">))</span><span class="w"></span> + +<span class="w"> </span><span class="n">def</span><span class="w"> </span><span class="n">_parse_known_pattern</span><span class="p">(</span><span class="n">self</span><span class="p">,</span><span class="w"> </span><span class="nl">pattern</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="n">List</span><span class="o">[</span><span class="n">str</span><span class="o">]</span><span class="err">:</span><span class="w"></span> + +<span class="w"> </span><span class="ss">"""Expand pattern if identified as a directory and return found sub packages"""</span><span class="w"></span> + +<span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="n">pattern</span><span class="p">.</span><span class="n">endswith</span><span class="p">(</span><span class="n">os</span><span class="p">.</span><span class="k">path</span><span class="p">.</span><span class="n">sep</span><span class="p">)</span><span class="err">:</span><span class="w"></span> + +<span class="w"> </span><span class="n">patterns</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="o">[</span><span class="n"></span> + +<span class="n"> filename</span> + +<span class="n"> for filename in os.listdir(os.path.join(self.config.directory, pattern))</span> + +<span class="n"> if os.path.isdir(os.path.join(self.config.directory, pattern, filename))</span> + +<span class="n"> </span><span class="o">]</span><span class="w"></span> + +<span class="w"> </span><span class="k">else</span><span class="err">:</span><span class="w"></span> + +<span class="w"> </span><span class="n">patterns</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="o">[</span><span class="n">pattern</span><span class="o">]</span><span class="w"></span> + +<span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="n">patterns</span><span class="w"></span> + +<span class="w"> </span><span class="n">def</span><span class="w"> </span><span class="n">find</span><span class="p">(</span><span class="n">self</span><span class="p">,</span><span class="w"> </span><span class="nl">module_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="o">-></span><span class="w"> </span><span class="n">Optional</span><span class="o">[</span><span class="n">str</span><span class="o">]</span><span class="err">:</span><span class="w"></span> + +<span class="w"> </span><span class="err">#</span><span class="w"> </span><span class="k">Try</span><span class="w"> </span><span class="k">to</span><span class="w"> </span><span class="n">find</span><span class="w"> </span><span class="n">most</span><span class="w"> </span><span class="k">specific</span><span class="w"> </span><span class="n">placement</span><span class="w"> </span><span class="n">instruction</span><span class="w"> </span><span class="k">match</span><span class="w"> </span><span class="p">(</span><span class="k">if</span><span class="w"> </span><span class="ow">any</span><span class="p">)</span><span class="w"></span> + +<span class="w"> </span><span class="n">parts</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">module_name</span><span class="p">.</span><span class="n">split</span><span class="p">(</span><span class="ss">"."</span><span class="p">)</span><span class="w"></span> + +<span class="w"> </span><span class="n">module_names_to_check</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">(</span><span class="ss">"."</span><span class="p">.</span><span class="k">join</span><span class="p">(</span><span class="n">parts</span><span class="o">[</span><span class="n">:first_k</span><span class="o">]</span><span class="p">)</span><span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="n">first_k</span><span class="w"> </span><span class="ow">in</span><span class="w"> </span><span class="k">range</span><span class="p">(</span><span class="nf">len</span><span class="p">(</span><span class="n">parts</span><span class="p">),</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w"> </span><span class="o">-</span><span class="mi">1</span><span class="p">))</span><span class="w"></span> + +<span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="n">module_name_to_check</span><span class="w"> </span><span class="ow">in</span><span class="w"> </span><span class="nl">module_names_to_check</span><span class="p">:</span><span class="w"></span> + +<span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="n">pattern</span><span class="p">,</span><span class="w"> </span><span class="n">placement</span><span class="w"> </span><span class="ow">in</span><span class="w"> </span><span class="n">self</span><span class="p">.</span><span class="nl">known_patterns</span><span class="p">:</span><span class="w"></span> + +<span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="n">pattern</span><span class="p">.</span><span class="k">match</span><span class="p">(</span><span class="n">module_name_to_check</span><span class="p">)</span><span class="err">:</span><span class="w"></span> + +<span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="n">placement</span><span class="w"></span> + +<span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="k">None</span><span class="w"></span> +</code></pre></div> + +</details> +<hr /> +<h4 id="ancestors-in-mro_2">Ancestors (in MRO)</h4> +<ul> +<li>isort.deprecated.finders.BaseFinder</li> +</ul> +<h4 id="methods_4">Methods</h4> +<h4 id="find_4">find</h4> +<div class="codehilite"><pre><span></span><code><span class="k">def</span> <span class="nf">find</span><span class="p">(</span> + <span class="bp">self</span><span class="p">,</span> + <span class="n">module_name</span><span class="p">:</span> <span class="nb">str</span> +<span class="p">)</span> <span class="o">-></span> <span class="n">Optional</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="w"> </span><span class="n">def</span><span class="w"> </span><span class="n">find</span><span class="p">(</span><span class="n">self</span><span class="p">,</span><span class="w"> </span><span class="nl">module_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="o">-></span><span class="w"> </span><span class="n">Optional</span><span class="o">[</span><span class="n">str</span><span class="o">]</span><span class="err">:</span><span class="w"></span> + +<span class="w"> </span><span class="err">#</span><span class="w"> </span><span class="k">Try</span><span class="w"> </span><span class="k">to</span><span class="w"> </span><span class="n">find</span><span class="w"> </span><span class="n">most</span><span class="w"> </span><span class="k">specific</span><span class="w"> </span><span class="n">placement</span><span class="w"> </span><span class="n">instruction</span><span class="w"> </span><span class="k">match</span><span class="w"> </span><span class="p">(</span><span class="k">if</span><span class="w"> </span><span class="ow">any</span><span class="p">)</span><span class="w"></span> + +<span class="w"> </span><span class="n">parts</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">module_name</span><span class="p">.</span><span class="n">split</span><span class="p">(</span><span class="ss">"."</span><span class="p">)</span><span class="w"></span> + +<span class="w"> </span><span class="n">module_names_to_check</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">(</span><span class="ss">"."</span><span class="p">.</span><span class="k">join</span><span class="p">(</span><span class="n">parts</span><span class="o">[</span><span class="n">:first_k</span><span class="o">]</span><span class="p">)</span><span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="n">first_k</span><span class="w"> </span><span class="ow">in</span><span class="w"> </span><span class="k">range</span><span class="p">(</span><span class="nf">len</span><span class="p">(</span><span class="n">parts</span><span class="p">),</span><span class="w"> </span><span class="mi">0</span><span class="p">,</span><span class="w"> </span><span class="o">-</span><span class="mi">1</span><span class="p">))</span><span class="w"></span> + +<span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="n">module_name_to_check</span><span class="w"> </span><span class="ow">in</span><span class="w"> </span><span class="nl">module_names_to_check</span><span class="p">:</span><span class="w"></span> + +<span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="n">pattern</span><span class="p">,</span><span class="w"> </span><span class="n">placement</span><span class="w"> </span><span class="ow">in</span><span class="w"> </span><span class="n">self</span><span class="p">.</span><span class="nl">known_patterns</span><span class="p">:</span><span class="w"></span> + +<span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="n">pattern</span><span class="p">.</span><span class="k">match</span><span class="p">(</span><span class="n">module_name_to_check</span><span class="p">)</span><span class="err">:</span><span class="w"></span> + +<span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="n">placement</span><span class="w"></span> + +<span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="k">None</span><span class="w"></span> +</code></pre></div> + +</details> +<h3 id="localfinder">LocalFinder</h3> +<div class="codehilite"><pre><span></span><code><span class="k">class</span> <span class="nc">LocalFinder</span><span class="p">(</span> + <span class="n">config</span><span class="p">:</span> <span class="n">isort</span><span class="o">.</span><span class="n">settings</span><span class="o">.</span><span class="n">Config</span> +<span class="p">)</span> +</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">LocalFinder</span><span class="p">(</span><span class="n">BaseFinder</span><span class="p">)</span><span class="err">:</span><span class="w"></span> + +<span class="w"> </span><span class="n">def</span><span class="w"> </span><span class="n">find</span><span class="p">(</span><span class="n">self</span><span class="p">,</span><span class="w"> </span><span class="nl">module_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="o">-></span><span class="w"> </span><span class="n">Optional</span><span class="o">[</span><span class="n">str</span><span class="o">]</span><span class="err">:</span><span class="w"></span> + +<span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="n">module_name</span><span class="p">.</span><span class="n">startswith</span><span class="p">(</span><span class="ss">"."</span><span class="p">)</span><span class="err">:</span><span class="w"></span> + +<span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="ss">"LOCALFOLDER"</span><span class="w"></span> + +<span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="k">None</span><span class="w"></span> +</code></pre></div> + +</details> +<hr /> +<h4 id="ancestors-in-mro_3">Ancestors (in MRO)</h4> +<ul> +<li>isort.deprecated.finders.BaseFinder</li> +</ul> +<h4 id="methods_5">Methods</h4> +<h4 id="find_5">find</h4> +<div class="codehilite"><pre><span></span><code><span class="k">def</span> <span class="nf">find</span><span class="p">(</span> + <span class="bp">self</span><span class="p">,</span> + <span class="n">module_name</span><span class="p">:</span> <span class="nb">str</span> +<span class="p">)</span> <span class="o">-></span> <span class="n">Optional</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="w"> </span><span class="n">def</span><span class="w"> </span><span class="n">find</span><span class="p">(</span><span class="n">self</span><span class="p">,</span><span class="w"> </span><span class="nl">module_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="o">-></span><span class="w"> </span><span class="n">Optional</span><span class="o">[</span><span class="n">str</span><span class="o">]</span><span class="err">:</span><span class="w"></span> + +<span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="n">module_name</span><span class="p">.</span><span class="n">startswith</span><span class="p">(</span><span class="ss">"."</span><span class="p">)</span><span class="err">:</span><span class="w"></span> + +<span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="ss">"LOCALFOLDER"</span><span class="w"></span> + +<span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="k">None</span><span class="w"></span> +</code></pre></div> + +</details> +<h3 id="pathfinder">PathFinder</h3> +<div class="codehilite"><pre><span></span><code><span class="k">class</span> <span class="nc">PathFinder</span><span class="p">(</span> + <span class="n">config</span><span class="p">:</span> <span class="n">isort</span><span class="o">.</span><span class="n">settings</span><span class="o">.</span><span class="n">Config</span><span class="p">,</span> + <span class="n">path</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s1">'.'</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">PathFinder</span><span class="p">(</span><span class="n">BaseFinder</span><span class="p">):</span> + + <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">config</span><span class="p">:</span> <span class="n">Config</span><span class="p">,</span> <span class="n">path</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">"."</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</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">config</span><span class="p">)</span> + + <span class="c1"># restore the original import path (i.e. not the path to bin/isort)</span> + + <span class="n">root_dir</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">abspath</span><span class="p">(</span><span class="n">path</span><span class="p">)</span> + + <span class="n">src_dir</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="n">root_dir</span><span class="si">}</span><span class="s2">/src"</span> + + <span class="bp">self</span><span class="o">.</span><span class="n">paths</span> <span class="o">=</span> <span class="p">[</span><span class="n">root_dir</span><span class="p">,</span> <span class="n">src_dir</span><span class="p">]</span> + + <span class="c1"># virtual env</span> + + <span class="bp">self</span><span class="o">.</span><span class="n">virtual_env</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">virtual_env</span> <span class="ow">or</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"VIRTUAL_ENV"</span><span class="p">)</span> + + <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">virtual_env</span><span class="p">:</span> + + <span class="bp">self</span><span class="o">.</span><span class="n">virtual_env</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">realpath</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">virtual_env</span><span class="p">)</span> + + <span class="bp">self</span><span class="o">.</span><span class="n">virtual_env_src</span> <span class="o">=</span> <span class="s2">""</span> + + <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">virtual_env</span><span class="p">:</span> + + <span class="bp">self</span><span class="o">.</span><span class="n">virtual_env_src</span> <span class="o">=</span> <span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">virtual_env</span><span class="si">}</span><span class="s2">/src/"</span> + + <span class="k">for</span> <span class="n">venv_path</span> <span class="ow">in</span> <span class="n">glob</span><span class="p">(</span><span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">virtual_env</span><span class="si">}</span><span class="s2">/lib/python*/site-packages"</span><span class="p">):</span> + + <span class="k">if</span> <span class="n">venv_path</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">paths</span><span class="p">:</span> + + <span class="bp">self</span><span class="o">.</span><span class="n">paths</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">venv_path</span><span class="p">)</span> + + <span class="k">for</span> <span class="n">nested_venv_path</span> <span class="ow">in</span> <span class="n">glob</span><span class="p">(</span><span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">virtual_env</span><span class="si">}</span><span class="s2">/lib/python*/*/site-packages"</span><span class="p">):</span> + + <span class="k">if</span> <span class="n">nested_venv_path</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">paths</span><span class="p">:</span> + + <span class="bp">self</span><span class="o">.</span><span class="n">paths</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">nested_venv_path</span><span class="p">)</span> + + <span class="k">for</span> <span class="n">venv_src_path</span> <span class="ow">in</span> <span class="n">glob</span><span class="p">(</span><span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">virtual_env</span><span class="si">}</span><span class="s2">/src/*"</span><span class="p">):</span> + + <span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isdir</span><span class="p">(</span><span class="n">venv_src_path</span><span class="p">):</span> + + <span class="bp">self</span><span class="o">.</span><span class="n">paths</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">venv_src_path</span><span class="p">)</span> + + <span class="c1"># conda</span> + + <span class="bp">self</span><span class="o">.</span><span class="n">conda_env</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">conda_env</span> <span class="ow">or</span> <span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">"CONDA_PREFIX"</span><span class="p">)</span> <span class="ow">or</span> <span class="s2">""</span> + + <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">conda_env</span><span class="p">:</span> + + <span class="bp">self</span><span class="o">.</span><span class="n">conda_env</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">realpath</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">conda_env</span><span class="p">)</span> + + <span class="k">for</span> <span class="n">conda_path</span> <span class="ow">in</span> <span class="n">glob</span><span class="p">(</span><span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">conda_env</span><span class="si">}</span><span class="s2">/lib/python*/site-packages"</span><span class="p">):</span> + + <span class="k">if</span> <span class="n">conda_path</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">paths</span><span class="p">:</span> + + <span class="bp">self</span><span class="o">.</span><span class="n">paths</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">conda_path</span><span class="p">)</span> + + <span class="k">for</span> <span class="n">nested_conda_path</span> <span class="ow">in</span> <span class="n">glob</span><span class="p">(</span><span class="sa">f</span><span class="s2">"</span><span class="si">{</span><span class="bp">self</span><span class="o">.</span><span class="n">conda_env</span><span class="si">}</span><span class="s2">/lib/python*/*/site-packages"</span><span class="p">):</span> + + <span class="k">if</span> <span class="n">nested_conda_path</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">paths</span><span class="p">:</span> + + <span class="bp">self</span><span class="o">.</span><span class="n">paths</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">nested_conda_path</span><span class="p">)</span> + + <span class="c1"># handle case-insensitive paths on windows</span> + + <span class="bp">self</span><span class="o">.</span><span class="n">stdlib_lib_prefix</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">normcase</span><span class="p">(</span><span class="n">sysconfig</span><span class="o">.</span><span class="n">get_paths</span><span class="p">()[</span><span class="s2">"stdlib"</span><span class="p">])</span> + + <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">stdlib_lib_prefix</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">paths</span><span class="p">:</span> + + <span class="bp">self</span><span class="o">.</span><span class="n">paths</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stdlib_lib_prefix</span><span class="p">)</span> + + <span class="c1"># add system paths</span> + + <span class="k">for</span> <span class="n">system_path</span> <span class="ow">in</span> <span class="n">sys</span><span class="o">.</span><span class="n">path</span><span class="p">[</span><span class="mi">1</span><span class="p">:]:</span> + + <span class="k">if</span> <span class="n">system_path</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">paths</span><span class="p">:</span> + + <span class="bp">self</span><span class="o">.</span><span class="n">paths</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="n">system_path</span><span class="p">)</span> + + <span class="k">def</span> <span class="nf">find</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">module_name</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="n">Optional</span><span class="p">[</span><span class="nb">str</span><span class="p">]:</span> + + <span class="k">for</span> <span class="n">prefix</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">paths</span><span class="p">:</span> + + <span class="n">package_path</span> <span class="o">=</span> <span class="s2">"/"</span><span class="o">.</span><span class="n">join</span><span class="p">((</span><span class="n">prefix</span><span class="p">,</span> <span class="n">module_name</span><span class="o">.</span><span class="n">split</span><span class="p">(</span><span class="s2">"."</span><span class="p">)[</span><span class="mi">0</span><span class="p">]))</span> + + <span class="n">path_obj</span> <span class="o">=</span> <span class="n">Path</span><span class="p">(</span><span class="n">package_path</span><span class="p">)</span><span class="o">.</span><span class="n">resolve</span><span class="p">()</span> + + <span class="n">is_module</span> <span class="o">=</span> <span class="p">(</span> + + <span class="n">exists_case_sensitive</span><span class="p">(</span><span class="n">package_path</span> <span class="o">+</span> <span class="s2">".py"</span><span class="p">)</span> + + <span class="ow">or</span> <span class="nb">any</span><span class="p">(</span> + + <span class="n">exists_case_sensitive</span><span class="p">(</span><span class="n">package_path</span> <span class="o">+</span> <span class="n">ext_suffix</span><span class="p">)</span> + + <span class="k">for</span> <span class="n">ext_suffix</span> <span class="ow">in</span> <span class="n">importlib</span><span class="o">.</span><span class="n">machinery</span><span class="o">.</span><span class="n">EXTENSION_SUFFIXES</span> + + <span class="p">)</span> + + <span class="ow">or</span> <span class="n">exists_case_sensitive</span><span class="p">(</span><span class="n">package_path</span> <span class="o">+</span> <span class="s2">"/__init__.py"</span><span class="p">)</span> + + <span class="p">)</span> + + <span class="n">is_package</span> <span class="o">=</span> <span class="n">exists_case_sensitive</span><span class="p">(</span><span class="n">package_path</span><span class="p">)</span> <span class="ow">and</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">isdir</span><span class="p">(</span><span class="n">package_path</span><span class="p">)</span> + + <span class="k">if</span> <span class="n">is_module</span> <span class="ow">or</span> <span class="n">is_package</span><span class="p">:</span> + + <span class="k">if</span> <span class="p">(</span> + + <span class="s2">"site-packages"</span> <span class="ow">in</span> <span class="n">prefix</span> + + <span class="ow">or</span> <span class="s2">"dist-packages"</span> <span class="ow">in</span> <span class="n">prefix</span> + + <span class="ow">or</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">virtual_env</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">virtual_env_src</span> <span class="ow">in</span> <span class="n">prefix</span><span class="p">)</span> + + <span class="p">):</span> + + <span class="k">return</span> <span class="n">sections</span><span class="o">.</span><span class="n">THIRDPARTY</span> + + <span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">normcase</span><span class="p">(</span><span class="n">prefix</span><span class="p">)</span> <span class="o">==</span> <span class="bp">self</span><span class="o">.</span><span class="n">stdlib_lib_prefix</span><span class="p">:</span> + + <span class="k">return</span> <span class="n">sections</span><span class="o">.</span><span class="n">STDLIB</span> + + <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">conda_env</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">conda_env</span> <span class="ow">in</span> <span class="n">prefix</span><span class="p">:</span> + + <span class="k">return</span> <span class="n">sections</span><span class="o">.</span><span class="n">THIRDPARTY</span> + + <span class="k">for</span> <span class="n">src_path</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">src_paths</span><span class="p">:</span> + + <span class="k">if</span> <span class="n">src_path</span> <span class="ow">in</span> <span class="n">path_obj</span><span class="o">.</span><span class="n">parents</span> <span class="ow">and</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">is_skipped</span><span class="p">(</span><span class="n">path_obj</span><span class="p">):</span> + + <span class="k">return</span> <span class="n">sections</span><span class="o">.</span><span class="n">FIRSTPARTY</span> + + <span class="k">if</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">normcase</span><span class="p">(</span><span class="n">prefix</span><span class="p">)</span><span class="o">.</span><span class="n">startswith</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">stdlib_lib_prefix</span><span class="p">):</span> + + <span class="k">return</span> <span class="n">sections</span><span class="o">.</span><span class="n">STDLIB</span> <span class="c1"># pragma: no cover - edge case for one OS. Hard to test.</span> + + <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">default_section</span> + + <span class="k">return</span> <span class="kc">None</span> +</code></pre></div> + +</details> +<hr /> +<h4 id="ancestors-in-mro_4">Ancestors (in MRO)</h4> +<ul> +<li>isort.deprecated.finders.BaseFinder</li> +</ul> +<h4 id="methods_6">Methods</h4> +<h4 id="find_6">find</h4> +<div class="codehilite"><pre><span></span><code><span class="k">def</span> <span class="nf">find</span><span class="p">(</span> + <span class="bp">self</span><span class="p">,</span> + <span class="n">module_name</span><span class="p">:</span> <span class="nb">str</span> +<span class="p">)</span> <span class="o">-></span> <span class="n">Optional</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="w"> </span><span class="n">def</span><span class="w"> </span><span class="n">find</span><span class="p">(</span><span class="n">self</span><span class="p">,</span><span class="w"> </span><span class="nl">module_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="o">-></span><span class="w"> </span><span class="n">Optional</span><span class="o">[</span><span class="n">str</span><span class="o">]</span><span class="err">:</span><span class="w"></span> + +<span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="k">prefix</span><span class="w"> </span><span class="ow">in</span><span class="w"> </span><span class="n">self</span><span class="p">.</span><span class="nl">paths</span><span class="p">:</span><span class="w"></span> + +<span class="w"> </span><span class="n">package_path</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="ss">"/"</span><span class="p">.</span><span class="k">join</span><span class="p">((</span><span class="k">prefix</span><span class="p">,</span><span class="w"> </span><span class="n">module_name</span><span class="p">.</span><span class="n">split</span><span class="p">(</span><span class="ss">"."</span><span class="p">)</span><span class="o">[</span><span class="n">0</span><span class="o">]</span><span class="p">))</span><span class="w"></span> + +<span class="w"> </span><span class="n">path_obj</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="k">Path</span><span class="p">(</span><span class="n">package_path</span><span class="p">).</span><span class="n">resolve</span><span class="p">()</span><span class="w"></span> + +<span class="w"> </span><span class="n">is_module</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">(</span><span class="w"></span> + +<span class="w"> </span><span class="n">exists_case_sensitive</span><span class="p">(</span><span class="n">package_path</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="ss">".py"</span><span class="p">)</span><span class="w"></span> + +<span class="w"> </span><span class="ow">or</span><span class="w"> </span><span class="ow">any</span><span class="p">(</span><span class="w"></span> + +<span class="w"> </span><span class="n">exists_case_sensitive</span><span class="p">(</span><span class="n">package_path</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="n">ext_suffix</span><span class="p">)</span><span class="w"></span> + +<span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="n">ext_suffix</span><span class="w"> </span><span class="ow">in</span><span class="w"> </span><span class="n">importlib</span><span class="p">.</span><span class="n">machinery</span><span class="p">.</span><span class="n">EXTENSION_SUFFIXES</span><span class="w"></span> + +<span class="w"> </span><span class="p">)</span><span class="w"></span> + +<span class="w"> </span><span class="ow">or</span><span class="w"> </span><span class="n">exists_case_sensitive</span><span class="p">(</span><span class="n">package_path</span><span class="w"> </span><span class="o">+</span><span class="w"> </span><span class="ss">"/__init__.py"</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">is_package</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">exists_case_sensitive</span><span class="p">(</span><span class="n">package_path</span><span class="p">)</span><span class="w"> </span><span class="ow">and</span><span class="w"> </span><span class="n">os</span><span class="p">.</span><span class="k">path</span><span class="p">.</span><span class="n">isdir</span><span class="p">(</span><span class="n">package_path</span><span class="p">)</span><span class="w"></span> + +<span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="n">is_module</span><span class="w"> </span><span class="ow">or</span><span class="w"> </span><span class="nl">is_package</span><span class="p">:</span><span class="w"></span> + +<span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="p">(</span><span class="w"></span> + +<span class="w"> </span><span class="ss">"site-packages"</span><span class="w"> </span><span class="ow">in</span><span class="w"> </span><span class="k">prefix</span><span class="w"></span> + +<span class="w"> </span><span class="ow">or</span><span class="w"> </span><span class="ss">"dist-packages"</span><span class="w"> </span><span class="ow">in</span><span class="w"> </span><span class="k">prefix</span><span class="w"></span> + +<span class="w"> </span><span class="ow">or</span><span class="w"> </span><span class="p">(</span><span class="n">self</span><span class="p">.</span><span class="n">virtual_env</span><span class="w"> </span><span class="ow">and</span><span class="w"> </span><span class="n">self</span><span class="p">.</span><span class="n">virtual_env_src</span><span class="w"> </span><span class="ow">in</span><span class="w"> </span><span class="k">prefix</span><span class="p">)</span><span class="w"></span> + +<span class="w"> </span><span class="p">)</span><span class="err">:</span><span class="w"></span> + +<span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="n">sections</span><span class="p">.</span><span class="n">THIRDPARTY</span><span class="w"></span> + +<span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="n">os</span><span class="p">.</span><span class="k">path</span><span class="p">.</span><span class="n">normcase</span><span class="p">(</span><span class="k">prefix</span><span class="p">)</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="n">self</span><span class="p">.</span><span class="nl">stdlib_lib_prefix</span><span class="p">:</span><span class="w"></span> + +<span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="n">sections</span><span class="p">.</span><span class="n">STDLIB</span><span class="w"></span> + +<span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="n">self</span><span class="p">.</span><span class="n">conda_env</span><span class="w"> </span><span class="ow">and</span><span class="w"> </span><span class="n">self</span><span class="p">.</span><span class="n">conda_env</span><span class="w"> </span><span class="ow">in</span><span class="w"> </span><span class="k">prefix</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">sections</span><span class="p">.</span><span class="n">THIRDPARTY</span><span class="w"></span> + +<span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="n">src_path</span><span class="w"> </span><span class="ow">in</span><span class="w"> </span><span class="n">self</span><span class="p">.</span><span class="n">config</span><span class="p">.</span><span class="nl">src_paths</span><span class="p">:</span><span class="w"></span> + +<span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="n">src_path</span><span class="w"> </span><span class="ow">in</span><span class="w"> </span><span class="n">path_obj</span><span class="p">.</span><span class="n">parents</span><span class="w"> </span><span class="ow">and</span><span class="w"> </span><span class="ow">not</span><span class="w"> </span><span class="n">self</span><span class="p">.</span><span class="n">config</span><span class="p">.</span><span class="n">is_skipped</span><span class="p">(</span><span class="n">path_obj</span><span class="p">)</span><span class="err">:</span><span class="w"></span> + +<span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="n">sections</span><span class="p">.</span><span class="n">FIRSTPARTY</span><span class="w"></span> + +<span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="n">os</span><span class="p">.</span><span class="k">path</span><span class="p">.</span><span class="n">normcase</span><span class="p">(</span><span class="k">prefix</span><span class="p">).</span><span class="n">startswith</span><span class="p">(</span><span class="n">self</span><span class="p">.</span><span class="n">stdlib_lib_prefix</span><span class="p">)</span><span class="err">:</span><span class="w"></span> + +<span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="n">sections</span><span class="p">.</span><span class="n">STDLIB</span><span class="w"> </span><span class="err">#</span><span class="w"> </span><span class="nl">pragma</span><span class="p">:</span><span class="w"> </span><span class="k">no</span><span class="w"> </span><span class="n">cover</span><span class="w"> </span><span class="o">-</span><span class="w"> </span><span class="n">edge</span><span class="w"> </span><span class="k">case</span><span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="n">one</span><span class="w"> </span><span class="n">OS</span><span class="p">.</span><span class="w"> </span><span class="n">Hard</span><span class="w"> </span><span class="k">to</span><span class="w"> </span><span class="n">test</span><span class="p">.</span><span class="w"></span> + +<span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="n">self</span><span class="p">.</span><span class="n">config</span><span class="p">.</span><span class="n">default_section</span><span class="w"></span> + +<span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="k">None</span><span class="w"></span> +</code></pre></div> + +</details> +<h3 id="pipfilefinder">PipfileFinder</h3> +<div class="codehilite"><pre><span></span><code><span class="k">class</span> <span class="nc">PipfileFinder</span><span class="p">(</span> + <span class="n">config</span><span class="p">:</span> <span class="n">isort</span><span class="o">.</span><span class="n">settings</span><span class="o">.</span><span class="n">Config</span><span class="p">,</span> + <span class="n">path</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s1">'.'</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">PipfileFinder</span><span class="p">(</span><span class="n">ReqsBaseFinder</span><span class="p">)</span><span class="err">:</span><span class="w"></span> + +<span class="w"> </span><span class="n">enabled</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">bool</span><span class="p">(</span><span class="n">Pipfile</span><span class="p">)</span><span class="w"></span> + +<span class="w"> </span><span class="n">def</span><span class="w"> </span><span class="n">_get_names</span><span class="p">(</span><span class="n">self</span><span class="p">,</span><span class="w"> </span><span class="k">path</span><span class="err">:</span><span class="w"> </span><span class="nf">str</span><span class="p">)</span><span class="w"> </span><span class="o">-></span><span class="w"> </span><span class="n">Iterator</span><span class="o">[</span><span class="n">str</span><span class="o">]</span><span class="err">:</span><span class="w"></span> + +<span class="w"> </span><span class="k">with</span><span class="w"> </span><span class="n">chdir</span><span class="p">(</span><span class="k">path</span><span class="p">)</span><span class="err">:</span><span class="w"></span> + +<span class="w"> </span><span class="n">project</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">Pipfile</span><span class="p">.</span><span class="k">load</span><span class="p">(</span><span class="k">path</span><span class="p">)</span><span class="w"></span> + +<span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="n">req</span><span class="w"> </span><span class="ow">in</span><span class="w"> </span><span class="n">project</span><span class="p">.</span><span class="nl">packages</span><span class="p">:</span><span class="w"></span> + +<span class="w"> </span><span class="n">yield</span><span class="w"> </span><span class="n">req</span><span class="p">.</span><span class="n">name</span><span class="w"></span> + +<span class="w"> </span><span class="n">def</span><span class="w"> </span><span class="n">_get_files_from_dir</span><span class="p">(</span><span class="n">self</span><span class="p">,</span><span class="w"> </span><span class="k">path</span><span class="err">:</span><span class="w"> </span><span class="nf">str</span><span class="p">)</span><span class="w"> </span><span class="o">-></span><span class="w"> </span><span class="n">Iterator</span><span class="o">[</span><span class="n">str</span><span class="o">]</span><span class="err">:</span><span class="w"></span> + +<span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="ss">"Pipfile"</span><span class="w"> </span><span class="ow">in</span><span class="w"> </span><span class="n">os</span><span class="p">.</span><span class="n">listdir</span><span class="p">(</span><span class="k">path</span><span class="p">)</span><span class="err">:</span><span class="w"></span> + +<span class="w"> </span><span class="n">yield</span><span class="w"> </span><span class="k">path</span><span class="w"></span> +</code></pre></div> + +</details> +<hr /> +<h4 id="ancestors-in-mro_5">Ancestors (in MRO)</h4> +<ul> +<li>isort.deprecated.finders.ReqsBaseFinder</li> +<li>isort.deprecated.finders.BaseFinder</li> +</ul> +<h4 id="class-variables">Class variables</h4> +<div class="codehilite"><pre><span></span><code><span class="n">enabled</span> +</code></pre></div> + +<h4 id="methods_7">Methods</h4> +<h4 id="find_7">find</h4> +<div class="codehilite"><pre><span></span><code><span class="k">def</span> <span class="nf">find</span><span class="p">(</span> + <span class="bp">self</span><span class="p">,</span> + <span class="n">module_name</span><span class="p">:</span> <span class="nb">str</span> +<span class="p">)</span> <span class="o">-></span> <span class="n">Optional</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="w"> </span><span class="n">def</span><span class="w"> </span><span class="n">find</span><span class="p">(</span><span class="n">self</span><span class="p">,</span><span class="w"> </span><span class="nl">module_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="o">-></span><span class="w"> </span><span class="n">Optional</span><span class="o">[</span><span class="n">str</span><span class="o">]</span><span class="err">:</span><span class="w"></span> + +<span class="w"> </span><span class="err">#</span><span class="w"> </span><span class="n">required</span><span class="w"> </span><span class="n">lib</span><span class="w"> </span><span class="ow">not</span><span class="w"> </span><span class="n">installed</span><span class="w"> </span><span class="n">yet</span><span class="w"></span> + +<span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="ow">not</span><span class="w"> </span><span class="n">self</span><span class="p">.</span><span class="nl">enabled</span><span class="p">:</span><span class="w"></span> + +<span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="k">None</span><span class="w"></span> + +<span class="w"> </span><span class="n">module_name</span><span class="p">,</span><span class="w"> </span><span class="n">_sep</span><span class="p">,</span><span class="w"> </span><span class="n">_submodules</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">module_name</span><span class="p">.</span><span class="k">partition</span><span class="p">(</span><span class="ss">"."</span><span class="p">)</span><span class="w"></span> + +<span class="w"> </span><span class="n">module_name</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">module_name</span><span class="p">.</span><span class="nf">lower</span><span class="p">()</span><span class="w"></span> + +<span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="ow">not</span><span class="w"> </span><span class="nl">module_name</span><span class="p">:</span><span class="w"></span> + +<span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="k">None</span><span class="w"></span> + +<span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="n">name</span><span class="w"> </span><span class="ow">in</span><span class="w"> </span><span class="n">self</span><span class="p">.</span><span class="k">names</span><span class="err">:</span><span class="w"></span> + +<span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="n">module_name</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="nl">name</span><span class="p">:</span><span class="w"></span> + +<span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="n">sections</span><span class="p">.</span><span class="n">THIRDPARTY</span><span class="w"></span> + +<span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="k">None</span><span class="w"></span> +</code></pre></div> + +</details> +<h3 id="reqsbasefinder">ReqsBaseFinder</h3> +<div class="codehilite"><pre><span></span><code><span class="k">class</span> <span class="nc">ReqsBaseFinder</span><span class="p">(</span> + <span class="n">config</span><span class="p">:</span> <span class="n">isort</span><span class="o">.</span><span class="n">settings</span><span class="o">.</span><span class="n">Config</span><span class="p">,</span> + <span class="n">path</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s1">'.'</span> +<span class="p">)</span> +</code></pre></div> + +<details class="example"><summary>View Source</summary><div class="codehilite"><pre><span></span><code><span class="s s-Atom">class</span> <span class="nv">ReqsBaseFinder</span><span class="p">(</span><span class="nv">BaseFinder</span><span class="p">)</span><span class="s s-Atom">:</span> + + <span class="s s-Atom">enabled</span> <span class="o">=</span> <span class="nv">False</span> + + <span class="s s-Atom">def</span> <span class="k">__</span><span class="nf">init__</span><span class="p">(</span><span class="s s-Atom">self</span><span class="p">,</span> <span class="nn">config</span><span class="p">:</span> <span class="nv">Config</span><span class="p">,</span> <span class="nn">path</span><span class="p">:</span> <span class="s s-Atom">str</span> <span class="o">=</span> <span class="s2">"."</span><span class="p">)</span> <span class="s s-Atom">-></span> <span class="nv">None</span><span class="s s-Atom">:</span> + + <span class="nf">super</span><span class="p">().</span><span class="k">__</span><span class="nf">init__</span><span class="p">(</span><span class="s s-Atom">config</span><span class="p">)</span> + + <span class="s s-Atom">self</span><span class="p">.</span><span class="s s-Atom">path</span> <span class="o">=</span> <span class="s s-Atom">path</span> + + <span class="s s-Atom">if</span> <span class="s s-Atom">self</span><span class="p">.</span><span class="nn">enabled</span><span class="p">:</span> + + <span class="s s-Atom">self</span><span class="p">.</span><span class="s s-Atom">mapping</span> <span class="o">=</span> <span class="s s-Atom">self</span><span class="p">.</span><span class="k">_</span><span class="nf">load_mapping</span><span class="p">()</span> + + <span class="s s-Atom">self</span><span class="p">.</span><span class="s s-Atom">names</span> <span class="o">=</span> <span class="s s-Atom">self</span><span class="p">.</span><span class="k">_</span><span class="nf">load_names</span><span class="p">()</span> + + <span class="s s-Atom">@abstractmethod</span> + + <span class="s s-Atom">def</span> <span class="k">_</span><span class="nf">get_names</span><span class="p">(</span><span class="s s-Atom">self</span><span class="p">,</span> <span class="nn">path</span><span class="p">:</span> <span class="s s-Atom">str</span><span class="p">)</span> <span class="s s-Atom">-></span> <span class="nv">Iterator</span><span class="p">[</span><span class="s s-Atom">str</span><span class="p">]</span><span class="s s-Atom">:</span> + + <span class="s s-Atom">raise</span> <span class="nv">NotImplementedError</span> + + <span class="s s-Atom">@abstractmethod</span> + + <span class="s s-Atom">def</span> <span class="k">_</span><span class="nf">get_files_from_dir</span><span class="p">(</span><span class="s s-Atom">self</span><span class="p">,</span> <span class="nn">path</span><span class="p">:</span> <span class="s s-Atom">str</span><span class="p">)</span> <span class="s s-Atom">-></span> <span class="nv">Iterator</span><span class="p">[</span><span class="s s-Atom">str</span><span class="p">]</span><span class="s s-Atom">:</span> + + <span class="s s-Atom">raise</span> <span class="nv">NotImplementedError</span> + + <span class="s s-Atom">@staticmethod</span> + + <span class="s s-Atom">def</span> <span class="k">_</span><span class="nf">load_mapping</span><span class="p">()</span> <span class="s s-Atom">-></span> <span class="nv">Optional</span><span class="p">[</span><span class="nv">Dict</span><span class="p">[</span><span class="s s-Atom">str</span><span class="p">,</span> <span class="s s-Atom">str</span><span class="p">]]</span><span class="s s-Atom">:</span> + + <span class="s2">"""Return list of mappings `package_name -> module_name`</span> + +<span class="s2"> Example:</span> + +<span class="s2"> django-haystack -> haystack</span> + +<span class="s2"> """</span> + + <span class="s s-Atom">if</span> <span class="o">not</span> <span class="nn">pipreqs</span><span class="p">:</span> + + <span class="s s-Atom">return</span> <span class="nv">None</span> + + <span class="s s-Atom">path</span> <span class="o">=</span> <span class="s s-Atom">os</span><span class="p">.</span><span class="s s-Atom">path</span><span class="p">.</span><span class="nf">dirname</span><span class="p">(</span><span class="s s-Atom">inspect</span><span class="p">.</span><span class="nf">getfile</span><span class="p">(</span><span class="s s-Atom">pipreqs</span><span class="p">))</span> + + <span class="s s-Atom">path</span> <span class="o">=</span> <span class="s s-Atom">os</span><span class="p">.</span><span class="s s-Atom">path</span><span class="p">.</span><span class="nf">join</span><span class="p">(</span><span class="s s-Atom">path</span><span class="p">,</span> <span class="s2">"mapping"</span><span class="p">)</span> + + <span class="s s-Atom">with</span> <span class="nf">open</span><span class="p">(</span><span class="s s-Atom">path</span><span class="p">)</span> <span class="s s-Atom">as</span> <span class="nn">f</span><span class="p">:</span> + + <span class="nn">mappings</span><span class="p">:</span> <span class="nv">Dict</span><span class="p">[</span><span class="s s-Atom">str</span><span class="p">,</span> <span class="s s-Atom">str</span><span class="p">]</span> <span class="o">=</span> <span class="p">{}</span> <span class="s s-Atom">#</span> <span class="s s-Atom">pypi_name:</span> <span class="s s-Atom">import_name</span> + + <span class="s s-Atom">for</span> <span class="s s-Atom">line</span> <span class="s s-Atom">in</span> <span class="nn">f</span><span class="p">:</span> + + <span class="s s-Atom">import_name</span><span class="p">,</span> <span class="k">_</span><span class="p">,</span> <span class="s s-Atom">pypi_name</span> <span class="o">=</span> <span class="s s-Atom">line</span><span class="p">.</span><span class="nf">strip</span><span class="p">().</span><span class="nf">partition</span><span class="p">(</span><span class="s2">":"</span><span class="p">)</span> + + <span class="s s-Atom">mappings</span><span class="p">[</span><span class="s s-Atom">pypi_name</span><span class="p">]</span> <span class="o">=</span> <span class="s s-Atom">import_name</span> + + <span class="s s-Atom">return</span> <span class="s s-Atom">mappings</span> + + <span class="s s-Atom">#</span> <span class="s s-Atom">return</span> <span class="nf">dict</span><span class="p">(</span><span class="nf">tuple</span><span class="p">(</span><span class="s s-Atom">line</span><span class="p">.</span><span class="nf">strip</span><span class="p">().</span><span class="nf">split</span><span class="p">(</span><span class="s2">":"</span><span class="p">)[</span><span class="s s-Atom">::-</span><span class="mi">1</span><span class="p">])</span> <span class="s s-Atom">for</span> <span class="s s-Atom">line</span> <span class="s s-Atom">in</span> <span class="s s-Atom">f</span><span class="p">)</span> + + <span class="s s-Atom">def</span> <span class="k">_</span><span class="nf">load_names</span><span class="p">(</span><span class="s s-Atom">self</span><span class="p">)</span> <span class="s s-Atom">-></span> <span class="nv">List</span><span class="p">[</span><span class="s s-Atom">str</span><span class="p">]</span><span class="s s-Atom">:</span> + + <span class="s2">"""Return list of thirdparty modules from requirements"""</span> + + <span class="s s-Atom">names</span> <span class="o">=</span> <span class="p">[]</span> + + <span class="s s-Atom">for</span> <span class="s s-Atom">path</span> <span class="s s-Atom">in</span> <span class="s s-Atom">self</span><span class="p">.</span><span class="k">_</span><span class="nf">get_files</span><span class="p">()</span><span class="s s-Atom">:</span> + + <span class="s s-Atom">for</span> <span class="s s-Atom">name</span> <span class="s s-Atom">in</span> <span class="s s-Atom">self</span><span class="p">.</span><span class="k">_</span><span class="nf">get_names</span><span class="p">(</span><span class="s s-Atom">path</span><span class="p">)</span><span class="s s-Atom">:</span> + + <span class="s s-Atom">names</span><span class="p">.</span><span class="nf">append</span><span class="p">(</span><span class="s s-Atom">self</span><span class="p">.</span><span class="k">_</span><span class="nf">normalize_name</span><span class="p">(</span><span class="s s-Atom">name</span><span class="p">))</span> + + <span class="s s-Atom">return</span> <span class="s s-Atom">names</span> + + <span class="s s-Atom">@staticmethod</span> + + <span class="s s-Atom">def</span> <span class="k">_</span><span class="nf">get_parents</span><span class="p">(</span><span class="nn">path</span><span class="p">:</span> <span class="s s-Atom">str</span><span class="p">)</span> <span class="s s-Atom">-></span> <span class="nv">Iterator</span><span class="p">[</span><span class="s s-Atom">str</span><span class="p">]</span><span class="s s-Atom">:</span> + + <span class="s s-Atom">prev</span> <span class="o">=</span> <span class="s2">""</span> + + <span class="s s-Atom">while</span> <span class="s s-Atom">path</span> <span class="p">!</span><span class="o">=</span> <span class="nn">prev</span><span class="p">:</span> + + <span class="s s-Atom">prev</span> <span class="o">=</span> <span class="s s-Atom">path</span> + + <span class="s s-Atom">yield</span> <span class="s s-Atom">path</span> + + <span class="s s-Atom">path</span> <span class="o">=</span> <span class="s s-Atom">os</span><span class="p">.</span><span class="s s-Atom">path</span><span class="p">.</span><span class="nf">dirname</span><span class="p">(</span><span class="s s-Atom">path</span><span class="p">)</span> + + <span class="s s-Atom">def</span> <span class="k">_</span><span class="nf">get_files</span><span class="p">(</span><span class="s s-Atom">self</span><span class="p">)</span> <span class="s s-Atom">-></span> <span class="nv">Iterator</span><span class="p">[</span><span class="s s-Atom">str</span><span class="p">]</span><span class="s s-Atom">:</span> + + <span class="s2">"""Return paths to all requirements files"""</span> + + <span class="s s-Atom">path</span> <span class="o">=</span> <span class="s s-Atom">os</span><span class="p">.</span><span class="s s-Atom">path</span><span class="p">.</span><span class="nf">abspath</span><span class="p">(</span><span class="s s-Atom">self</span><span class="p">.</span><span class="s s-Atom">path</span><span class="p">)</span> + + <span class="s s-Atom">if</span> <span class="s s-Atom">os</span><span class="p">.</span><span class="s s-Atom">path</span><span class="p">.</span><span class="nf">isfile</span><span class="p">(</span><span class="s s-Atom">path</span><span class="p">)</span><span class="s s-Atom">:</span> + + <span class="s s-Atom">path</span> <span class="o">=</span> <span class="s s-Atom">os</span><span class="p">.</span><span class="s s-Atom">path</span><span class="p">.</span><span class="nf">dirname</span><span class="p">(</span><span class="s s-Atom">path</span><span class="p">)</span> + + <span class="s s-Atom">for</span> <span class="s s-Atom">path</span> <span class="s s-Atom">in</span> <span class="s s-Atom">self</span><span class="p">.</span><span class="k">_</span><span class="nf">get_parents</span><span class="p">(</span><span class="s s-Atom">path</span><span class="p">)</span><span class="s s-Atom">:</span> + + <span class="s s-Atom">yield</span> <span class="s s-Atom">from</span> <span class="s s-Atom">self</span><span class="p">.</span><span class="k">_</span><span class="nf">get_files_from_dir</span><span class="p">(</span><span class="s s-Atom">path</span><span class="p">)</span> + + <span class="s s-Atom">def</span> <span class="k">_</span><span class="nf">normalize_name</span><span class="p">(</span><span class="s s-Atom">self</span><span class="p">,</span> <span class="nn">name</span><span class="p">:</span> <span class="s s-Atom">str</span><span class="p">)</span> <span class="s s-Atom">-></span> <span class="nn">str</span><span class="p">:</span> + + <span class="s2">"""Convert package name to module name</span> + +<span class="s2"> Examples:</span> + +<span class="s2"> Django -> django</span> + +<span class="s2"> django-haystack -> django_haystack</span> + +<span class="s2"> Flask-RESTFul -> flask_restful</span> + +<span class="s2"> """</span> + + <span class="s s-Atom">if</span> <span class="s s-Atom">self</span><span class="p">.</span><span class="nn">mapping</span><span class="p">:</span> + + <span class="s s-Atom">name</span> <span class="o">=</span> <span class="s s-Atom">self</span><span class="p">.</span><span class="s s-Atom">mapping</span><span class="p">.</span><span class="nf">get</span><span class="p">(</span><span class="s s-Atom">name</span><span class="p">.</span><span class="nf">replace</span><span class="p">(</span><span class="s2">"-"</span><span class="p">,</span> <span class="s2">"_"</span><span class="p">),</span> <span class="s s-Atom">name</span><span class="p">)</span> + + <span class="s s-Atom">return</span> <span class="s s-Atom">name</span><span class="p">.</span><span class="nf">lower</span><span class="p">().</span><span class="nf">replace</span><span class="p">(</span><span class="s2">"-"</span><span class="p">,</span> <span class="s2">"_"</span><span class="p">)</span> + + <span class="s s-Atom">def</span> <span class="nf">find</span><span class="p">(</span><span class="s s-Atom">self</span><span class="p">,</span> <span class="s s-Atom">module_name:</span> <span class="s s-Atom">str</span><span class="p">)</span> <span class="s s-Atom">-></span> <span class="nv">Optional</span><span class="p">[</span><span class="s s-Atom">str</span><span class="p">]</span><span class="s s-Atom">:</span> + + <span class="s s-Atom">#</span> <span class="s s-Atom">required</span> <span class="s s-Atom">lib</span> <span class="o">not</span> <span class="s s-Atom">installed</span> <span class="s s-Atom">yet</span> + + <span class="s s-Atom">if</span> <span class="o">not</span> <span class="s s-Atom">self</span><span class="p">.</span><span class="nn">enabled</span><span class="p">:</span> + + <span class="s s-Atom">return</span> <span class="nv">None</span> + + <span class="s s-Atom">module_name</span><span class="p">,</span> <span class="k">_</span><span class="s s-Atom">sep</span><span class="p">,</span> <span class="k">_</span><span class="s s-Atom">submodules</span> <span class="o">=</span> <span class="s s-Atom">module_name</span><span class="p">.</span><span class="nf">partition</span><span class="p">(</span><span class="s2">"."</span><span class="p">)</span> + + <span class="s s-Atom">module_name</span> <span class="o">=</span> <span class="s s-Atom">module_name</span><span class="p">.</span><span class="nf">lower</span><span class="p">()</span> + + <span class="s s-Atom">if</span> <span class="o">not</span> <span class="s s-Atom">module_name:</span> + + <span class="s s-Atom">return</span> <span class="nv">None</span> + + <span class="s s-Atom">for</span> <span class="s s-Atom">name</span> <span class="s s-Atom">in</span> <span class="s s-Atom">self</span><span class="p">.</span><span class="nn">names</span><span class="p">:</span> + + <span class="s s-Atom">if</span> <span class="s s-Atom">module_name</span> <span class="o">==</span> <span class="nn">name</span><span class="p">:</span> + + <span class="s s-Atom">return</span> <span class="s s-Atom">sections</span><span class="p">.</span><span class="nv">THIRDPARTY</span> + + <span class="s s-Atom">return</span> <span class="nv">None</span> +</code></pre></div> + +</details> +<hr /> +<h4 id="ancestors-in-mro_6">Ancestors (in MRO)</h4> +<ul> +<li>isort.deprecated.finders.BaseFinder</li> +</ul> +<h4 id="descendants_1">Descendants</h4> +<ul> +<li>isort.deprecated.finders.RequirementsFinder</li> +<li>isort.deprecated.finders.PipfileFinder</li> +</ul> +<h4 id="class-variables_1">Class variables</h4> +<div class="codehilite"><pre><span></span><code><span class="n">enabled</span> +</code></pre></div> + +<h4 id="methods_8">Methods</h4> +<h4 id="find_8">find</h4> +<div class="codehilite"><pre><span></span><code><span class="k">def</span> <span class="nf">find</span><span class="p">(</span> + <span class="bp">self</span><span class="p">,</span> + <span class="n">module_name</span><span class="p">:</span> <span class="nb">str</span> +<span class="p">)</span> <span class="o">-></span> <span class="n">Optional</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="w"> </span><span class="n">def</span><span class="w"> </span><span class="n">find</span><span class="p">(</span><span class="n">self</span><span class="p">,</span><span class="w"> </span><span class="nl">module_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="o">-></span><span class="w"> </span><span class="n">Optional</span><span class="o">[</span><span class="n">str</span><span class="o">]</span><span class="err">:</span><span class="w"></span> + +<span class="w"> </span><span class="err">#</span><span class="w"> </span><span class="n">required</span><span class="w"> </span><span class="n">lib</span><span class="w"> </span><span class="ow">not</span><span class="w"> </span><span class="n">installed</span><span class="w"> </span><span class="n">yet</span><span class="w"></span> + +<span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="ow">not</span><span class="w"> </span><span class="n">self</span><span class="p">.</span><span class="nl">enabled</span><span class="p">:</span><span class="w"></span> + +<span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="k">None</span><span class="w"></span> + +<span class="w"> </span><span class="n">module_name</span><span class="p">,</span><span class="w"> </span><span class="n">_sep</span><span class="p">,</span><span class="w"> </span><span class="n">_submodules</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">module_name</span><span class="p">.</span><span class="k">partition</span><span class="p">(</span><span class="ss">"."</span><span class="p">)</span><span class="w"></span> + +<span class="w"> </span><span class="n">module_name</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">module_name</span><span class="p">.</span><span class="nf">lower</span><span class="p">()</span><span class="w"></span> + +<span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="ow">not</span><span class="w"> </span><span class="nl">module_name</span><span class="p">:</span><span class="w"></span> + +<span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="k">None</span><span class="w"></span> + +<span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="n">name</span><span class="w"> </span><span class="ow">in</span><span class="w"> </span><span class="n">self</span><span class="p">.</span><span class="k">names</span><span class="err">:</span><span class="w"></span> + +<span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="n">module_name</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="nl">name</span><span class="p">:</span><span class="w"></span> + +<span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="n">sections</span><span class="p">.</span><span class="n">THIRDPARTY</span><span class="w"></span> + +<span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="k">None</span><span class="w"></span> +</code></pre></div> + +</details> +<h3 id="requirementsfinder">RequirementsFinder</h3> +<div class="codehilite"><pre><span></span><code><span class="k">class</span> <span class="nc">RequirementsFinder</span><span class="p">(</span> + <span class="n">config</span><span class="p">:</span> <span class="n">isort</span><span class="o">.</span><span class="n">settings</span><span class="o">.</span><span class="n">Config</span><span class="p">,</span> + <span class="n">path</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s1">'.'</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">RequirementsFinder</span><span class="p">(</span><span class="n">ReqsBaseFinder</span><span class="p">)</span><span class="err">:</span><span class="w"></span> + +<span class="w"> </span><span class="n">exts</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="p">(</span><span class="ss">".txt"</span><span class="p">,</span><span class="w"> </span><span class="ss">".in"</span><span class="p">)</span><span class="w"></span> + +<span class="w"> </span><span class="n">enabled</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">bool</span><span class="p">(</span><span class="n">parse_requirements</span><span class="p">)</span><span class="w"></span> + +<span class="w"> </span><span class="n">def</span><span class="w"> </span><span class="n">_get_files_from_dir</span><span class="p">(</span><span class="n">self</span><span class="p">,</span><span class="w"> </span><span class="k">path</span><span class="err">:</span><span class="w"> </span><span class="nf">str</span><span class="p">)</span><span class="w"> </span><span class="o">-></span><span class="w"> </span><span class="n">Iterator</span><span class="o">[</span><span class="n">str</span><span class="o">]</span><span class="err">:</span><span class="w"></span> + +<span class="w"> </span><span class="ss">"""Return paths to requirements files from passed dir."""</span><span class="w"></span> + +<span class="w"> </span><span class="n">yield</span><span class="w"> </span><span class="k">from</span><span class="w"> </span><span class="n">self</span><span class="p">.</span><span class="n">_get_files_from_dir_cached</span><span class="p">(</span><span class="k">path</span><span class="p">)</span><span class="w"></span> + +<span class="w"> </span><span class="nv">@classmethod</span><span class="w"></span> + +<span class="w"> </span><span class="nv">@lru_cache</span><span class="p">(</span><span class="n">maxsize</span><span class="o">=</span><span class="mi">16</span><span class="p">)</span><span class="w"></span> + +<span class="w"> </span><span class="n">def</span><span class="w"> </span><span class="n">_get_files_from_dir_cached</span><span class="p">(</span><span class="n">cls</span><span class="p">,</span><span class="w"> </span><span class="k">path</span><span class="err">:</span><span class="w"> </span><span class="nf">str</span><span class="p">)</span><span class="w"> </span><span class="o">-></span><span class="w"> </span><span class="n">List</span><span class="o">[</span><span class="n">str</span><span class="o">]</span><span class="err">:</span><span class="w"></span> + +<span class="w"> </span><span class="n">results</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="err">[]</span><span class="w"></span> + +<span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="n">fname</span><span class="w"> </span><span class="ow">in</span><span class="w"> </span><span class="n">os</span><span class="p">.</span><span class="n">listdir</span><span class="p">(</span><span class="k">path</span><span class="p">)</span><span class="err">:</span><span class="w"></span> + +<span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="ss">"requirements"</span><span class="w"> </span><span class="ow">not</span><span class="w"> </span><span class="ow">in</span><span class="w"> </span><span class="nl">fname</span><span class="p">:</span><span class="w"></span> + +<span class="w"> </span><span class="k">continue</span><span class="w"></span> + +<span class="w"> </span><span class="n">full_path</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">os</span><span class="p">.</span><span class="k">path</span><span class="p">.</span><span class="k">join</span><span class="p">(</span><span class="k">path</span><span class="p">,</span><span class="w"> </span><span class="n">fname</span><span class="p">)</span><span class="w"></span> + +<span class="w"> </span><span class="err">#</span><span class="w"> </span><span class="o">*</span><span class="n">requirements</span><span class="o">*</span><span class="cm">/*.{txt,in}</span> + +<span class="cm"> if os.path.isdir(full_path):</span> + +<span class="cm"> for subfile_name in os.listdir(full_path):</span> + +<span class="cm"> for ext in cls.exts:</span> + +<span class="cm"> if subfile_name.endswith(ext):</span> + +<span class="cm"> results.append(os.path.join(full_path, subfile_name))</span> + +<span class="cm"> continue</span> + +<span class="cm"> # *requirements*.{txt,in}</span> + +<span class="cm"> if os.path.isfile(full_path):</span> + +<span class="cm"> for ext in cls.exts:</span> + +<span class="cm"> if fname.endswith(ext):</span> + +<span class="cm"> results.append(full_path)</span> + +<span class="cm"> break</span> + +<span class="cm"> return results</span> + +<span class="cm"> def _get_names(self, path: str) -> Iterator[str]:</span> + +<span class="cm"> """Load required packages from path to requirements file"""</span> + +<span class="cm"> yield from self._get_names_cached(path)</span> + +<span class="cm"> @classmethod</span> + +<span class="cm"> @lru_cache(maxsize=16)</span> + +<span class="cm"> def _get_names_cached(cls, path: str) -> List[str]:</span> + +<span class="cm"> result = []</span> + +<span class="cm"> with chdir(os.path.dirname(path)):</span> + +<span class="cm"> requirements = parse_requirements(path)</span> + +<span class="cm"> for req in requirements.values():</span> + +<span class="cm"> if req.name:</span> + +<span class="cm"> result.append(req.name)</span> + +<span class="cm"> return result</span> +</code></pre></div> + +</details> +<hr /> +<h4 id="ancestors-in-mro_7">Ancestors (in MRO)</h4> +<ul> +<li>isort.deprecated.finders.ReqsBaseFinder</li> +<li>isort.deprecated.finders.BaseFinder</li> +</ul> +<h4 id="class-variables_2">Class variables</h4> +<div class="codehilite"><pre><span></span><code><span class="n">enabled</span> +</code></pre></div> + +<div class="codehilite"><pre><span></span><code><span class="n">exts</span> +</code></pre></div> + +<h4 id="methods_9">Methods</h4> +<h4 id="find_9">find</h4> +<div class="codehilite"><pre><span></span><code><span class="k">def</span> <span class="nf">find</span><span class="p">(</span> + <span class="bp">self</span><span class="p">,</span> + <span class="n">module_name</span><span class="p">:</span> <span class="nb">str</span> +<span class="p">)</span> <span class="o">-></span> <span class="n">Optional</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="w"> </span><span class="n">def</span><span class="w"> </span><span class="n">find</span><span class="p">(</span><span class="n">self</span><span class="p">,</span><span class="w"> </span><span class="nl">module_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="o">-></span><span class="w"> </span><span class="n">Optional</span><span class="o">[</span><span class="n">str</span><span class="o">]</span><span class="err">:</span><span class="w"></span> + +<span class="w"> </span><span class="err">#</span><span class="w"> </span><span class="n">required</span><span class="w"> </span><span class="n">lib</span><span class="w"> </span><span class="ow">not</span><span class="w"> </span><span class="n">installed</span><span class="w"> </span><span class="n">yet</span><span class="w"></span> + +<span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="ow">not</span><span class="w"> </span><span class="n">self</span><span class="p">.</span><span class="nl">enabled</span><span class="p">:</span><span class="w"></span> + +<span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="k">None</span><span class="w"></span> + +<span class="w"> </span><span class="n">module_name</span><span class="p">,</span><span class="w"> </span><span class="n">_sep</span><span class="p">,</span><span class="w"> </span><span class="n">_submodules</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">module_name</span><span class="p">.</span><span class="k">partition</span><span class="p">(</span><span class="ss">"."</span><span class="p">)</span><span class="w"></span> + +<span class="w"> </span><span class="n">module_name</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">module_name</span><span class="p">.</span><span class="nf">lower</span><span class="p">()</span><span class="w"></span> + +<span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="ow">not</span><span class="w"> </span><span class="nl">module_name</span><span class="p">:</span><span class="w"></span> + +<span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="k">None</span><span class="w"></span> + +<span class="w"> </span><span class="k">for</span><span class="w"> </span><span class="n">name</span><span class="w"> </span><span class="ow">in</span><span class="w"> </span><span class="n">self</span><span class="p">.</span><span class="k">names</span><span class="err">:</span><span class="w"></span> + +<span class="w"> </span><span class="k">if</span><span class="w"> </span><span class="n">module_name</span><span class="w"> </span><span class="o">==</span><span class="w"> </span><span class="nl">name</span><span class="p">:</span><span class="w"></span> + +<span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="n">sections</span><span class="p">.</span><span class="n">THIRDPARTY</span><span class="w"></span> + +<span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="k">None</span><span class="w"></span> +</code></pre></div> + +</details> + + + + + + + + </article> + </div> + </div> + + </main> + + +<footer class="md-footer"> + + <div class="md-footer-nav"> + <nav class="md-footer-nav__inner md-grid"> + + <a href="../../wrap_modes/" title="Wrap Modes" 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> + Wrap Modes + </span> + </div> + </a> + + + <a href="../" title="Index" 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> + Index + </span> + </div> + <div class="md-flex__cell md-flex__cell--shrink"> + <i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i> + </div> + </a> + + </nav> + </div> + + <div class="md-footer-meta md-typeset"> + <div class="md-footer-meta__inner md-grid"> + <div class="md-footer-copyright"> + + Powered by + <a href="http://timothycrosley.github.io/portray">portray.</a> + You too can + <a href="http://timothycrosley.github.io/portray"> + portray</a> + your Python project well using automatic documentation. + </div> + + </div> + </div> +</footer> + + </div> + <div class="md-dialog" data-md-component="dialog"> + <div class="md-dialog__inner md-typeset"></div> + </div> + <script id="__config" type="application/json">{"base": "../../../..", "features": [], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing", "select.version.title": "Select version"}, "search": "../../../../assets/javascripts/workers/search.709b4209.min.js", "version": null}</script> + + + <script src="../../../../assets/javascripts/bundle.2b46852b.min.js"></script> + + + </body> +</html>
\ No newline at end of file |