venv_management.environment module

Summary

Functions:

preferred_drivers	The preferred drivers from optionally controlled by VENV_MANAGEMENT_PREFERRED_DRIVERS.
preferred_shell	The preferred shell from the VENV_MANAGEMENT_SHELL environment variable.
shell_is_interactive	True if the shell has been set to interactive.

Reference

venv_management.environment.preferred_shell(preferred_shell_name)

The preferred shell from the VENV_MANAGEMENT_SHELL environment variable.

Parameters

preferred_shell_name – The name of the preferred shell to use if the environment variable VENV_MANAGEMENT_SHELL is not set.

Returns

The name of the preferred shell.

venv_management.environment.shell_is_interactive()

True if the shell has been set to interactive.

Control the setting with the VENV_MANAGEMENT_INTERACTIVE_SHELL environment variable by setting it to ‘yes’ or ‘no’.

Returns

True if the shell is interactive, otherwise False.

venv_management.environment.preferred_drivers(available_driver_names)

The preferred drivers from optionally controlled by VENV_MANAGEMENT_PREFERRED_DRIVERS.

Parameters

available_driver_names – A list of available driver names.

Returns

A list of available driver names, with the preferred drivers first.