gigl.common.utils.compute.serialization.serialize_string

Classes

StringCoder

Base class for protocol classes.

Module Contents

class gigl.common.utils.compute.serialization.serialize_string.StringCoder(encoding='utf-8')

Bases: gigl.common.utils.compute.serialization.coder.CoderProtocol[str]

Base class for protocol classes.

Protocol classes are defined as:

class Proto(Protocol):
    def meth(self) -> int:
        ...

Such classes are primarily used with static type checkers that recognize structural subtyping (static duck-typing), for example:

class C:
    def meth(self) -> int:
        return 0

def func(x: Proto) -> int:
    return x.meth()

func(C())  # Passes static type check

See PEP 544 for details. Protocol classes decorated with @typing.runtime_checkable act as simple-minded runtime protocols that check only the presence of given attributes, ignoring their type signatures. Protocol classes can be generic, they are defined as:

class GenProto(Protocol[T]):
    def meth(self) -> T:
        ...

Parameters:

encoding (str)

decode(byte_str)

Parameters:

byte_str (bytes)

Return type:

str

encode(obj)

Parameters:

obj (str)

Return type:

bytes

encoding = 'utf-8'