graph-sitter
Documentation menu

TSUnionType

Union type Examples: string | number

View source on GitHub

Inherits from

UnionType, Type, Expression, SymbolGroup, Editable

Attributes

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 contained within this expression.

next_named_sibling

Returns the next named sibling of the last symbol in the group.

next_sibling

Returns the next sibling of the last symbol in the symbol group.

parent

The parent node of this Editable instance.

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.

source

Get the source code content of the node.

symbols

Returns the list of symbols in the group.

variable_usages

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

Methods

ancestors

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

View source on GitHub

Returns

edit

Edit the source for this Collection instance.

View source on GitHub

Returns

find

Search for substrings in the given symbols that match strings_to_match.

View source on GitHub

Parameters

strings_to_matchrequired

The string or list of strings to search for.

exactdefault: False

If True, only return nodes that exactly match the query.

Returns

A list of Editable objects representing each match found.

find_string_literals

Search for string literals matching given strings in the SymbolGroup.

View source on GitHub

Parameters

strings_to_matchrequired

List of strings to search for in string literals.

fuzzy_matchdefault: False

If True, performs fuzzy matching instead of exact matching.

Returns

List of Editable nodes representing the matching string literals found within the symbols.

flag

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

View source on GitHub

Returns

get_variable_usages

Returns Editables for all TreeSitter nodes corresponding to instances of variable usage

View source on GitHub

Parameters

var_namerequired

The variable name to search for.

fuzzy_matchdefault: False

If True, matches variables where var_name is a substring. If False, requires exact match. Defaults to False.

Returns

List of Editable objects representing variable usage nodes matching the given name.

index

Return the index of the first occurrence of value.

View source on GitHub

Returns

insert

Adds value to the container that this node represents

View source on GitHub

Returns

insert_after

Inserts source code after this node in the codebase.

View source on GitHub

Parameters

new_srcrequired

The source code to insert.

fix_indentationdefault: False

Adjust indentation to match current text.

newlinedefault: True

Add a newline before the inserted code.

prioritydefault: 0

Priority of the edit operation.

dedupedefault: True

Deduplicate identical edits.

Returns

insert_before

Inserts source code before this symbol group.

View source on GitHub

Parameters

new_srcrequired

The source code to insert.

fix_indentationdefault: False

Whether to adjust the indentation of the inserted code to match the current code. Defaults to False.

newlinedefault: True

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

prioritydefault: 0

The priority of this edit operation. Higher priority edits are applied first. Defaults to 0.

dedupedefault: True

Whether to prevent duplicate insertions of the same code. Defaults to True.

Returns

is_child_of

Checks if this node is a descendant of the given editable instance in the AST.

View source on GitHub

Returns

is_wrapped_in

Check if this node is contained another node of the given class

View source on GitHub

Returns

parent_of_type

Find the first ancestor of the node of the given type. Does not return itself

View source on GitHub

Returns

parent_of_types

Find the first ancestor of the node of the given type. Does not return itself

View source on GitHub

Returns

reduce_condition

Reduces an editable to the following condition

View source on GitHub

Returns

remove

Removes an element from a Collection.

View source on GitHub

Parameters

valuedefault: None

The element to remove from the Collection. If None, delegates to parent class.

Returns

This method doesn't return anything.

replace

Replaces all instances of a string with a new string in all symbols within the group.

View source on GitHub

Parameters

oldrequired

The string to be replaced.

newrequired

The string to replace with.

countdefault: -1

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

prioritydefault: 0

Priority of the replacement operation. Defaults to 0.

Returns

Number of replacements made.

Searches for regex matches in the codebase.

View source on GitHub

Parameters

regex_patternrequired

The regular expression pattern to search for.

include_stringsdefault: True

Whether to include string literals in the search. Defaults to True.

include_commentsdefault: True

Whether to include comments in the search. Defaults to True.

Returns

A list of Editable objects representing matched text nodes in the codebase.