Source code for pcapkit.protocols.data.data

# -*- coding: utf-8 -*-
"""base class for data models"""

from typing import TYPE_CHECKING

from pcapkit.corekit.infoclass import Info

__all__ = ['Data']

if TYPE_CHECKING:
    from typing import Type

    from pcapkit.protocols.protocol import ProtocolBase




class Data(Info):
    """Base class for data models."""

    __excluded__ = ['__next_name__', '__next_type__']

    if TYPE_CHECKING:
        #: Next field name, i.e., the name of the payload field.
        __next_name__: 'str'
        #: Next field type, i.e., the type of the payload field.
        __next_type__: 'Type[ProtocolBase]'
        #: Name of the header field the data ended inside, and how many of its
        #: octets were there; present only then. Not excluded, so that
        #: :meth:`to_dict` carries it and ``from_data(info.to_dict())`` cuts
        #: the rebuild back as ``from_data(info)`` does. See
        #: :func:`~pcapkit.protocols.schema.schema.keep_short_read`.
        __short_read__: 'tuple[str, int]'