Environment

The rite.system.environment submodule provides helpers for reading and modifying environment variables.

Environment Module

Environment variable operations.

This submodule provides utilities for reading and modifying environment variables.

Examples

from rite.system.environment import env_get, env_set env_set("MY_VAR", "value") env_get("MY_VAR") 'value'

Modules

env_delete

Environment Delete

Delete environment variable.

Examples

from rite.system.environment import env_delete env_delete("MY_VAR")

Functions

env_delete(key: str) -> None

Delete environment variable.

Parameters:

Name	Type	Description	Default
key	str	Environment variable name.	required

Returns:

Type	Description
None	None

Examples:

>>> env_delete("MY_VAR")

Notes

Silently ignores if variable doesn't exist.

env_get

Environment Get

Get environment variable value.

Examples

from rite.system.environment import env_get env_get("PATH")

Functions

env_get(key: str, default: str | None = None) -> str | None

Get environment variable value.

Parameters:

Name	Type	Description	Default
key	str	Environment variable name.	required
default	str | None	Default value if not found.	None

Returns:

Type	Description
str | None	Variable value or default.

Examples:

>>> env_get("PATH")
'/usr/bin:/bin'
>>> env_get("MISSING", "default")
'default'

Notes

Returns None if not found and no default.

env_list

Environment List

Get all environment variables.

Examples

from rite.system.environment import env_list env_list()

Functions

env_list() -> dict[str, str]

Get all environment variables as dictionary.

Returns:

Type	Description
dict[str, str]	Dictionary of environment variables.

Examples:

>>> env_list()
{'PATH': '/usr/bin', 'HOME': '/home/user', ...}

Notes

Returns a copy, modifications don't affect environment.

env_set

Environment Set

Set environment variable value.

Examples

from rite.system.environment import env_set env_set("MY_VAR", "value")

Functions

env_set(key: str, value: str) -> None

Set environment variable value.

Parameters:

Name	Type	Description	Default
key	str	Environment variable name.	required
value	str	Value to set.	required

Returns:

Type	Description
None	None

Examples:

>>> env_set("MY_VAR", "value")
>>> env_get("MY_VAR")
'value'

Notes

Affects current process and children.

options: show_root_heading: true show_source: false heading_level: 2