PyCodeBlock

Extends CodeBlock for Python codebases.

View source on GitHub

Inherits from

CodeBlock, Expression, Editable

Attributes

assignment_statements

Returns list of top level assignment statements in the code block.

assignments

Returns all assignments in the code block across all nesting levels.

attributes

Returns a list of top level class attribute statements in the code block.

comments

Gets list of top level comments in the code block.

extended

Returns a SymbolGroup of all extended nodes associated with this element.

extended_source

Returns the source text representation of all extended nodes.

file

The file object that this Editable instance belongs to.

filepath

The file path of the file that this Editable instance belongs to.

function_calls

Returns a list of all function calls in the code block.

if_blocks

Returns a list of top level if statements in the code block.

level

The indentation level of the code block.

local_var_assignments

Returns all local variable assignment in the code block, for all nest levels.

parent

The parent node of this Editable instance.

parent_block

The parent code block containing this block, or None if it is a top-level block.

parent_class

Find the class this node is contained in

parent_function

Find the function this node is contained in

parent_statement

Find the statement this node is contained in

resolved_value

Returns the resolved type of an Expression.

return_statements

Gets all return statements at the top level of the code block.

source

Text representation of the Editable instance.

statements

Gets a view of the top-level statements in the code block.

symbol_statements

Returns list of top level symbol statements in the code block.

variable_usages

Returns Editables for all TreeSitter node instances of variable usages within this node's

with_statements

Returns a list of all 'with' statements within the code block.

Methods

ancestors

Find all ancestors of the node of the given type. Does not return itself

View source on GitHub

Returns

edit

Replace the source of this Editable with new_src.

View source on GitHub

Parameters

new_srcrequired

The new source text to replace the current text with.

fix_indentationdefault: False

If True, adjusts the indentation of `new_src` to match the current text's indentation level. Defaults to False.

prioritydefault: 0

The priority of the edit transaction. Higher priority edits are applied first. Defaults to 0.

dedupedefault: True

If True, deduplicates identical transactions. Defaults to True.

Returns

find

Find and return matching nodes or substrings within an Editable instance.

View source on GitHub

Parameters

strings_to_matchrequired

One or more strings to search for.

exactdefault: False

If True, only return nodes whose source exactly matches one of the strings_to_match.

Returns

A list of Editable instances that match the search criteria.

find_string_literals

Returns a list of string literals within this node's source that match any of the given

View source on GitHub

Parameters

strings_to_matchrequired

A list of strings to search for in string literals.

fuzzy_matchdefault: False

If True, matches substrings within string literals. If False, only matches exact strings. Defaults to False.

Returns

A list of Editable objects representing the matching string literals.

flag

Adds a visual flag comment to the end of this Editable's source text.

View source on GitHub

Returns

Returns

List of Assignment objects representing local variable assignments that match the specified name criteria.

get_statements

Returns all statements of a given type up to the specified block level.

View source on GitHub

Parameters

statement_typedefault: None

The type of statements to return. If None, returns all statement types.

max_leveldefault: None

The maximum block depth level to search. If None, searches all levels.

Returns

get_variable_usages

Returns all instances of variable usages in a code block.

View source on GitHub

Parameters

var_namerequired

The name of the variable to search for.

fuzzy_matchdefault: False

When True, matches on variable names that contain var_name. When False (default), only matches exact variable names.

Returns

A sorted list of variable usage instances as Editable objects.

get_with_statements

Gets with statements at a specific block level.

View source on GitHub

Parameters

levelrequired

The block level to filter by. 0 represents the top level.

Returns

A list of WithStatement objects at the specified block level.

indent

Adjusts the indentation level of the entire code block.

View source on GitHub

Parameters

levelrequired

The number of indentation levels to adjust. Positive values indent right, negative values indent left.

Returns

insert_after

Inserts source code at the bottom of the code block.

View source on GitHub

Parameters

new_srcrequired

The source code to insert.

fix_indentationdefault: True

Whether to fix the indentation of the inserted code. Defaults to True.

newlinedefault: True

Whether to add a newline before the inserted code. Defaults to True.

Returns

insert_before

Inserts new source code at the top of the code block.

View source on GitHub

delete_formattingdefault: True

Whether to delete surrounding whitespace and formatting. Defaults to True.

prioritydefault: 0

Priority of the removal transaction. Higher priority transactions are executed first. Defaults to 0.

dedupedefault: True

Whether to deduplicate removal transactions at the same location. Defaults to True.

Returns

rename_variable_usages

Renames all instances of variable usages in the code block.

View source on GitHub

Parameters

old_var_namerequired

The current name of the variable to rename.

new_var_namerequired

The new name to give the variable.

fuzzy_matchdefault: False

When True, matches variables containing old_var_name. When False, only exact matches. Defaults to False.

Returns

This method mutates the code block in place.

replace

Search and replace occurrences of text within this node's source and its extended nodes.

View source on GitHub

Parameters

oldrequired

The text or pattern to search for.

newrequired

The text to replace matches with.

countdefault: -1

Maximum number of replacements to make. Defaults to -1 (replace all).

is_regexdefault: False

Whether to treat 'old' as a regex pattern. Defaults to False.

prioritydefault: 0

Priority of the replacement operation. Defaults to 0.

Returns

The total number of replacements made.

search

Returns a list of all regex match of regex_pattern, similar to python's re.search().

View source on GitHub

Parameters

regex_patternrequired

The regular expression pattern to search for.

include_stringsdefault: True

When False, excludes the contents of string literals from the search. Defaults to True.

include_commentsdefault: True

When False, excludes the contents of comments from the search. Defaults to True.

Returns

A list of Editable objects corresponding to the matches found.

unwrap

Extracts a code block from its parent wrapper container by removing the wrapping

View source on GitHub

Returns

wrap

Wraps a code block with a statement and indents it.

View source on GitHub

Parameters

before_srcrequired

The source code to insert before the block.

after_srcdefault: ""

The source code to insert after the block. Defaults to an empty string.