whylogs.api.writer.writer#

Module Contents#

Classes#

Writable

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

Writer

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

Attributes#

T

whylogs.api.writer.writer.T#
class whylogs.api.writer.writer.Writable#

Bases: abc.ABC

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

abstract get_default_path() → str#
Return type

str

abstract write(path: Optional[str] = None, **kwargs: Any) → Tuple[bool, str]#
Parameters

  • path (Optional[str]) –

  • kwargs (Any) –

Return type

Tuple[bool, str]

class whylogs.api.writer.writer.Writer#

Bases: abc.ABC

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

check_interval(interval_seconds: int) → None#

Validate an interval configuration for a given writer.

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

Parameters

interval_seconds (int) –

Return type

None

abstract write(file: Writable, dest: Optional[str] = None, **kwargs: Any) → Tuple[bool, str]#
Parameters

  • file (Writable) –

  • dest (Optional[str]) –

  • kwargs (Any) –

Return type

Tuple[bool, str]

abstract option(**kwargs: Any) → T#
Parameters

kwargs (Any) –

Return type

T