> ## Documentation Index
> Fetch the complete documentation index at: https://codegeninc-codegen-bot-sdk-docs-2-0.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# File
> Represents a generic file. Could represent a source file or a non-code file such as a markdown file or image file.
export const Attribute = ({type, description}) => ;
export const GithubLinkNote = ({link}) =>
;
export const HorizontalDivider = ({light = false}) => ;
export const Return = ({return_type, description}) => ;
export const ParameterWrapper = ({children}) => ;
export const Parameter = ({name, type, description, defaultValue}) =>
{defaultValue ?
default:
{defaultValue}
:
required
}
{description}
;
### Inherits from
[Editable](/api-reference/core/Editable)
## Attributes
### content
str } description="Returns the content of the file as a UTF-8 encoded string." />
### directory
Directory | None } description="Returns the directory that contains this file." />
### extended
SymbolGroup } description="Returns a SymbolGroup of all extended nodes associated with this element." />
### extended\_source
str } description="Returns the source text representation of all extended nodes." />
### extension
str } description="Returns the file extension." />
### file
File } description="A property that returns the file object for non-source files." />
### file\_path
str } description="The relative file path as a string." />
### filepath
str } description="Retrieves the file path of the file that this Editable instance belongs to." />
### function\_calls
list[ FunctionCall ] } description="Returns a list of all function calls contained within this expression." />
### is\_binary
bool } description="Indicates whether the file contains binary data." />
### name
str } description="The name of the file." />
### owners
set[str] } description="Returns the CODEOWNERS of the file." />
### parent
Editable } description="The parent node of this Editable instance." />
### parent\_class
Class | None } description="Find the class this node is contained in" />
### parent\_function
Function | None } description="Find the function this node is contained in" />
### parent\_statement
Statement | None } description="Find the statement this node is contained in" />
### path
Path } description="The absolute path of the file as a Path object." />
### source
str } description="Text representation of the Editable instance." />
### start\_byte
int } description="Returns the starting byte position of a file in its content." />
### variable\_usages
list[ Editable ] } description="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
list[ Editable ] } description="" />
### edit
Replace the source of this file with new\_src.
str } description="The new source text to replace the current text with." defaultValue="" />
bool } description="If True, adjusts the indentation of new_src to match the current" defaultValue="False" />
int } description="The priority of the edit transaction. Higher priority edits are" defaultValue="0" />
bool } description="If True, deduplicates identical transactions. Defaults to True." defaultValue="True" />
None } description="" />
### find
Find and return matching nodes or substrings within an Editable instance.
Union[list[str], str] } description="One or more strings to search for." defaultValue="" />
bool } description="If True, only return nodes whose source exactly matches one of the strings_to_match." defaultValue="False" />
list[ Editable ] } description="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
list[str] } description="A list of strings to search for in string literals." defaultValue="" />
bool } description="If True, matches substrings within string literals. If False, only matches exact strings. Defaults to False." defaultValue="False" />
list[ Editable [ File ]] } description="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.
CodeFlag[ File ] } description="" />
### get\_variable\_usages
Returns Editables for all TreeSitter nodes corresponding to instances of variable usage
str } description="The variable name to search for." defaultValue="" />
bool } description="If True, matches variables where var_name is a substring. If False, requires exact match. Defaults to False." defaultValue="False" />
Sequence[ Editable [ File ]] } description="List of Editable objects representing variable usage nodes matching the given name." />
### insert\_after
Inserts code after this node.
str } description="The source code to insert after this node." defaultValue="" />
bool, optional } description="Whether to adjust the indentation of new_src to match the current node. Defaults to False." defaultValue="False" />
bool, optional } description="Whether to add a newline before the new_src. Defaults to True." defaultValue="True" />
int, optional } description="Priority of the insertion transaction. Defaults to 0." defaultValue="0" />
bool, optional } description="Whether to deduplicate identical transactions. Defaults to True." defaultValue="True" />
None } description="" />
### insert\_before
Inserts text before this node's source with optional indentation and newline handling.
str } description="The text to insert before this node." defaultValue="" />
bool } description="Whether to fix the indentation of new_src to match the current node. Defaults to False." defaultValue="False" />
bool } description="Whether to add a newline after new_src. Defaults to True." defaultValue="True" />
int } description="Transaction priority for managing multiple edits. Defaults to 0." defaultValue="0" />
bool } description="Whether to deduplicate identical transactions. Defaults to True." defaultValue="True" />
None } description="" />
### is\_child\_of
Checks if this node is a descendant of the given editable instance in the AST.
bool } description="" />
### is\_wrapped\_in
Check if this node is contained another node of the given class
bool } description="" />
### parent\_of\_type
Find the first ancestor of the node of the given type. Does not return itself
Editable | None } description="" />
### parent\_of\_types
Find the first ancestor of the node of the given type. Does not return itself
Editable | None } description="" />
### parse
Parses the file representation into the graph.
CodebaseContext } description="The codebase context that the file belongs to." defaultValue="" />
None } description="" />
### reduce\_condition
Reduces an editable to the following condition
None } description="" />
### remove
Removes the file from the file system and graph.
None } description="" />
### rename
Renames the file to the specified name, preserving the file extension.
str } description="The new name for the file. If the new name includes the file extension, it will be used as-is." defaultValue="" />
None } description="" />
### replace
Replace occurrences of text in the file.
str } description="The text to be replaced." defaultValue="" />
str } description="The text to replace with." defaultValue="" />
int } description="Maximum number of replacements to make. -1 means replace all occurrences." defaultValue="-1" />
bool } description="If True, treat 'old' as a regular expression pattern." defaultValue="False" />
int } description="The priority of the edit transaction. Higher priority edits are" defaultValue="0" />
int } description="List of affected Editable objects. For non-source files, always returns an empty list since they don't have Editable sub-components." />
### search
Returns a list of all regex match of `regex_pattern`, similar to python's re.search().
str } description="The regular expression pattern to search for." defaultValue="" />
bool } description="When False, excludes the contents of string literals from the search. Defaults to True." defaultValue="True" />
bool } description="When False, excludes the contents of comments from the search. Defaults to True." defaultValue="True" />
list[ Editable ] } description="A list of Editable objects corresponding to the matches found." />
### update\_filepath
Updates the file path and inbound imports of a file.
str } description="The new file path to rename the file to." defaultValue="" />
None } description="" />