MirascopeLilypad

mirascope.tools.system._file_system

Module _file_system

Class FileSystemToolKitConfig

Configuration for file_system toolkit

Bases:

_ConfigurableToolConfig

Attributes

NameTypeDescription
max_file_sizeint-
allowed_extensionslist[str]-

Class FileOperation

Base class for file system operations.

Bases: ConfigurableTool[FileSystemToolKitConfig], ABC

Attributes

NameTypeDescription
base_directoryPath-

Class FileSystemToolKit

ToolKit for file system operations. Read, write, list, create, and delete files and directories.

Bases:

ConfigurableToolKit[FileSystemToolKitConfig]

Attributes

NameTypeDescription
configFileSystemToolKitConfig-
base_directoryPath-

Class ReadFile

Tool for reading file contents.

Bases:

FileOperation

Attributes

NameTypeDescription
pathstr-

Function call

Read and return file contents.

Parameters

NameTypeDescription
selfAny-

Returns

TypeDescription
strFile contents or error message if operation fails

Class WriteFile

Tool for writing content to a file.

Bases:

FileOperation

Attributes

NameTypeDescription
pathstr-
contentstr-

Function call

Write content to file and return status.

Parameters

NameTypeDescription
selfAny-

Returns

TypeDescription
strSuccess message or error message if operation fails

Class ListDirectory

Tool for listing directory contents.

Bases:

FileOperation

Attributes

NameTypeDescription
pathstr-

Function call

List directory contents and return formatted string.

Parameters

NameTypeDescription
selfAny-

Returns

TypeDescription
strFormatted directory listing or error message if operation fails

Class CreateDirectory

Tool for creating directories.

Bases:

FileOperation

Attributes

NameTypeDescription
pathstr-

Function call

Create directory and return status.

Parameters

NameTypeDescription
selfAny-

Returns

TypeDescription
strSuccess message or error message if operation fails

Class DeleteFile

Tool for deleting files.

Bases:

FileOperation

Attributes

NameTypeDescription
pathstr-

Function call

Delete file and return status.

Parameters

NameTypeDescription
selfAny-

Returns

TypeDescription
strSuccess message or error message if operation fails

Function validate_base_directory

Validates that the base directory exists and is a directory.

Parameters

NameTypeDescription
clsAny-
vPathThe path to validate

Returns

TypeDescription
PathThe validated path