Source code for pcapkit.const.ipv4.tos_ecn
# -*- coding: utf-8 -*-
# pylint: disable=line-too-long,consider-using-f-string
"""ToS ECN Field
===================
.. module:: pcapkit.const.ipv4.tos_ecn
This module contains the constant enumeration for **ToS ECN Field**,
which is automatically generated from :class:`pcapkit.vendor.ipv4.tos_ecn.ToSECN`.
"""
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__ = ['ToSECN']
[docs]
class ToSECN(EnumRegistry, IntEnum):
"""[ToSECN] ToS ECN Field"""
Not_ECT = 0b00
ECT_0b01 = 0b01
ECT_0b10 = 0b10
CE = 0b11
[docs]
@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 0b00 <= value <= 0b11):
raise EnumValueError('%r is not a valid %s' % (value, cls.__name__))
[docs]
@classmethod
def _missing_(cls, value: 'int') -> 'ToSECN':
"""Lookup function used when value is not found.
Args:
value: Value to get enum item.
"""
if not (isinstance(value, int) and 0b00 <= value <= 0b11):
raise ValueError('%r is not a valid %s' % (value, cls.__name__))
return cls._unregistered_member(value, 'Unassigned')