Skip to content

environment

optimus_dl.core.environment

EnvironmentVariable dataclass

Manages a single environment variable with type and default value.

Parameters:

Name Type Description Default
name str
required
var_type type
required
default Any | None
None
Source code in optimus_dl/core/environment.py 
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
@dataclass
class EnvironmentVariable:
    """Manages a single environment variable with type and default value."""

    name: str
    var_type: type
    default: Any | None = None

    def get(self) -> Any:
        """Get the environment variable value or return default."""
        value = os.getenv(self.name)
        if value is None:
            return self.default
        if self.var_type is bool:
            return value.lower() in ("1", "true", "yes", "on", "y")
        return self.var_type(value)

    def set(self, value: Any) -> None:
        """Set the environment variable."""
        os.environ[self.name] = str(value)

get()

Get the environment variable value or return default.

Source code in optimus_dl/core/environment.py 
14
15
16
17
18
19
20
21
def get(self) -> Any:
    """Get the environment variable value or return default."""
    value = os.getenv(self.name)
    if value is None:
        return self.default
    if self.var_type is bool:
        return value.lower() in ("1", "true", "yes", "on", "y")
    return self.var_type(value)

set(value)

Set the environment variable.

Source code in optimus_dl/core/environment.py 
23
24
25
def set(self, value: Any) -> None:
    """Set the environment variable."""
    os.environ[self.name] = str(value)