Set environment variables from a .env file.
| PARAMETER |
DESCRIPTION |
path |
Path to a .env file, or to a directory containing such a file.
By default, this will fall back on ~ then ~/Documents.
TYPE:
str
DEFAULT:
'.'
|
name |
Name of the file, when path points to a directory.
By default, this will fall back on .Renviron.
TYPE:
str
DEFAULT:
'.env'
|
overwrite |
If True, overwrites existing environment variables with
the same name as those in the .env file.
TYPE:
bool
DEFAULT:
False
|
| RETURNS |
DESCRIPTION |
None
|
If a file is found, it will add contents to os.environ.
|
Examples:
Source code in src\receptiviti\readin_env.py
| def readin_env(path=".", name=".env", overwrite=False) -> None:
"""
Set environment variables from a .env file.
Args:
path (str): Path to a .env file, or to a directory containing such a file.
By default, this will fall back on `~` then `~/Documents`.
name (str): Name of the file, when `path` points to a directory.
By default, this will fall back on `.Renviron`.
overwrite (bool): If `True`, overwrites existing environment variables with
the same name as those in the .env file.
Returns:
If a file is found, it will add contents to `os.environ`.
Examples:
```python
receptiviti.readin_env()
```
"""
path = os.path.expanduser(path)
envpath = path if os.path.isfile(path) else path + "/" + name
if os.path.isfile(envpath):
ql = re.compile("^['\"]|['\"\\s]+$")
with open(envpath, encoding="utf-8") as file:
for line in file:
entry = line.split("=", 1)
if len(entry) == 2 and (overwrite or os.getenv(entry[0]) is None):
os.environ[entry[0]] = ql.sub("", entry[1])
elif name != ".Renviron":
readin_env(path, ".Renviron", overwrite)
elif os.path.isfile(os.path.expanduser("~/") + name):
readin_env("~", name, overwrite)
elif os.path.isfile(os.path.expanduser("~/Documents/") + name):
readin_env("~/Documents", name, overwrite)
|