| title | PyBlockStatement |
|---|---|
| sidebarTitle | PyBlockStatement |
| icon | |
| description | Statement which contains a block. |
import {Parameter} from '/snippets/Parameter.mdx'; import {ParameterWrapper} from '/snippets/ParameterWrapper.mdx'; import {Return} from '/snippets/Return.mdx'; import {HorizontalDivider} from '/snippets/HorizontalDivider.mdx'; import {GithubLinkNote} from '/snippets/GithubLinkNote.mdx'; import {Attribute} from '/snippets/Attribute.mdx';
PyHasBlock, BlockStatement, HasBlock, Statement, Expression, Editable
### code_block PyCodeBlock | None } description="The code block contained within the statement, if it exists." /> list[ PyDecorator ] } description="Returns a list of decorators associated with this symbol." /> PyCommentGroup | None } description="Gets the function's docstring." /> SymbolGroup } description="Returns a SymbolGroup of all extended nodes associated with this element." /> str } description="Returns the source text representation of all extended nodes." /> PyFile } description="The file object that this Editable instance belongs to." /> str } description="The file path of the file that this Editable instance belongs to." /> list[ FunctionCall ] } description="Gets all function calls within the statement's code block." /> int } description="The 0-based index of the statement in the parent code block." /> bool } description="Returns whether the symbol is decorated with decorators." /> list[ PyCodeBlock ] } description="Returns all nested CodeBlocks within the statement." /> list[ MultiLineCollection [ Statement [ PyBlockStatement ], Editable ]] } description="Returns a list of statement collections within nested code blocks." /> Editable } description="The parent node of this Editable instance." /> PyClass | None } description="Find the class this node is contained in" /> PyFunction | None } description="Find the function this node is contained in" /> Statement | None } description="Find the statement this node is contained in" /> Expression | list[ Expression ] } description="Returns the resolved type of an Expression." /> str } description="Text representation of the Editable instance." /> list[ Editable ] } description="Returns Editables for all TreeSitter node instances of variable usages within this node's" /> ### add_decorator Adds a decorator to a function or method. str } description="The decorator to add, including the '@' symbol." defaultValue="" /> bool, optional } description="If True, skips adding if the decorator exists." defaultValue="False" /><Return return_type={ bool } description="True if the decorator was added, False if skipped."/>
Find all ancestors of the node of the given type. Does not return itself
<Return return_type={ <>list[ <a href="/api-reference/core/Editable" style={ {fontWeight: "inherit", fontSize: "inherit"} }>Editable ]</> } description=""/>
Replace the source of this Editable with new_src.
<Return return_type={ None } description=""/>
Find and return matching nodes or substrings within an Editable instance.
Union[list[str], str] } description="One or more strings to search for." defaultValue="" /> bool } description="If True, only return nodes whose source exactly matches one of the strings_to_match." defaultValue="False" /><Return return_type={ <>list[ <a href="/api-reference/core/Editable" style={ {fontWeight: "inherit", fontSize: "inherit"} }>Editable ]</> } description="A list of Editable instances that match the search criteria."/>
Returns a list of string literals within this node's source that match any of the given
list[str] } description="A list of strings to search for in string literals." defaultValue="" /> bool } description="If True, matches substrings within string literals. If False, only matches exact strings. Defaults to False." defaultValue="False" /><Return return_type={ <>list[ <a href="/api-reference/core/Editable" style={ {fontWeight: "inherit", fontSize: "inherit"} }>Editable [ <a href="/api-reference/python/PyBlockStatement" style={ {fontWeight: "inherit", fontSize: "inherit"} }>PyBlockStatement ]]</> } description="A list of Editable objects representing the matching string literals."/>
Adds a visual flag comment to the end of this Editable's source text.
<Return return_type={ <>CodeFlag[ <a href="/api-reference/python/PyBlockStatement" style={ {fontWeight: "inherit", fontSize: "inherit"} }>PyBlockStatement ]</> } description=""/>
Returns Editables for all TreeSitter nodes corresponding to instances of variable usage
str } description="The variable name to search for." defaultValue="" /> bool } description="If True, matches variables where var_name is a substring. If False, requires exact match. Defaults to False." defaultValue="False" /><Return return_type={ <>Sequence[ <a href="/api-reference/core/Editable" style={ {fontWeight: "inherit", fontSize: "inherit"} }>Editable [ <a href="/api-reference/python/PyBlockStatement" style={ {fontWeight: "inherit", fontSize: "inherit"} }>PyBlockStatement ]]</> } description="List of Editable objects representing variable usage nodes matching the given name."/>
Inserts code after this node.
str } description="The source code to insert after this node." defaultValue="" /> bool, optional } description="Whether to adjust the indentation of new_src to match the current node. Defaults to False." defaultValue="False" /> bool, optional } description="Whether to add a newline before the new_src. Defaults to True." defaultValue="True" /> int, optional } description="Priority of the insertion transaction. Defaults to 0." defaultValue="0" /> bool, optional } description="Whether to deduplicate identical transactions. Defaults to True." defaultValue="True" /><Return return_type={ None } description=""/>
Inserts text before this node's source with optional indentation and newline handling.
str } description="The text to insert before this node." defaultValue="" /> bool } description="Whether to fix the indentation of new_src to match the current node. Defaults to False." defaultValue="False" /> bool } description="Whether to add a newline after new_src. Defaults to True." defaultValue="True" /> int } description="Transaction priority for managing multiple edits. Defaults to 0." defaultValue="0" /> bool } description="Whether to deduplicate identical transactions. Defaults to True." defaultValue="True" /><Return return_type={ None } description=""/>
Checks if this node is a descendant of the given editable instance in the AST.
<Return return_type={ bool } description=""/>
Check if this node is contained another node of the given class
<Return return_type={ bool } description=""/>
Find the first ancestor of the node of the given type. Does not return itself
<Return return_type={ <><a href="/api-reference/core/Editable" style={ {fontWeight: "inherit", fontSize: "inherit"} }>Editable | None</> } description=""/>
Find the first ancestor of the node of the given type. Does not return itself
<Return return_type={ <><a href="/api-reference/core/Editable" style={ {fontWeight: "inherit", fontSize: "inherit"} }>Editable | None</> } description=""/>
Reduces an editable to the following condition
<Return return_type={ None } description=""/>
Deletes this Node and its related extended nodes (e.g. decorators, comments).
bool } description="Whether to delete surrounding whitespace and formatting. Defaults to True." defaultValue="True" /> int } description="Priority of the removal transaction. Higher priority transactions are executed first. Defaults to 0." defaultValue="0" /> bool } description="Whether to deduplicate removal transactions at the same location. Defaults to True." defaultValue="True" /><Return return_type={ None } description=""/>
Search and replace occurrences of text within this node's source and its extended nodes.
str } description="The text or pattern to search for." defaultValue="" /> str } description="The text to replace matches with." defaultValue="" /> int, optional } description="Maximum number of replacements to make. Defaults to -1 (replace all)." defaultValue="-1" /> bool, optional } description="Whether to treat 'old' as a regex pattern. Defaults to False." defaultValue="False" /> int, optional } description="Priority of the replacement operation. Defaults to 0." defaultValue="0" /><Return return_type={ int } description="The total number of replacements made."/>
Returns a list of all regex match of regex_pattern, similar to python's re.search().
<Return return_type={ <>list[ <a href="/api-reference/core/Editable" style={ {fontWeight: "inherit", fontSize: "inherit"} }>Editable ]</> } description="A list of Editable objects corresponding to the matches found."/>
Sets or updates a docstring for a Python function or class.
str } description="The docstring content to set." defaultValue="" /> bool, optional } description="Whether to format the text into a proper docstring format. Defaults to True." defaultValue="True" /> bool, optional } description="Whether to clean and normalize the docstring format before insertion. Defaults to True." defaultValue="True" /> bool, optional } description="Whether to force single-line comments to be converted to multi-line format. Defaults to False." defaultValue="False" /><Return return_type={ None } description=""/>