mirascope.tools.system._file_system
Module _file_system
Class FileSystemToolKitConfig
Configuration for file_system toolkit
Bases:
_ConfigurableToolConfigClass FileOperation
Base class for file system operations.
Bases: ConfigurableTool[FileSystemToolKitConfig], ABC
Attributes
Name | Type | Description |
---|---|---|
base_directory | Path | - |
Class FileSystemToolKit
ToolKit for file system operations. Read, write, list, create, and delete files and directories.
Bases:
ConfigurableToolKit[FileSystemToolKitConfig]Attributes
Name | Type | Description |
---|---|---|
config | FileSystemToolKitConfig | - |
base_directory | Path | - |
Class ReadFile
Tool for reading file contents.
Bases:
FileOperationAttributes
Name | Type | Description |
---|---|---|
path | str | - |
Function call
Read and return file contents.
Parameters
Name | Type | Description |
---|---|---|
self | Any | - |
Returns
Type | Description |
---|---|
str | File contents or error message if operation fails |
Class WriteFile
Tool for writing content to a file.
Bases:
FileOperationFunction call
Write content to file and return status.
Parameters
Name | Type | Description |
---|---|---|
self | Any | - |
Returns
Type | Description |
---|---|
str | Success message or error message if operation fails |
Class ListDirectory
Tool for listing directory contents.
Bases:
FileOperationAttributes
Name | Type | Description |
---|---|---|
path | str | - |
Function call
List directory contents and return formatted string.
Parameters
Name | Type | Description |
---|---|---|
self | Any | - |
Returns
Type | Description |
---|---|
str | Formatted directory listing or error message if operation fails |
Class CreateDirectory
Tool for creating directories.
Bases:
FileOperationAttributes
Name | Type | Description |
---|---|---|
path | str | - |
Function call
Create directory and return status.
Parameters
Name | Type | Description |
---|---|---|
self | Any | - |
Returns
Type | Description |
---|---|
str | Success message or error message if operation fails |
Class DeleteFile
Tool for deleting files.
Bases:
FileOperationAttributes
Name | Type | Description |
---|---|---|
path | str | - |
Function call
Delete file and return status.
Parameters
Name | Type | Description |
---|---|---|
self | Any | - |
Returns
Type | Description |
---|---|
str | Success message or error message if operation fails |
Function validate_base_directory
Validates that the base directory exists and is a directory.
Parameters
Name | Type | Description |
---|---|---|
cls | Any | - |
v | Path | The path to validate |
Returns
Type | Description |
---|---|
Path | The validated path |