Revert ignore_case deprecation from 13.0.0

[Mogost]

Version 13.0.0 was introduced Backwards-incompatible change

Remove ignore_case param from Env.enum.

This change makes usage less convenient. Additionally, environs only respects enum "keys", not values, which seems illogical in many cases because values often represent the actual data being used in comparisons or user inputs, while keys are more like internal identifiers.

from enum import StrEnum, auto
class Color(StrEnum):
    RED = auto()
print(Color.RED == "red")  # True
print(Color.RED)  # red

[sloria]

It's not documented (yet), but you can pass by_value=True if you expect the envvar to be set as the value.

import os
from enum import StrEnum, auto

from environs import env

os.environ["COLOR"] = "red"


class Color(StrEnum):
    RED = auto()


COLOR = env.enum("COLOR", enum=Color, by_value=True)

assert isinstance(COLOR, Color)
assert COLOR == Color.RED
print(COLOR)  # => "red"

@Mogost does this meet your use case?

[Mogost]

@sloria, this meets my case; thank you. Unfortunately, I cannot use it; mypy is not satisfied with that.

./settings/base.py:37: error: No overload variant of "__call__" of "EnumFieldMethod" matches argument types "str", "type[InstanceType]", "bool", "InstanceType"  [call-overload]
./settings/base.py:37: note: Possible overload variants:
./settings/base.py:37: note:     def __call__(self, name: str, *, enum: type[Any], validate: Callable[[Any], Any] | Iterable[Callable[[Any], Any]] | None = ..., required: bool = ...) -> Any
./settings/base.py:37: note:     def __call__(self, name: str, default: None = ..., *, enum: type[Any], validate: Callable[[Any], Any] | Iterable[Callable[[Any], Any]] | None = ..., required: bool = ...) -> Any | None
./settings/base.py:37: note:     def __call__(self, name: str, default: Any = ..., *, enum: type[Any], validate: Callable[[Any], Any] | Iterable[Callable[[Any], Any]] | None = ..., required: bool = ...) -> Any

INSTANCE_TYPE = env.enum("INSTANCE_TYPE", default=InstanceType.UNDEFINED, enum=InstanceType, by_value=True)

class InstanceType(enum.StrEnum):
    PROD = enum.auto()
    DEV = enum.auto()
    UNDEFINED = enum.auto()

[sloria]

@Mogost ah thanks for reporting that. i've fixed the typing in #388. I'll release it in 14.1.0 today.

[Mogost]

@sloria thank you!

Also one offtop question. Is this usage of the "default" argument correct in the new version? (especially ma.missing)

TENANT_ID = env.str(
    "TENANT_ID",
    default=default_tenant_id_by_instance_type.get(INSTANCE_TYPE) or ma.missing,
    validate=Regexp(r"^[a-zA-Z0-9_-]+$", error="TENANT_ID must contain only letters, numbers, underscores, and dashes"),
).lower()

[sloria]

@Mogost you'll need to change ma.missing to ... or Ellipsis.

TENANT_ID = env.str(
    "TENANT_ID",
    default=default_tenant_id_by_instance_type.get(INSTANCE_TYPE) or Ellipsis,
    validate=Regexp(r"^[a-zA-Z0-9_-]+$", error="TENANT_ID must contain only letters, numbers, underscores, and dashes"),
).lower()

[sloria]

14.1.0 is released with the by_value fix, so closing this

[maximz]

Hey @sloria , long time no chat 👋 Thanks for this awesome library.

Unfortunately the removal of ignore_case broke my usage. Unlike the OP, I can't switch to enum values, as my enum values are dataclasses. We will make it work with exact cased strings, but just wanted to put in a vote for a future return of ignore_case if it's on your roadmap. Thanks for considering this!

[sloria]

oh hello @maximz 👋

i'm hesitant to add a special case in the codebase to resurrect ignore_case, and it's arguably better to enforce a single casing constraint on envvars anyway.

if your envvar casing differs from the enum name casing, you could do something like this

import os
from dataclasses import dataclass
from enum import Enum

from environs import env, validate

# Envvar uses lowercase names
os.environ["ANIMAL"] = "dog"

@dataclass
class AnimalConfig:
    genus: str

# Enum uses uppercase names
class Animal(Enum):
    DOG = AnimalConfig("Canis")
    CAT = AnimalConfig("Felis")


animal_config_name = env.str("ANIMAL", validate=validate.OneOf({v.name.lower() for v in Animal}))
animal_config = Animal[animal_config_name.upper()]

print(animal_config.value.genus)  # Canis

[maximz]

@sloria Sounds good — thanks for the quick reply and suggested workaround! Love the new singleton env by the way. Hope all is well with you

[sloria]

great! glad it works for you