Source code for pcapkit.protocols.internet.ipv6.data

# -*- coding: utf-8 -*-
"""data model for Internet Protocol version 6"""

from typing import TYPE_CHECKING

from pcapkit.corekit.infoclass import info_final
from pcapkit.protocols.data import Protocol

if TYPE_CHECKING:
    from ipaddress import IPv6Address
    from typing import Any, Type

    from typing_extensions import Literal

    from pcapkit.const.reg.transtype import TransType
    from pcapkit.protocols.data import Data, Packet
    from pcapkit.protocols.protocol import ProtocolBase

__all__ = [
    'IPv6',
]




@info_final
class IPv6(Protocol):
    """Data model for Internet Protocol version 6.

    Important:
        Due to the reserved keyword conflict, please use
        :meth:`~pcapkit.corekit.infoclass.Info.from_dict`
        to create an instance of this data model.

    """

    # NOTE: ``__exthdr__`` is metadata, as the keys ``Data`` names are:
    # ``to_dict`` carries it, the dumps and ``repr`` leave it out (#2003).
    __included__ = ['__exthdr__']
    __excluded__ = ['__exthdr__']

    #: Version.
    version: 'Literal[6]'
    #: Traffic class.
    #class: 'int'
    #: Flow label.
    label: 'int'
    #: Payload length.
    payload: 'int'
    #: Next header.
    next: 'TransType'
    #: Hop limit.
    limit: 'int'
    #: Source address.
    src: 'IPv6Address'
    #: Destination address.
    dst: 'IPv6Address'

    if TYPE_CHECKING:
        #: Fragmented packet header & payload (from IPv6-Frag header).
        fragment: 'Packet'
        #: Highest header protocol type (extension header excluded).
        protocol: 'TransType'
        #: Header length (including extension headers).
        hdr_len: 'int'
        #: Raw payload length (excluding extension headers).
        raw_len: 'int'
        #: Octets captured past the Payload Length -- or, for a jumbogram,
        #: past the Jumbo Payload Length -- present only when there are any.
        trailer: 'bytes'
        #: Extension header chain, in wire order, as pairs of the parser
        #: class and its info. The per-header keys hold the same infos, but in
        #: the order of the keys of this :class:`~pcapkit.corekit.infoclass.Info`,
        #: which differs on PyPy, so the chain is rebuilt from this alone
        #: (:issue:`1473`, :issue:`2003`).
        __exthdr__: 'tuple[tuple[Type[ProtocolBase], Data], ...]'

    def __new__(cls, *args: 'Any', **kwargs: 'Any') -> 'IPv6':
        self = super().__new__(cls, *args, **kwargs)

        # NOTE: We cannot define ``class`` due to reserved keyword conflict.
        # Thus, we directly inject the information into the annotations.
        cls.__annotations__['class'] = int

        return self