Parameter
Abstract representation of a parameter in a Function definition
Inherits from
Expression, Typeable, HasName, HasValue, Editable
Properties
default
Returns the default value of the parameter if it exists, None otherwise
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
full_name
The full name including the object lookup (if applicable).
Examples: For a.b, the full name is a.b
function_calls
Returns all contained function calls. Useful for renaming function invocations etc.
index
0-based index of the parameter defined in a callable
is_optional
Returns True if the parameter is optional, False otherwise
is_typed
Returns True if the object is explicitly typed, False otherwise
is_variadic
Returns True if the parameter is variadic, False otherwise
name
The name of the object excluding whichever namespace precedes it, as a string.
Examples: For a.b, the name is b
parent_function
The function that this Parameter belongs to
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
value
The value of the object
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.
Attributes
type
The type annotation associated with this node
Methods
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_name
Returns the Name of the object, as a Name
(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
Removes the parameter from the function definition and all its call sites.
rename
Renames a parameter in a function definition and all usages in the function body and call sites.
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_name
Sets the name of the object
set_type_annotation
Set the type annotation of the parameter
set_value
Sets the value of the object
Was this page helpful?