| 1 |
name: environment |
| 2 |
returns: env |
| 3 |
since: 0.35.0 |
| 4 |
description: Returns an empty [[@env]] object. |
| 5 |
|
| 6 |
arg_flattening: false |
| 7 |
|
| 8 |
optargs: |
| 9 |
env: |
| 10 |
type: str | list[str] | dict[str] | dict[list[str]] |
| 11 |
since: 0.52.0 |
| 12 |
description: | |
| 13 |
If provided, each key/value pair is added into the [[@env]] object |
| 14 |
as if [[env.set]] method was called for each of them. |
| 15 |
Since *0.62.0* list of strings is allowed in dictionary values. In that |
| 16 |
case values are joined using the separator. |
| 17 |
|
| 18 |
kwargs: |
| 19 |
separator: |
| 20 |
type: str |
| 21 |
since: 0.62.0 |
| 22 |
description: | |
| 23 |
The separator to use for the initial values defined in |
| 24 |
the first positional argument. If not explicitly specified, the default |
| 25 |
path separator for the host operating system will be used, i.e. ';' for |
| 26 |
Windows and ':' for UNIX/POSIX systems. |
| 27 |
|
| 28 |
method: |
| 29 |
type: str |
| 30 |
since: 0.62.0 |
| 31 |
description: | |
| 32 |
Must be one of 'set', 'prepend', or 'append' |
| 33 |
(defaults to 'set'). Controls if initial values defined in the first |
| 34 |
positional argument are prepended, appended or replace the current value |
| 35 |
of the environment variable. |