Reference#

class LZOCompressor:
    """Object containing the compressor state.

    Reusing a single instance of this class reuses compressor-memory,
    reducing allocations.

    Thread safety:
        Instance and static methods are thread-safe.
    """

    def compress(self, data: Buffer) -> bytes:
        """Compresses data.

        Args:
            data (bytes): Any python object that implements the buffer protocol

        Note:
            The GIL (Global Interpreter Lock) is released for the duration of this
            function.
        """
    @staticmethod
    def decompress(data: Buffer, output_size_hint: int | None = None) -> bytes:
        """Decompresses data.

        Args:
            data (bytes): Any python object that implements the buffer protocol
            output_size_hint: Preallocate output buffer to this size.
                Helps reducing memory overhead if decompressed size is known in advance.

        Note:
            The GIL (Global Interpreter Lock) is released for the duration of this
            function.
        """

class EResult:
    """Error codes in [`LZOError.args[0]`][lzallright._lzallright.LZOError.args]."""

    LookbehindOverrun = ...
    "Invalid input"
    OutputOverrun = ...
    """Buffer is not long enough to hold output.

    Warning:
        lzallright always tries to find the appropriate buffer size.
        If you see this, it is an error.
    """
    InputOverrun = ...
    "Input to decompress is truncated"
    Error = ...
    "Other error occurred"
    InputNotConsumed = ...
    "See [`InputNotConsumed`][lzallright._lzallright.InputNotConsumed]"

class LZOError(Exception):
    """Fatal error during compression/decompression."""

    args: tuple[EResult]
    """Error reason.

    See [`EResult`][lzallright._lzallright.EResult]"""

class InputNotConsumed(LZOError):  # noqa: N818
    """Decompression finished with leftover data."""

    args: tuple[EResult, bytes]  # type: ignore[assignment]
    """Error reason, with decompressed data

    ``(EResult.InputNotConsumed, decompressed: bytes)``
    """