Skip to content

Base tool io

base_tool_io

Classes

BaseToolFileIO

A base class to handle reading and writing tool results.

Functions
read abstractmethod 
read(
    file_name: str | Path, directory_path: str | Path = ""
) -> Any

Read a result.

Source code in src/vimseo/io/base_tool_io.py 
38
39
40
@abstractmethod
def read(self, file_name: str | Path, directory_path: str | Path = "") -> Any:
    """Read a result."""
write abstractmethod 
write(
    data: Any,
    file_base_name: str | Path = "",
    directory_path: str | Path = "",
) -> dict

Write a result.

Source code in src/vimseo/io/base_tool_io.py 
42
43
44
45
46
47
48
49
@abstractmethod
def write(
    self,
    data: Any,
    file_base_name: str | Path = "",
    directory_path: str | Path = "",
) -> dict:
    """Write a result."""