Python Typing: Given Set of Values

user_3566606 0
Viewed 1403

I want to type the parameter of a method to be one of a finite set of valid values. So basically, I would like to have the typing equivalent of the following minimal example:

valid_parameters = ["value", "other value"]

def typed_method(parameter):
    if not parameter in valid_parameters:
        raise ValueError("invalid parameter")

I checked typing already, but I didn't manage to find a solution. Maybe I was just not able to fully understand the documentation. Is there such a solution? Can it be created?

typing python
2 Answers

This feature has just been introduced in Python 3.8: typing.Literal. See PEP 586 for details.

Example:

def typed_method(parameter: Literal["value", "other value"]):
    pass
user_4760

I want to type the parameter of a method to be one of a finite set of valid values

Use Enum

from enum import Enum


class Color(Enum):
    RED = 1
    GREEN = 2
    BLUE = 3


def handle_color(color):
    if not isinstance(color, Color):
        raise ValueError('Not a color')
    print(color)


handle_color(Color.GREEN)
handle_color('something')
user_4150160
Related