Использование .env
Файл .env - это текстовый файл, содержащий пары ключ-значение всех переменных окружения, требуемых вашим приложением.
Этот файл включен в ваш проект локально, но не сохраняется в системе управления версиями,
чтобы вы не подвергали риску потенциально конфиденциальную информацию.
# environment variables defined inside a .env file
GCP_PROJECT_ID=my-project-id
SERVICE_ACCOUNT_FILE=path/to/serviceAccountCredentials
STORAGE_BUCKET_NAME=my-super-important-data
DEBUG=True
TEMPLATE_DEBUG=True
SECRET_KEY=ARANDOMSECRETKEY
DATABASE_URL=mysql://myuser:mypassword@myhost/mydatabase
PERCENTILE=90%
#COMMENTED=42
Во всех языках есть модули которые работдают с файлами
Почти в каждом языке программирования есть пакет или библиотека,
которые можно использовать для чтения переменных окружения из файла .env,
а не из вашей локальной среды.
Для Python есть несколько:
Python-dotenv
Библиотека сторонная устанавливается стандартно:
pip install python-dotenv
Как только библиотека установлена, обычный вариант использования python-dotenv требует добавления в ваш проект всего двух строк кода.
import os
from dotenv import load_dotenv
load_dotenv()
GCP_PROJECT_ID = os.getenv('GCP_PROJECT_ID')
SERVICE_ACCOUNT_FILE = os.getenv('SERVICE_ACCOUNT_FILE')
STORAGE_BUCKET_NAME = os.getenv('STORAGE_BUCKET_NAME')
По умолчанию load_dotenv будет искать файл .env в текущем рабочем каталоге или любых родительских каталогах,
однако вы также можете указать путь, если ваш конкретный вариант использования требует, чтобы он хранился в другом месте.
from dotenv import load_dotenv
from pathlib import Path
dotenv_path = Path('path/to/.env')
load_dotenv(dotenv_path=dotenv_path)
Для большинства приложений это вся информация, которая вам должна понадобиться для продуктивной работы с python-dotenv, однако есть несколько дополнительных функций, о которых вы можете прочитать в документации [python-dotenv][python-dotenv].
Python-decouple
Библиотека так же является сторонеей, предварительно устанавливаем:
pip install python-decouple
Аналогично с предыдущей библиотекой код будет выглядить так:
from decouple import config
SECRET_KEY = config('SECRET_KEY')
DEBUG = config('DEBUG', default=False, cast=bool)
EMAIL_HOST = config('EMAIL_HOST', default='localhost')
EMAIL_PORT = config('EMAIL_PORT', default=25, cast=int)
ini files
Приятным дополнением Decouple является поддержкой не только .env, но и .ini файлов.
[settings]
DEBUG=True
TEMPLATE_DEBUG=%(DEBUG)s
SECRET_KEY=ARANDOMSECRETKEY
DATABASE_URL=mysql://myuser:mypassword@myhost/mydatabase
PERCENTILE=90%%
#COMMENTED=42
Примечание: Поскольку ConfigParser поддерживает интерполяцию строк, для представления символа % вам нужно экранировать его как %%.
Подробнее про все возможности Decouple можно узнать в ретозитории