a aRc @sdZddlZddlZddlZddlmZddlmZddlm Z ddl m Z ddl m Z mZmZmZmZmZmZddlmZdd lmZd d lmZmZmZd d lmZmZmZmZd d l m!Z!m"Z"m#Z#d dlm$Z$m%Z%d dl&m'Z(d dl&m)Z*d dl+m,Z,m-Z-m.Z.GdddeZ/de-dddfe0ee0e.ee e1ee1efe e0dddZ2dde-ddfe0ee1efee0e.ee e1e e1dddZ3de-ddddfeeee0e.ee e1ee1efe1e e1d ddZ4dde-ddfeee1efee0e.ee e1e e1dd d!Z5de-dddfee0e fee1efe.ee e1ee0e e1d"d#d$Z6e%e d%d&d'Z7ej8eed(d)d*Z9ej8ee0e fe%eed+d,d-Z:de-ddddddfee0e fee0e.ee e1e1ee1efe1eee e1d. d/d0Z;e-dddfe0e.ee ee1e/fe1e eej<d1d2d3Z=e-ddddfee.ee ee1e/fe1eee0e eej<d4d5d6Z>e-dddfee0e fe.ee ee1e/fe1e eej<d7d8d9Z?e-dddfeee0e fe.ee ee1e/fe1e eej<d:d;d<Z@de-fee e.e e.d=d>d?ZAdS)@) ImportKeycheck_code_string check_file check_streamfind_imports_in_codefind_imports_in_filefind_imports_in_pathsfind_imports_in_stream place_moduleplace_module_with_reasonsort_code_string sort_file sort_streamN)EnumStringIO)chain)Path)AnyIteratorOptionalSetTextIOUnioncast)warn)core)filesidentifyio)ExistingSyntaxErrorsFileSkipCommentFileSkipSettingIntroducedSyntaxErrors)$ask_whether_to_apply_changes_to_filecreate_terminal_printershow_unified_diff)EmptyFile)module)module_with_reason)CYTHON_EXTENSIONSDEFAULT_CONFIGConfigc@s eZdZdZdZdZdZdZdS)raDefines how to key an individual import, generally for deduping. Import keys are defined from less to more specific: from x.y import z as a ______| | | | | | | | PACKAGE | | | ________| | | | | | MODULE | | _________________| | | | ATTRIBUTE | ______________________| | ALIAS rN)__name__ __module__ __qualname____doc__PACKAGEMODULE ATTRIBUTEALIASr:r:(lib/python3.9/site-packages/isort/api.pyr+s rF)code extensionconfig file_pathdisregard_skip show_diff config_kwargsreturnc KsJt|}t}tf||d|}t|||||||d|d|S)aSorts any imports within the provided code string, returning a new string with them sorted. - **code**: The string of code with imports that need to be sorted. - **extension**: The file extension that contains imports. Defaults to filename extension or py. - **config**: The config object to use when sorting imports. - **file_path**: The disk location where the code string was pulled from. - **disregard_skip**: set to `True` if you want to ignore a skip set in config for this file. - **show_diff**: If `True` the changes that need to be done will be printed to stdout, if a TextIO stream is provided results will be written to it, otherwise no diff will be computed. - ****config_kwargs**: Any config modifications. pathr>)r=r>r?r@rAr)r_configr seekread) r<r=r>r?r@rArB input_stream output_streamr:r:r;r Es r )r<rAr=r>r?r@rBrCcKs,tf||d|}tt||||||dS)a2Checks the order, format, and categorization of imports within the provided code string. Returns `True` if everything is correct, otherwise `False`. - **code**: The string of code with imports that need to be sorted. - **show_diff**: If `True` the changes that need to be done will be printed to stdout, if a TextIO stream is provided results will be written to it, otherwise no diff will be computed. - **extension**: The file extension that contains imports. Defaults to filename extension or py. - **config**: The config object to use when sorting imports. - **file_path**: The disk location where the code string was pulled from. - **disregard_skip**: set to `True` if you want to ignore a skip set in config for this file. - ****config_kwargs**: Any config modifications. rDrAr=r>r?r@)rFrr)r<rAr=r>r?r@rBr:r:r;risrT) rIrJr=r>r?r@rA raise_on_skiprBrCc Ks|p|r|jdpd}|rt} t|} tf| | |||||d|} | d| dt| | ||dur||ntt||j d| St f||d|}t |pd} |s|r| |rt | |} |jrLz|}t|| d dd Wn>ty2|tvrt| n|jr.t| d Yn0t|}|sLt} ztj|| |||d } Wntyt| Yn0|jr| dz"t| | d dd | dWn>ty|tvrt| n|jrt| d Yn0| |kr|| | S) aSorts any imports within the provided code stream, outputs to the provided output stream. Returns `True` if anything is modified from the original input stream, otherwise `False`. - **input_stream**: The stream of code with imports that need to be sorted. - **output_stream**: The stream where sorted imports should be written to. - **extension**: The file extension that contains imports. Defaults to filename extension or py. - **config**: The config object to use when sorting imports. - **file_path**: The disk location where the code string was pulled from. - **disregard_skip**: set to `True` if you want to ignore a skip set in config for this file. - **show_diff**: If `True` the changes that need to be done will be printed to stdout, if a TextIO stream is provided results will be written to it, otherwise no diff will be computed. - ****config_kwargs**: Any config modifications. .py)rIrJr=r>r?r@rLrTZ file_inputZ file_outputr?output color_outputrDzPassed in contentexecrz< Python AST errors found but ignored due to Cython extension)r=r>rL)suffixlstriprrHr rGr'rrrQrFstrZ is_skippedr#Zatomiccompile SyntaxErrorr,r!verboserreadablerZprocessr"r$write)rIrJr=r>r?r@rArLrBZ_output_streamZ _input_streamchangedZcontent_sourceZ_internal_outputZ file_contentr:r:r;r s              r )rIrAr=r>r?r@rBrCc Kstf||d|}|r$t|}t|t||||d}t|j|j|jd}|st|j rp|j sp| |pfdddS| |p~dd|rt} | d|} tt| | ||||d| dt| | ||durd ntt||jd d S) aEChecks any imports within the provided code stream, returning `False` if any unsorted or incorrectly imports are found or `True` if no problems are identified. - **input_stream**: The stream of code with imports that need to be sorted. - **show_diff**: If `True` the changes that need to be done will be printed to stdout, if a TextIO stream is provided results will be written to it, otherwise no diff will be computed. - **extension**: The file extension that contains imports. Defaults to filename extension or py. - **config**: The config object to use when sorting imports. - **file_path**: The disk location where the code string was pulled from. - **disregard_skip**: set to `True` if you want to ignore a skip set in config for this file. - ****config_kwargs**: Any config modifications. rD)rIrJr=r>r?r@)Zcolorerrorsuccessz Everything Looks Good!Tz1 Imports are incorrectly sorted and/or formatted.rNrOF)rFrrHr r(r&rQZ format_errorZformat_successrXZ only_modifiedr]r\rGr'rr) rIrAr=r>r?r@rBr[ZprinterrJZ file_contentsr:r:r;rsP     r)filenamerAr>r?r@r=rBrCc KsTtj|4}t|jf||||p$|j|d|WdS1sF0YdS)a)Checks any imports within the provided file, returning `False` if any unsorted or incorrectly imports are found or `True` if no problems are identified. - **filename**: The name or Path of the file to check. - **show_diff**: If `True` the changes that need to be done will be printed to stdout, if a TextIO stream is provided results will be written to it, otherwise no diff will be computed. - **config**: The config object to use when sorting imports. - **file_path**: The disk location where the code string was pulled from. - **disregard_skip**: set to `True` if you want to ignore a skip set in config for this file. - **extension**: The file extension that contains imports. Defaults to filename extension or py. - ****config_kwargs**: Any config modifications. rKN)r r)rHrstreamrE)r_rAr>r?r@r=rB source_filer:r:r;r1sr)rarCcCs|j|jjdS)Nz.isorted)rE with_suffixrS)rar:r:r; _tmp_fileRsrc)rCccstddVdS)N)newlinerr:r:r:r; _in_memory_output_stream_contextVsre)r_rarCccsPt|}|jd|jdd"}t|||VWdn1sB0YdS)Nzw+r^)encodingrd)rcopenrfshutilcopymode)r_ratmp_filerJr:r:r;_file_output_stream_context[s rk) r_r=r>r?r@ ask_to_applyrAwrite_to_stdoutrPrBrCc Ks\tj|8} |p| j} tf| |d| }d} z|rVt| jtj|| ||d} n|durzz|j rrt } n t || } | @}t| j||| ||d} | d| r|s|r^| j dt | j|| |durdntt||jd|s |r^tt| js^WdWz|j s4t| }|WntyJYn0WWddS| j|j r| d| jd}t||Wdn1s0YWdn1s0Y| r|j st| }|| j|jstd | jWz|j s*t| }|Wnty@Yn0n4z|j s^t| }|WntytYn00ntt| j||| ||d} | r|r| j d| dt | j|| |durdntt||jd| jWnBtyt| d Yn"ty2t| d Yn0| WdS1sN0YdS) a:Sorts and formats any groups of imports imports within the provided file or Path. Returns `True` if the file has been changed, otherwise `False`. - **filename**: The name or Path of the file to format. - **extension**: The file extension that contains imports. Defaults to filename extension or py. - **config**: The config object to use when sorting imports. - **file_path**: The disk location where the code string was pulled from. - **disregard_skip**: set to `True` if you want to ignore a skip set in config for this file. - **ask_to_apply**: If `True`, prompt before applying any changes. - **show_diff**: If `True` the changes that need to be done will be printed to stdout, if a TextIO stream is provided results will be written to it, otherwise no diff will be computed. - **write_to_stdout**: If `True`, write to stdout instead of the input file. - **output**: If a TextIO is provided, results will be written there rather than replacing the original file content. - ****config_kwargs**: Any config modifications. rDF)rIrJr>r?r@r=NrTrOwzFixing z- unable to sort due to existing syntax errorsz5 unable to sort as isort introduces new syntax errors) r r)rHrErFr r`sysstdoutZoverwrite_in_placererkrGr'rrrQr%rUrcunlinkFileNotFoundErrorclosergrh copyfileobjreplacequietprintr!rr$)r_r=r>r?r@rlrArmrPrBraZactual_file_pathr[Zoutput_stream_contextrJrjZfsr:r:r;r cs          L       r )r<r>r?uniquetop_onlyrBrCcks(tft|||||d|EdHdS)aFinds and returns all imports within the provided code string. - **code**: The string of code with imports that need to be sorted. - **config**: The config object to use when sorting imports. - **file_path**: The disk location where the code string was pulled from. - **unique**: If True, only the first instance of an import is returned. - **top_only**: If True, only return imports that occur before the first function or class. - ****config_kwargs**: Any config modifications. rIr>r?rxryN)rr)r<r>r?rxryrBr:r:r;rsr)rIr>r?rxry_seenrBrCc kstfd|i|}tj||||d}|s2|EdH|dur@tn|}|D]} |dtjfvrd| } nJ|tjkr| jd| j } n,|tj kr| j} n|tj kr| j dd} | rH| |vrH| | | VqHdS)afFinds and returns all imports within the provided code stream. - **input_stream**: The stream of code with imports that need to be sorted. - **config**: The config object to use when sorting imports. - **file_path**: The disk location where the code string was pulled from. - **unique**: If True, only the first instance of an import is returned. - **top_only**: If True, only return imports that occur before the first function or class. - **_seen**: An optional set of imports already seen. Generally meant only for internal use. - ****config_kwargs**: Any config modifications. r>)r>r?ryNTrMr)rFrZimportssetrr9Z statementr8r*Z attributer7r6splitadd) rIr>r?rxryr{rBZidentified_importsseenZidentified_importkeyr:r:r;rs&       r)r_r>r?rxryrBrCc ksXtj|8}tf|j||p |j||d|EdHWdn1sJ0YdS)acFinds and returns all imports within the provided source file. - **filename**: The name or Path of the file to look for imports in. - **extension**: The file extension that contains imports. Defaults to filename extension or py. - **config**: The config object to use when sorting imports. - **file_path**: The disk location where the code string was pulled from. - **unique**: If True, only the first instance of an import is returned. - **top_only**: If True, only return imports that occur before the first function or class. - ****config_kwargs**: Any config modifications. rzN)r r)rHrr`rE)r_r>r?rxryrBrar:r:r;r'sr)pathsr>r?rxryrBrCc+sXtfdi|rtndtfddttt|ggDEdHdS)ajFinds and returns all imports within the provided source paths. - **paths**: A collection of paths to recursively look for imports within. - **extension**: The file extension that contains imports. Defaults to filename extension or py. - **config**: The config object to use when sorting imports. - **file_path**: The disk location where the code string was pulled from. - **unique**: If True, only the first instance of an import is returned. - **top_only**: If True, only return imports that occur before the first function or class. - ****config_kwargs**: Any config modifications. r>Nc3s |]}t|dVqdS))rxr>ryr{N)r).0 file_namer>rryrxr:r; Ys z(find_imports_in_paths..)rFr|rrfindmaprU)rr>r?rxryrBr:rr;rDsr)rEr>rBrCcKsJ|r$|tur$d|vr$d|vr$||d<|rF|tur8tdtfi|}|S)NZ settings_pathZ settings_fileziYou can either specify custom configuration options using kwargs or passing in a Config object. Not Both!)r- ValueErrorr.)rEr>rBr:r:r;rFbsrF)B__all__ contextlibrhroenumrr r itertoolsrpathlibrtypingrrrrrrrwarningsrZisortrr^rr exceptionsr!r"r#r$formatr%r&r'r(r)Zplacer*r r+r Zsettingsr,r-r.rrUboolr rr rrrccontextmanagerrerkr ZImportrrrrrFr:r:r:r;sl    $      &  #  g  E   !         ,