| |
| <!doctype html> |
| <html lang="en" class="no-js"> |
| <head> |
| |
| <meta charset="utf-8"> |
| <meta name="viewport" content="width=device-width,initial-scale=1"> |
| |
| |
| |
| |
| <link rel="icon" href="../../art/logo.png"> |
| <meta name="generator" content="mkdocs-1.2.1, mkdocs-material-7.2.3"> |
| |
| |
| |
| <title>Hooks - isort</title> |
| |
| |
| |
| <link rel="stylesheet" href="../../assets/stylesheets/main.f7f47774.min.css"> |
| |
| |
| <link rel="stylesheet" href="../../assets/stylesheets/palette.3f5d1f46.min.css"> |
| |
| |
| |
| |
| |
| |
| |
| <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin> |
| <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback"> |
| <style>:root{--md-text-font-family:"Roboto";--md-code-font-family:"Roboto Mono"}</style> |
| |
| |
| |
| |
| <link rel="stylesheet" href="../../art/stylesheets/extra.css"> |
| |
| |
| |
| |
| |
| |
| |
| </head> |
| |
| |
| |
| |
| |
| |
| |
| <body dir="ltr" data-md-color-scheme="isort" data-md-color-primary="" data-md-color-accent=""> |
| |
| |
| <script>function __prefix(e){return new URL("../..",location).pathname+"."+e}function __get(e,t=localStorage){return JSON.parse(t.getItem(__prefix(e)))}</script> |
| |
| <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off"> |
| <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off"> |
| <label class="md-overlay" for="__drawer"></label> |
| <div data-md-component="skip"> |
| |
| |
| <a href="#module-isorthooks" class="md-skip"> |
| Skip to content |
| </a> |
| |
| </div> |
| <div data-md-component="announce"> |
| |
| </div> |
| |
| <header class="md-header" data-md-component="header"> |
| <nav class="md-header__inner md-grid" aria-label="Header"> |
| <a href="../../index.html" title="isort" class="md-header__button md-logo" aria-label="isort" data-md-component="logo"> |
| |
| <img src="../../art/logo.png" alt="logo"> |
| |
| </a> |
| <label class="md-header__button md-icon" for="__drawer"> |
| <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"/></svg> |
| </label> |
| <div class="md-header__title" data-md-component="header-title"> |
| <div class="md-header__ellipsis"> |
| <div class="md-header__topic"> |
| <span class="md-ellipsis"> |
| isort |
| </span> |
| </div> |
| <div class="md-header__topic" data-md-component="header-topic"> |
| <span class="md-ellipsis"> |
| |
| Hooks |
| |
| </span> |
| </div> |
| </div> |
| </div> |
| |
| |
| |
| <label class="md-header__button md-icon" for="__search"> |
| <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg> |
| </label> |
| |
| <div class="md-search" data-md-component="search" role="dialog"> |
| <label class="md-search__overlay" for="__search"></label> |
| <div class="md-search__inner" role="search"> |
| <form class="md-search__form" name="search"> |
| <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required> |
| <label class="md-search__icon md-icon" for="__search"> |
| <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5z"/></svg> |
| <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12z"/></svg> |
| </label> |
| <nav class="md-search__options" aria-label="Search"> |
| |
| <button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1"> |
| <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41z"/></svg> |
| </button> |
| </nav> |
| |
| </form> |
| <div class="md-search__output"> |
| <div class="md-search__scrollwrap" data-md-scrollfix> |
| <div class="md-search-result" data-md-component="search-result"> |
| <div class="md-search-result__meta"> |
| Initializing search |
| </div> |
| <ol class="md-search-result__list"></ol> |
| </div> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| |
| <div class="md-header__source"> |
| |
| <a href="https://github.com/timothycrosley/isort/" title="Go to repository" class="md-source" data-md-component="source"> |
| <div class="md-source__icon md-icon"> |
| |
| <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg> |
| </div> |
| <div class="md-source__repository"> |
| isort |
| </div> |
| </a> |
| </div> |
| |
| </nav> |
| </header> |
| |
| <div class="md-container" data-md-component="container"> |
| |
| |
| |
| |
| <main class="md-main" data-md-component="main"> |
| <div class="md-main__inner md-grid"> |
| |
| |
| |
| <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" > |
| <div class="md-sidebar__scrollwrap"> |
| <div class="md-sidebar__inner"> |
| |
| |
| |
| <nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0"> |
| <label class="md-nav__title" for="__drawer"> |
| <a href="../../index.html" title="isort" class="md-nav__button md-logo" aria-label="isort" data-md-component="logo"> |
| |
| <img src="../../art/logo.png" alt="logo"> |
| |
| </a> |
| isort |
| </label> |
| |
| <div class="md-nav__source"> |
| |
| <a href="https://github.com/timothycrosley/isort/" title="Go to repository" class="md-source" data-md-component="source"> |
| <div class="md-source__icon md-icon"> |
| |
| <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg> |
| </div> |
| <div class="md-source__repository"> |
| isort |
| </div> |
| </a> |
| </div> |
| |
| <ul class="md-nav__list" data-md-scrollfix> |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../../index.html" class="md-nav__link"> |
| Home |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../../CHANGELOG.html" class="md-nav__link"> |
| Changelog |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item md-nav__item--nested"> |
| |
| |
| <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3" > |
| |
| <label class="md-nav__link" for="__nav_3"> |
| Configuration |
| <span class="md-nav__icon md-icon"></span> |
| </label> |
| <nav class="md-nav" aria-label="Configuration" data-md-level="1"> |
| <label class="md-nav__title" for="__nav_3"> |
| <span class="md-nav__icon md-icon"></span> |
| Configuration |
| </label> |
| <ul class="md-nav__list" data-md-scrollfix> |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../../docs/configuration/action_comments.html" class="md-nav__link"> |
| Action Comments |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../../docs/configuration/add_or_remove_imports.html" class="md-nav__link"> |
| Add Or Remove Imports |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../../docs/configuration/black_compatibility.html" class="md-nav__link"> |
| Black Compatibility |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../../docs/configuration/config_files.html" class="md-nav__link"> |
| Config Files |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../../docs/configuration/custom_sections_and_ordering.html" class="md-nav__link"> |
| Custom Sections And Ordering |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../../docs/configuration/git_hook.html" class="md-nav__link"> |
| Git Hook |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../../docs/configuration/github_action.html" class="md-nav__link"> |
| Github Action |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../../docs/configuration/multi_line_output_modes.html" class="md-nav__link"> |
| Multi Line Output Modes |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../../docs/configuration/options.html" class="md-nav__link"> |
| Options |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../../docs/configuration/pre-commit.html" class="md-nav__link"> |
| Pre Commit |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../../docs/configuration/profiles.html" class="md-nav__link"> |
| Profiles |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../../docs/configuration/setuptools_integration.html" class="md-nav__link"> |
| Setuptools Integration |
| </a> |
| </li> |
| |
| |
| |
| </ul> |
| </nav> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item md-nav__item--nested"> |
| |
| |
| <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_4" type="checkbox" id="__nav_4" > |
| |
| <label class="md-nav__link" for="__nav_4"> |
| Contributing |
| <span class="md-nav__icon md-icon"></span> |
| </label> |
| <nav class="md-nav" aria-label="Contributing" data-md-level="1"> |
| <label class="md-nav__title" for="__nav_4"> |
| <span class="md-nav__icon md-icon"></span> |
| Contributing |
| </label> |
| <ul class="md-nav__list" data-md-scrollfix> |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../../docs/contributing/1.-contributing-guide.html" class="md-nav__link"> |
| 1. Contributing Guide |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../../docs/contributing/2.-coding-standard.html" class="md-nav__link"> |
| 2. Coding Standard |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../../docs/contributing/3.-code-of-conduct.html" class="md-nav__link"> |
| 3. Code Of Conduct |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../../docs/contributing/4.-acknowledgements.html" class="md-nav__link"> |
| 4. Acknowledgements |
| </a> |
| </li> |
| |
| |
| |
| </ul> |
| </nav> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item md-nav__item--nested"> |
| |
| |
| <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5" > |
| |
| <label class="md-nav__link" for="__nav_5"> |
| Major Releases |
| <span class="md-nav__icon md-icon"></span> |
| </label> |
| <nav class="md-nav" aria-label="Major Releases" data-md-level="1"> |
| <label class="md-nav__title" for="__nav_5"> |
| <span class="md-nav__icon md-icon"></span> |
| Major Releases |
| </label> |
| <ul class="md-nav__list" data-md-scrollfix> |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../../docs/major_releases/introducing_isort_5.html" class="md-nav__link"> |
| Introducing Isort 5 |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../../docs/major_releases/release_policy.html" class="md-nav__link"> |
| Release Policy |
| </a> |
| </li> |
| |
| |
| |
| </ul> |
| </nav> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item md-nav__item--nested"> |
| |
| |
| <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6" > |
| |
| <label class="md-nav__link" for="__nav_6"> |
| Quick Start |
| <span class="md-nav__icon md-icon"></span> |
| </label> |
| <nav class="md-nav" aria-label="Quick Start" data-md-level="1"> |
| <label class="md-nav__title" for="__nav_6"> |
| <span class="md-nav__icon md-icon"></span> |
| Quick Start |
| </label> |
| <ul class="md-nav__list" data-md-scrollfix> |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../../docs/quick_start/0.-try.html" class="md-nav__link"> |
| 0. Try |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../../docs/quick_start/1.-install.html" class="md-nav__link"> |
| 1. Install |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../../docs/quick_start/2.-cli.html" class="md-nav__link"> |
| 2. Cli |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../../docs/quick_start/3.-api.html" class="md-nav__link"> |
| 3. Api |
| </a> |
| </li> |
| |
| |
| |
| </ul> |
| </nav> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item md-nav__item--nested"> |
| |
| |
| <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7" > |
| |
| <label class="md-nav__link" for="__nav_7"> |
| Upgrade Guides |
| <span class="md-nav__icon md-icon"></span> |
| </label> |
| <nav class="md-nav" aria-label="Upgrade Guides" data-md-level="1"> |
| <label class="md-nav__title" for="__nav_7"> |
| <span class="md-nav__icon md-icon"></span> |
| Upgrade Guides |
| </label> |
| <ul class="md-nav__list" data-md-scrollfix> |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../../docs/upgrade_guides/5.0.0.html" class="md-nav__link"> |
| 5.0.0 |
| </a> |
| </li> |
| |
| |
| |
| </ul> |
| </nav> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item md-nav__item--nested"> |
| |
| |
| <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_8" type="checkbox" id="__nav_8" > |
| |
| <label class="md-nav__link" for="__nav_8"> |
| Warning And Error Codes |
| <span class="md-nav__icon md-icon"></span> |
| </label> |
| <nav class="md-nav" aria-label="Warning And Error Codes" data-md-level="1"> |
| <label class="md-nav__title" for="__nav_8"> |
| <span class="md-nav__icon md-icon"></span> |
| Warning And Error Codes |
| </label> |
| <ul class="md-nav__list" data-md-scrollfix> |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="../../docs/warning_and_error_codes/W0500.html" class="md-nav__link"> |
| W0500 |
| </a> |
| </li> |
| |
| |
| |
| </ul> |
| </nav> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item md-nav__item--active md-nav__item--nested"> |
| |
| |
| <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_9" type="checkbox" id="__nav_9" checked> |
| |
| <label class="md-nav__link" for="__nav_9"> |
| Reference |
| <span class="md-nav__icon md-icon"></span> |
| </label> |
| <nav class="md-nav" aria-label="Reference" data-md-level="1"> |
| <label class="md-nav__title" for="__nav_9"> |
| <span class="md-nav__icon md-icon"></span> |
| Reference |
| </label> |
| <ul class="md-nav__list" data-md-scrollfix> |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item md-nav__item--active md-nav__item--nested"> |
| |
| |
| <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_9_1" type="checkbox" id="__nav_9_1" checked> |
| |
| <label class="md-nav__link" for="__nav_9_1"> |
| Isort |
| <span class="md-nav__icon md-icon"></span> |
| </label> |
| <nav class="md-nav" aria-label="Isort" data-md-level="2"> |
| <label class="md-nav__title" for="__nav_9_1"> |
| <span class="md-nav__icon md-icon"></span> |
| Isort |
| </label> |
| <ul class="md-nav__list" data-md-scrollfix> |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="api.html" class="md-nav__link"> |
| API |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="comments.html" class="md-nav__link"> |
| Comments |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="core.html" class="md-nav__link"> |
| Core |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="exceptions.html" class="md-nav__link"> |
| Exceptions |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="files.html" class="md-nav__link"> |
| Files |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="format.html" class="md-nav__link"> |
| Format |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item 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"> |
| Hooks |
| <span class="md-nav__icon md-icon"></span> |
| </label> |
| |
| <a href="hooks.html" class="md-nav__link md-nav__link--active"> |
| Hooks |
| </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="#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="#get_lines" class="md-nav__link"> |
| get_lines |
| </a> |
| |
| </li> |
| |
| <li class="md-nav__item"> |
| <a href="#get_output" class="md-nav__link"> |
| get_output |
| </a> |
| |
| </li> |
| |
| <li class="md-nav__item"> |
| <a href="#git_hook" class="md-nav__link"> |
| git_hook |
| </a> |
| |
| </li> |
| |
| </ul> |
| </nav> |
| |
| </li> |
| |
| </ul> |
| |
| </nav> |
| |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="identify.html" class="md-nav__link"> |
| Identify |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="index.html" class="md-nav__link"> |
| Index |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="io.html" class="md-nav__link"> |
| Io |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="literal.html" class="md-nav__link"> |
| Literal |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="logo.html" class="md-nav__link"> |
| Logo |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="main.html" class="md-nav__link"> |
| Main |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="output.html" class="md-nav__link"> |
| Output |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="parse.html" class="md-nav__link"> |
| Parse |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="place.html" class="md-nav__link"> |
| Place |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="profiles.html" class="md-nav__link"> |
| Profiles |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="pylama_isort.html" class="md-nav__link"> |
| Pylama Isort |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="sections.html" class="md-nav__link"> |
| Sections |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="settings.html" class="md-nav__link"> |
| Settings |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="setuptools_commands.html" class="md-nav__link"> |
| Setuptools Commands |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="sorting.html" class="md-nav__link"> |
| Sorting |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="utils.html" class="md-nav__link"> |
| Utils |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="wrap.html" class="md-nav__link"> |
| Wrap |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="wrap_modes.html" class="md-nav__link"> |
| Wrap Modes |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item md-nav__item--nested"> |
| |
| |
| <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_9_1_26" type="checkbox" id="__nav_9_1_26" > |
| |
| <label class="md-nav__link" for="__nav_9_1_26"> |
| Deprecated |
| <span class="md-nav__icon md-icon"></span> |
| </label> |
| <nav class="md-nav" aria-label="Deprecated" data-md-level="3"> |
| <label class="md-nav__title" for="__nav_9_1_26"> |
| <span class="md-nav__icon md-icon"></span> |
| Deprecated |
| </label> |
| <ul class="md-nav__list" data-md-scrollfix> |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="deprecated/finders.html" class="md-nav__link"> |
| Finders |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="deprecated/index.html" class="md-nav__link"> |
| Index |
| </a> |
| </li> |
| |
| |
| |
| </ul> |
| </nav> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item md-nav__item--nested"> |
| |
| |
| <input class="md-nav__toggle md-toggle" data-md-toggle="__nav_9_1_27" type="checkbox" id="__nav_9_1_27" > |
| |
| <label class="md-nav__link" for="__nav_9_1_27"> |
| Stdlibs |
| <span class="md-nav__icon md-icon"></span> |
| </label> |
| <nav class="md-nav" aria-label="Stdlibs" data-md-level="3"> |
| <label class="md-nav__title" for="__nav_9_1_27"> |
| <span class="md-nav__icon md-icon"></span> |
| Stdlibs |
| </label> |
| <ul class="md-nav__list" data-md-scrollfix> |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="stdlibs/all.html" class="md-nav__link"> |
| All |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="stdlibs/index.html" class="md-nav__link"> |
| Index |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="stdlibs/py2.html" class="md-nav__link"> |
| Py2 |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="stdlibs/py27.html" class="md-nav__link"> |
| Py27 |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="stdlibs/py3.html" class="md-nav__link"> |
| Py3 |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="stdlibs/py310.html" class="md-nav__link"> |
| Py310 |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="stdlibs/py35.html" class="md-nav__link"> |
| Py35 |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="stdlibs/py36.html" class="md-nav__link"> |
| Py36 |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="stdlibs/py37.html" class="md-nav__link"> |
| Py37 |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="stdlibs/py38.html" class="md-nav__link"> |
| Py38 |
| </a> |
| </li> |
| |
| |
| |
| |
| |
| |
| |
| <li class="md-nav__item"> |
| <a href="stdlibs/py39.html" class="md-nav__link"> |
| Py39 |
| </a> |
| </li> |
| |
| |
| |
| </ul> |
| </nav> |
| </li> |
| |
| |
| |
| </ul> |
| </nav> |
| </li> |
| |
| |
| |
| </ul> |
| </nav> |
| </li> |
| |
| |
| |
| </ul> |
| </nav> |
| </div> |
| </div> |
| </div> |
| |
| |
| |
| <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" > |
| <div class="md-sidebar__scrollwrap"> |
| <div class="md-sidebar__inner"> |
| |
| <nav class="md-nav md-nav--secondary" aria-label="Table of contents"> |
| |
| |
| |
| |
| |
| |
| <label class="md-nav__title" for="__toc"> |
| <span class="md-nav__icon md-icon"></span> |
| Table of contents |
| </label> |
| <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix> |
| |
| <li class="md-nav__item"> |
| <a href="#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="#get_lines" class="md-nav__link"> |
| get_lines |
| </a> |
| |
| </li> |
| |
| <li class="md-nav__item"> |
| <a href="#get_output" class="md-nav__link"> |
| get_output |
| </a> |
| |
| </li> |
| |
| <li class="md-nav__item"> |
| <a href="#git_hook" class="md-nav__link"> |
| git_hook |
| </a> |
| |
| </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/hooks.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-isorthooks">Module isort.hooks</h1> |
| <p>Defines a git hook to allow pre-commit warnings and errors about import order.</p> |
| <p>usage: |
| exit_code = git_hook(strict=True|False, modify=True|False)</p> |
| <details class="example"><summary>View Source</summary><div class="codehilite"><pre><span></span><code><span class="sd">"""Defines a git hook to allow pre-commit warnings and errors about import order.</span> |
| |
| <span class="sd">usage:</span> |
| |
| <span class="sd"> exit_code = git_hook(strict=True|False, modify=True|False)</span> |
| |
| <span class="sd">"""</span> |
| |
| <span class="kn">import</span> <span class="nn">os</span> |
| |
| <span class="kn">import</span> <span class="nn">subprocess</span> <span class="c1"># nosec - Needed for hook</span> |
| |
| <span class="kn">from</span> <span class="nn">pathlib</span> <span class="kn">import</span> <span class="n">Path</span> |
| |
| <span class="kn">from</span> <span class="nn">typing</span> <span class="kn">import</span> <span class="n">List</span> |
| |
| <span class="kn">from</span> <span class="nn">isort</span> <span class="kn">import</span> <span class="n">Config</span><span class="p">,</span> <span class="n">api</span><span class="p">,</span> <span class="n">exceptions</span> |
| |
| <span class="k">def</span> <span class="nf">get_output</span><span class="p">(</span><span class="n">command</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">])</span> <span class="o">-></span> <span class="nb">str</span><span class="p">:</span> |
| |
| <span class="sd">"""Run a command and return raw output</span> |
| |
| <span class="sd"> :param str command: the command to run</span> |
| |
| <span class="sd"> :returns: the stdout output of the command</span> |
| |
| <span class="sd"> """</span> |
| |
| <span class="n">result</span> <span class="o">=</span> <span class="n">subprocess</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="n">command</span><span class="p">,</span> <span class="n">stdout</span><span class="o">=</span><span class="n">subprocess</span><span class="o">.</span><span class="n">PIPE</span><span class="p">,</span> <span class="n">check</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> <span class="c1"># nosec - trusted input</span> |
| |
| <span class="k">return</span> <span class="n">result</span><span class="o">.</span><span class="n">stdout</span><span class="o">.</span><span class="n">decode</span><span class="p">()</span> |
| |
| <span class="k">def</span> <span class="nf">get_lines</span><span class="p">(</span><span class="n">command</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">])</span> <span class="o">-></span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]:</span> |
| |
| <span class="sd">"""Run a command and return lines of output</span> |
| |
| <span class="sd"> :param str command: the command to run</span> |
| |
| <span class="sd"> :returns: list of whitespace-stripped lines output by command</span> |
| |
| <span class="sd"> """</span> |
| |
| <span class="n">stdout</span> <span class="o">=</span> <span class="n">get_output</span><span class="p">(</span><span class="n">command</span><span class="p">)</span> |
| |
| <span class="k">return</span> <span class="p">[</span><span class="n">line</span><span class="o">.</span><span class="n">strip</span><span class="p">()</span> <span class="k">for</span> <span class="n">line</span> <span class="ow">in</span> <span class="n">stdout</span><span class="o">.</span><span class="n">splitlines</span><span class="p">()]</span> |
| |
| <span class="k">def</span> <span class="nf">git_hook</span><span class="p">(</span> |
| |
| <span class="n">strict</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span> <span class="n">modify</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span> <span class="n">lazy</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span> <span class="n">settings_file</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s2">""</span> |
| |
| <span class="p">)</span> <span class="o">-></span> <span class="nb">int</span><span class="p">:</span> |
| |
| <span class="sd">"""Git pre-commit hook to check staged files for isort errors</span> |
| |
| <span class="sd"> :param bool strict - if True, return number of errors on exit,</span> |
| |
| <span class="sd"> causing the hook to fail. If False, return zero so it will</span> |
| |
| <span class="sd"> just act as a warning.</span> |
| |
| <span class="sd"> :param bool modify - if True, fix the sources if they are not</span> |
| |
| <span class="sd"> sorted properly. If False, only report result without</span> |
| |
| <span class="sd"> modifying anything.</span> |
| |
| <span class="sd"> :param bool lazy - if True, also check/fix unstaged files.</span> |
| |
| <span class="sd"> This is useful if you frequently use ``git commit -a`` for example.</span> |
| |
| <span class="sd"> If False, only check/fix the staged files for isort errors.</span> |
| |
| <span class="sd"> :param str settings_file - A path to a file to be used as</span> |
| |
| <span class="sd"> the configuration file for this run.</span> |
| |
| <span class="sd"> When settings_file is the empty string, the configuration file</span> |
| |
| <span class="sd"> will be searched starting at the directory containing the first</span> |
| |
| <span class="sd"> staged file, if any, and going upward in the directory structure.</span> |
| |
| <span class="sd"> :return number of errors if in strict mode, 0 otherwise.</span> |
| |
| <span class="sd"> """</span> |
| |
| <span class="c1"># Get list of files modified and staged</span> |
| |
| <span class="n">diff_cmd</span> <span class="o">=</span> <span class="p">[</span><span class="s2">"git"</span><span class="p">,</span> <span class="s2">"diff-index"</span><span class="p">,</span> <span class="s2">"--cached"</span><span class="p">,</span> <span class="s2">"--name-only"</span><span class="p">,</span> <span class="s2">"--diff-filter=ACMRTUXB"</span><span class="p">,</span> <span class="s2">"HEAD"</span><span class="p">]</span> |
| |
| <span class="k">if</span> <span class="n">lazy</span><span class="p">:</span> |
| |
| <span class="n">diff_cmd</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="s2">"--cached"</span><span class="p">)</span> |
| |
| <span class="n">files_modified</span> <span class="o">=</span> <span class="n">get_lines</span><span class="p">(</span><span class="n">diff_cmd</span><span class="p">)</span> |
| |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">files_modified</span><span class="p">:</span> |
| |
| <span class="k">return</span> <span class="mi">0</span> |
| |
| <span class="n">errors</span> <span class="o">=</span> <span class="mi">0</span> |
| |
| <span class="n">config</span> <span class="o">=</span> <span class="n">Config</span><span class="p">(</span> |
| |
| <span class="n">settings_file</span><span class="o">=</span><span class="n">settings_file</span><span class="p">,</span> |
| |
| <span class="n">settings_path</span><span class="o">=</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">dirname</span><span class="p">(</span><span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">abspath</span><span class="p">(</span><span class="n">files_modified</span><span class="p">[</span><span class="mi">0</span><span class="p">])),</span> |
| |
| <span class="p">)</span> |
| |
| <span class="k">for</span> <span class="n">filename</span> <span class="ow">in</span> <span class="n">files_modified</span><span class="p">:</span> |
| |
| <span class="k">if</span> <span class="n">filename</span><span class="o">.</span><span class="n">endswith</span><span class="p">(</span><span class="s2">".py"</span><span class="p">):</span> |
| |
| <span class="c1"># Get the staged contents of the file</span> |
| |
| <span class="n">staged_cmd</span> <span class="o">=</span> <span class="p">[</span><span class="s2">"git"</span><span class="p">,</span> <span class="s2">"show"</span><span class="p">,</span> <span class="sa">f</span><span class="s2">":</span><span class="si">{</span><span class="n">filename</span><span class="si">}</span><span class="s2">"</span><span class="p">]</span> |
| |
| <span class="n">staged_contents</span> <span class="o">=</span> <span class="n">get_output</span><span class="p">(</span><span class="n">staged_cmd</span><span class="p">)</span> |
| |
| <span class="k">try</span><span class="p">:</span> |
| |
| <span class="k">if</span> <span class="ow">not</span> <span class="n">api</span><span class="o">.</span><span class="n">check_code_string</span><span class="p">(</span> |
| |
| <span class="n">staged_contents</span><span class="p">,</span> <span class="n">file_path</span><span class="o">=</span><span class="n">Path</span><span class="p">(</span><span class="n">filename</span><span class="p">),</span> <span class="n">config</span><span class="o">=</span><span class="n">config</span> |
| |
| <span class="p">):</span> |
| |
| <span class="n">errors</span> <span class="o">+=</span> <span class="mi">1</span> |
| |
| <span class="k">if</span> <span class="n">modify</span><span class="p">:</span> |
| |
| <span class="n">api</span><span class="o">.</span><span class="n">sort_file</span><span class="p">(</span><span class="n">filename</span><span class="p">,</span> <span class="n">config</span><span class="o">=</span><span class="n">config</span><span class="p">)</span> |
| |
| <span class="k">except</span> <span class="n">exceptions</span><span class="o">.</span><span class="n">FileSkipped</span><span class="p">:</span> <span class="c1"># pragma: no cover</span> |
| |
| <span class="k">pass</span> |
| |
| <span class="k">return</span> <span class="n">errors</span> <span class="k">if</span> <span class="n">strict</span> <span class="k">else</span> <span class="mi">0</span> |
| </code></pre></div> |
| |
| </details> |
| <h2 id="functions">Functions</h2> |
| <h3 id="get_lines">get_lines</h3> |
| <div class="codehilite"><pre><span></span><code><span class="k">def</span> <span class="nf">get_lines</span><span class="p">(</span> |
| <span class="n">command</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> |
| <span class="p">)</span> <span class="o">-></span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> |
| </code></pre></div> |
| |
| <p>Run a command and return lines of output</p> |
| <p><strong>Parameters:</strong></p> |
| <table> |
| <thead> |
| <tr> |
| <th>Name</th> |
| <th>Type</th> |
| <th>Description</th> |
| <th>Default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>command</td> |
| <td>str</td> |
| <td>the command to run</td> |
| <td>None</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Returns:</strong></p> |
| <table> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>None</td> |
| <td>list of whitespace-stripped lines output by command</td> |
| </tr> |
| </tbody> |
| </table> |
| <details class="example"><summary>View Source</summary><div class="codehilite"><pre><span></span><code><span class="n">def</span><span class="w"> </span><span class="n">get_lines</span><span class="p">(</span><span class="nl">command</span><span class="p">:</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="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">"""Run a command and return lines of output</span> |
| |
| <span class="ss"> :param str command: the command to run</span> |
| |
| <span class="ss"> :returns: list of whitespace-stripped lines output by command</span> |
| |
| <span class="ss"> """</span><span class="w"></span> |
| |
| <span class="w"> </span><span class="n">stdout</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">get_output</span><span class="p">(</span><span class="n">command</span><span class="p">)</span><span class="w"></span> |
| |
| <span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="o">[</span><span class="n">line.strip() for line in stdout.splitlines()</span><span class="o">]</span><span class="w"></span> |
| </code></pre></div> |
| |
| </details> |
| <h3 id="get_output">get_output</h3> |
| <div class="codehilite"><pre><span></span><code><span class="k">def</span> <span class="nf">get_output</span><span class="p">(</span> |
| <span class="n">command</span><span class="p">:</span> <span class="n">List</span><span class="p">[</span><span class="nb">str</span><span class="p">]</span> |
| <span class="p">)</span> <span class="o">-></span> <span class="nb">str</span> |
| </code></pre></div> |
| |
| <p>Run a command and return raw output</p> |
| <p><strong>Parameters:</strong></p> |
| <table> |
| <thead> |
| <tr> |
| <th>Name</th> |
| <th>Type</th> |
| <th>Description</th> |
| <th>Default</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>command</td> |
| <td>str</td> |
| <td>the command to run</td> |
| <td>None</td> |
| </tr> |
| </tbody> |
| </table> |
| <p><strong>Returns:</strong></p> |
| <table> |
| <thead> |
| <tr> |
| <th>Type</th> |
| <th>Description</th> |
| </tr> |
| </thead> |
| <tbody> |
| <tr> |
| <td>None</td> |
| <td>the stdout output of the command</td> |
| </tr> |
| </tbody> |
| </table> |
| <details class="example"><summary>View Source</summary><div class="codehilite"><pre><span></span><code><span class="n">def</span><span class="w"> </span><span class="n">get_output</span><span class="p">(</span><span class="nl">command</span><span class="p">:</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="p">)</span><span class="w"> </span><span class="o">-></span><span class="w"> </span><span class="nf">str</span><span class="err">:</span><span class="w"></span> |
| |
| <span class="w"> </span><span class="ss">"""Run a command and return raw output</span> |
| |
| <span class="ss"> :param str command: the command to run</span> |
| |
| <span class="ss"> :returns: the stdout output of the command</span> |
| |
| <span class="ss"> """</span><span class="w"></span> |
| |
| <span class="w"> </span><span class="k">result</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="n">subprocess</span><span class="p">.</span><span class="n">run</span><span class="p">(</span><span class="n">command</span><span class="p">,</span><span class="w"> </span><span class="n">stdout</span><span class="o">=</span><span class="n">subprocess</span><span class="p">.</span><span class="n">PIPE</span><span class="p">,</span><span class="w"> </span><span class="k">check</span><span class="o">=</span><span class="k">True</span><span class="p">)</span><span class="w"> </span><span class="err">#</span><span class="w"> </span><span class="n">nosec</span><span class="w"> </span><span class="o">-</span><span class="w"> </span><span class="n">trusted</span><span class="w"> </span><span class="k">input</span><span class="w"></span> |
| |
| <span class="w"> </span><span class="k">return</span><span class="w"> </span><span class="k">result</span><span class="p">.</span><span class="n">stdout</span><span class="p">.</span><span class="n">decode</span><span class="p">()</span><span class="w"></span> |
| </code></pre></div> |
| |
| </details> |
| <h3 id="git_hook">git_hook</h3> |
| <div class="codehilite"><pre><span></span><code><span class="k">def</span> <span class="nf">git_hook</span><span class="p">(</span> |
| <span class="n">strict</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span> |
| <span class="n">modify</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span> |
| <span class="n">lazy</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span><span class="p">,</span> |
| <span class="n">settings_file</span><span class="p">:</span> <span class="nb">str</span> <span class="o">=</span> <span class="s1">''</span> |
| <span class="p">)</span> <span class="o">-></span> <span class="nb">int</span> |
| </code></pre></div> |
| |
| <p>Git pre-commit hook to check staged files for isort errors</p> |
| <p>:param bool strict - if True, return number of errors on exit, |
| causing the hook to fail. If False, return zero so it will |
| just act as a warning. |
| :param bool modify - if True, fix the sources if they are not |
| sorted properly. If False, only report result without |
| modifying anything. |
| :param bool lazy - if True, also check/fix unstaged files. |
| This is useful if you frequently use <code>git commit -a</code> for example. |
| If False, only check/fix the staged files for isort errors. |
| :param str settings_file - A path to a file to be used as |
| the configuration file for this run. |
| When settings_file is the empty string, the configuration file |
| will be searched starting at the directory containing the first |
| staged file, if any, and going upward in the directory structure.</p> |
| <p>:return number of errors if in strict mode, 0 otherwise.</p> |
| <details class="example"><summary>View Source</summary><div class="codehilite"><pre><span></span><code><span class="n">def</span> <span class="n">git_hook</span><span class="p">(</span> |
| |
| <span class="n">strict</span><span class="o">:</span> <span class="n">bool</span> <span class="o">=</span> <span class="kr">False</span><span class="p">,</span> <span class="n">modify</span><span class="o">:</span> <span class="n">bool</span> <span class="o">=</span> <span class="kr">False</span><span class="p">,</span> <span class="n">lazy</span><span class="o">:</span> <span class="n">bool</span> <span class="o">=</span> <span class="kr">False</span><span class="p">,</span> <span class="n">settings_file</span><span class="o">:</span> <span class="n">str</span> <span class="o">=</span> <span class="s">""</span> |
| |
| <span class="p">)</span> <span class="o">-></span> <span class="n">int</span><span class="o">:</span> |
| |
| <span class="s">"""Git pre-commit hook to check staged files for isort errors</span> |
| |
| <span class="s"> :param bool strict - if True, return number of errors on exit,</span> |
| |
| <span class="s"> causing the hook to fail. If False, return zero so it will</span> |
| |
| <span class="s"> just act as a warning.</span> |
| |
| <span class="s"> :param bool modify - if True, fix the sources if they are not</span> |
| |
| <span class="s"> sorted properly. If False, only report result without</span> |
| |
| <span class="s"> modifying anything.</span> |
| |
| <span class="s"> :param bool lazy - if True, also check/fix unstaged files.</span> |
| |
| <span class="s"> This is useful if you frequently use ``git commit -a`` for example.</span> |
| |
| <span class="s"> If False, only check/fix the staged files for isort errors.</span> |
| |
| <span class="s"> :param str settings_file - A path to a file to be used as</span> |
| |
| <span class="s"> the configuration file for this run.</span> |
| |
| <span class="s"> When settings_file is the empty string, the configuration file</span> |
| |
| <span class="s"> will be searched starting at the directory containing the first</span> |
| |
| <span class="s"> staged file, if any, and going upward in the directory structure.</span> |
| |
| <span class="s"> :return number of errors if in strict mode, 0 otherwise.</span> |
| |
| <span class="s"> """</span> |
| |
| <span class="err">#</span> <span class="n">Get</span> <span class="n">list</span> <span class="kr">of</span> <span class="n">files</span> <span class="n">modified</span> <span class="kr">and</span> <span class="n">staged</span> |
| |
| <span class="n">diff_cmd</span> <span class="o">=</span> <span class="p">[</span><span class="s">"git"</span><span class="p">,</span> <span class="s">"diff-index"</span><span class="p">,</span> <span class="s">"--cached"</span><span class="p">,</span> <span class="s">"--name-only"</span><span class="p">,</span> <span class="s">"--diff-filter=ACMRTUXB"</span><span class="p">,</span> <span class="s">"HEAD"</span><span class="p">]</span> |
| |
| <span class="nf">if</span> <span class="n">lazy</span><span class="o">:</span> |
| |
| <span class="n">diff_cmd</span><span class="p">.</span><span class="n">remove</span><span class="p">(</span><span class="s">"--cached"</span><span class="p">)</span> |
| |
| <span class="n">files_modified</span> <span class="o">=</span> <span class="n">get_lines</span><span class="p">(</span><span class="n">diff_cmd</span><span class="p">)</span> |
| |
| <span class="nf">if</span> <span class="kr">not</span> <span class="n">files_modified</span><span class="o">:</span> |
| |
| <span class="kr">return</span> <span class="mi">0</span> |
| |
| <span class="n">errors</span> <span class="o">=</span> <span class="mi">0</span> |
| |
| <span class="n">config</span> <span class="o">=</span> <span class="n">Config</span><span class="p">(</span> |
| |
| <span class="n">settings_file</span><span class="o">=</span><span class="n">settings_file</span><span class="p">,</span> |
| |
| <span class="n">settings_path</span><span class="o">=</span><span class="n">os</span><span class="p">.</span><span class="n">path</span><span class="p">.</span><span class="n">dirname</span><span class="p">(</span><span class="n">os</span><span class="p">.</span><span class="n">path</span><span class="p">.</span><span class="n">abspath</span><span class="p">(</span><span class="n">files_modified</span><span class="p">[</span><span class="mi">0</span><span class="p">])),</span> |
| |
| <span class="p">)</span> |
| |
| <span class="n">for</span> <span class="n">filename</span> <span class="kr">in</span> <span class="n">files_modified</span><span class="o">:</span> |
| |
| <span class="nf">if</span> <span class="n">filename</span><span class="p">.</span><span class="kd">ends</span><span class="n">with</span><span class="p">(</span><span class="s">".py"</span><span class="p">)</span><span class="o">:</span> |
| |
| <span class="err">#</span> <span class="n">Get</span> <span class="n">the</span> <span class="n">staged</span> <span class="n">contents</span> <span class="kr">of</span> <span class="n">the</span> <span class="n">file</span> |
| |
| <span class="n">staged_cmd</span> <span class="o">=</span> <span class="p">[</span><span class="s">"git"</span><span class="p">,</span> <span class="s">"show"</span><span class="p">,</span> <span class="n">f</span><span class="s">":{filename}"</span><span class="p">]</span> |
| |
| <span class="n">staged_contents</span> <span class="o">=</span> <span class="n">get_output</span><span class="p">(</span><span class="n">staged_cmd</span><span class="p">)</span> |
| |
| <span class="n">try</span><span class="o">:</span> |
| |
| <span class="nf">if</span> <span class="kr">not</span> <span class="n">api</span><span class="p">.</span><span class="n">check_code_string</span><span class="p">(</span> |
| |
| <span class="n">staged_contents</span><span class="p">,</span> <span class="n">file_path</span><span class="o">=</span><span class="n">Path</span><span class="p">(</span><span class="n">filename</span><span class="p">),</span> <span class="n">config</span><span class="o">=</span><span class="n">config</span> |
| |
| <span class="p">)</span><span class="o">:</span> |
| |
| <span class="n">errors</span> <span class="o">+=</span> <span class="mi">1</span> |
| |
| <span class="nf">if</span> <span class="n">modify</span><span class="o">:</span> |
| |
| <span class="n">api</span><span class="p">.</span><span class="n">sort_file</span><span class="p">(</span><span class="n">filename</span><span class="p">,</span> <span class="n">config</span><span class="o">=</span><span class="n">config</span><span class="p">)</span> |
| |
| <span class="kr">except</span> <span class="n">exceptions</span><span class="p">.</span><span class="n">FileSkipped</span><span class="o">:</span> <span class="err">#</span> <span class="n">pragma</span><span class="o">:</span> <span class="n">no</span> <span class="n">cover</span> |
| |
| <span class="n">pass</span> |
| |
| <span class="kr">return</span> <span class="n">errors</span> <span class="nf">if</span> <span class="n">strict</span> <span class="n">else</span> <span class="mi">0</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="format.html" title="Format" 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> |
| Format |
| </span> |
| </div> |
| </a> |
| |
| |
| <a href="identify.html" title="Identify" 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> |
| Identify |
| </span> |
| </div> |
| <div class="md-flex__cell md-flex__cell--shrink"> |
| <i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i> |
| </div> |
| </a> |
| |
| </nav> |
| </div> |
| |
| <div class="md-footer-meta md-typeset"> |
| <div class="md-footer-meta__inner md-grid"> |
| <div class="md-footer-copyright"> |
| |
| Powered by |
| <a href="http://timothycrosley.github.io/portray">portray.</a> |
| You too can |
| <a href="http://timothycrosley.github.io/portray"> |
| portray</a> |
| your Python project well using automatic documentation. |
| </div> |
| |
| </div> |
| </div> |
| </footer> |
| |
| </div> |
| <div class="md-dialog" data-md-component="dialog"> |
| <div class="md-dialog__inner md-typeset"></div> |
| </div> |
| <script id="__config" type="application/json">{"base": "../..", "features": [], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing", "select.version.title": "Select version"}, "search": "../../assets/javascripts/workers/search.709b4209.min.js", "version": null}</script> |
| |
| |
| <script src="../../assets/javascripts/bundle.29db7785.min.js"></script> |
| |
| |
| </body> |
| </html> |
