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
Attributes
content
strReturns the content of the file as a UTF-8 encoded string.
directory
Returns the directory that contains this file.
extended
Returns a SymbolGroup of all extended nodes associated with this element.
extended_source
strReturns the source text representation of all extended nodes.
extension
strReturns the file extension.
file
A property that returns the file object for non-source files.
file_node_id
NodeId
file_path
str
filepath
strRetrieves 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.
is_binary
boolIndicates whether the file contains binary data.
name
str
node_type
Literal[NodeType.FILE]
owners
set[str]Returns the CODEOWNERS of the file.
parent
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
path
Path
source
strText representation of the Editable instance.
start_byte
intReturns the starting byte position of a file in its content.
ts_node
TSNode
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
Returns
edit
Replace the source of this Editable with new_src.
Parameters
strThe new source text to replace the current text with.
boolIf True, adjusts the indentation of `new_src` to match the current text's indentation level. Defaults to False.
intThe priority of the edit transaction. Higher priority edits are applied first. Defaults to 0.
boolIf True, deduplicates identical transactions. Defaults to True.
Returns
Nonefind
Find and return matching nodes or substrings within an Editable instance.
Parameters
Union[list[str], str]One or more strings to search for.
boolIf True, only return nodes whose source exactly matches one of the strings_to_match.
Returns
A list of Editable instances that match the search criteria.
find_string_literals
Returns a list of string literals within this node’s source that match any of the given
Parameters
list[str]A list of strings to search for in string literals.
boolIf True, matches substrings within string literals. If False, only matches exact strings. Defaults to False.
Returns
A list of Editable objects representing the matching string literals.
flag
Adds a visual flag comment to the end of this Editable’s source text.
Returns
get_variable_usages
Returns Editables for all TreeSitter nodes corresponding to instances of variable usage
Parameters
strThe variable name to search for.
boolIf 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.
insert_after
Inserts code after this node.
Parameters
strThe source code to insert after this node.
bool, optionalWhether to adjust the indentation of new_src to match the current node. Defaults to False.
bool, optionalWhether to add a newline before the new_src. Defaults to True.
int, optionalPriority of the insertion transaction. Defaults to 0.
bool, optionalWhether to deduplicate identical transactions. Defaults to True.
Returns
Noneinsert_before
Inserts text before this node’s source with optional indentation and newline handling.
Parameters
strThe text to insert before this node.
boolWhether to fix the indentation of new_src to match the current node. Defaults to False.
boolWhether to add a newline after new_src. Defaults to True.
intTransaction priority for managing multiple edits. Defaults to 0.
boolWhether to deduplicate identical transactions. Defaults to True.
Returns
Noneis_wrapped_in
Check if this node is contained another node of the given class
Returns
boolparent_of_type
Find the first ancestor of the node of the given type. Does not return itself
Returns
parse
Parses the file representation into the graph.
Parameters
CodebaseGraphThe codebase graph that the file belongs to.
Returns
Nonereduce_condition
Reduces an editable to the following condition
Returns
Noneremove
Removes the file from the file system and graph.
Returns
Nonerename
Renames the file to the specified name, preserving the file extension.
Parameters
strThe new name for the file. If the new name includes the file extension, it will be used as-is.
Returns
Nonereplace
Search and replace occurrences of text within this node’s source and its extended nodes.
Parameters
strThe text or pattern to search for.
strThe text to replace matches with.
int, optionalMaximum number of replacements to make. Defaults to -1 (replace all).
bool, optionalWhether to treat 'old' as a regex pattern. Defaults to False.
int, optionalPriority of the replacement operation. Defaults to 0.
Returns
intThe total number of replacements made.
search
Returns a list of all regex match of regex_pattern, similar to python’s re.search().
Parameters
strThe regular expression pattern to search for.
boolWhen False, excludes the contents of string literals from the search. Defaults to True.
boolWhen False, excludes the contents of comments from the search. Defaults to True.
Returns
A list of Editable objects corresponding to the matches found.
update_filepath
Updates the file path and inbound imports of a file.
Parameters
strThe new file path to rename the file to.
Returns
NoneWas this page helpful?