whylogs.api.writer.local

Module Contents

Classes

LocalWriter

Helper class that provides a standard way to create an ABC using

Attributes

logger

whylogs.api.writer.local.logger

class whylogs.api.writer.local.LocalWriter(base_dir: Optional[str] = None, base_name: Optional[str] = None)

Bases: whylogs.api.writer.Writer

Helper class that provides a standard way to create an ABC using inheritance.

Parameters

• base_dir (Optional[str]) –

• base_name (Optional[str]) –

write(file: whylogs.api.writer.writer.Writable, dest: Optional[str] = None, **kwargs: Any) → Tuple[bool, str]

Parameters

• file (whylogs.api.writer.writer.Writable) –

• dest (Optional[str]) –

• kwargs (Any) –

Return type

Tuple[bool, str]

option(base_dir: Optional[str] = None, base_name: Optional[str] = None) → LocalWriter

Parameters

• base_dir (Optional[str]) –

• base_name (Optional[str]) –

Return type

LocalWriter

check_interval(interval_seconds: int) → None

Validate an interval configuration for a given writer.

Some writers only accepts certain interval configuration. Raise BadConfigError for an unacceptable interval.

Parameters

interval_seconds (int) –

Return type

None