PyHasBlock
Extends HasBlock for Python codebases.
Inherits from
HasBlock, Expression, Editable
Properties
decorators
Returns list of all Decorators on this Symbol
docstring
Returns the docstring of the function. The docstring is represented as a CommentGroup.
extended
Returns a SymbolGroup of all extended nodes. This allows a common edit interface for all of extended nodes.
extended_source
Text representation of all its 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.
is_decorated
Returns True if the symbol is decorated with decorators
resolved_value
If the expression is a resolvable value, returns the last assigned expression value. Else, returns itself.
Example: a = 1 b = a foo(b)
If we call resolve_value on b, it returns 1.
source
Text representation of the Editable instance
variable_usages
Returns Editables for all TreeSitter node instances of variable usages. (Excludes: property identifiers and argument keywords) This is useful for renaming variables locally and analyzing variable usages.
Methods
add_decorator
Adds a decorator to this function based on the source
skip_if_exists
: Do not add a decorator if it already exists- returns
bool
:True
if the decorator was added,False
otherwise
commit
Commit just this node
edit
Replace the source of this Editable
with new_src
.
When fix_indentation
is True, the indentation of new_src
will be adjusted to match the current text’s indentation.
find
Returns a list of all substring match in strings_to_match
, similar to python’s str.find(..)
Args: exact: Only match individual nodes which exactly match the query
find_string_literals
Returns a list of all editable substrings within string literals that match strings_to_match
flag
Adds a comment so the developer can see this Editable
get_variable_usages
Returns Editables for all TreeSitter nodes corresponding to instances of variable usage that matches the given variable name.
(Excludes: property identifiers and argument keywords)
fuzzy_match
allows for partial matching of variable names and effectively does var_name in usage.name
insert_after
Inserts new_src after this node
insert_before
Inserts new_src before this node
remove
Deletes this Node, and optionally its related extended nodes (e.g. decorators, comments, etc.)
replace
Search and replace an instance of substring
within this node’s source. Similar to python’s string.replace(..)
Throws ValueError if there are more than one occurrence of substring in this node’s source.
Arguments:
old: the occurrences of this string to replace
new: the string to replace with
count: the max number of occurrences to replace. Default value: -1 (replace all)
is_regex: whether old
is a regex pattern. Default value: False
Returns:
The total count of old
occurrences replaced.
search
Returns a list of all regex match of regex_pattern
, similar to python’s re.search(…)
When include_strings
is False, the search will exclude the contents of string literals from the search.
When include_comments
is False, the search will exclude the contents of comments from the search.
set_docstring
Sets a docstring to the function.
Args: docstring (str): The docstring to be added. auto_format (bool, optional): Flag to automatically format the text into a docstring. Defaults to True. clean_format (bool, optional): Flag to clean the format of the docstring before inserting. Defaults to True. force_multiline (bool, optional): Flag to force single line comments to be multi-line. Defaults to False.
Returns: None
Notes: If a docstring already exists, the existing docstring will be edited. If no docstring exists, a new docstring will be created.
Examples:
If auto_format
is True, the comment “Hello” will be formatted as:
If auto_format
is False, the comment string will be added as is, without any formatting.
Was this page helpful?