File

Represents a generic file. Could represent a source file or a non-code file such as a markdown file or image file.

Inherits from

Editable

Attributes

content

directory

extended

extended_source

extension

file

file_path

filepath

function_calls

is_binary

name

owners

parent

parent_class

parent_function

parent_statement

path

source

start_byte

variable_usages

Methods

ancestors

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

edit

Replace the source of this file with new_src.

find

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

find_string_literals

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

flag

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

get_variable_usages

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

insert_after

Inserts code after this node.

insert_before

Inserts text before this node’s source with optional indentation and newline handling.

is_child_of

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

is_wrapped_in

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

parent_of_type

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

parent_of_types

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

parse

Parses the file representation into the graph.

reduce_condition

Reduces an editable to the following condition

remove

Removes the file from the file system and graph.

rename

Renames the file to the specified name, preserving the file extension.

replace

Replace occurrences of text in the file.

search

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

update_filepath

Updates the file path and inbound imports of a file.