Module bare.baretype

Classes

class BAREType (*arg, **kwargs)

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[T](Protocol):
    def meth(self) -> T:
        ...
Expand source code 
class BAREType(Protocol, Generic[T]):
    @abstractmethod
    def __init__(self, *arg, **kwargs):
        ...

    @abstractmethod
    def pack(self) -> bytes:
        ...

    @classmethod
    @abstractmethod
    def unpack(cls, fp: BinaryIO) -> BAREType:
        ...

    @classmethod
    @abstractmethod
    def validate(cls, value: Any) -> bool:
        return False

    @abstractmethod
    def __eq__(cls, other: Any) -> bool:
        return NotImplemented

Ancestors

  • typing.Protocol
  • typing.Generic

Subclasses

Static methods

def unpack(fp: BinaryIO) ‑> BAREType
def validate(value: Any) ‑> bool

Methods

def pack(self) ‑> bytes