abc

numcodecs_observers.abc

This module defines the CodecObserver base class, which allows observing a Codec's encode and decode calls.

Classes:

  • CodecObserver –

    Observer base class, which allows observing a Codec's encode and decode calls.

CodecObserver

Observer base class, which allows observing a Codec's encode and decode calls.

Methods:

  • observe_encode –

    Hook that is called before codec.encode(buf) is called.

  • observe_decode –

    Hook that is called before codec.decode(buf, out=out) is called.

observe_encode 

observe_encode(
    codec: Codec, buf: Buffer
) -> Callable[[Buffer], None]

Hook that is called before codec.encode(buf) is called.

Parameters:
  • codec (Codec) –

    Codec whose encode method is called.

  • buf (Buffer) –

    Data to be encoded. May be any object supporting the new-style buffer protocol.
Returns:
  • posthook( Callable[[Buffer], None] ) –

    Hook that is called with the encoded data after encoded = codec.encode(buf) has returned.

observe_decode 

observe_decode(
    codec: Codec, buf: Buffer, out: Optional[Buffer] = None
) -> Callable[[Buffer], None]

Hook that is called before codec.decode(buf, out=out) is called.

Parameters:
  • codec (Codec) –

    Codec whose decode method is called.

  • buf (Buffer) –

    Encoded data. May be any object supporting the new-style buffer protocol.

  • out (Buffer, default: None ) –

    Writeable buffer to store decoded data. N.B. if provided, this buffer must be exactly the right size to store the decoded data.
Returns:
  • posthook( Callable[[Buffer], None] ) –

    Hook that is called with the decoded data after decoded = codec.decode(buf, out=out) has returned.