Skip to content

argenum

ArgEnum #

Bases: Enum

This base class can be used to define Enum argument for Typer. It allows to use the Enum name of the enum in the command line arguments instead the Enum value. To get the Enum name, use ArgEnum.val property instead of ArgEnum.value.

This workaround is explained here: https://github.com/tiangolo/typer/issues/151#issuecomment-1755370085. There is a pending merge request here: https://github.com/tiangolo/typer/pull/224.

Source code in cogip/utils/argenum.py 
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
class ArgEnum(Enum):
    """
    This base class can be used to define Enum argument for Typer.
    It allows to use the Enum name of the enum in the command line arguments instead the Enum value.
    To get the Enum name, use `ArgEnum.val` property instead of `ArgEnum.value`.

    This workaround is explained here: https://github.com/tiangolo/typer/issues/151#issuecomment-1755370085.
    There is a pending merge request here: https://github.com/tiangolo/typer/pull/224.
    """

    def __init__(self, val):
        self.val = val

    @property
    def value(self):
        return self.name