Skip to content

result

Containers for extraction results.

Result dataclass

Bases: ToJsonMixin

A container for the result of an extraction.

Attributes:

`success` (bool | None):
    Whether the extraction was successful.
`method` (str | None):
    The name of the method that was called.
`message` (str | None):
    A message describing the result of the extraction.
`destpath` (Path | None):
    The path to the destination file or directory.
`elapsed_time` (float | None):
    The number of seconds it took to complete the extraction.

Methods:

- `json()` -> `str`: Return a JSON string representation of the request.

success class-attribute instance-attribute

success = None

method class-attribute instance-attribute

method = None

message class-attribute instance-attribute

message = None

destpath class-attribute instance-attribute

destpath = None

elapsed_time class-attribute instance-attribute

elapsed_time = None