from ast import (Assign, Name, Attribute, Expr, Num, Str, NameConstant, Load, Store, UnaryOp, USub, ClassDef, Call, ImportFrom, alias) def document(sentences, to_source, **kw): """ This macro takes literal strings and converts them into: _help_ID = type_hint+STRING where: ID is the first target of the last assignment. type_hint is the assigned type and default value (only works for a few types) STRING is the literal string """ for n in range(len(sentences)): s = sentences[n] if not n: prev = s continue # The whole sentence is a string? if (isinstance(s, Expr) and isinstance(s.value, Str) and # and the previous is an assign isinstance(prev, Assign)): # noqa: E128 # Apply it to the first target target = prev.targets[0] value = prev.value # Extract its name # variables and attributes are supported if isinstance(target, Name): name = target.id is_attr = False elif isinstance(target, Attribute): name = target.attr is_attr = True else: continue # Remove starting underscore if name[0] == '_': name = name[1:] # Create a _help_ID doc_id = '_help_'+name # Create the type hint for numbers, strings and booleans type_hint = '' if isinstance(value, Num): type_hint = '[number={}]'.format(value.n) elif isinstance(value, UnaryOp) and isinstance(value.operand, Num) and isinstance(value.op, USub): # -Num type_hint = '[number={}]'.format(-value.operand.n) elif isinstance(value, Str): type_hint = "[string='{}']".format(value.s) elif isinstance(value, NameConstant) and isinstance(value.value, bool): type_hint = '[boolean={}]'.format(str(value.value).lower()) # Transform the string into an assign for _help_ID if is_attr: target = Attribute(value=Name(id='self', ctx=Load()), attr=doc_id, ctx=Store()) else: target = Name(id=doc_id, ctx=Store()) sentences[n] = Assign(targets=[target], value=Str(s=type_hint+s.value.s)) prev = s # Return the modified AST return sentences def output_class(tree, **kw): if isinstance(tree, ClassDef): # Create the register call name = tree.name reg_name = name.lower() # BaseOutput.register member: attr = Attribute(value=Name(id='BaseOutput', ctx=Load()), attr='register', ctx=Load()) # Function call to it passing reg_name and name do_register = Expr(value=Call(func=attr, args=[Str(s=reg_name), Name(id=name, ctx=Load())], keywords=[])) # Create the import do_import = ImportFrom(module='out_base', names=[alias(name='BaseOutput', asname=None)], level=1) return [do_import, tree, do_register] return tree