ctfsolver.find_usage.function_definition_class

function_definition_class.py

Provides a class for traversing Python Abstract Syntax Trees (AST) to locate specific function definitions.

This module defines the FunctionDefFinder class, which extends ast.NodeVisitor to search for a function definition node by name within a Python AST. It is useful for static code analysis, refactoring tools, or any application that requires inspection of Python source code structure.

Classes:

FunctionDefFinder: AST NodeVisitor to find a specific function definition by name.

Example

finder = FunctionDefFinder(function_target=”my_function”) finder.visit(ast.parse(source_code)) found_node = finder.function_def

Classes

FunctionDefFinder

AST NodeVisitor to find a specific function definition in a Python AST.

Module Contents

class FunctionDefFinder(*args, **kwargs)

Bases: ast.NodeVisitor

AST NodeVisitor to find a specific function definition in a Python AST.

function_def

The found function definition node.

Type:

Optional[ast.FunctionDef]

function_target

The name of the function to search for.

Type:

Optional[str]

visit_list

List of visited function definition nodes.

Type:

List[ast.FunctionDef]

Functions:

visit_FunctionDef: Visits a function definition node in the AST.

tree

function_target: str | None

source_file: str | None

function_def: ast.FunctionDef | None = None

visit_list: list[ast.FunctionDef] = []

info

visit_FunctionDef(node)

Visits a function definition node in the AST.

Parameters:

node (ast.FunctionDef) – The function definition node to visit.

Return type:

None