U ¾|ckã@sdZdZddlZddlZddlZddlZddlZddlZddlZddl m Z ddl m Z m Z mZddlmZddlmZmZdd lmZd!d d „ZGd d„deƒZdd„Zdd„Zdd„Zdd„Zdd„ZGdd„deƒZGdd„deƒZ Gdd„deƒZ!Gdd „d e ƒZ"dS)"zÛRefactoring framework. Used as a main program, this can refactor any number of files and/or recursively descend down directories. Imported as a module, this provides infrastructure to write your own refactoring tool. z#Guido van Rossum éN)Úchainé)ÚdriverÚtokenizeÚtoken)Ú find_root)ÚpytreeÚpygram)Ú btm_matcherTcCsTt|ggdgƒ}g}t |j¡D].\}}}| d¡r |rD|dd…}| |¡q |S)zEReturn a sorted list of all available fix names in the given package.Ú*Úfix_éN)Ú __import__ÚpkgutilÚ iter_modulesÚ__path__Ú startswithÚappend)Z fixer_pkgZ remove_prefixÚpkgZ fix_namesÚfinderÚnameÚispkg©rú!lib/python3.8/lib2to3/refactor.pyÚget_all_fix_namess   rc@s eZdZdS)Ú _EveryNodeN©Ú__name__Ú __module__Ú __qualname__rrrrr+srcCs’t|tjtjfƒr(|jdkr t‚|jhSt|tjƒrH|jrDt|jƒSt‚t|tj ƒr‚t ƒ}|jD]}|D]}|  t|ƒ¡qhq`|St d|ƒ‚dS)zf Accepts a pytree Pattern Node and returns a set of the pattern types which will match first. Nz$Oh no! I don't understand pattern %s) Ú isinstancerZ NodePatternZ LeafPatternÚtyperZNegatedPatternZcontentÚ_get_head_typesZWildcardPatternÚsetÚupdateÚ Exception)ZpatÚrÚpÚxrrrr"/s     r"c Cs¾t t¡}g}|D]x}|jrdzt|jƒ}Wntk rH| |¡YqŠX|D]}|| |¡qNq|jdk r€||j |¡q| |¡qtt j j   ¡t j j ƒD]}|| |¡q¢t|ƒS)z^ Accepts a list of fixers and returns a dictionary of head node type --> fixer list. N)Ú collectionsÚ defaultdictÚlistÚpatternr"rrZ _accept_typerr Úpython_grammarZ symbol2numberÚvaluesÚtokensÚextendÚdict)Z fixer_listZ head_nodesZeveryÚfixerZheadsZ node_typerrrÚ_get_headnode_dictKs$    ÿr3cs‡fdd„tˆdƒDƒS)zN Return the fully qualified names for fixers in the package pkg_name. csg|]}ˆd|‘qS©Ú.r)Ú.0Úfix_name©Úpkg_namerrÚ hsÿz+get_fixers_from_package..F)rr8rr8rÚget_fixers_from_packageds ÿr;cCs|S©Nr)ÚobjrrrÚ _identityksr>csXd}t t |¡j¡‰‡fdd„}ttjtjtj hƒ}t ƒ}zü|ƒ\}}||krTq>q>|tj krl|rfq6d}q>|tj kr6|dkr6|ƒ\}}|tj ksž|dkr¢q6|ƒ\}}|tj ks¾|dkrÂq6|ƒ\}}|tj krè|dkrè|ƒ\}}|tj kr4| |¡|ƒ\}}|tj ks.|d kr"q4|ƒ\}}qèq>q6q>Wntk rNYnXt|ƒS) NFcstˆƒ}|d|dfS)Nrr)Únext)Útok©ÚgenrrÚadvancersz(_detect_future_features..advanceTÚfromZ __future__Úimportú(ú,)rÚgenerate_tokensÚioÚStringIOÚreadlineÚ frozensetrÚNEWLINEÚNLÚCOMMENTr#ÚSTRINGÚNAMEÚOPÚaddÚ StopIteration)ÚsourceZhave_docstringrCÚignoreÚfeaturesÚtpÚvaluerrArÚ_detect_future_featuresosB           rZc@seZdZdZdS)Ú FixerErrorzA fixer could not be loaded.N)rrrÚ__doc__rrrrr[—sr[c@säeZdZdddœZdZdZd4dd„Zdd „Zd d „Zd d „Z dd„Z dd„Z d5dd„Z d6dd„Z dd„Zd7dd„Zdd„Zd8dd„Zdd„Zd d!„Zd9d"d#„Zd:d$d%„Zd&Zd'Zd(d)„Zd*d+„Zd,d-„Zd.d/„Zd0d1„Zd2d3„ZdS);ÚRefactoringToolF)Úprint_functionÚwrite_unchanged_filesZFixr NcCs.||_|p g|_|j ¡|_|dk r0|j |¡|jdrDtj|_ntj |_|j  d¡|_ g|_ t  d¡|_g|_d|_tj|jtj|jd|_| ¡\|_|_g|_t ¡|_g|_g|_t|j|jƒD]F}|j râ|j !|¡qÊ||jkrú|j "|¡qÊ||jkrÊ|j "|¡qÊt#|jƒ|_$t#|jƒ|_%dS)zÑInitializer. Args: fixer_names: a list of fixers to import options: a dict with configuration. explicit: a list of fixers to run even if they are explicit. Nr^r_r]F)ÚconvertÚlogger)&ÚfixersÚexplicitÚ_default_optionsÚcopyÚoptionsr$r Ú!python_grammar_no_print_statementÚgrammarr-Úgetr_ÚerrorsÚloggingZ getLoggerraÚ fixer_logÚwroterZDriverrr`Ú get_fixersÚ pre_orderÚ post_orderÚfilesÚbmZ BottomMatcherÚBMZ bmi_pre_orderZbmi_post_orderrZ BM_compatibleZ add_fixerrr3Úbmi_pre_order_headsÚbmi_post_order_heads)ÚselfZ fixer_namesrfrcr2rrrÚ__init__£s>      þ    zRefactoringTool.__init__c CsXg}g}|jD]}t|iidgƒ}| dd¡d}| |j¡rR|t|jƒd…}| d¡}|jd dd „|Dƒ¡}zt ||ƒ}Wn&t k rªt d ||fƒd‚YnX||j |j ƒ} | jrâ|jd k râ||jkrâ| d |¡q| d |¡| jdkr| | ¡q| jdkr| | ¡qt d| jƒ‚qt d¡} |j| d|j| d||fS)aInspects the options to load the requested patterns and handlers. Returns: (pre_order, post_order), where pre_order is the list of fixers that want a pre-order AST traversal, and post_order is the list that want post-order traversal. r r5réÿÿÿÿNÚ_ÚcSsg|] }| ¡‘qSr)Útitle)r6r'rrrr:çsz.RefactoringTool.get_fixers..zCan't find %s.%sTzSkipping optional fixer: %szAdding transformation: %sZpreZpostzIllegal fixer order: %rZ run_order©Úkey)rbrÚrsplitrÚ FILE_PREFIXÚlenÚsplitÚ CLASS_PREFIXÚjoinÚgetattrÚAttributeErrorr[rfrlrcÚ log_messageÚ log_debugÚorderrÚoperatorÚ attrgetterÚsort) rvZpre_order_fixersZpost_order_fixersZ fix_mod_pathÚmodr7ÚpartsÚ class_nameZ fix_classr2Zkey_funcrrrrn×s:   ÿ         zRefactoringTool.get_fixerscOs‚dS)zCalled when an error occurs.Nr)rvÚmsgÚargsÚkwdsrrrÚ log_errorÿszRefactoringTool.log_errorcGs|r ||}|j |¡dS)zHook to log a message.N)raÚinfo©rvrrrrrr†szRefactoringTool.log_messagecGs|r ||}|j |¡dSr<)raÚdebugr”rrrr‡ szRefactoringTool.log_debugcCsdS)zTCalled with the old version, new version, and filename of a refactored file.Nr)rvÚold_textÚnew_textÚfilenameÚequalrrrÚ print_outputszRefactoringTool.print_outputcCs8|D].}tj |¡r$| |||¡q| |||¡qdS)z)Refactor a list of files and directories.N)ÚosÚpathÚisdirÚ refactor_dirÚ refactor_file)rvÚitemsÚwriteÚ doctests_onlyZ dir_or_filerrrÚrefactors zRefactoringTool.refactorc Csštjd}t |¡D]€\}}}| d|¡| ¡| ¡|D]>}| d¡s>tj |¡d|kr>tj ||¡} |  | ||¡q>dd„|Dƒ|dd…<qdS)zÄDescends down a directory and refactor every Python file found. Python files are assumed to have a .py extension. Files and subdirectories starting with '.' are skipped. ÚpyzDescending into %sr5rcSsg|]}| d¡s|‘qSr4)r)r6Zdnrrrr:.s z0RefactoringTool.refactor_dir..N) r›ÚextsepÚwalkr‡r‹rrœÚsplitextrƒrŸ) rvZdir_namer¡r¢Zpy_extÚdirpathZdirnamesÚ filenamesrÚfullnamerrrržs   ÿzRefactoringTool.refactor_dirc Csœzt|dƒ}Wn6tk rD}z| d||¡WY¢dSd}~XYnXzt |j¡d}W5| ¡Xtj|d|dd}| ¡|fW5QR£SQRXdS) zG Do our best to decode a Python source file correctly. ÚrbzCan't open %s: %s)NNNrr&rz©ÚencodingÚnewline) ÚopenÚOSErrorr’ÚcloserÚdetect_encodingrKrIÚread)rvr˜ÚfÚerrr­rrrÚ_read_python_source0s z#RefactoringTool._read_python_sourcecCsº| |¡\}}|dkrdS|d7}|rn| d|¡| ||¡}|jsL||kr`| |||||¡q¶| d|¡nH| ||¡}|jsŠ|rª|jrª|jt|ƒdd…|||dn | d|¡dS)zRefactors a file.NÚ zRefactoring doctests in %szNo doctest changes in %srx)r¡r­zNo changes in %s)r¶r‡Úrefactor_docstringr_Úprocessed_fileÚrefactor_stringÚ was_changedÚstr)rvr˜r¡r¢Úinputr­ÚoutputÚtreerrrrŸ@s"   ÿzRefactoringTool.refactor_filec Cs t|ƒ}d|krtj|j_zVz|j |¡}Wn@tk rl}z"| d||jj |¡WY¢W¢dSd}~XYnXW5|j|j_X||_ |  d|¡|  ||¡|S)aFRefactor a given input string. Args: data: a string holding the code to be refactored. name: a human-readable name for use in error/log messages. Returns: An AST corresponding to the refactored input stream; None if there were errors during the parse. r^zCan't parse %s: %s: %sNzRefactoring %s) rZr rgrrhZ parse_stringr%r’Ú __class__rÚfuture_featuresr‡Ú refactor_tree)rvÚdatarrWr¿rµrrrrºWs"  ÿ    zRefactoringTool.refactor_stringcCsŒtj ¡}|rN| d¡| |d¡}|js2||krB| |d|¡qˆ| d¡n:| |d¡}|jsj|r~|jr~| t |ƒd|¡n | d¡dS)NzRefactoring doctests in stdinzzNo doctest changes in stdinzNo changes in stdin) ÚsysÚstdinr³r‡r¸r_r¹rºr»r¼)rvr¢r½r¾r¿rrrÚrefactor_stdinrs     zRefactoringTool.refactor_stdinc CsÜt|j|jƒD]}| ||¡q| |j| ¡¡| |j| ¡¡|j |  ¡¡}t |  ¡ƒr´|jj D]D}||krj||rj||j tjjdd|jr°||j tjjdt||ƒD]ò}|||krÚ|| |¡z t|ƒWntk rYq¼YnX|jr||jkrq¼| |¡}|r¼| ||¡}|dk r¼| |¡| ¡D] }|js^g|_|j |¡qL|j |  ¡¡}|D]*} | |kr˜g|| <||  || ¡q‚q¼qjqTt|j|jƒD]}| ||¡qÂ|jS)aÏRefactors a parse tree (modifying the tree in place). For compatible patterns the bottom matcher module is used. Otherwise the tree is traversed node-to-node for matches. Args: tree: a pytree.Node instance representing the root of the tree to be refactored. name: a human-readable name for this tree. Returns: True if the tree was modified, False otherwise. T)r}Úreverser|N)rrorpZ start_treeÚ traverse_byrtrursÚrunZleavesÚanyr.rbr‹rZBaseZdepthZkeep_line_orderZ get_linenor+ÚremoverÚ ValueErrorZfixers_appliedÚmatchÚ transformÚreplacerr0Z finish_treer») rvr¿rr2Z match_setÚnodeÚresultsÚnewZ new_matchesZfxrrrrr‚sJ        zRefactoringTool.refactor_treecCsV|sdS|D]D}||jD]4}| |¡}|r| ||¡}|dk r| |¡|}qq dS)aTraverse an AST, applying a set of fixers to each node. This is a helper method for refactor_tree(). Args: fixers: a list of fixer instances. traversal: a generator that yields AST nodes. Returns: None N)r!rÍrÎrÏ)rvrbZ traversalrÐr2rÑrÒrrrrÈÑs    zRefactoringTool.traverse_bycCs†|j |¡|dkr.| |¡d}|dkr.dS||k}| ||||¡|r`| d|¡|js`dS|rv| ||||¡n | d|¡dS)zR Called when a file has been refactored and there may be changes. NrzNo changes to %szNot writing changes to %s)rqrr¶ršr‡r_Ú write_file)rvr—r˜r–r¡r­r™rrrr¹ès  zRefactoringTool.processed_filec Cs´ztj|d|dd}Wn6tk rL}z| d||¡WY¢dSd}~XYnX|Fz| |¡Wn0tk r’}z| d||¡W5d}~XYnXW5QRX| d|¡d|_dS) zÑWrites a string to a file. It first shows a unified diff between the old text and the new text, and then rewrites the file; the latter is only done if the write option is set. Úwrzr¬zCan't create %s: %sNzCan't write %s: %szWrote changes to %sT)rIr¯r°r’r¡r‡rm)rvr—r˜r–r­ÚfprµrrrrÓýs* zRefactoringTool.write_filez>>> z... c Csg}d}d}d}d}|jddD]È}|d7}| ¡ |j¡r~|dk rZ| | ||||¡¡|}|g}| |j¡} |d| …}q |dk r¸| ||j¡s¬|||j ¡dkr¸|  |¡q |dk rÖ| | ||||¡¡d}d}|  |¡q |dk r | | ||||¡¡d  |¡S)aËRefactors a docstring, looking for doctests. This returns a modified version of the input string. It looks for doctests, which start with a ">>>" prompt, and may be continued with "..." prompts, as long as the "..." is indented the same as the ">>>". (Unfortunately we can't use the doctest module's parser, since, like most parsers, it is not geared towards preserving the original source.) NrT©Úkeependsrr·rz) Ú splitlinesÚlstriprÚPS1r0Úrefactor_doctestÚfindÚPS2Úrstriprrƒ) rvr½r˜ÚresultÚblockZ block_linenoÚindentÚlinenoÚlineÚirrrr¸sJ  ÿ ÿþ  ÿ   ÿz"RefactoringTool.refactor_docstringc s.zˆ ||ˆ¡}Wnjtk r|}zLˆj tj¡rN|D]}ˆ d| d¡¡q6ˆ d|||j j |¡|WY¢Sd}~XYnXˆ  ||¡r*t |ƒj dd}|d|d…||dd…} }| dg|dksØt| ƒ‚|d d¡sö|dd7<ˆˆj| d ¡g}|r*|‡‡fd d „|Dƒ7}|S) zÞRefactors one doctest. A doctest is given as a block of lines, the first of which starts with ">>>" (possibly indented), while the remaining lines start with "..." (identically indented). z Source: %sr·z+Can't parse docstring in %s line %s: %s: %sNTrÖrrxrcsg|]}ˆˆj|‘qSr)rÝ)r6rã©rárvrrr:Zsz4RefactoringTool.refactor_doctest..)Ú parse_blockr%raZ isEnabledForrkÚDEBUGr‡rÞr’rÀrrÂr¼rØÚAssertionErrorÚendswithrÚÚpop) rvràrârár˜r¿rµrãrÒZclippedrrårrÛ@s.ÿ"z RefactoringTool.refactor_doctestcCsÆ|jr d}nd}|js$| d|¡n"| d|¡|jD]}| |¡q6|jrl| d¡|jD]}| |¡q\|jrÂt|jƒdkrŒ| d¡n| dt|jƒ¡|jD]\}}}|j|f|ž|Žq¤dS) NÚwerez need to bezNo files %s modified.zFiles that %s modified:z$Warnings/messages while refactoring:rzThere was 1 error:zThere were %d errors:)rmrqr†rlrjr€)rvrëÚfileÚmessagerrr‘rrrÚ summarize]s$       zRefactoringTool.summarizecCs"|j | |||¡¡}tƒ|_|S)z³Parses a block into a tree. This is necessary to get correct line number / offset information in the parser diagnostics and embedded into the parse tree. )rZ parse_tokensÚ wrap_toksrLrÁ)rvràrârár¿rrrrætszRefactoringTool.parse_blockc csdt | ||¡j¡}|D]F\}}\}}\} } } ||d7}| |d7} ||||f| | f| fVqdS)z;Wraps a tokenize stream to systematically modify start/end.rN)rrHÚ gen_linesÚ__next__) rvràrârár/r!rYZline0Zcol0Zline1Zcol1Z line_textrrrrï~s   zRefactoringTool.wrap_toksccsx||j}||j}|}|D]N}| |¡r>|t|ƒd…Vn(|| ¡dkrVdVntd||fƒ‚|}qdVqldS)z–Generates lines as expected by tokenize from a list of lines. This strips the first len(indent + self.PS1) characters off each line. Nr·zline=%r, prefix=%rrz)rÚrÝrr€rÞrè)rvràráÚprefix1Zprefix2ÚprefixrãrrrrðŒs   zRefactoringTool.gen_lines)NN)FF)FF)FF)F)NFN)N)rrrrdr‚rrwrnr’r†r‡ršr£ržr¶rŸrºrÆrÂrÈr¹rÓrÚrÝr¸rÛrîrærïrðrrrrr]›s>ÿ 4(   Oÿ  + r]c@s eZdZdS)ÚMultiprocessingUnsupportedNrrrrrrô srôcsBeZdZ‡fdd„Zd ‡fdd„ Z‡fdd„Z‡fd d „Z‡ZS) ÚMultiprocessRefactoringToolcs"tt|ƒj||Žd|_d|_dSr<)ÚsuperrõrwÚqueueÚ output_lock©rvrÚkwargs©rÀrrrw¦sz$MultiprocessRefactoringTool.__init__Frc sö|dkrttˆƒ |||¡Sz ddl‰Wntk r@t‚YnXˆjdk rTtdƒ‚ˆ ¡ˆ_ˆ  ¡ˆ_ ‡‡fdd„t |ƒDƒ}z*|D] }| ¡q†ttˆƒ |||¡W5ˆj  ¡t |ƒD]}ˆj  d¡q¾|D]}| ¡rÔ|  ¡qÔdˆ_XdS)Nrrz already doing multiple processescsg|]}ˆjˆjd‘qS))Útarget)ZProcessÚ_child)r6rä©Úmultiprocessingrvrrr:¸sÿz8MultiprocessRefactoringTool.refactor..)rörõr£rÿÚ ImportErrorrôr÷Ú RuntimeErrorZ JoinableQueueZLockrøÚrangerƒÚputZis_aliveÚstart)rvr r¡r¢Z num_processesZ processesrär'rûrþrr£«s< ÿ      ÿ ÿ   z$MultiprocessRefactoringTool.refactorcsN|j ¡}|dk rJ|\}}ztt|ƒj||ŽW5|j ¡X|j ¡}q dSr<)r÷riZ task_donerörõrŸ)rvZtaskrrúrûrrrýÈs  ÿ z"MultiprocessRefactoringTool._childcs2|jdk r|j ||f¡ntt|ƒj||ŽSdSr<)r÷rrörõrŸrùrûrrrŸÓs   ÿz)MultiprocessRefactoringTool.refactor_file)FFr)rrrrwr£rýrŸÚ __classcell__rrrûrrõ¤s  ÿ rõ)T)#r\Ú __author__rIr›rrÄrkr‰r)Ú itertoolsrZpgen2rrrZ fixer_utilrrzrr r rrrr%rr"r3r;r>rZr[Úobjectr]rôrõrrrrÚs8    (