acme.helpers.ACMEIntEnum.ACMEIntEnum

class documentation

class ACMEIntEnum(IntEnum):

A base class for many oneM2M related enum types in ACME. It provides additional halper methods to simplify working with IntEnum classes.

Class Method	`has`	Check whether the enum type has an entry with either the given int value or string name.
Class Method	`to`	Return an enum value by its name.
Method	`__int__`	Get the integer value of an enum.
Method	`__repr__`	Stringify an enum.
Method	`__str__`	Stringify an enum.

@classmethod

Check whether the enum type has an entry with either the given int value or string name.

Parameters
value:`int \| str \| list[int \| str] \| tuple[int \| str]`	value can also be a tuple of values to test. In this case, all the values in the tuple must exist.

Returns
`bool`	True if the value exists.

@classmethod

def to(cls, name: str | tuple[str], insensitive: bool | None = False) -> Any: ¶

overridden in acme.etc.Types.BasicType, acme.etc.Types.Cardinality

Return an enum value by its name.

Parameters
name:`str \| tuple[str]`	String or a tuple of strings with names.
insensitive:`bool \| None`	Optional boolean indicating whether names should be treated case-sensitive or not.

Returns
`Any`	A valid enum value, a list of enum values if name is a tupple of strings (according to the order in the tuple), or None in case of an error.

def __int__(self) -> int: ¶

Get the integer value of an enum.

Returns
`int`	The value of an enum value.

def __repr__(self) -> str: ¶

Stringify an enum.

Returns
`str`	The name of an enum value.

def __str__(self) -> str: ¶

overridden in acme.etc.Types.ResourceTypes, acme.etc.Types.TreeMode

Stringify an enum.

Returns
`str`	The name of an enum value.