qgis_deployment_toolbelt.utils.os_utils_router module¶

Just a router to functions depending on operating system.

qgis_deployment_toolbelt.utils.os_utils_router.delete_environment_variable(envvar_name: str, scope: Literal['system', 'user'] = 'user') → bool¶

Remove environment variable from Linux profile file.

Parameters:

envvar_name (str) – environment variable name (= key) to remove
scope (str, optional) – environment variable scope. Must be “user” or “system”, defaults to “user”. Defaults to “user”.

Returns:

True if environment variable successfully removed or False if not

Return type:

bool

qgis_deployment_toolbelt.utils.os_utils_router.get_environment_variable(envvar_name: str, scope: str = 'user') → str | None¶

Get environment variable from Linux profile file.

Parameters:

envvar_name (str) – environment variable name (= key) to retrieve
scope (str, optional) – environment variable scope. Must be “user” or “system”, defaults to “user”. Defaults to “user”.

Returns:

environment variable value or None if not found

Return type:

str | None

qgis_deployment_toolbelt.utils.os_utils_router.refresh_environment() → bool¶

Just here to be equivalent with Windows logic.

TODO: refacto merging win32 methods in a single class.

Returns:: always True
Return type:: bool

qgis_deployment_toolbelt.utils.os_utils_router.set_environment_variable(envvar_name: str, envvar_value: str | bool | int, scope: str = 'user') → bool¶

Set environment variable in Linux profile file.

Parameters:

envvar_name (str) – environment variable name (= key) to set
envvar_value (str) – environment variable value to set
scope (str, optional) – environment variable scope. Must be “user” or “system”, defaults to “user”. Defaults to “user”.

Returns:

True if environment variable correctly set or False if not

Return type:

bool