ॺH d Z ddlZddlZddlZddlmZ ddlmZ ddlm Z ddl
m Z ddl m
Z
mZmZmZmZmZmZ ddlmZ dd lmZ d
d lmZmZmZ d
d lm Z m Z m Z m Z d
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. G d de Z/de-dddfde0dee0 de.dee de1dee1ef de
d e0fd Z2dde-ddfde0dee1ef dee0 de.dee de1de
d e1fd Z3de-dddd fd ed!edee0 de.dee de1dee1ef d"e1de
d e1fd#Z4dde-ddfd edee1ef dee0 de.dee de1de
d e1fd$Z5de-dd dfd%ee0e f dee1ef de.dee de1dee0 de
d e1fd&Z6d'e%d e fd(Z7ej8 d ee fd) Z9ej8 d%ee0e f d'e%d ee fd* Z:de-dd ddddfd%ee0e f dee0 de.dee de1d+e1dee1ef d,e1d-ee de
d e1fd.Z;e-dddfde0de.dee d/ee1e/f d0e1de
d eej< fd1Z=e-ddddfd ede.dee d/ee1e/f d0e1d2eee0 de
d eej< fd3Z>e-dddfd%ee0e f de.dee d/ee1e/f d0e1de
d eej< fd4Z?e-dddfd5eee0e f de.dee d/ee1e/f d0e1de
d eej< fd6Z@de-fd7ee de.de
d e.fd8ZAdS )9)
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_stream N)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 " e Zd ZdZdZdZdZdZdS )r a Defines 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
r N)__name__
__module__ __qualname____doc__PACKAGEMODULE ATTRIBUTEALIAS [/builddir/build/BUILD/cloudlinux-venv-1.0.10/venv/lib/python3.11/site-packages/isort/api.pyr r + s. & G
FI
EEEr= r Fcode extensionconfig file_pathdisregard_skip show_diff
config_kwargsreturnc t | }t }t d||d|}t ||||||| | d | S )a Sorts 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.
pathrA )r@ rA rB rC rD r r< )r _configr seekread) r? r@ rA rB rC rD rE input_stream
output_streams r> r r E s ( D>>L JJM
D)F
D
Dm
D
DF% q r= c d t d||d|}t t | ||||| S )a2 Checks 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.
rH rD r@ rA rB rC r< )rJ r r )r? rD r@ rA rB rC rE s r> r r i sM *
D)F
D
Dm
D
DF %
r= TrM rN
raise_on_skipc |p |r|j d pd}|rt } t | }
t d
|
| |||||d|} | d |
d t
|
| ||du r|n||j | S t d
||d|}t |pd } |s&|r$|
| rt | |}
|j r | }t || d dd
nA# t $ r4 |t vrt! | |j rt% | d Y nw xY wt | } | st }
t) j | |
||| } n # t, $ r t- | w xY w|j r|
d t |
| d dd
|
d nA# t $ r4 |t vrt/ | |j rt% | d Y nw xY w|
|k r'| |
| S )a Sorts 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)rM rN r@ rA rB rC rQ r T
file_input file_outputrB output color_outputrH zPassed in contentexecr z< Python AST errors found but ignored due to Cython extension)r@ rA rQ r< )suffixlstripr rL r rK r( rY rJ str
is_skippedr$ atomiccompile SyntaxErrorr- r" verboser readabler processr# r% write)rM rN r@ rA rB rC rD rQ rE _output_stream
_input_streamchangedcontent_source_internal_output file_contents r> r r s} 0 Qi HI,<,C,CC,H,HQTI ! !2!2!4!455
&( )'
A 1 $))++&++-- $-$5$5==9 ,
D)F
D
Dm
D
DF9&9::N .i .F,=,=i,H,H . n---$
} * ',,..L L.&!Q ? ? ? ? 111*>:::~
%ccc -- %%'' * 'zz ., '
. . . n---. }
9 a $))++^VQ J J J ! !! $ $ $ $ 111,^<<<~
%ccc } , , 0 5 5 7 7 8 8 8 Ns0 ''E ;F
F
G G6:I ;JJc t d ||d|}|r!t | } t | t |||| }t |j |j |j }|s*|j r!|j
s| |pd d dS | |pd d |rt } |
d | }
t t |
| |||| |
d t |
| ||du rd n||j
d S )
aE Checks 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.
rH )rM rN r@ rA rB rC )colorerrorsuccess z Everything Looks Good!Tz1 Imports are incorrectly sorted and/or formatted.r NrU Fr< )rJ r rL r r) r' rY format_errorformat_successrb
only_modifiedro rn rK r( ) rM rD r@ rA rB rC rE rh printerrN
file_contentss r> r r s *
D)F
D
Dm
D
DF 5 1 1 3 344 !%
G &!) I&"6 I OOyB G G G H H Ht MMY_"WWWXXX
! $))++
!-00' )
1 $%**,, $,,44) ,
5r= filenamec
~ |}d|v r`| dd }|rH| | } |j rt | d d| t di | d }t
j | 5 }
t |
j f||||p|
j
|d|cddd S # 1 swxY w Y dS )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.
config_trieNr used for file r rP r< ) popsearchrb printr/ r! r* rL r streamrI ) rv rD rA rB rC r@ rE file_configrx config_info source_files r> r r 1 s9 * !K
%%#''
t<< 3%,,X66K~
DQ BBBBCCC 22;q>22K h
;
3;#3)
s B22B69B6r c P | j | j j dz S )Nz.isorted)rI with_suffixr[ )r s r> _tmp_filer ] s$ ' ' (8(?*(L M MMr= c # . K t d V d S )N)newliner r< r= r> _in_memory_output_stream_contextr a s#
4
r= c # K t | }| d|j d 5 }t j | | |V d d d d S # 1 swxY w Y d S )Nzw+rp )encodingr )r openr shutilcopymode)rv r tmp_filerN s r> _file_output_stream_contextr f s %%H tk&:B G G =(+++ s AA A ask_to_applywrite_to_stdoutrX c
|}
d| v r`| dd } | rH| | } |j rt | d d| t di | d }
t
j | 5 }
|p|
j }t d||
d| }d} |r&t |
j t j
|||| }n`| |j rt }nt! | |
}|5 }t |
j ||||| }| d |ro|s|r|
j d t% |
j | ||d u rdnt' t( | |j
|s#|rvt- t/ |
j sU ddd |j s#t1 |
}| n# t4 $ r Y nw xY wddd dS |
j |j r\| d |
j d 5 }t; j || ddd n # 1 swxY w Y ddd n # 1 swxY w Y |rN|j s)t1 |
}| |
j |j st d |
j |j s#t1 |
}| n# t4 $ r Y nw xY w# |j s$t1 |
}| w w # t4 $ r Y w w xY wxY wt |
j ||||| }|ry|rw|
j d | d t% |
j | ||d u rdn||j
|
j n?# tB $ r tE | d
Y n!tF $ r tE | d Y nw xY w|cddd S # 1 swxY w Y dS )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.
rx Nr ry r rH F)rM rN rA rB rC r@ TrU wzFixing z- unable to sort due to existing syntax errorsz5 unable to sort as isort introduces new syntax errorsr< )$rz r{ rb r| r/ r! r* rL rI rJ r r} sysstdoutoverwrite_in_placer r rK r( r r rY r& r] r unlinkFileNotFoundErrorcloser r copyfileobjreplacequietr" r r% )rv r@ rA rB rC r rD r rX rE r~ rx r r actual_file_pathrh output_stream_contextrN r fss r> r
r
n s 8 !K
%%#''
t<< 3%,,X66K~
DQ BBBBCCC 22;q>22K h `;$8 (8T .{TTmTT Z ] T
/%!,!3"%*! .#1 '
>5!!4 4T4V4V 1 14O (+5 5 1 3 !Nm&1-8-?.;'-*:/=*3
' ' ' G * . .q 1 1 1 & N#, !5 !5$/$6$;$;A$>$>$>$53>3E3J3J3L3L4A4F4F4H4H2B+4+<+< 04t-1&)-D-D5;5H%& %& %& %& (1 %5(4%50T,/ 0@,A,A1* 1*%5 059!N !N !N !N !N !NR!#)#< 2+4[+A+A ( 1 1 1 0 ! ! ! D!I` ` ` ` ` ` ` `h !, 2 8 8 : : :#)#< !N$1$6$6q$9$9$9)4)9)>)>s)C)C %Nr(.(:="(M(M(M%N %N %N %N %N %N %N %N %N %N %N %N %N %N %NA!N !N !N !N !N !N !N !N !N !N !N !N !N !N !ND # D#)#< C+4[+A+A ( 0 01A B B B#)< D %&B 0@&B&B C C C!#)#< 2+4[+A+A ( 1 1 1 0 ! ! ! D! !#)#< 2+4[+A+A ( 1 1 1 1 2 1 ! ! ! D! *%0%7&, %"2'5"+
G 9 #*//222 A)'2'9'>'>'@'@(.
&6+4+<+<44))/)< &,,...# U U U $SSS T T T T T% ] ] ] $[[[ \ \ \ \ \ ] A` ` ` ` ` ` ` ` ` ` ` ` ` ` ` ` ` `s Q8"+P+(L;6CJ$ L;*G?>P+?
H P+ H P+ AJ$+J
J$
J J$J J$ L;$J( (L;+J( ,AL; *L+*P++
L85P+7L88P+;M9=*M)'M9)
M6 3M95M6 6M99B1P+*Q8+ Q'Q8 Q'$Q8&Q''Q88Q<?Q<uniquetop_onlyc + T K t dt | ||||d|E d{V dS )a Finds 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.
rM rA rB r r Nr< )r r )r? rA rB r r rE s r> r r sk " & d^^
r= _seenc + K t dd|i|}t j | ||| }|s|E d{V |t n|}|D ]} |dt j fv r| }
nj|t j k r| j d| j }
nH|t j
k r| j }
n0|t j k r | j d d }
|
r |
|vr|
|
| V dS )af Finds 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.
rA )rA rB r NTrS r r< )rJ r importssetr r; statementr: r+ attributer9 r8 splitadd) rM rA rB r r r rE identified_importsseenidentified_importkeys r> r r sJ &
4
4F
4m
4
4F!)Vy8 &%%%%%%%% #mSUUUD / $ $ dIO, , ,#--//CC
y*
*
*&-MM0A0KMMCC
y'
'
'#*CC
y(
(
(#*0055a8C $3d?? HHSMMM# # # # $ $r= c
+ K t j | 5 }t d|j ||p|j ||d|E d{V ddd dS # 1 swxY w Y dS )ac Finds 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.
r Nr< )r! r* rL r r} rI )rv rA rB r r rE r s r> r r = s $
h
;)
$+ 3;#3
s %AAApathsc + K t ddi|rt ndt fdt j t t | g g D E d{V dS )aj Finds 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.
rA Nc 3 @ K | ]}t | V dS ))r rA r r N)r ).0 file_namerA r r r s r> z(find_imports_in_paths..o sT
!&(RV
r= r< )rJ r r r findmapr] )r rA rB r r rE r s ` `` @r> r r Z s $
4
4F
4m
4
4F(. 8suuuDD
#ZCR H H
r= rI c | r|t u r
d|vr d|vr| |d< |r$|t urt d t di |}|S )N
settings_path
settings_fileziYou can either specify custom configuration options using kwargs or passing in a Config object. Not Both!r< )r.
ValueErrorr/ )rI rA rE s r> rJ rJ x s{ .. = 0 0 = 0 0)-
o& ) ' ' 8
((-(( Mr= )B__all__
contextlibr r enumr r! r itertoolsr pathlibr typingr r r r r r r warningsr isortr rp r r
exceptionsr" r# r$ r% formatr& r' r( r) r* placer+ r
r, r settingsr- r. r/ r r] boolr r r r r r contextmanagerr r r
Importr r r r rJ r< r= r> r s
D D D D D D D D D D D D D D D D D D ! ! ! ! ! ! ! ! ! ! e d d d d d d d d d ) ) ) ) ) ) A A A A A A ? ? ? ? ? ? ? ? ? ? 8 $# $ %*
! !
! }!
! ~ !
! T6\"
! ! ! ! ! ! L &+ ## $
T6\" }
~
F $# $ %* b bbb }b
b
~ b
b T6\"b b b
b b b bN &+ ## $
@ @@T6\"@ }@
@
~ @
@ @
@ @ @ @J &+# $ #
)
)
CI )
T6\")
)
~ )
)
}
)
)
)
)
)
)
XN4 ND N N N N !(6*: ! ! ! ! %T *: RZ[aRb $# $ %* ! #G GCI G}G
G ~ G
G
G T6\"G G
V G G
G G G GX $ $%*
~
$ / "
ho : $ $%* $
'$ '$'$ '$ ~'$
$ / " '$
'$ CH
'$ '$ ho '$ '$ '$ '$X $ $%*
CI
~
$ / "
ho
> $ $%* E#t)$ % ~
$ / "
ho > .
4.)/SV r=