Documentation Index
Fetch the complete documentation index at: https://docs.camel-ai.org/llms.txt
Use this file to discover all available pages before exploring further.
class FileWriteToolkit(BaseToolkit):
init
def __init__(
self,
working_directory: Optional[str] = None,
timeout: Optional[float] = None,
default_encoding: str = 'utf-8',
backup_enabled: bool = True
):
- working_directory (str, optional): The default directory for output files. If not provided, it will be determined by the
CAMEL_WORKDIR environment variable (if set). If the environment variable is not set, it defaults to camel_working_dir.
- timeout (Optional[float]): The timeout for the toolkit. (default: :obj:
None)
- default_encoding (str): Default character encoding for text operations. (default: :obj:
utf-8)
- backup_enabled (bool): Whether to create backups of existing files before overwriting. (default: :obj:
True)
_resolve_filepath
def _resolve_filepath(self, file_path: str):
- file_path (str): The file path to resolve.
Returns:
Path: A fully resolved (absolute) and sanitized Path object.
_sanitize_filename
def _sanitize_filename(self, filename: str):
- filename (str): The original filename which may contain spaces or special characters.
Returns:
str: The sanitized filename with disallowed characters replaced by
underscores.
_write_text_file
def _write_text_file(
self,
file_path: Path,
content: str,
encoding: str = 'utf-8'
):
- file_path (Path): The target file path.
- content (str): The text content to write.
- encoding (str): Character encoding to use. (default: :obj:
utf-8) (default: utf-8)
_generate_unique_filename
def _generate_unique_filename(self, file_path: Path):
- file_path (Path): The original file path.
Returns:
Path: A unique file path that doesn’t exist yet.
_write_docx_file
def _write_docx_file(self, file_path: Path, content: str):
- file_path (Path): The target file path.
- content (str): The text content to write.
_write_pdf_file
def _write_pdf_file(
self,
file_path: Path,
title: str,
content: Union[str, List[List[str]]],
use_latex: bool = False
):
- file_path (Path): The target file path.
- title (str): The document title.
- content (Union[str, List[List[str]]]): The content to write. Can
- be: - String: Supports Markdown-style tables and LaTeX math expressions - List[List[str]]: Table data as list of rows for direct table rendering
- use_latex (bool): Whether to use LaTeX for math rendering. (default: :obj:
False)
_process_text_content
def _process_text_content(
self,
story,
content: str,
heading_style,
body_style
):
- story: The reportlab story list to append to
- content (str): The text content to process
- heading_style: Style for headings
- body_style: Style for body text
_find_table_line_ranges
def _find_table_line_ranges(self, lines: List[str]):
- lines (List[str]): List of lines to analyze.
Returns:
List[Tuple[int, int]]: List of (start_line, end_line) tuples
for table ranges.
_register_chinese_font
def _register_chinese_font(self):
_parse_markdown_table
def _parse_markdown_table(self, lines: List[str]):
- lines (List[str]): List of text lines that may contain tables.
Returns:
List[List[List[str]]]: List of tables, where each table is a list
of rows, and each row is a list of cells.
_is_table_row
def _is_table_row(self, line: str):
- line (str): The line to check.
Returns:
bool: True if the line looks like a table row.
_is_table_separator
def _is_table_separator(self, line: str):
- line (str): The line to check.
Returns:
bool: True if the line is a table separator.
_parse_table_row
def _parse_table_row(self, line: str):
- line (str): The table row line.
Returns:
List[str]: List of cell contents.
_create_pdf_table
def _create_pdf_table(self, table_data: List[List[str]]):
- table_data (List[List[str]]): Table data as list of rows.
Returns:
Table: A formatted reportlab Table object.
_convert_markdown_to_html
def _convert_markdown_to_html(self, text: str):
- text (str): Text with markdown formatting.
Returns:
str: Text with HTML formatting.
def _ensure_html_utf8_meta(self, content: str):
- content (str): The HTML content.
Returns:
str: HTML content with UTF-8 meta tag.
_write_csv_file
def _write_csv_file(
self,
file_path: Path,
content: Union[str, List[List]],
encoding: str = 'utf-8'
):
- file_path (Path): The target file path.
- content (Union[str, List[List]]): The CSV content as a string or list of lists.
- encoding (str): Character encoding to use. (default: :obj:
utf-8) (default: utf-8)
_write_json_file
def _write_json_file(
self,
file_path: Path,
content: str,
encoding: str = 'utf-8'
):
- file_path (Path): The target file path.
- content (str): The JSON content as a string.
- encoding (str): Character encoding to use. (default: :obj:
utf-8) (default: utf-8)
_write_simple_text_file
def _write_simple_text_file(
self,
file_path: Path,
content: str,
encoding: str = 'utf-8'
):
- file_path (Path): The target file path.
- content (str): The content to write.
- encoding (str): Character encoding to use. (default: :obj:
utf-8) (default: utf-8)
write_to_file
def write_to_file(
self,
title: str,
content: Union[str, List[List[str]]],
filename: str,
encoding: Optional[str] = None,
use_latex: bool = False
):
- title (str): The title of the document.
- content (Union[str, List[List[str]]]): The content to write to the file. Content format varies by file type: - Text formats (txt, md, html, yaml): string - CSV: string or list of lists - JSON: string or serializable object
- filename (str): The name or path of the file. If a relative path is supplied, it is resolved to self.working_directory.
- encoding (Optional[str]): The character encoding to use. (default: :obj:
None)
- use_latex (bool): Whether to use LaTeX for math rendering. (default: :obj:
False)
Returns:
str: A message indicating success or error details.
Returns:
List[FunctionTool]: A list of FunctionTool objects representing
the available functions in this toolkit.
