vimsheet.io.base

Abstract base class for all format adapters.

class vimsheet.io.base.FormatAdapter

Bases: ABC

Base class every I/O adapter must implement.

supported_extensions: list[str] = []

can_read_formulas: bool = False

can_write_formulas: bool = False

multi_sheet: bool = False

abstractmethod read(path, **opts)

Read path and return a populated Workbook.

Parameters:

• path (Path)

• opts (object)

Return type:

Workbook

abstractmethod write(workbook, path, **opts)

Serialise workbook to path.

Parameters:

• workbook (Workbook)

• path (Path)

• opts (object)

Return type:

None