INSTRUCTION
stringlengths
1
46.3k
RESPONSE
stringlengths
75
80.2k
Set all attributes and unset attributes by using a value of 'null'.
def update_user_attributes(self, id, old_attrs, new_attrs): """ Set all attributes and unset attributes by using a value of 'null'. """ from alerta.utils.collections import merge merge(old_attrs, new_attrs) attrs = {k: v for k, v in old_attrs.items() if v is not None} ...
Does this alert match a blackout period?
def is_blackout(self) -> bool: """Does this alert match a blackout period?""" if not current_app.config['NOTIFICATION_BLACKOUT']: if self.severity in current_app.config['BLACKOUT_ACCEPT']: return False return db.is_blackout_period(self)
should return internal id of external system
def take_action(self, alert, action, text, **kwargs): """should return internal id of external system""" BASE_URL = '{}/projects/{}'.format(GITLAB_URL, quote(GITLAB_PROJECT_ID, safe='')) if action == 'createIssue': if 'issue_iid' not in alert.attributes: url = BASE_...
Wraps JSONified output for JSONP requests.
def jsonp(func): """Wraps JSONified output for JSONP requests.""" @wraps(func) def decorated(*args, **kwargs): callback = request.args.get('callback', False) if callback: data = str(func(*args, **kwargs).data) content = str(callback) + '(' + data + ')' mim...
Return true if alert severity has changed more than X times in Y seconds
def is_flapping(self, alert, window=1800, count=2): """ Return true if alert severity has changed more than X times in Y seconds """ select = """ SELECT COUNT(*) FROM alerts, unnest(history) h WHERE environment=%(environment)s AND res...
Update alert status, service, value, text, timeout and rawData, increment duplicate count and set repeat=True, and keep track of last receive id and time but don't append to history unless status changes.
def dedup_alert(self, alert, history): """ Update alert status, service, value, text, timeout and rawData, increment duplicate count and set repeat=True, and keep track of last receive id and time but don't append to history unless status changes. """ alert.history = history ...
Insert, with return.
def _insert(self, query, vars): """ Insert, with return. """ cursor = self.get_db().cursor() self._log(cursor, query, vars) cursor.execute(query, vars) self.get_db().commit() return cursor.fetchone()
Return none or one row.
def _fetchone(self, query, vars): """ Return none or one row. """ cursor = self.get_db().cursor() self._log(cursor, query, vars) cursor.execute(query, vars) return cursor.fetchone()
Return multiple rows.
def _fetchall(self, query, vars, limit=None, offset=0): """ Return multiple rows. """ if limit is None: limit = current_app.config['DEFAULT_PAGE_SIZE'] query += ' LIMIT %s OFFSET %s''' % (limit, offset) cursor = self.get_db().cursor() self._log(cursor,...
Update, with optional return.
def _updateone(self, query, vars, returning=False): """ Update, with optional return. """ cursor = self.get_db().cursor() self._log(cursor, query, vars) cursor.execute(query, vars) self.get_db().commit() return cursor.fetchone() if returning else None
Update, with optional return.
def _updateall(self, query, vars, returning=False): """ Update, with optional return. """ cursor = self.get_db().cursor() self._log(cursor, query, vars) cursor.execute(query, vars) self.get_db().commit() return cursor.fetchall() if returning else None
Merge two dictionaries. :param dict1: :param dict2: :return:
def merge(dict1, dict2): """ Merge two dictionaries. :param dict1: :param dict2: :return: """ for k in dict2: if k in dict1 and isinstance(dict1[k], dict) and isinstance(dict2[k], dict): merge(dict1[k], dict2[k]) else: dict1[k] = dict2[k]
Return True if wanted scope is in list of scopes or derived scopes. :param want_scope: scope wanted for permission to do something (str because could be invalid scope) :param have_scopes: list of valid scopes that user has been assigned
def is_in_scope(cls, want_scope: str, have_scopes: List[Scope]) -> bool: """Return True if wanted scope is in list of scopes or derived scopes. :param want_scope: scope wanted for permission to do something (str because could be invalid scope) :param have_scopes: list of valid scopes that user ...
Return a scope based on the supplied action and resource. :param action: the scope action eg. read, write or admin :param resource: the specific resource of the scope, if any eg. alerts, blackouts, heartbeats, users, perms, customers, keys, webhooks, oembed, management or userin...
def from_str(action: str, resource: str=None): """Return a scope based on the supplied action and resource. :param action: the scope action eg. read, write or admin :param resource: the specific resource of the scope, if any eg. alerts, blackouts, heartbeats, users, perms, customers...
ingests and deparses a given code block 'co'. If version is None, we will use the current Python interpreter version.
def code_deparse(co, out=sys.stdout, version=None, debug_opts=DEFAULT_DEBUG_OPTS, code_objects={}, compile_mode='exec', is_pypy=IS_PYPY, walker=SourceWalker): """ ingests and deparses a given code block 'co'. If version is None, we will use the current Python interpreter version. """ ...
Return the deparsed text for a Python code object. `out` is where any intermediate output for assembly or tree output will be sent.
def deparse_code2str(code, out=sys.stdout, version=None, debug_opts=DEFAULT_DEBUG_OPTS, code_objects={}, compile_mode='exec', is_pypy=IS_PYPY, walker=SourceWalker): """Return the deparsed text for a Python code object. `out` is where any intermediate ...
Pretty print a tuple
def pp_tuple(self, tup): """Pretty print a tuple""" last_line = self.f.getvalue().split("\n")[-1] l = len(last_line)+1 indent = ' ' * l self.write('(') sep = '' for item in tup: self.write(sep) l += len(sep) s = repr(item) ...
exec_stmt ::= expr exprlist DUP_TOP EXEC_STMT exec_stmt ::= expr exprlist EXEC_STMT
def n_exec_stmt(self, node): """ exec_stmt ::= expr exprlist DUP_TOP EXEC_STMT exec_stmt ::= expr exprlist EXEC_STMT """ self.write(self.indent, 'exec ') self.preorder(node[0]) if not node[1][0].isNone(): sep = ' in ' for subnode in node[1]...
List comprehensions
def n_list_comp(self, node): """List comprehensions""" p = self.prec self.prec = 100 if self.version >= 2.7: if self.is_pypy: self.n_list_comp_pypy27(node) return n = node[-1] elif node[-1] == 'del_stmt': if node...
List comprehensions in PYPY.
def n_list_comp_pypy27(self, node): """List comprehensions in PYPY.""" p = self.prec self.prec = 27 if node[-1].kind == 'list_iter': n = node[-1] elif self.is_pypy and node[-1] == 'JUMP_BACK': n = node[-2] list_expr = node[1] if len(node) ...
Non-closure-based comprehensions the way they are done in Python3 and some Python 2.7. Note: there are also other set comprehensions.
def comprehension_walk_newer(self, node, iter_index, code_index=-5): """Non-closure-based comprehensions the way they are done in Python3 and some Python 2.7. Note: there are also other set comprehensions. """ p = self.prec self.prec = 27 code = node[code_index].attr ...
List comprehensions the way they are done in Python 2 and sometimes in Python 3. They're more other comprehensions, e.g. set comprehensions See if we can combine code.
def listcomprehension_walk2(self, node): """List comprehensions the way they are done in Python 2 and sometimes in Python 3. They're more other comprehensions, e.g. set comprehensions See if we can combine code. """ p = self.prec self.prec = 27 code = Cod...
Set comprehensions the way they are done in Python3. They're more other comprehensions, e.g. set comprehensions See if we can combine code.
def setcomprehension_walk3(self, node, collection_index): """Set comprehensions the way they are done in Python3. They're more other comprehensions, e.g. set comprehensions See if we can combine code. """ p = self.prec self.prec = 27 code = Code(node[1].attr, sel...
prettyprint a dict 'dict' is something like k = {'a': 1, 'b': 42}" We will source-code use line breaks to guide us when to break.
def n_dict(self, node): """ prettyprint a dict 'dict' is something like k = {'a': 1, 'b': 42}" We will source-code use line breaks to guide us when to break. """ p = self.prec self.prec = 100 self.indent_more(INDENT_PER_LEVEL) sep = INDENT_PER_LEV...
prettyprint a list or tuple
def n_list(self, node): """ prettyprint a list or tuple """ p = self.prec self.prec = 100 lastnode = node.pop() lastnodetype = lastnode.kind # If this build list is inside a CALL_FUNCTION_VAR, # then the first * has already been printed. #...
The format template interpetation engine. See the comment at the beginning of this module for the how we interpret format specifications such as %c, %C, and so on.
def template_engine(self, entry, startnode): """The format template interpetation engine. See the comment at the beginning of this module for the how we interpret format specifications such as %c, %C, and so on. """ # print("-----") # print(startnode) # print(en...
Special handling for opcodes, such as those that take a variable number of arguments -- we add a new entry for each in TABLE_R.
def customize(self, customize): """ Special handling for opcodes, such as those that take a variable number of arguments -- we add a new entry for each in TABLE_R. """ for k, v in list(customize.items()): if k in TABLE_R: continue op = k[ :...
If the name of the formal parameter starts with dot, it's a tuple parameter, like this: # def MyFunc(xx, (a,b,c), yy): # print a, b*2, c*42 In byte-code, the whole tuple is assigned to parameter '.1' and then the tuple gets unpacked to 'a', 'b' and 'c'. ...
def get_tuple_parameter(self, ast, name): """ If the name of the formal parameter starts with dot, it's a tuple parameter, like this: # def MyFunc(xx, (a,b,c), yy): # print a, b*2, c*42 In byte-code, the whole tuple is assigned to parameter '.1' ...
Dump class definition, doc string and class body.
def build_class(self, code): """Dump class definition, doc string and class body.""" assert iscode(code) self.classes.append(self.currentclass) code = Code(code, self.scanner, self.currentclass) indent = self.indent # self.println(indent, '#flags:\t', int(code.co_flags)...
convert SyntaxTree to Python source code
def gen_source(self, ast, name, customize, is_lambda=False, returnNone=False): """convert SyntaxTree to Python source code""" rn = self.return_none self.return_none = returnNone old_name = self.name self.name = name # if code would be empty, append 'pass' if len(...
diassembles and deparses a given code block 'co'
def disco(version, co, out=None, is_pypy=False): """ diassembles and deparses a given code block 'co' """ assert iscode(co) # store final output stream for case of error real_out = out or sys.stdout print('# Python %s' % version, file=real_out) if co.co_filename: print('# Embed...
disassemble Python byte-code file (.pyc) If given a Python source file (".py") file, we'll try to find the corresponding compiled object.
def disassemble_file(filename, outstream=None): """ disassemble Python byte-code file (.pyc) If given a Python source file (".py") file, we'll try to find the corresponding compiled object. """ filename = check_object_path(filename) (version, timestamp, magic_int, co, is_pypy, source_s...
The base grammar we start out for a Python version even with the subclassing is, well, is pretty base. And we want it that way: lean and mean so that parsing will go faster. Here, we add additional grammar rules based on specific instructions that are in the instruction/token stream. I...
def customize_grammar_rules(self, tokens, customize): """The base grammar we start out for a Python version even with the subclassing is, well, is pretty base. And we want it that way: lean and mean so that parsing will go faster. Here, we add additional grammar rules based on specific...
ingests and deparses a given code block 'co'
def code_deparse_align(co, out=sys.stderr, version=None, is_pypy=None, debug_opts=DEFAULT_DEBUG_OPTS, code_objects={}, compile_mode='exec'): """ ingests and deparses a given code block 'co' """ assert iscode(co) if version is None: version = fl...
Show the asm based on the showasm flag (or file object), writing to the appropriate stream depending on the type of the flag. :param showasm: Flag which determines whether the ingested code is written to sys.stdout or not. (It is also to pass a file like object, into whi...
def maybe_show_asm(showasm, tokens): """ Show the asm based on the showasm flag (or file object), writing to the appropriate stream depending on the type of the flag. :param showasm: Flag which determines whether the ingested code is written to sys.stdout or not. (It is also to pass...
Show the ast based on the showast flag (or file object), writing to the appropriate stream depending on the type of the flag. :param show_tree: Flag which determines whether the parse tree is written to sys.stdout or not. (It is also to pass a file like object, into ...
def maybe_show_tree(walker, ast): """ Show the ast based on the showast flag (or file object), writing to the appropriate stream depending on the type of the flag. :param show_tree: Flag which determines whether the parse tree is written to sys.stdout or not. (It is also to pass a...
Show a function parameter with default for an grammar-tree based on the show_tree flag (or file object), writing to the appropriate stream depending on the type of the flag. :param show_tree: Flag which determines whether the function parameter with default is written to sys.stdout or...
def maybe_show_tree_param_default(show_tree, name, default): """ Show a function parameter with default for an grammar-tree based on the show_tree flag (or file object), writing to the appropriate stream depending on the type of the flag. :param show_tree: Flag which determines whether the function...
Pick out tokens from an uncompyle6 code object, and transform them, returning a list of uncompyle6 Token's. The transformations are made to assist the deparsing grammar.
def ingest(self, co, classname=None, code_objects={}, show_asm=None): """ Pick out tokens from an uncompyle6 code object, and transform them, returning a list of uncompyle6 Token's. The transformations are made to assist the deparsing grammar. """ tokens, customize = sca...
Pick out tokens from an uncompyle6 code object, and transform them, returning a list of uncompyle6 Token's. The transformations are made to assist the deparsing grammar. Specificially: - various types of LOAD_CONST's are categorized in terms of what they load - COME_FROM...
def ingest(self, co, classname=None, code_objects={}, show_asm=None): """ Pick out tokens from an uncompyle6 code object, and transform them, returning a list of uncompyle6 Token's. The transformations are made to assist the deparsing grammar. Specificially: - variou...
Detect all offsets in a byte code which are jump targets where we might insert a COME_FROM instruction. Return the list of offsets. Return the list of offsets. An instruction can be jumped to in from multiple instructions.
def find_jump_targets(self, debug): """ Detect all offsets in a byte code which are jump targets where we might insert a COME_FROM instruction. Return the list of offsets. Return the list of offsets. An instruction can be jumped to in from multiple instructions. ...
Detect type of block structures and their boundaries to fix optimized jumps in python2.3+
def detect_control_flow(self, offset, targets, inst_index): """ Detect type of block structures and their boundaries to fix optimized jumps in python2.3+ """ code = self.code inst = self.insts[inst_index] op = inst.opcode # Detect parent structure ...
Return True if the code at offset is some sort of jump back. That is, it is ether "JUMP_FORWARD" or an absolute jump that goes forward.
def is_jump_back(self, offset, extended_arg): """ Return True if the code at offset is some sort of jump back. That is, it is ether "JUMP_FORWARD" or an absolute jump that goes forward. """ if self.code[offset] != self.opc.JUMP_ABSOLUTE: return False r...
Return the next jump that was generated by an except SomeException: construct in a try...except...else clause or None if not found.
def next_except_jump(self, start): """ Return the next jump that was generated by an except SomeException: construct in a try...except...else clause or None if not found. """ if self.code[start] == self.opc.DUP_TOP: except_match = self.first_instr(start, len(self.cod...
Find offsets of all requested <instr> between <start> and <end>, optionally <target>ing specified offset, and return list found <instr> offsets which are not within any POP_JUMP_IF_TRUE jumps.
def rem_or(self, start, end, instr, target=None, include_beyond_target=False): """ Find offsets of all requested <instr> between <start> and <end>, optionally <target>ing specified offset, and return list found <instr> offsets which are not within any POP_JUMP_IF_TRUE jumps. """ ...
Create a list of instructions (a structured object rather than an array of bytes) and store that in self.insts
def build_instructions(self, co): """ Create a list of instructions (a structured object rather than an array of bytes) and store that in self.insts """ # FIXME: remove this when all subsidiary functions have been removed. # We should be able to get everything from the se...
Generate various line-related helper data.
def build_lines_data(self, code_obj): """ Generate various line-related helper data. """ # Offset: lineno pairs, only for offsets which start line. # Locally we use list for more convenient iteration using indices if self.version > 1.4: linestarts = list(self...
Compose 'list-map' which allows to jump to previous op, given offset of current op as index.
def build_prev_op(self): """ Compose 'list-map' which allows to jump to previous op, given offset of current op as index. """ code = self.code codelen = len(code) # 2.x uses prev 3.x uses prev_op. Sigh # Until we get this sorted out. self.prev = se...
Return True if the code at offset is some sort of jump forward. That is, it is ether "JUMP_FORWARD" or an absolute jump that goes forward.
def is_jump_forward(self, offset): """ Return True if the code at offset is some sort of jump forward. That is, it is ether "JUMP_FORWARD" or an absolute jump that goes forward. """ opname = self.get_inst(offset).opname if opname == 'JUMP_FORWARD': ret...
Get next instruction offset for op located at given <offset>. NOTE: extended_arg is no longer used
def get_target(self, offset, extended_arg=0): """ Get next instruction offset for op located at given <offset>. NOTE: extended_arg is no longer used """ inst = self.get_inst(offset) if inst.opcode in self.opc.JREL_OPS | self.opc.JABS_OPS: target = inst.argval ...
Find the first <instr> in the block from start to end. <instr> is any python bytecode instruction or a list of opcodes If <instr> is an opcode with a target (like a jump), a target destination can be specified which must match precisely if exact is True, or if exact is False, the instruc...
def first_instr(self, start, end, instr, target=None, exact=True): """ Find the first <instr> in the block from start to end. <instr> is any python bytecode instruction or a list of opcodes If <instr> is an opcode with a target (like a jump), a target destination can be specified...
Find the last <instr> in the block from start to end. <instr> is any python bytecode instruction or a list of opcodes If <instr> is an opcode with a target (like a jump), a target destination can be specified which must match precisely if exact is True, or if exact is False, the instruct...
def last_instr(self, start, end, instr, target=None, exact=True): """ Find the last <instr> in the block from start to end. <instr> is any python bytecode instruction or a list of opcodes If <instr> is an opcode with a target (like a jump), a target destination can be specified w...
Find all `instr` in the block from start to end. `instr` is a Python opcode or a list of opcodes If `instr` is an opcode with a target (like a jump), a target destination can be specified which must match precisely. Return a list with indexes to them or [] if none found.
def inst_matches(self, start, end, instr, target=None, include_beyond_target=False): """ Find all `instr` in the block from start to end. `instr` is a Python opcode or a list of opcodes If `instr` is an opcode with a target (like a jump), a target destination can be specified whi...
Find all `instr` in the block from start to end. `instr` is any Python opcode or a list of opcodes If `instr` is an opcode with a target (like a jump), a target destination can be specified which must match precisely. Return a list with indexes to them or [] if none found.
def all_instr(self, start, end, instr, target=None, include_beyond_target=False): """ Find all `instr` in the block from start to end. `instr` is any Python opcode or a list of opcodes If `instr` is an opcode with a target (like a jump), a target destination can be specified whic...
Iterate through positions of opcodes, skipping arguments.
def op_range(self, start, end): """ Iterate through positions of opcodes, skipping arguments. """ while start < end: yield start start += instruction_size(self.code[start], self.opc)
Go through instructions removing extended ARG. get_instruction_bytes previously adjusted the operand values to account for these
def remove_extended_args(self, instructions): """Go through instructions removing extended ARG. get_instruction_bytes previously adjusted the operand values to account for these""" new_instructions = [] last_was_extarg = False n = len(instructions) for i, inst in ...
Go through passed offsets, filtering ifs located somewhere mid-line.
def remove_mid_line_ifs(self, ifs): """ Go through passed offsets, filtering ifs located somewhere mid-line. """ # FIXME: this doesn't work for Python 3.6+ filtered = [] for i in ifs: # For each offset, if line number of current and next op ...
Restrict target to parent structure boundaries.
def restrict_to_parent(self, target, parent): """Restrict target to parent structure boundaries.""" if not (parent['start'] < target < parent['end']): target = parent['end'] return target
Returns parser object for Python version 2 or 3, 3.2, 3.5on, etc., depending on the parameters passed. *compile_mode* is either 'exec', 'eval', or 'single'. See https://docs.python.org/3.6/library/functions.html#compile for an explanation of the different modes.
def get_python_parser( version, debug_parser=PARSER_DEFAULT_DEBUG, compile_mode='exec', is_pypy = False): """Returns parser object for Python version 2 or 3, 3.2, 3.5on, etc., depending on the parameters passed. *compile_mode* is either 'exec', 'eval', or 'single'. See https://docs.pyth...
Parse a code object to an abstract syntax tree representation. :param version: The python version this code is from as a float, for example 2.6, 2.7, 3.2, 3.3, 3.4, 3.5 etc. :param co: The code object to parse. :param out: File like object to wri...
def python_parser(version, co, out=sys.stdout, showasm=False, parser_debug=PARSER_DEFAULT_DEBUG, is_pypy=False): """ Parse a code object to an abstract syntax tree representation. :param version: The python version this code is from as a float, for exam...
Add rule to grammar, but only if it hasn't been added previously opname and stack_count are used in the customize() semantic the actions to add the semantic action rule. Stack_count is used in custom opcodes like MAKE_FUNCTION to indicate how many arguments it has. Often it i...
def add_unique_rule(self, rule, opname, arg_count, customize): """Add rule to grammar, but only if it hasn't been added previously opname and stack_count are used in the customize() semantic the actions to add the semantic action rule. Stack_count is used in custom opcodes like ...
Add rules (a list of string) to grammar. Note that the rules must not be those that set arg_count in the custom dictionary.
def add_unique_rules(self, rules, customize): """Add rules (a list of string) to grammar. Note that the rules must not be those that set arg_count in the custom dictionary. """ for rule in rules: if len(rule) == 0: continue opname = rule.sp...
Add rules (a docstring-like list of rules) to grammar. Note that the rules must not be those that set arg_count in the custom dictionary.
def add_unique_doc_rules(self, rules_str, customize): """Add rules (a docstring-like list of rules) to grammar. Note that the rules must not be those that set arg_count in the custom dictionary. """ rules = [r.strip() for r in rules_str.split("\n")] self.add_unique_rules(...
Remove recursive references to allow garbage collector to collect this object.
def cleanup(self): """ Remove recursive references to allow garbage collector to collect this object. """ for dict in (self.rule2func, self.rules, self.rule2name): for i in list(dict.keys()): dict[i] = None for i in dir(self): setat...
Customized format and print for our kind of tokens which gets called in debugging grammar reduce rules
def debug_reduce(self, rule, tokens, parent, last_token_pos): """Customized format and print for our kind of tokens which gets called in debugging grammar reduce rules """ def fix(c): s = str(c) last_token_pos = s.find('_') if last_token_pos == -1: ...
Return then the number of positional parameters and represented by the attr field of token
def get_pos_kw(self, token): """Return then the number of positional parameters and represented by the attr field of token""" # Low byte indicates number of positional paramters, # high byte number of keyword parameters args_pos = token.attr & 0xff args_kw = (token.attr >...
Remove __ from the end of _name_ if it starts with __classname__ return the "unmangled" name.
def unmangle_name(name, classname): """Remove __ from the end of _name_ if it starts with __classname__ return the "unmangled" name. """ if name.startswith(classname) and name[-2:] != '__': return name[len(classname) - 2:] return name
Remove __ from the end of _name_ if it starts with __classname__ return the "unmangled" name.
def unmangle_code_names(self, co, classname): """Remove __ from the end of _name_ if it starts with __classname__ return the "unmangled" name. """ if classname: classname = '_' + classname.lstrip('_') + '__' free = [ self.unmangle_name(name, classname) ...
Pick out tokens from an uncompyle6 code object, and transform them, returning a list of uncompyle6 Token's. The transformations are made to assist the deparsing grammar. Specificially: - various types of LOAD_CONST's are categorized in terms of what they load - COME_FROM...
def ingest(self, co, classname=None, code_objects={}, show_asm=None): """ Pick out tokens from an uncompyle6 code object, and transform them, returning a list of uncompyle6 Token's. The transformations are made to assist the deparsing grammar. Specificially: - variou...
Return the next jump that was generated by an except SomeException: construct in a try...except...else clause or None if not found.
def next_except_jump(self, start): """ Return the next jump that was generated by an except SomeException: construct in a try...except...else clause or None if not found. """ if self.code[start] == self.opc.DUP_TOP: except_match = self.first_instr(start, len(self.cod...
Detect type of block structures and their boundaries to fix optimized jumps in python2.3+
def detect_control_flow(self, offset, op, extended_arg): """ Detect type of block structures and their boundaries to fix optimized jumps in python2.3+ """ code = self.code # Detect parent structure parent = self.structs[0] start = parent['start'] ...
Detect all offsets in a byte code which are jump targets where we might insert a pseudo "COME_FROM" instruction. "COME_FROM" instructions are used in detecting overall control flow. The more detailed information about the control flow is captured in self.structs. Since this stuff...
def find_jump_targets(self, debug): """ Detect all offsets in a byte code which are jump targets where we might insert a pseudo "COME_FROM" instruction. "COME_FROM" instructions are used in detecting overall control flow. The more detailed information about the control fl...
Find all <instr> in the block from start to end. <instr> is any python bytecode instruction or a list of opcodes If <instr> is an opcode with a target (like a jump), a target destination can be specified which must match precisely. Return a list with indexes to them or [] if none found.
def rem_or(self, start, end, instr, target=None, include_beyond_target=False): """ Find all <instr> in the block from start to end. <instr> is any python bytecode instruction or a list of opcodes If <instr> is an opcode with a target (like a jump), a target destination can be spe...
Customize CALL_FUNCTION to add the number of positional arguments
def call_fn_name(token): """Customize CALL_FUNCTION to add the number of positional arguments""" if token.attr is not None: return '%s_%i' % (token.kind, token.attr) else: return '%s_0' % (token.kind)
# Should the first rule be somehow folded into the 2nd one? build_class ::= LOAD_BUILD_CLASS mkfunc LOAD_CLASSNAME {expr}^n-1 CALL_FUNCTION_n LOAD_CONST CALL_FUNCTION_n build_class ::= LOAD_BUILD_CLASS mkfunc expr ...
def custom_build_class_rule(self, opname, i, token, tokens, customize): ''' # Should the first rule be somehow folded into the 2nd one? build_class ::= LOAD_BUILD_CLASS mkfunc LOAD_CLASSNAME {expr}^n-1 CALL_FUNCTION_n LOAD_CONST CALL_FUNCTION_n ...
call ::= expr {expr}^n CALL_FUNCTION_n call ::= expr {expr}^n CALL_FUNCTION_VAR_n call ::= expr {expr}^n CALL_FUNCTION_VAR_KW_n call ::= expr {expr}^n CALL_FUNCTION_KW_n classdefdeco2 ::= LOAD_BUILD_CLASS mkfunc {expr}^n-1 CALL_FUNCTION_n
def custom_classfunc_rule(self, opname, token, customize, next_token): """ call ::= expr {expr}^n CALL_FUNCTION_n call ::= expr {expr}^n CALL_FUNCTION_VAR_n call ::= expr {expr}^n CALL_FUNCTION_VAR_KW_n call ::= expr {expr}^n CALL_FUNCTION_KW_n classdefdeco2 ::= LOAD_BUI...
Python 3.3 added a an addtional LOAD_CONST before MAKE_FUNCTION and this has an effect on many rules.
def add_make_function_rule(self, rule, opname, attr, customize): """Python 3.3 added a an addtional LOAD_CONST before MAKE_FUNCTION and this has an effect on many rules. """ if self.version >= 3.3: new_rule = rule % (('LOAD_CONST ') * 1) else: new_rule = r...
The base grammar we start out for a Python version even with the subclassing is, well, is pretty base. And we want it that way: lean and mean so that parsing will go faster. Here, we add additional grammar rules based on specific instructions that are in the instruction/token stream. I...
def customize_grammar_rules(self, tokens, customize): """The base grammar we start out for a Python version even with the subclassing is, well, is pretty base. And we want it that way: lean and mean so that parsing will go faster. Here, we add additional grammar rules based on specific...
ingests and deparses a given code block 'co' if `bytecode_version` is None, use the current Python intepreter version. Caller is responsible for closing `out` and `mapstream`
def decompile( bytecode_version, co, out=None, showasm=None, showast=False, timestamp=None, showgrammar=False, code_objects={}, source_size=None, is_pypy=None, magic_int=None, mapstream=None, do_fragments=False): """ ingests and deparses a given code block 'co' if `bytecode_...
decompile Python byte-code file (.pyc). Return objects to all of the deparsed objects found in `filename`.
def decompile_file(filename, outstream=None, showasm=None, showast=False, showgrammar=False, mapstream=None, do_fragments=False): """ decompile Python byte-code file (.pyc). Return objects to all of the deparsed objects found in `filename`. """ filename = check_object_path(filena...
in_base base directory for input files out_base base directory for output files (ignored when files list of filenames to be uncompyled (relative to in_base) outfile write output to this filename (overwrites out_base) For redirecting output to - <filename> outfile=<filename> (out_base is ignored) ...
def main(in_base, out_base, compiled_files, source_files, outfile=None, showasm=None, showast=False, do_verify=False, showgrammar=False, raise_on_error=False, do_linemaps=False, do_fragments=False): """ in_base base directory for input files out_base base directory for output file...
Dump function defintion, doc string, and function body. This code is specialized for Python 3
def make_function3_annotate(self, node, is_lambda, nested=1, code_node=None, annotate_last=-1): """ Dump function defintion, doc string, and function body. This code is specialized for Python 3""" def build_param(ast, name, default): """build parameters: ...
Dump function defintion, doc string, and function body. This code is specialied for Python 2.
def make_function2(self, node, is_lambda, nested=1, code_node=None): """ Dump function defintion, doc string, and function body. This code is specialied for Python 2. """ # FIXME: call make_function3 if we are self.version >= 3.0 # and then simplify the below. def build_param(ast, name, de...
Dump function definition, doc string, and function body in Python version 3.0 and above
def make_function3(self, node, is_lambda, nested=1, code_node=None): """Dump function definition, doc string, and function body in Python version 3.0 and above """ # For Python 3.3, the evaluation stack in MAKE_FUNCTION is: # * default argument objects in positional order # * pairs of name a...
Compare two code-objects. This is the main part of this module.
def cmp_code_objects(version, is_pypy, code_obj1, code_obj2, verify, name=''): """ Compare two code-objects. This is the main part of this module. """ # print code_obj1, type(code_obj2) assert iscode(code_obj1), \ "cmp_code_object first object type is %s, not code" % ...
Compare a .pyc with a source code file. If everything is okay, None is returned. Otherwise a string message describing the mismatch is returned.
def compare_code_with_srcfile(pyc_filename, src_filename, verify): """Compare a .pyc with a source code file. If everything is okay, None is returned. Otherwise a string message describing the mismatch is returned. """ (version, timestamp, magic_int, code_obj1, is_pypy, source_size) = load_module(p...
Compare two .pyc files.
def compare_files(pyc_filename1, pyc_filename2, verify): """Compare two .pyc files.""" (version1, timestamp, magic_int1, code_obj1, is_pypy, source_size) = uncompyle6.load_module(pyc_filename1) (version2, timestamp, magic_int2, code_obj2, is_pypy, source_size) = uncompyle6.load_module(pyc_filen...
Convert the code object co into a python source fragment. :param version: The python version this code is from as a float, for example 2.6, 2.7, 3.2, 3.3, 3.4, 3.5 etc. :param co: The code object to parse. :param out: File like object to write th...
def code_deparse(co, out=StringIO(), version=None, is_pypy=None, debug_opts=DEFAULT_DEBUG_OPTS, code_objects={}, compile_mode='exec', walker=FragmentsWalker): """ Convert the code object co into a python source fragment. :param version: The python ...
Like deparse_code(), but given a function/module name and offset, finds the node closest to offset. If offset is not an instruction boundary, we raise an IndexError.
def code_deparse_around_offset(name, offset, co, out=StringIO(), version=None, is_pypy=None, debug_opts=DEFAULT_DEBUG_OPTS): """ Like deparse_code(), but given a function/module name and offset, finds the node closest to offset. If offset is not...
Return the instruction name at code[loc] using opc to look up instruction names. Returns 'got IndexError' if code[loc] is invalid. `code` is instruction bytecode, `loc` is an offset (integer) and `opc` is an opcode module from `xdis`.
def op_at_code_loc(code, loc, opc): """Return the instruction name at code[loc] using opc to look up instruction names. Returns 'got IndexError' if code[loc] is invalid. `code` is instruction bytecode, `loc` is an offset (integer) and `opc` is an opcode module from `xdis`. """ try: ...
Return a NodeInfo nametuple for a fragment-deparsed `deparsed` at `tup`. `tup` is a name and offset tuple, `deparsed` is a fragment object and `code` is instruction bytecode.
def deparsed_find(tup, deparsed, code): """Return a NodeInfo nametuple for a fragment-deparsed `deparsed` at `tup`. `tup` is a name and offset tuple, `deparsed` is a fragment object and `code` is instruction bytecode. """ nodeInfo = None name, last_i = tup if (name, last_i) in deparsed.offsets....
General pattern where the last node should should get the text span attributes of the entire tree
def table_r_node(self, node): """General pattern where the last node should should get the text span attributes of the entire tree""" start = len(self.f.getvalue()) try: self.default(node) except GenericASTTraversalPruningException: final = len(self.f.getv...
exec_stmt ::= expr exprlist DUP_TOP EXEC_STMT exec_stmt ::= expr exprlist EXEC_STMT
def n_exec_stmt(self, node): """ exec_stmt ::= expr exprlist DUP_TOP EXEC_STMT exec_stmt ::= expr exprlist EXEC_STMT """ start = len(self.f.getvalue()) + len(self.indent) try: super(FragmentsWalker, self).n_exec_stmt(node) except GenericASTTraversalPru...
List comprehensions
def n_list_comp(self, node): """List comprehensions""" p = self.prec self.prec = 27 n = node[-1] assert n == 'list_iter' # find innermost node while n == 'list_iter': n = n[0] # recurse one step if n == 'list_for': n = n[3] el...
List comprehensions the way they are done in Python3. They're more other comprehensions, e.g. set comprehensions See if we can combine code.
def comprehension_walk3(self, node, iter_index, code_index=-5): """ List comprehensions the way they are done in Python3. They're more other comprehensions, e.g. set comprehensions See if we can combine code. """ p = self.prec self.prec = 27 code = node[co...
List comprehensions the way they are done in Python3. They're more other comprehensions, e.g. set comprehensions See if we can combine code.
def setcomprehension_walk3(self, node, collection_index): """List comprehensions the way they are done in Python3. They're more other comprehensions, e.g. set comprehensions See if we can combine code. """ p = self.prec self.prec = 27 code = Code(node[1].attr, se...
Make sure each node has a parent
def fixup_parents(self, node, parent): """Make sure each node has a parent""" start, finish = 0, self.last_finish # We assume anything with a start has a finish. needs_range = not hasattr(node, 'start') if not hasattr(node, 'parent'): node.parent = parent fo...
Adjust all offsets under node
def fixup_offsets(self, new_start, node): """Adjust all offsets under node""" if hasattr(node, 'start'): node.start += new_start node.finish += new_start for n in node: if hasattr(n, 'offset'): if hasattr(n, 'start'): n.star...
Set positions under node
def set_pos_info_recurse(self, node, start, finish, parent=None): """Set positions under node""" self.set_pos_info(node, start, finish) if parent is None: parent = node for n in node: n.parent = parent if hasattr(n, 'offset'): self.set_...
prettyprint a dict 'dict' is something like k = {'a': 1, 'b': 42 }"
def n_dict(self, node): """ prettyprint a dict 'dict' is something like k = {'a': 1, 'b': 42 }" """ p = self.prec self.prec = 100 self.indent_more(INDENT_PER_LEVEL) line_seperator = ',\n' + self.indent sep = INDENT_PER_LEVEL[:-1] start = l...
prettyprint a list or tuple
def n_list(self, node): """ prettyprint a list or tuple """ p = self.prec self.prec = 100 n = node.pop() lastnode = n.kind start = len(self.f.getvalue()) if lastnode.startswith('BUILD_LIST'): self.write('['); endchar = ']' elif ...