""" ast ~~~ The `ast` module helps Python applications to process trees of the Python abstract syntax grammar. The abstract syntax itself might change with each Python release; this module helps to find out programmatically what the current grammar looks like and allows modifications of it. An abstract syntax tree can be generated by passing `ast.PyCF_ONLY_AST` as a flag to the `compile()` builtin function or by using the `parse()` function from this module. The result will be a tree of objects whose classes all inherit from `ast.AST`. A modified abstract syntax tree can be compiled into a Python code object using the built-in `compile()` function. Additionally various helper functions are provided that make working with the trees simpler. The main intention of the helper functions and this module in general is to provide an easy to use interface for libraries that work tightly with the python syntax (template engines for example). :copyright: Copyright 2008 by Armin Ronacher. :license: Python License."""importsysfrom_astimport*fromcontextlibimportcontextmanager,nullcontextfromenumimportIntEnum,auto,_simple_enumdefparse(source,filename='<unknown>',mode='exec',*,type_comments=False,feature_version=None):""" Parse the source into an AST node. Equivalent to compile(source, filename, mode, PyCF_ONLY_AST). Pass type_comments=True to get back type comments where the syntax allows. """flags=PyCF_ONLY_ASTiftype_comments:flags|=PyCF_TYPE_COMMENTSifisinstance(feature_version,tuple):major,minor=feature_version# Should be a 2-tuple.assertmajor==3feature_version=minoreliffeature_versionisNone:feature_version=-1# Else it should be an int giving the minor version for 3.x.returncompile(source,filename,mode,flags,_feature_version=feature_version)defliteral_eval(node_or_string):""" Evaluate an expression node or a string containing only a Python expression. The string or node provided may only consist of the following Python literal structures: strings, bytes, numbers, tuples, lists, dicts, sets, booleans, and None. Caution: A complex expression can overflow the C stack and cause a crash. """ifisinstance(node_or_string,str):node_or_string=parse(node_or_string.lstrip(" \t"),mode='eval')ifisinstance(node_or_string,Expression):node_or_string=node_or_string.bodydef_raise_malformed_node(node):msg="malformed node or string"iflno:=getattr(node,'lineno',None):msg+=f' on line {lno}'raiseValueError(msg+f': {node!r}')def_convert_num(node):ifnotisinstance(node,Constant)ortype(node.value)notin(int,float,complex):_raise_malformed_node(node)returnnode.valuedef_convert_signed_num(node):ifisinstance(node,UnaryOp)andisinstance(node.op,(UAdd,USub)):operand=_convert_num(node.operand)ifisinstance(node.op,UAdd):return+operandelse:return-operandreturn_convert_num(node)def_convert(node):ifisinstance(node,Constant):returnnode.valueelifisinstance(node,Tuple):returntuple(map(_convert,node.elts))elifisinstance(node,List):returnlist(map(_convert,node.elts))elifisinstance(node,Set):returnset(map(_convert,node.elts))elif(isinstance(node,Call)andisinstance(node.func,Name)andnode.func.id=='set'andnode.args==node.keywords==[]):returnset()elifisinstance(node,Dict):iflen(node.keys)!=len(node.values):_raise_malformed_node(node)returndict(zip(map(_convert,node.keys),map(_convert,node.values)))elifisinstance(node,BinOp)andisinstance(node.op,(Add,Sub)):left=_convert_signed_num(node.left)right=_convert_num(node.right)ifisinstance(left,(int,float))andisinstance(right,complex):ifisinstance(node.op,Add):returnleft+rightelse:returnleft-rightreturn_convert_signed_num(node)return_convert(node_or_string)defdump(node,annotate_fields=True,include_attributes=False,*,indent=None):""" Return a formatted dump of the tree in node. This is mainly useful for debugging purposes. If annotate_fields is true (by default), the returned string will show the names and the values for fields. If annotate_fields is false, the result string will be more compact by omitting unambiguous field names. Attributes such as line numbers and column offsets are not dumped by default. If this is wanted, include_attributes can be set to true. If indent is a non-negative integer or string, then the tree will be pretty-printed with that indent level. None (the default) selects the single line representation. """def_format(node,level=0):ifindentisnotNone:level+=1prefix='\n'+indent*levelsep=',\n'+indent*levelelse:prefix=''sep=', 'ifisinstance(node,AST):cls=type(node)args=[]allsimple=Truekeywords=annotate_fieldsfornameinnode._fields:try:value=getattr(node,name)exceptAttributeError:keywords=TruecontinueifvalueisNoneandgetattr(cls,name,...)isNone:keywords=Truecontinuevalue,simple=_format(value,level)allsimple=allsimpleandsimpleifkeywords:args.append('%s=%s'%(name,value))else:args.append(value)ifinclude_attributesandnode._attributes:fornameinnode._attributes:try:value=getattr(node,name)exceptAttributeError:continueifvalueisNoneandgetattr(cls,name,...)isNone:continuevalue,simple=_format(value,level)allsimple=allsimpleandsimpleargs.append('%s=%s'%(name,value))ifallsimpleandlen(args)<=3:return'%s(%s)'%(node.__class__.__name__,', '.join(args)),notargsreturn'%s(%s%s)'%(node.__class__.__name__,prefix,sep.join(args)),Falseelifisinstance(node,list):ifnotnode:return'[]',Truereturn'[%s%s]'%(prefix,sep.join(_format(x,level)[0]forxinnode)),Falsereturnrepr(node),Trueifnotisinstance(node,AST):raiseTypeError('expected AST, got %r'%node.__class__.__name__)ifindentisnotNoneandnotisinstance(indent,str):indent=' '*indentreturn_format(node)[0]defcopy_location(new_node,old_node):""" Copy source location (`lineno`, `col_offset`, `end_lineno`, and `end_col_offset` attributes) from *old_node* to *new_node* if possible, and return *new_node*. """forattrin'lineno','col_offset','end_lineno','end_col_offset':ifattrinold_node._attributesandattrinnew_node._attributes:value=getattr(old_node,attr,None)# end_lineno and end_col_offset are optional attributes, and they# should be copied whether the value is None or not.ifvalueisnotNoneor(hasattr(old_node,attr)andattr.startswith("end_")):setattr(new_node,attr,value)returnnew_nodedeffix_missing_locations(node):""" When you compile a node tree with compile(), the compiler expects lineno and col_offset attributes for every node that supports them. This is rather tedious to fill in for generated nodes, so this helper adds these attributes recursively where not already set, by setting them to the values of the parent node. It works recursively starting at *node*. """def_fix(node,lineno,col_offset,end_lineno,end_col_offset):if'lineno'innode._attributes:ifnothasattr(node,'lineno'):node.lineno=linenoelse:lineno=node.linenoif'end_lineno'innode._attributes:ifgetattr(node,'end_lineno',None)isNone:node.end_lineno=end_linenoelse:end_lineno=node.end_linenoif'col_offset'innode._attributes:ifnothasattr(node,'col_offset'):node.col_offset=col_offsetelse:col_offset=node.col_offsetif'end_col_offset'innode._attributes:ifgetattr(node,'end_col_offset',None)isNone:node.end_col_offset=end_col_offsetelse:end_col_offset=node.end_col_offsetforchildiniter_child_nodes(node):_fix(child,lineno,col_offset,end_lineno,end_col_offset)_fix(node,1,0,1,0)returnnodedefincrement_lineno(node,n=1):""" Increment the line number and end line number of each node in the tree starting at *node* by *n*. This is useful to "move code" to a different location in a file. """forchildinwalk(node):# TypeIgnore is a special case where lineno is not an attribute# but rather a field of the node itself.ifisinstance(child,TypeIgnore):child.lineno=getattr(child,'lineno',0)+ncontinueif'lineno'inchild._attributes:child.lineno=getattr(child,'lineno',0)+nif("end_lineno"inchild._attributesand(end_lineno:=getattr(child,"end_lineno",0))isnotNone):child.end_lineno=end_lineno+nreturnnodedefiter_fields(node):""" Yield a tuple of ``(fieldname, value)`` for each field in ``node._fields`` that is present on *node*. """forfieldinnode._fields:try:yieldfield,getattr(node,field)exceptAttributeError:passdefiter_child_nodes(node):""" Yield all direct child nodes of *node*, that is, all fields that are nodes and all items of fields that are lists of nodes. """forname,fieldiniter_fields(node):ifisinstance(field,AST):yieldfieldelifisinstance(field,list):foriteminfield:ifisinstance(item,AST):yielditemdefget_docstring(node,clean=True):""" Return the docstring for the given node or None if no docstring can be found. If the node provided does not have docstrings a TypeError will be raised. If *clean* is `True`, all tabs are expanded to spaces and any whitespace that can be uniformly removed from the second line onwards is removed. """ifnotisinstance(node,(AsyncFunctionDef,FunctionDef,ClassDef,Module)):raiseTypeError("%r can't have docstrings"%node.__class__.__name__)ifnot(node.bodyandisinstance(node.body[0],Expr)):returnNonenode=node.body[0].valueifisinstance(node,Str):text=node.selifisinstance(node,Constant)andisinstance(node.value,str):text=node.valueelse:returnNoneifclean:importinspecttext=inspect.cleandoc(text)returntextdef_splitlines_no_ff(source):"""Split a string into lines ignoring form feed and other chars. This mimics how the Python parser splits source code. """idx=0lines=[]next_line=''whileidx<len(source):c=source[idx]next_line+=cidx+=1# Keep \r\n togetherifc=='\r'andidx<len(source)andsource[idx]=='\n':next_line+='\n'idx+=1ifcin'\r\n':lines.append(next_line)next_line=''ifnext_line:lines.append(next_line)returnlinesdef_pad_whitespace(source):r"""Replace all chars except '\f\t' in a line with spaces."""result=''forcinsource:ifcin'\f\t':result+=celse:result+=' 'returnresultdefget_source_segment(source,node,*,padded=False):"""Get source code segment of the *source* that generated *node*. If some location information (`lineno`, `end_lineno`, `col_offset`, or `end_col_offset`) is missing, return None. If *padded* is `True`, the first line of a multi-line statement will be padded with spaces to match its original position. """try:ifnode.end_linenoisNoneornode.end_col_offsetisNone:returnNonelineno=node.lineno-1end_lineno=node.end_lineno-1col_offset=node.col_offsetend_col_offset=node.end_col_offsetexceptAttributeError:returnNonelines=_splitlines_no_ff(source)ifend_lineno==lineno:returnlines[lineno].encode()[col_offset:end_col_offset].decode()ifpadded:padding=_pad_whitespace(lines[lineno].encode()[:col_offset].decode())else:padding=''first=padding+lines[lineno].encode()[col_offset:].decode()last=lines[end_lineno].encode()[:end_col_offset].decode()lines=lines[lineno+1:end_lineno]lines.insert(0,first)lines.append(last)return''.join(lines)defwalk(node):""" Recursively yield all descendant nodes in the tree starting at *node* (including *node* itself), in no specified order. This is useful if you only want to modify nodes in place and don't care about the context. """fromcollectionsimportdequetodo=deque([node])whiletodo:node=todo.popleft()todo.extend(iter_child_nodes(node))yieldnodeclassNodeVisitor(object):""" A node visitor base class that walks the abstract syntax tree and calls a visitor function for every node found. This function may return a value which is forwarded by the `visit` method. This class is meant to be subclassed, with the subclass adding visitor methods. Per default the visitor functions for the nodes are ``'visit_'`` + class name of the node. So a `TryFinally` node visit function would be `visit_TryFinally`. This behavior can be changed by overriding the `visit` method. If no visitor function exists for a node (return value `None`) the `generic_visit` visitor is used instead. Don't use the `NodeVisitor` if you want to apply changes to nodes during traversing. For this a special visitor exists (`NodeTransformer`) that allows modifications. """defvisit(self,node):"""Visit a node."""method='visit_'+node.__class__.__name__visitor=getattr(self,method,self.generic_visit)returnvisitor(node)defgeneric_visit(self,node):"""Called if no explicit visitor function exists for a node."""forfield,valueiniter_fields(node):ifisinstance(value,list):foriteminvalue:ifisinstance(item,AST):self.visit(item)elifisinstance(value,AST):self.visit(value)defvisit_Constant(self,node):value=node.valuetype_name=_const_node_type_names.get(type(value))iftype_nameisNone:forcls,namein_const_node_type_names.items():ifisinstance(value,cls):type_name=namebreakiftype_nameisnotNone:method='visit_'+type_nametry:visitor=getattr(self,method)exceptAttributeError:passelse:importwarningswarnings.warn(f"{method} is deprecated; add visit_Constant",DeprecationWarning,2)returnvisitor(node)returnself.generic_visit(node)classNodeTransformer(NodeVisitor):""" A :class:`NodeVisitor` subclass that walks the abstract syntax tree and allows modification of nodes. The `NodeTransformer` will walk the AST and use the return value of the visitor methods to replace or remove the old node. If the return value of the visitor method is ``None``, the node will be removed from its location, otherwise it is replaced with the return value. The return value may be the original node in which case no replacement takes place. Here is an example transformer that rewrites all occurrences of name lookups (``foo``) to ``data['foo']``:: class RewriteName(NodeTransformer): def visit_Name(self, node): return Subscript( value=Name(id='data', ctx=Load()), slice=Constant(value=node.id), ctx=node.ctx ) Keep in mind that if the node you're operating on has child nodes you must either transform the child nodes yourself or call the :meth:`generic_visit` method for the node first. For nodes that were part of a collection of statements (that applies to all statement nodes), the visitor may also return a list of nodes rather than just a single node. Usually you use the transformer like this:: node = YourTransformer().visit(node) """defgeneric_visit(self,node):forfield,old_valueiniter_fields(node):ifisinstance(old_value,list):new_values=[]forvalueinold_value:ifisinstance(value,AST):value=self.visit(value)ifvalueisNone:continueelifnotisinstance(value,AST):new_values.extend(value)continuenew_values.append(value)old_value[:]=new_valueselifisinstance(old_value,AST):new_node=self.visit(old_value)ifnew_nodeisNone:delattr(node,field)else:setattr(node,field,new_node)returnnode# If the ast module is loaded more than once, only add deprecated methods onceifnothasattr(Constant,'n'):# The following code is for backward compatibility.# It will be removed in future.def_getter(self):"""Deprecated. Use value instead."""returnself.valuedef_setter(self,value):self.value=valueConstant.n=property(_getter,_setter)Constant.s=property(_getter,_setter)class_ABC(type):def__init__(cls,*args):cls.__doc__="""Deprecated AST node class. Use ast.Constant instead"""def__instancecheck__(cls,inst):ifnotisinstance(inst,Constant):returnFalseifclsin_const_types:try:value=inst.valueexceptAttributeError:returnFalseelse:return(isinstance(value,_const_types[cls])andnotisinstance(value,_const_types_not.get(cls,())))returntype.__instancecheck__(cls,inst)def_new(cls,*args,**kwargs):forkeyinkwargs:ifkeynotincls._fields:# arbitrary keyword arguments are acceptedcontinuepos=cls._fields.index(key)ifpos<len(args):raiseTypeError(f"{cls.__name__} got multiple values for argument {key!r}")ifclsin_const_types:returnConstant(*args,**kwargs)returnConstant.__new__(cls,*args,**kwargs)classNum(Constant,metaclass=_ABC):_fields=('n',)__new__=_newclassStr(Constant,metaclass=_ABC):_fields=('s',)__new__=_newclassBytes(Constant,metaclass=_ABC):_fields=('s',)__new__=_newclassNameConstant(Constant,metaclass=_ABC):__new__=_newclassEllipsis(Constant,metaclass=_ABC):_fields=()def__new__(cls,*args,**kwargs):ifclsisEllipsis:returnConstant(...,*args,**kwargs)returnConstant.__new__(cls,*args,**kwargs)_const_types={Num:(int,float,complex),Str:(str,),Bytes:(bytes,),NameConstant:(type(None),bool),Ellipsis:(type(...),),}_const_types_not={Num:(bool,),}_const_node_type_names={bool:'NameConstant',# should be before inttype(None):'NameConstant',int:'Num',float:'Num',complex:'Num',str:'Str',bytes:'Bytes',type(...):'Ellipsis',}classslice(AST):"""Deprecated AST node class."""classIndex(slice):"""Deprecated AST node class. Use the index value directly instead."""def__new__(cls,value,**kwargs):returnvalueclassExtSlice(slice):"""Deprecated AST node class. Use ast.Tuple instead."""def__new__(cls,dims=(),**kwargs):returnTuple(list(dims),Load(),**kwargs)# If the ast module is loaded more than once, only add deprecated methods onceifnothasattr(Tuple,'dims'):# The following code is for backward compatibility.# It will be removed in future.def_dims_getter(self):"""Deprecated. Use elts instead."""returnself.eltsdef_dims_setter(self,value):self.elts=valueTuple.dims=property(_dims_getter,_dims_setter)classSuite(mod):"""Deprecated AST node class. Unused in Python 3."""classAugLoad(expr_context):"""Deprecated AST node class. Unused in Python 3."""classAugStore(expr_context):"""Deprecated AST node class. Unused in Python 3."""classParam(expr_context):"""Deprecated AST node class. Unused in Python 3."""# Large float and imaginary literals get turned into infinities in the AST.# We unparse those infinities to INFSTR._INFSTR="1e"+repr(sys.float_info.max_10_exp+1)@_simple_enum(IntEnum)class_Precedence:"""Precedence table that originated from python grammar."""NAMED_EXPR=auto()# <target> := <expr1>TUPLE=auto()# <expr1>, <expr2>YIELD=auto()# 'yield', 'yield from'TEST=auto()# 'if'-'else', 'lambda'OR=auto()# 'or'AND=auto()# 'and'NOT=auto()# 'not'CMP=auto()# '<', '>', '==', '>=', '<=', '!=',# 'in', 'not in', 'is', 'is not'EXPR=auto()BOR=EXPR# '|'BXOR=auto()# '^'BAND=auto()# '&'SHIFT=auto()# '<<', '>>'ARITH=auto()# '+', '-'TERM=auto()# '*', '@', '/', '%', '//'FACTOR=auto()# unary '+', '-', '~'POWER=auto()# '**'AWAIT=auto()# 'await'ATOM=auto()defnext(self):try:returnself.__class__(self+1)exceptValueError:returnself_SINGLE_QUOTES=("'",'"')_MULTI_QUOTES=('"""',"'''")_ALL_QUOTES=(*_SINGLE_QUOTES,*_MULTI_QUOTES)class_Unparser(NodeVisitor):"""Methods in this class recursively traverse an AST and output source code for the abstract syntax; original formatting is disregarded."""def__init__(self,*,_avoid_backslashes=False):self._source=[]self._precedences={}self._type_ignores={}self._indent=0self._avoid_backslashes=_avoid_backslashesself._in_try_star=Falsedefinterleave(self,inter,f,seq):"""Call f on each item in seq, calling inter() in between."""seq=iter(seq)try:f(next(seq))exceptStopIteration:passelse:forxinseq:inter()f(x)defitems_view(self,traverser,items):"""Traverse and separate the given *items* with a comma and append it to the buffer. If *items* is a single item sequence, a trailing comma will be added."""iflen(items)==1:traverser(items[0])self.write(",")else:self.interleave(lambda:self.write(", "),traverser,items)defmaybe_newline(self):"""Adds a newline if it isn't the start of generated source"""ifself._source:self.write("\n")deffill(self,text=""):"""Indent a piece of text and append it, according to the current indentation level"""self.maybe_newline()self.write(" "*self._indent+text)defwrite(self,*text):"""Add new source parts"""self._source.extend(text)@contextmanagerdefbuffered(self,buffer=None):ifbufferisNone:buffer=[]original_source=self._sourceself._source=bufferyieldbufferself._source=original_source@contextmanagerdefblock(self,*,extra=None):"""A context manager for preparing the source for blocks. It adds the character':', increases the indentation on enter and decreases the indentation on exit. If *extra* is given, it will be directly appended after the colon character. """self.write(":")ifextra:self.write(extra)self._indent+=1yieldself._indent-=1@contextmanagerdefdelimit(self,start,end):"""A context manager for preparing the source for expressions. It adds *start* to the buffer and enters, after exit it adds *end*."""self.write(start)yieldself.write(end)defdelimit_if(self,start,end,condition):ifcondition:returnself.delimit(start,end)else:returnnullcontext()defrequire_parens(self,precedence,node):"""Shortcut to adding precedence related parens"""returnself.delimit_if("(",")",self.get_precedence(node)>precedence)defget_precedence(self,node):returnself._precedences.get(node,_Precedence.TEST)defset_precedence(self,precedence,*nodes):fornodeinnodes:self._precedences[node]=precedencedefget_raw_docstring(self,node):"""If a docstring node is found in the body of the *node* parameter, return that docstring node, None otherwise. Logic mirrored from ``_PyAST_GetDocString``."""ifnotisinstance(node,(AsyncFunctionDef,FunctionDef,ClassDef,Module))orlen(node.body)<1:returnNonenode=node.body[0]ifnotisinstance(node,Expr):returnNonenode=node.valueifisinstance(node,Constant)andisinstance(node.value,str):returnnodedefget_type_comment(self,node):comment=self._type_ignores.get(node.lineno)ornode.type_commentifcommentisnotNone:returnf" # type: {comment}"deftraverse(self,node):ifisinstance(node,list):foriteminnode:self.traverse(item)else:super().visit(node)# Note: as visit() resets the output text, do NOT rely on# NodeVisitor.generic_visit to handle any nodes (as it calls back in to# the subclass visit() method, which resets self._source to an empty list)defvisit(self,node):"""Outputs a source code string that, if converted back to an ast (using ast.parse) will generate an AST equivalent to *node*"""self._source=[]self.traverse(node)return"".join(self._source)def_write_docstring_and_traverse_body(self,node):if(docstring:=self.get_raw_docstring(node)):self._write_docstring(docstring)self.traverse(node.body[1:])else:self.traverse(node.body)defvisit_Module(self,node):self._type_ignores={ignore.lineno:f"ignore{ignore.tag}"forignoreinnode.type_ignores}self._write_docstring_and_traverse_body(node)self._type_ignores.clear()defvisit_FunctionType(self,node):withself.delimit("(",")"):self.interleave(lambda:self.write(", "),self.traverse,node.argtypes)self.write(" -> ")self.traverse(node.returns)defvisit_Expr(self,node):self.fill()self.set_precedence(_Precedence.YIELD,node.value)self.traverse(node.value)defvisit_NamedExpr(self,node):withself.require_parens(_Precedence.NAMED_EXPR,node):self.set_precedence(_Precedence.ATOM,node.target,node.value)self.traverse(node.target)self.write(" := ")self.traverse(node.value)defvisit_Import(self,node):self.fill("import ")self.interleave(lambda:self.write(", "),self.traverse,node.names)defvisit_ImportFrom(self,node):self.fill("from ")self.write("."*(node.levelor0))ifnode.module:self.write(node.module)self.write(" import ")self.interleave(lambda:self.write(", "),self.traverse,node.names)defvisit_Assign(self,node):self.fill()fortargetinnode.targets:self.set_precedence(_Precedence.TUPLE,target)self.traverse(target)self.write(" = ")self.traverse(node.value)iftype_comment:=self.get_type_comment(node):self.write(type_comment)defvisit_AugAssign(self,node):self.fill()self.traverse(node.target)self.write(" "+self.binop[node.op.__class__.__name__]+"= ")self.traverse(node.value)defvisit_AnnAssign(self,node):self.fill()withself.delimit_if("(",")",notnode.simpleandisinstance(node.target,Name)):self.traverse(node.target)self.write(": ")self.traverse(node.annotation)ifnode.value:self.write(" = ")self.traverse(node.value)defvisit_Return(self,node):self.fill("return")ifnode.value:self.write(" ")self.traverse(node.value)defvisit_Pass(self,node):self.fill("pass")defvisit_Break(self,node):self.fill("break")defvisit_Continue(self,node):self.fill("continue")defvisit_Delete(self,node):self.fill("del ")self.interleave(lambda:self.write(", "),self.traverse,node.targets)defvisit_Assert(self,node):self.fill("assert ")self.traverse(node.test)ifnode.msg:self.write(", ")self.traverse(node.msg)defvisit_Global(self,node):self.fill("global ")self.interleave(lambda:self.write(", "),self.write,node.names)defvisit_Nonlocal(self,node):self.fill("nonlocal ")self.interleave(lambda:self.write(", "),self.write,node.names)defvisit_Await(self,node):withself.require_parens(_Precedence.AWAIT,node):self.write("await")ifnode.value:self.write(" ")self.set_precedence(_Precedence.ATOM,node.value)self.traverse(node.value)defvisit_Yield(self,node):withself.require_parens(_Precedence.YIELD,node):self.write("yield")ifnode.value:self.write(" ")self.set_precedence(_Precedence.ATOM,node.value)self.traverse(node.value)defvisit_YieldFrom(self,node):withself.require_parens(_Precedence.YIELD,node):self.write("yield from ")ifnotnode.value:raiseValueError("Node can't be used without a value attribute.")self.set_precedence(_Precedence.ATOM,node.value)self.traverse(node.value)defvisit_Raise(self,node):self.fill("raise")ifnotnode.exc:ifnode.cause:raiseValueError(f"Node can't use cause without an exception.")returnself.write(" ")self.traverse(node.exc)ifnode.cause:self.write(" from ")self.traverse(node.cause)defdo_visit_try(self,node):self.fill("try")withself.block():self.traverse(node.body)forexinnode.handlers:self.traverse(ex)ifnode.orelse:self.fill("else")withself.block():self.traverse(node.orelse)ifnode.finalbody:self.fill("finally")withself.block():self.traverse(node.finalbody)defvisit_Try(self,node):prev_in_try_star=self._in_try_startry:self._in_try_star=Falseself.do_visit_try(node)finally:self._in_try_star=prev_in_try_stardefvisit_TryStar(self,node):prev_in_try_star=self._in_try_startry:self._in_try_star=Trueself.do_visit_try(node)finally:self._in_try_star=prev_in_try_stardefvisit_ExceptHandler(self,node):self.fill("except*"ifself._in_try_starelse"except")ifnode.type:self.write(" ")self.traverse(node.type)ifnode.name:self.write(" as ")self.write(node.name)withself.block():self.traverse(node.body)defvisit_ClassDef(self,node):self.maybe_newline()fordecoinnode.decorator_list:self.fill("@")self.traverse(deco)self.fill("class "+node.name)withself.delimit_if("(",")",condition=node.basesornode.keywords):comma=Falseforeinnode.bases:ifcomma:self.write(", ")else:comma=Trueself.traverse(e)foreinnode.keywords:ifcomma:self.write(", ")else:comma=Trueself.traverse(e)withself.block():self._write_docstring_and_traverse_body(node)defvisit_FunctionDef(self,node):self._function_helper(node,"def")defvisit_AsyncFunctionDef(self,node):self._function_helper(node,"async def")def_function_helper(self,node,fill_suffix):self.maybe_newline()fordecoinnode.decorator_list:self.fill("@")self.traverse(deco)def_str=fill_suffix+" "+node.nameself.fill(def_str)withself.delimit("(",")"):self.traverse(node.args)ifnode.returns:self.write(" -> ")self.traverse(node.returns)withself.block(extra=self.get_type_comment(node)):self._write_docstring_and_traverse_body(node)defvisit_For(self,node):self._for_helper("for ",node)defvisit_AsyncFor(self,node):self._for_helper("async for ",node)def_for_helper(self,fill,node):self.fill(fill)self.set_precedence(_Precedence.TUPLE,node.target)self.traverse(node.target)self.write(" in ")self.traverse(node.iter)withself.block(extra=self.get_type_comment(node)):self.traverse(node.body)ifnode.orelse:self.fill("else")withself.block():self.traverse(node.orelse)defvisit_If(self,node):self.fill("if ")self.traverse(node.test)withself.block():self.traverse(node.body)# collapse nested ifs into equivalent elifs.whilenode.orelseandlen(node.orelse)==1andisinstance(node.orelse[0],If):node=node.orelse[0]self.fill("elif ")self.traverse(node.test)withself.block():self.traverse(node.body)# final elseifnode.orelse:self.fill("else")withself.block():self.traverse(node.orelse)defvisit_While(self,node):self.fill("while ")self.traverse(node.test)withself.block():self.traverse(node.body)ifnode.orelse:self.fill("else")withself.block():self.traverse(node.orelse)defvisit_With(self,node):self.fill("with ")self.interleave(lambda:self.write(", "),self.traverse,node.items)withself.block(extra=self.get_type_comment(node)):self.traverse(node.body)defvisit_AsyncWith(self,node):self.fill("async with ")self.interleave(lambda:self.write(", "),self.traverse,node.items)withself.block(extra=self.get_type_comment(node)):self.traverse(node.body)def_str_literal_helper(self,string,*,quote_types=_ALL_QUOTES,escape_special_whitespace=False):"""Helper for writing string literals, minimizing escapes. Returns the tuple (string literal to write, possible quote types). """defescape_char(c):# \n and \t are non-printable, but we only escape them if# escape_special_whitespace is Trueifnotescape_special_whitespaceandcin"\n\t":returnc# Always escape backslashes and other non-printable charactersifc=="\\"ornotc.isprintable():returnc.encode("unicode_escape").decode("ascii")returncescaped_string="".join(map(escape_char,string))possible_quotes=quote_typesif"\n"inescaped_string:possible_quotes=[qforqinpossible_quotesifqin_MULTI_QUOTES]possible_quotes=[qforqinpossible_quotesifqnotinescaped_string]ifnotpossible_quotes:# If there aren't any possible_quotes, fallback to using repr# on the original string. Try to use a quote from quote_types,# e.g., so that we use triple quotes for docstrings.string=repr(string)quote=next((qforqinquote_typesifstring[0]inq),string[0])returnstring[1:-1],[quote]ifescaped_string:# Sort so that we prefer '''"''' over """\""""possible_quotes.sort(key=lambdaq:q[0]==escaped_string[-1])# If we're using triple quotes and we'd need to escape a final# quote, escape itifpossible_quotes[0][0]==escaped_string[-1]:assertlen(possible_quotes[0])==3escaped_string=escaped_string[:-1]+"\\"+escaped_string[-1]returnescaped_string,possible_quotesdef_write_str_avoiding_backslashes(self,string,*,quote_types=_ALL_QUOTES):"""Write string literal value with a best effort attempt to avoid backslashes."""string,quote_types=self._str_literal_helper(string,quote_types=quote_types)quote_type=quote_types[0]self.write(f"{quote_type}{string}{quote_type}")defvisit_JoinedStr(self,node):self.write("f")ifself._avoid_backslashes:withself.buffered()asbuffer:self._write_fstring_inner(node)returnself._write_str_avoiding_backslashes("".join(buffer))# If we don't need to avoid backslashes globally (i.e., we only need# to avoid them inside FormattedValues), it's cosmetically preferred# to use escaped whitespace. That is, it's preferred to use backslashes# for cases like: f"{x}\n". To accomplish this, we keep track of what# in our buffer corresponds to FormattedValues and what corresponds to# Constant parts of the f-string, and allow escapes accordingly.fstring_parts=[]forvalueinnode.values:withself.buffered()asbuffer:self._write_fstring_inner(value)fstring_parts.append(("".join(buffer),isinstance(value,Constant)))new_fstring_parts=[]quote_types=list(_ALL_QUOTES)fallback_to_repr=Falseforvalue,is_constantinfstring_parts:value,new_quote_types=self._str_literal_helper(value,quote_types=quote_types,escape_special_whitespace=is_constant,)new_fstring_parts.append(value)ifset(new_quote_types).isdisjoint(quote_types):fallback_to_repr=Truebreakquote_types=new_quote_typesiffallback_to_repr:# If we weren't able to find a quote type that works for all parts# of the JoinedStr, fallback to using repr and triple single quotes.quote_types=["'''"]new_fstring_parts.clear()forvalue,is_constantinfstring_parts:value=repr('"'+value)# force repr to use single quotesexpected_prefix="'\""assertvalue.startswith(expected_prefix),repr(value)new_fstring_parts.append(value[len(expected_prefix):-1])value="".join(new_fstring_parts)quote_type=quote_types[0]self.write(f"{quote_type}{value}{quote_type}")def_write_fstring_inner(self,node):ifisinstance(node,JoinedStr):# for both the f-string itself, and format_specforvalueinnode.values:self._write_fstring_inner(value)elifisinstance(node,Constant)andisinstance(node.value,str):value=node.value.replace("{","{{").replace("}","}}")self.write(value)elifisinstance(node,FormattedValue):self.visit_FormattedValue(node)else:raiseValueError(f"Unexpected node inside JoinedStr, {node!r}")defvisit_FormattedValue(self,node):defunparse_inner(inner):unparser=type(self)(_avoid_backslashes=True)unparser.set_precedence(_Precedence.TEST.next(),inner)returnunparser.visit(inner)withself.delimit("{","}"):expr=unparse_inner(node.value)if"\\"inexpr:raiseValueError("Unable to avoid backslash in f-string expression part")ifexpr.startswith("{"):# Separate pair of opening brackets as "{ {"self.write(" ")self.write(expr)ifnode.conversion!=-1:self.write(f"!{chr(node.conversion)}")ifnode.format_spec:self.write(":")self._write_fstring_inner(node.format_spec)defvisit_Name(self,node):self.write(node.id)def_write_docstring(self,node):self.fill()ifnode.kind=="u":self.write("u")self._write_str_avoiding_backslashes(node.value,quote_types=_MULTI_QUOTES)def_write_constant(self,value):ifisinstance(value,(float,complex)):# Substitute overflowing decimal literal for AST infinities,# and inf - inf for NaNs.self.write(repr(value).replace("inf",_INFSTR).replace("nan",f"({_INFSTR}-{_INFSTR})"))elifself._avoid_backslashesandisinstance(value,str):self._write_str_avoiding_backslashes(value)else:self.write(repr(value))defvisit_Constant(self,node):value=node.valueifisinstance(value,tuple):withself.delimit("(",")"):self.items_view(self._write_constant,value)elifvalueis...:self.write("...")else:ifnode.kind=="u":self.write("u")self._write_constant(node.value)defvisit_List(self,node):withself.delimit("[","]"):self.interleave(lambda:self.write(", "),self.traverse,node.elts)defvisit_ListComp(self,node):withself.delimit("[","]"):self.traverse(node.elt)forgeninnode.generators:self.traverse(gen)defvisit_GeneratorExp(self,node):withself.delimit("(",")"):self.traverse(node.elt)forgeninnode.generators:self.traverse(gen)defvisit_SetComp(self,node):withself.delimit("{","}"):self.traverse(node.elt)forgeninnode.generators:self.traverse(gen)defvisit_DictComp(self,node):withself.delimit("{","}"):self.traverse(node.key)self.write(": ")self.traverse(node.value)forgeninnode.generators:self.traverse(gen)defvisit_comprehension(self,node):ifnode.is_async:self.write(" async for ")else:self.write(" for ")self.set_precedence(_Precedence.TUPLE,node.target)self.traverse(node.target)self.write(" in ")self.set_precedence(_Precedence.TEST.next(),node.iter,*node.ifs)self.traverse(node.iter)forif_clauseinnode.ifs:self.write(" if ")self.traverse(if_clause)defvisit_IfExp(self,node):withself.require_parens(_Precedence.TEST,node):self.set_precedence(_Precedence.TEST.next(),node.body,node.test)self.traverse(node.body)self.write(" if ")self.traverse(node.test)self.write(" else ")self.set_precedence(_Precedence.TEST,node.orelse)self.traverse(node.orelse)defvisit_Set(self,node):ifnode.elts:withself.delimit("{","}"):self.interleave(lambda:self.write(", "),self.traverse,node.elts)else:# `{}` would be interpreted as a dictionary literal, and# `set` might be shadowed. Thus:self.write('{*()}')defvisit_Dict(self,node):defwrite_key_value_pair(k,v):self.traverse(k)self.write(": ")self.traverse(v)defwrite_item(item):k,v=itemifkisNone:# for dictionary unpacking operator in dicts {**{'y': 2}}# see PEP 448 for detailsself.write("**")self.set_precedence(_Precedence.EXPR,v)self.traverse(v)else:write_key_value_pair(k,v)withself.delimit("{","}"):self.interleave(lambda:self.write(", "),write_item,zip(node.keys,node.values))defvisit_Tuple(self,node):withself.delimit_if("(",")",len(node.elts)==0orself.get_precedence(node)>_Precedence.TUPLE):self.items_view(self.traverse,node.elts)unop={"Invert":"~","Not":"not","UAdd":"+","USub":"-"}unop_precedence={"not":_Precedence.NOT,"~":_Precedence.FACTOR,"+":_Precedence.FACTOR,"-":_Precedence.FACTOR,}defvisit_UnaryOp(self,node):operator=self.unop[node.op.__class__.__name__]operator_precedence=self.unop_precedence[operator]withself.require_parens(operator_precedence,node):self.write(operator)# factor prefixes (+, -, ~) shouldn't be separated# from the value they belong, (e.g: +1 instead of + 1)ifoperator_precedenceisnot_Precedence.FACTOR:self.write(" ")self.set_precedence(operator_precedence,node.operand)self.traverse(node.operand)binop={"Add":"+","Sub":"-","Mult":"*","MatMult":"@","Div":"/","Mod":"%","LShift":"<<","RShift":">>","BitOr":"|","BitXor":"^","BitAnd":"&","FloorDiv":"//","Pow":"**",}binop_precedence={"+":_Precedence.ARITH,"-":_Precedence.ARITH,"*":_Precedence.TERM,"@":_Precedence.TERM,"/":_Precedence.TERM,"%":_Precedence.TERM,"<<":_Precedence.SHIFT,">>":_Precedence.SHIFT,"|":_Precedence.BOR,"^":_Precedence.BXOR,"&":_Precedence.BAND,"//":_Precedence.TERM,"**":_Precedence.POWER,}binop_rassoc=frozenset(("**",))defvisit_BinOp(self,node):operator=self.binop[node.op.__class__.__name__]operator_precedence=self.binop_precedence[operator]withself.require_parens(operator_precedence,node):ifoperatorinself.binop_rassoc:left_precedence=operator_precedence.next()right_precedence=operator_precedenceelse:left_precedence=operator_precedenceright_precedence=operator_precedence.next()self.set_precedence(left_precedence,node.left)self.traverse(node.left)self.write(f" {operator} ")self.set_precedence(right_precedence,node.right)self.traverse(node.right)cmpops={"Eq":"==","NotEq":"!=","Lt":"<","LtE":"<=","Gt":">","GtE":">=","Is":"is","IsNot":"is not","In":"in","NotIn":"not in",}defvisit_Compare(self,node):withself.require_parens(_Precedence.CMP,node):self.set_precedence(_Precedence.CMP.next(),node.left,*node.comparators)self.traverse(node.left)foro,einzip(node.ops,node.comparators):self.write(" "+self.cmpops[o.__class__.__name__]+" ")self.traverse(e)boolops={"And":"and","Or":"or"}boolop_precedence={"and":_Precedence.AND,"or":_Precedence.OR}defvisit_BoolOp(self,node):operator=self.boolops[node.op.__class__.__name__]operator_precedence=self.boolop_precedence[operator]defincreasing_level_traverse(node):nonlocaloperator_precedenceoperator_precedence=operator_precedence.next()self.set_precedence(operator_precedence,node)self.traverse(node)withself.require_parens(operator_precedence,node):s=f" {operator} "self.interleave(lambda:self.write(s),increasing_level_traverse,node.values)defvisit_Attribute(self,node):self.set_precedence(_Precedence.ATOM,node.value)self.traverse(node.value)# Special case: 3.__abs__() is a syntax error, so if node.value# is an integer literal then we need to either parenthesize# it or add an extra space to get 3 .__abs__().ifisinstance(node.value,Constant)andisinstance(node.value.value,int):self.write(" ")self.write(".")self.write(node.attr)defvisit_Call(self,node):self.set_precedence(_Precedence.ATOM,node.func)self.traverse(node.func)withself.delimit("(",")"):comma=Falseforeinnode.args:ifcomma:self.write(", ")else:comma=Trueself.traverse(e)foreinnode.keywords:ifcomma:self.write(", ")else:comma=Trueself.traverse(e)defvisit_Subscript(self,node):defis_non_empty_tuple(slice_value):return(isinstance(slice_value,Tuple)andslice_value.elts)self.set_precedence(_Precedence.ATOM,node.value)self.traverse(node.value)withself.delimit("[","]"):ifis_non_empty_tuple(node.slice):# parentheses can be omitted if the tuple isn't emptyself.items_view(self.traverse,node.slice.elts)else:self.traverse(node.slice)defvisit_Starred(self,node):self.write("*")self.set_precedence(_Precedence.EXPR,node.value)self.traverse(node.value)defvisit_Ellipsis(self,node):self.write("...")defvisit_Slice(self,node):ifnode.lower:self.traverse(node.lower)self.write(":")ifnode.upper:self.traverse(node.upper)ifnode.step:self.write(":")self.traverse(node.step)defvisit_Match(self,node):self.fill("match ")self.traverse(node.subject)withself.block():forcaseinnode.cases:self.traverse(case)defvisit_arg(self,node):self.write(node.arg)ifnode.annotation:self.write(": ")self.traverse(node.annotation)defvisit_arguments(self,node):first=True# normal argumentsall_args=node.posonlyargs+node.argsdefaults=[None]*(len(all_args)-len(node.defaults))+node.defaultsforindex,elementsinenumerate(zip(all_args,defaults),1):a,d=elementsiffirst:first=Falseelse:self.write(", ")self.traverse(a)ifd:self.write("=")self.traverse(d)ifindex==len(node.posonlyargs):self.write(", /")# varargs, or bare '*' if no varargs but keyword-only arguments presentifnode.varargornode.kwonlyargs:iffirst:first=Falseelse:self.write(", ")self.write("*")ifnode.vararg:self.write(node.vararg.arg)ifnode.vararg.annotation:self.write(": ")self.traverse(node.vararg.annotation)# keyword-only argumentsifnode.kwonlyargs:fora,dinzip(node.kwonlyargs,node.kw_defaults):self.write(", ")self.traverse(a)ifd:self.write("=")self.traverse(d)# kwargsifnode.kwarg:iffirst:first=Falseelse:self.write(", ")self.write("**"+node.kwarg.arg)ifnode.kwarg.annotation:self.write(": ")self.traverse(node.kwarg.annotation)defvisit_keyword(self,node):ifnode.argisNone:self.write("**")else:self.write(node.arg)self.write("=")self.traverse(node.value)defvisit_Lambda(self,node):withself.require_parens(_Precedence.TEST,node):self.write("lambda")withself.buffered()asbuffer:self.traverse(node.args)ifbuffer:self.write(" ",*buffer)self.write(": ")self.set_precedence(_Precedence.TEST,node.body)self.traverse(node.body)defvisit_alias(self,node):self.write(node.name)ifnode.asname:self.write(" as "+node.asname)defvisit_withitem(self,node):self.traverse(node.context_expr)ifnode.optional_vars:self.write(" as ")self.traverse(node.optional_vars)defvisit_match_case(self,node):self.fill("case ")self.traverse(node.pattern)ifnode.guard:self.write(" if ")self.traverse(node.guard)withself.block():self.traverse(node.body)defvisit_MatchValue(self,node):self.traverse(node.value)defvisit_MatchSingleton(self,node):self._write_constant(node.value)defvisit_MatchSequence(self,node):withself.delimit("[","]"):self.interleave(lambda:self.write(", "),self.traverse,node.patterns)defvisit_MatchStar(self,node):name=node.nameifnameisNone:name="_"self.write(f"*{name}")defvisit_MatchMapping(self,node):defwrite_key_pattern_pair(pair):k,p=pairself.traverse(k)self.write(": ")self.traverse(p)withself.delimit("{","}"):keys=node.keysself.interleave(lambda:self.write(", "),write_key_pattern_pair,zip(keys,node.patterns,strict=True),)rest=node.restifrestisnotNone:ifkeys:self.write(", ")self.write(f"**{rest}")defvisit_MatchClass(self,node):self.set_precedence(_Precedence.ATOM,node.cls)self.traverse(node.cls)withself.delimit("(",")"):patterns=node.patternsself.interleave(lambda:self.write(", "),self.traverse,patterns)attrs=node.kwd_attrsifattrs:defwrite_attr_pattern(pair):attr,pattern=pairself.write(f"{attr}=")self.traverse(pattern)ifpatterns:self.write(", ")self.interleave(lambda:self.write(", "),write_attr_pattern,zip(attrs,node.kwd_patterns,strict=True),)defvisit_MatchAs(self,node):name=node.namepattern=node.patternifnameisNone:self.write("_")elifpatternisNone:self.write(node.name)else:withself.require_parens(_Precedence.TEST,node):self.set_precedence(_Precedence.BOR,node.pattern)self.traverse(node.pattern)self.write(f" as {node.name}")defvisit_MatchOr(self,node):withself.require_parens(_Precedence.BOR,node):self.set_precedence(_Precedence.BOR.next(),*node.patterns)self.interleave(lambda:self.write(" | "),self.traverse,node.patterns)defunparse(ast_obj):unparser=_Unparser()returnunparser.visit(ast_obj)defmain():importargparseparser=argparse.ArgumentParser(prog='python -m ast')parser.add_argument('infile',type=argparse.FileType(mode='rb'),nargs='?',default='-',help='the file to parse; defaults to stdin')parser.add_argument('-m','--mode',default='exec',choices=('exec','single','eval','func_type'),help='specify what kind of code must be parsed')parser.add_argument('--no-type-comments',default=True,action='store_false',help="don't add information about type comments")parser.add_argument('-a','--include-attributes',action='store_true',help='include attributes such as line numbers and ''column offsets')parser.add_argument('-i','--indent',type=int,default=3,help='indentation of nodes (number of spaces)')args=parser.parse_args()withargs.infileasinfile:source=infile.read()tree=parse(source,args.infile.name,args.mode,type_comments=args.no_type_comments)print(dump(tree,include_attributes=args.include_attributes,indent=args.indent))if__name__=='__main__':main()