Source code for pcapkit.const.mh.ani_suboption

# -*- coding: utf-8 -*-
# pylint: disable=line-too-long,consider-using-f-string
"""Access Network Information (ANI) Sub-Option Type Values
=============================================================

.. module:: pcapkit.const.mh.ani_suboption

This module contains the constant enumeration for **Access Network Information (ANI) Sub-Option Type Values**,
which is automatically generated from :class:`pcapkit.vendor.mh.ani_suboption.ANISuboption`.

"""

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__ = ['ANISuboption']




class ANISuboption(EnumRegistry, IntEnum):
    """[ANISuboption] Access Network Information (ANI) Sub-Option Type Values"""

    #: Reserved [:rfc:`6757`]
    Reserved_0 = 0

    #: Network-Identifier sub-option [:rfc:`6757`]
    Network_Identifier = 1

    #: Geo-Location sub-option [:rfc:`6757`]
    Geo_Location = 2

    #: Operator-Identifier sub-option [:rfc:`6757`]
    Operator_Identifier = 3

    #: Civic-Location sub-option [:rfc:`7563`]
    Civic_Location = 4

    #: MAG-Group-Identifier sub-option [:rfc:`7563`]
    MAG_Group_Identifier = 5

    #: ANI Update-Timer sub-option [:rfc:`7563`]
    ANI_Update_Timer = 6

    #: Reserved [:rfc:`6757`]
    Reserved_255 = 255



    @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 0 <= value <= 255):
            raise EnumValueError('%r is not a valid %s' % (value, cls.__name__))




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

        Args:
            value: Value to get enum item.

        """
        if not (isinstance(value, int) and 0 <= value <= 255):
            raise ValueError('%r is not a valid %s' % (value, cls.__name__))
        if 7 <= value <= 254:
            #: Unassigned
            return cls._unregistered_member(value, 'Unassigned')
        return super()._missing_(value)