Source code for pcapkit.const.http.frame

# -*- coding: utf-8 -*-
# pylint: disable=line-too-long,consider-using-f-string
"""HTTP/2 Frame Type
=======================

.. module:: pcapkit.const.http.frame

This module contains the constant enumeration for **HTTP/2 Frame Type**,
which is automatically generated from :class:`pcapkit.vendor.http.frame.Frame`.

"""

from typing import TYPE_CHECKING

from aenum import IntEnum

from pcapkit.corekit.enum import EnumRegistry
from pcapkit.utilities.exceptions import EnumValueError

if TYPE_CHECKING:
    from typing import Any

__all__ = ['Frame']




class Frame(EnumRegistry, IntEnum):
    """[Frame] HTTP/2 Frame Type"""

    #: ``DATA`` [:rfc:`9113#section-6.1`]
    DATA = 0x00

    #: ``HEADERS`` [:rfc:`9113#section-6.2`]
    HEADERS = 0x01

    #: ``PRIORITY`` [:rfc:`9113#section-6.3`]
    PRIORITY = 0x02

    #: ``RST_STREAM`` [:rfc:`9113#section-6.4`]
    RST_STREAM = 0x03

    #: ``SETTINGS`` [:rfc:`9113#section-6.5`]
    SETTINGS = 0x04

    #: ``PUSH_PROMISE`` [:rfc:`9113#section-6.6`]
    PUSH_PROMISE = 0x05

    #: ``PING`` [:rfc:`9113#section-6.7`]
    PING = 0x06

    #: ``GOAWAY`` [:rfc:`9113#section-6.8`]
    GOAWAY = 0x07

    #: ``WINDOW_UPDATE`` [:rfc:`9113#section-6.9`]
    WINDOW_UPDATE = 0x08

    #: ``CONTINUATION`` [:rfc:`9113#section-6.10`]
    CONTINUATION = 0x09

    #: ``ALTSVC`` [:rfc:`7838#section-4`]
    ALTSVC = 0x0A

    #: ``Unassigned``
    Unassigned_0x0B = 0x0B

    #: ``ORIGIN`` [:rfc:`8336`]
    ORIGIN = 0x0C

    #: ``PRIORITY_UPDATE`` [:rfc:`9218`]
    PRIORITY_UPDATE = 0x10



    @classmethod
    def _validate_value(cls, value: 'Any') -> 'None':
        """Reject ``value`` unless it passes the range check :meth:`_missing_` makes.

        Overrides :meth:`~pcapkit.corekit.enum.EnumLookup._validate_value`
        with that check and the message it raises, so
        :meth:`~pcapkit.corekit.enum.EnumRegistry.register` refuses exactly the
        values :meth:`~pcapkit.corekit.enum.EnumLookup.get` refuses, in the
        same words (:issue:`1816`).

        Args:
            value: Value about to be looked up or minted.

        Raises:
            EnumValueError: If ``value`` fails that check. A
                :exc:`ValueError`, so an ``except ValueError`` caller is
                unaffected.

        """
        if not (isinstance(value, int) and 0x00 <= value <= 0xFF):
            raise EnumValueError('%r is not a valid %s' % (value, cls.__name__))




    @classmethod
    def _missing_(cls, value: 'int') -> 'Frame':
        """Lookup function used when value is not found.

        Args:
            value: Value to get enum item.

        """
        if not (isinstance(value, int) and 0x00 <= value <= 0xFF):
            raise ValueError('%r is not a valid %s' % (value, cls.__name__))
        if 0x0D <= value <= 0x0F:
            #: ``Unassigned``
            return cls._unregistered_member(value, 'Unassigned')
        if 0x11 <= value <= 0xFF:
            #: ``Unassigned``
            return cls._unregistered_member(value, 'Unassigned')
        return super()._missing_(value)