> ## 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.
# SourceFile
> Represents a file with source code in the codebase. Enables creating, reading, updating, and deleting files and searching through their contents, etc.
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
[Usable](/api-reference/core/Usable), [HasBlock](/api-reference/core/HasBlock), [File](/api-reference/core/File), [Importable](/api-reference/core/Importable), [Expression](/api-reference/core/Expression), [Editable](/api-reference/core/Editable), [HasName](/api-reference/core/HasName)
## Attributes
### classes
list[ Class ] } description="Returns all Classes in the file." />
### code\_block
CodeBlock } description="Represents the block of code contained in the file." />
### content
str } description="Returns the content of the file as a UTF-8 encoded string." />
### decorators
list[ Decorator ] } description="Returns list of all decorators on this Symbol." />
### directory
Directory | None } description="Returns the directory that contains this file." />
### docstring
CommentGroup | None } description="Retrieves the docstring of the expression." />
### 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
SourceFile } 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." />
### full\_name
str | None } description="Returns the full name of the object, including the namespace path." />
### function\_calls
list[ FunctionCall ] } description="Returns all function calls within the code block and its decorators." />
### functions
list[ Function ] } description="Returns all Functions in the file." />
### global\_vars
list[ Assignment ] } description="Returns all GlobalVars in the file." />
### import\_module\_name
str } description="Returns the module name that this file gets imported as." />
### import\_statements
list[ ImportStatement ] } description="Returns all ImportStatements in the file, where each import statement can contain" />
### importers
list[ Import ] } description="Returns all imports that directly imports this file as a module." />
### imports
list[ Import ] } description="List of all Imports in this file." />
### inbound\_imports
list[ Import ] } description="Returns all imports that are importing symbols contained in this file." />
### is\_binary
bool } description="Indicates whether the file contains binary data." />
### is\_decorated
bool } description="Check if the symbol has decorators." />
### name
str | None } description="Retrieves the base name of the object without namespace prefixes." />
### 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." />
### resolved\_value
Expression | list[ Expression ] } description="Returns the resolved type of an Expression." />
### source
str } description="Text representation of the Editable instance." />
### start\_byte
int } description="Returns the starting byte position of a file in its content." />
### symbols\_sorted\_topologically
list[ Symbol ] } description="Returns all Symbols in the file, sorted topologically (parents first). Robust to" />
### variable\_usages
list[ Editable ] } description="Returns Editables for all TreeSitter node instances of variable usages within this node's" />
## Methods
### add\_decorator
Adds a decorator to a function or method.
str } description="The decorator to add, including the '@' symbol." defaultValue="" />
bool, optional } description="If True, skips adding if the decorator exists." defaultValue="False" />
bool } description="True if the decorator was added, False if skipped." />
### add\_import
Adds an import to the file.
Symbol | str } description="Either a Symbol to import or a string representation of an import statement." defaultValue="" />
str | None } description="Optional alias for the imported symbol. Only used when imp is a Symbol. Defaults to None." defaultValue="None" />
ImportType } description="The type of import to use. Only used when imp is a Symbol. Defaults to ImportType.UNKNOWN." defaultValue="ImportType.UNKNOWN" />
bool } description="Whether this is a type-only import. Only used when imp is a Symbol. Defaults to False." defaultValue="False" />
Import | None } description="The existing import for the symbol if found, otherwise None." />
### add\_symbol
Adds `symbol` to the file.
Symbol } description="The symbol to add to the file." defaultValue="" />
bool, optional } description="Whether to export the symbol. Defaults to True." defaultValue="True" />
Symbol | None } description="The existing symbol if it already exists in the file or None if it was added." />
### add\_symbol\_from\_source
Adds a symbol to a file from a string representation.
str } description="String representation of the symbol to be added. This should be valid source code for" defaultValue="" />
None } description="The symbol is added directly to the file's content." />
### ancestors
Find all ancestors of the node of the given type. Does not return itself
list[ Editable ] } description="" />
### dependencies
Returns a list of symbols that this symbol depends on.
UsageType | None } description="The types of dependencies to search for. Defaults to UsageType.DIRECT." defaultValue="UsageType.DIRECT" />
int | None } description="Maximum depth to traverse in the dependency graph. If provided, will recursively collect" defaultValue="None" />
list[Union[ Symbol , Import ]] } description="A list of symbols and imports that this symbol depends on, sorted by file location." />
### 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\_by\_byte\_range
Finds all editable objects that overlap with the given byte range in the file.
Range } description="The byte range to search within the file." defaultValue="" />
list[ Editable ] } description="A list of all Editable objects that overlap with the given range." />
### 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 [ SourceFile ]] } 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[ SourceFile ] } description="" />
### get\_class
Returns a specific Class by full name. Returns None if not found.
str } description="The full name of the class to search for." defaultValue="" />
Class | None } description="The matching Class object if found, None otherwise." />
### get\_function
Returns a specific Function by name.
str } description="The name of the function to find." defaultValue="" />
Function | None } description="The matching Function object if found, None otherwise." />
### get\_global\_var
Returns a specific global var by name. Returns None if not found.
str } description="The name of the global variable to find." defaultValue="" />
Assignment | None } description="The global variable if found, None otherwise." />
### get\_import
Returns the import with matching alias. Returns None if not found.
str } description="The alias name to search for. This can match either the direct import name or the aliased name." defaultValue="" />
Import | None } description="The import statement with the matching alias if found, None otherwise." />
### get\_name
Returns the name node of the object.
Name | ChainedAttribute | None } description="The name node of the object. Can be a Name node for simple names, a ChainedAttribute for names with namespaces (e.g., a.b), or None if the object has no name." />
### get\_symbol
Gets a symbol by its name from the file.
str } description="The name of the symbol to find." defaultValue="" />
Symbol | None } description="The found symbol, or None if not found." />
### 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 [ SourceFile ]] } description="List of Editable objects representing variable usage nodes matching the given name." />
### has\_import
Returns True if the file has an import with the given alias.
str } description="The alias to check for in the import statements." defaultValue="" />
bool } description="True if an import with the given alias exists, False otherwise." />
### 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="" />
### reduce\_condition
Reduces an editable to the following condition
None } description="" />
### remove
Removes the file from the file system and graph.
None } description="" />
### remove\_unused\_exports
Removes unused exports from the file.
None } description="" />
### rename
Renames a symbol and updates all its references in the codebase.
str } description="The new name for the symbol." defaultValue="" />
int } description="Priority of the edit operation. Defaults to 0." defaultValue="0" />
tuple[NodeId, NodeId] } description="A tuple containing the file node ID and the new node ID of the renamed symbol." />
### 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." />
### set\_docstring
Sets or updates the docstring for the current entity.
str } description="The new docstring content to set." defaultValue="" />
None } description="This method doesn't return anything." />
### set\_name
Sets the name of a code element.
str } description="The new name to set for the object." defaultValue="" />
None } description="" />
### symbol\_can\_be\_added
Checks if the file type supports adding the given symbol.
Symbol } description="The symbol to check for add compatibility." defaultValue="" />
bool } description="True if the symbol can be added to this file type, False otherwise." />
### symbol\_usages
Returns a list of symbols that use or import the exportable object.
UsageType | None } description="The types of usages to search for. Defaults to any." defaultValue="None" />
list[ Import | Symbol | TSExport ] } description="A list of symbols that use or import the exportable object." />
### symbols
Returns all Symbols in the file, sorted by position in the file.
list[ Symbol | Class | Function | Assignment | TSInterface ] } description="A list of all top-level symbols in the file, sorted by their position in the file. Symbols can be one of the following types: - Symbol: Base symbol class - TClass: Class definition - TFunction: Function definition - TGlobalVar: Global variable assignment - TInterface: Interface definition" />
### update\_filepath
Renames the file and updates all imports to point to the new location.
str } description="The new filepath to move the file to." defaultValue="" />
None } description="" />
### usages
Returns a list of usages of the exportable object.
UsageType | None } description="Specifies which types of usages to include in the results. Default is any usages." defaultValue="None" />
list[ Usage ] } description="A sorted list of Usage objects representing where this exportable is used, ordered by source location in reverse." />