Современные профессии Онлайн-интенсив 26.09 в 18:00 мск
Выберите профессию будущего в ИТ, дизайне, маркетинге и управлении проектами
Кнопка закрыть топ-бар
ГлавнаяБлогPython переменные окружения: виды и способы использования
Python переменные окружения
9 538
Время чтения: 15 минут

Python переменные окружения: виды и способы использования

9 538
Время чтения: 15 минут
Сохранить статью:
Сохранить статью:
В статье рассказывается: 
  1. Определение переменных окружения в Python
  2. Виды переменных окружения Python
  3. Работа с переменными окружения Python
  4. Работа с библиотекой python-dotenv

Переменные окружения Python необходимы для изменения настроек системы. Кроме этого, многие программы, написанные на данном языке, корректно работают только при правильном значении переменных среды. Если эти значения изменятся, скрипт перестанет работать задуманным образом, и его нужно будет отладить.

Не менее значимая функция переменных окружения – это использование их для хранения закрытых данных, таких как токены, пароли, IP-ключи и т. д. В нашем материале мы расскажем более подробно о задачах переменных среды и покажем, как с ними можно работать.

Определение переменных окружения в Python

Переменная, чье значение присваивается Python извне, называют переменной окружения. Как правило, ее устанавливают в командной строке перед тем, как обратиться к исполняемому файлу Python. После этого ОС позволяет программе Python получать доступ к такой переменной.

Переменные окружения в Python необходимы для гибкости программы. Благодаря им, пользователь получает возможность менять нужные параметры перед выполнением программы. Программа же, в свою очередь, может просматривать изменяемые параметры, динамически подстраивая свое поведение. Т.е. нет необходимости модифицировать код. Такое применение переменных окружения будет называться настройкой программы.

Определение переменных окружения в Python
Определение переменных окружения в Python

Алгоритм, по которому проходит установка переменных окружения, напрямую зависит от платформы. Поэтому следует использовать встроенный модуль OS компании Python для считывания переменных. Функции этого модуля позволяют взаимодействовать с операционной системой вне зависимости от ее платформы.

Для доступа к таким переменным в Python используется объект os.environ — это словарь, в котором хранятся все переменные окружения программы.

Имейте в виду, что объект os.environ фиксируется при загрузке модуля OS на Python. И если вы будете изменять переменные окружения после этого, то изменения не отобразятся os.environ (например, при экспорте новой переменной окружения в терминальный эмулятор).

Виды переменных окружения Python

  • PYTHONHOME

Меняет местоположение стандартных библиотек Python. Изначально они находятся в prefix/lib/pythonversion и exec_prefix/lib/pythonversion, где prefix и exec_prefix — каталоги, которые зависят от установки, оба по умолчанию — /usr/local.

Если для этой переменной окружения задан один каталог, то его значение может заменить prefix или exec_prefix. Для указания разных значений установите PYTHONHOME на prefix:exec_prefix.

  • PYTHONPATH

По умолчанию изменяет путь поиска для файлов модулей. Имеет такой же формат, как и для оболочки PATH — т. е. один или более путей каталога, разделяемых os.pathsep (например, знак «:» в Unix или «;» в Windows). Происходит автоматическое игнорирование несуществующих каталогов.

Дополнительный каталог указывается в пути поиска перед PYTHONPATH, как было рассмотрено выше в пункте «Интерфейсные опции». При необходимости изменения пути поиска нужно обратиться к переменной sys.path в программе Python.

  • PYTHONSTARTUP

Если эта переменная является именем файла, то Python-команды в этом файле будут выполняться до первого приглашения в интерактивном режиме. Файл и интерактивные команды выполняются в одном пространстве имен. Поэтому и определенные, и импортированные в этом пространстве объекты могут быть использованы без квалификации в интерактивном сеансе. Также можно изменять подсказки в этом файле sys.ps1 и sys.ps2 и хук sys.__interactivehook__.

  • PYTHONOPTIMIZE

Если в этой переменной окружения задана непустая строка, то это равнозначно указанию параметра -О. Если же задано целое число, то это равносильно -ОО.

  • PYTHONBREAKPOINT

Если эта переменная окружения Python установлена, то она определяет вызываемый объект, применяя нотацию пути с точками. Модуль с вызываемым объектом импортируется, далее непосредственно сам вызываемый объект будет запущен реализацией по умолчанию sys.breakpointhook(), вызываемая, в свою очередь, встроенной функцией breakpoint().

Если PYTHONBREAKPOINT не задана или установлена пустая строка, то это равносильно значению «pdb.set_trace». Если установить такое значения в строку «0», то это приведет к действию немедленного возврата со стороны реализации по умолчанию sys.breakpointhook().

  • PYTHONDEBUG

Если для этой переменной в качестве значения указана непустая строка, то это равносильно указанию параметра -d. Если же указано целое число, то это равнозначно -dd.

  • PYTHONINSPECT

Если значение переменной указано, как пустая строка, то это равносильно значению параметра -i.

Переменную окружения PYTHONINSPECT можно изменить кодом Python с применением os.environ для принудительного проверочного режима по окончанию работы программы.

  • PYTHONUNBUFFERED

Если в качестве значения этой переменной окружения Python задана непустая строка, то это равносильно указанию параметра -u.

  • PYTHONVERBOSE

Если для нее задается значение непустой строки, то это равнозначно указанию параметра -v. Если устанавливается целое число, то это равнозначно -vv.

  • PYTHONCASEOK

При установленном значении этой переменной Python пренебрегает регистром в операторах import. Это будет работать только в OS X и Windows.

  • PYTHONDONTWRITEBYTECODE

Если в качестве значения этой переменной установлена непустая строка, то это равнозначно указанию параметра -В. Т.е. Python не станет писать файлы.рус.

  • PYTHONPYCACHEPREFIX

Если для переменной значение установлено, то это равносильно указанию параметру -Х pycache_prefix=PATH. Т.е. Python осуществит запись фалов.рус не в каталогах __pycache__ в исходном дереве, а в зеркальном дереве каталогов по этому пути.

ТОП-30 IT-профессий
2022 года с доходом
от 200 000 ₽
Команда GeekBrains совместно с международными специалистами по развитию карьеры подготовили материалы, которые помогут вам начать путь к профессии мечты.
Подборка содержит только самые востребованные и высокооплачиваемые специальности и направления в IT-сфере. 86% наших учеников с помощью данных материалов определились с карьерной целью на ближайшее будущее!

Скачивайте и используйте уже сегодня:

Александр Сагун
Александр Сагун
Исполнительный
директор Geekbrains
pdf иконка

Топ-30 самых востребованных и высокооплачиваемых профессий 2022

Поможет разобраться в актуальной ситуации на рынке труда

doc иконка

Подборка 50+ ресурсов об IT-сфере

Только лучшие телеграм-каналы, каналы Youtube, подкасты, форумы и многое другое для того, чтобы узнавать новое про IT

pdf иконка

ТОП 50+ сервисов и приложений от Geekbrains

Безопасные и надежные программы для работы в наши дни

pdf 3,7mb
doc 1,7mb
Уже скачали 14799 pdf иконка
  • PYTHONHASHSEED

В случае, когда значение такой переменной определено, как random, или же она не установлена, то применяется случайное значение для заполнения хэшей объектов.

Если для значения переменной указано целое число, то оно используется, как неизменное начальное число для генерации hash() типов, включенных в процесс рандомизации хэша.

Главной целью является разрешение повторяемого хеширования (например, для самопроверки интерпретатора). А также допуск к совместному использованию хеш-значений кластером процессов Python.

  • PYTHONIOENCODING

Если эта переменная окружения установлена до начала запуска интерпретатора, то она заменяет кодировку, которую используют в stdin/stdout/stderr, в синтаксисе encodingname:errorhandler. И encodingname, и :errorhandler являются необязательными и содержат то же значение, что и str.encode().

Stderr пренебрегает частью :errorhandler. Обработчик всегда будет ‘backslashreplace’.

  • PYTHONNOUSERSITE

Если значение этой переменной задано, то Python не будет добавлять каталог пользователя site-packages в sys.path.

  • PYTHONUSERBASE

Данная переменная задает базовый пользовательский каталог, который применяют при вычислении пути установки Distutils для python setup.py install —user и пути пользовательской директории site-packages.

  • PYTHONEXECUTABLE

Если значение этой переменной задано, то для sys.argv[0] будет установлено её значение вместо значения, полученного через среду выполнения C. Работает только в Mac OS X.

Только до 29.09
Как за 3 часа
разбираться в IT
лучше, чем 90%
новичков и выйти на
доход в 200 000 ₽?
Приглашаем вас на бесплатный онлайн-интенсив «Путь в IT»! За несколько часов эксперты GeekBrains разберутся, как устроена сфера информационных технологий, как в нее попасть и развиваться.
Александр Волчек CEO GeekBrains

Интенсив «Путь в IT» поможет:

  • За 3 часа разбираться в IT лучше, чем 90% новичков.
  • Понять, что действительно ждет IT-индустрию в ближайшие 10 лет.
  • Узнать как по шагам c нуля выйти на доход в 200 000 ₽ в IT.
При регистрации вы получите в подарок:
pdf иконка

«Колесо компетенций»

Тест, в котором вы оцениваете свои качества и узнаете, какая профессия в IT подходит именно вам

doc иконка

«Критические ошибки, которые могут разрушить карьеру»

Собрали 7 типичных ошибок, четвертую должен знать каждый!

pdf иконка

Тест "Есть ли у вас синдром самозванца?"

Мини-тест из 11 вопросов поможет вам увидеть своего внутреннего критика

Хотите сделать первый шаг и погрузиться в мир информационных технологий? Регистрируйтесь и смотрите интенсив:
Только до 29 сентября
Осталось 17 мест
  • PYTHONWARNINGS

Эта переменная равнозначна опции -W. Если значение указано в виде строки, разделенной запятыми, то это равносильно многократному указанию -W. При этом фильтры, которые были расположены в списке позже, будут иметь преимущество над фильтрами, расположенными в списке ранее.

  • PYTHONFAULTHANDLER

В случае, когда для такой переменной задается непустая строка, то при запуске будет вызван faulthandler.enable(): установить обработчик для сигналов SIGSEGV, SIGFPE, SIGABRT, SIGBUS и SIGILL для дампа трассировки Python. Это равнозначно опции —X faulthandler.

  • PYTHONTRACEMALLOC

При определении этой переменной непустой строкой начинается отслеживание выделения памяти Python с использованием модуля tracemalloc. Значением переменной будет являться наибольшее количество фреймов, сохраняемых в обратной трассировке trace.

  • PYTHONPROFILEIMPORTTIME

Когда значение этой переменной — непустая строка, то Python укажет количество времени, занимаемое каждым импортом. Это полностью соответствует настройке —X importtime в командной строке.

  • PYTHONASYNCIODEBUG

Когда для такой переменной окружения задается непустая строка, то происходит включение режима отладки модуля asyncio.

  • PYTHONMALLOC

Эта переменная задает распределители памяти Python и/или устанавливает отладочные хуки.

  • PYTHONMALLOCSTATS

При установке непустой строки для этой переменной Python осуществит печать статистики pymalloc распределителя памяти. Причем это будет происходить каждый раз, когда создаётся новая объектная арена pymalloc, а также при завершении работы.

Эта переменная будет проигнорирована, если PYTHONMALLOC применяется для принудительного использования распределителя malloc() библиотеки C, или если Python был настроен без поддержки pymalloc.

  • PYTHONLEGACYWINDOWSFSENCODING

Если для значения этой переменной задана непустая строка, то режим ошибок и кодировка файловой системы по умолчанию откатятся до значений в версии 3.6 «replace» и «mbcs» соответственно. В ином случае будут использованы значения по умолчанию «surrogatepass» и «utf-8».

  • PYTHONLEGACYWINDOWSSTDIO

При для переменной используется непустая строка, то новые средства чтения и записи консоли не будут применены. Т.е. символы Юникод будут кодироваться согласно активной кодовой странице консоли, а не с использованием utf-8.

Переменная будет проигнорирована, если стандартные потоки перенаправляются (в каналы или файлы), а не ссылаются на буферы консоли.

  • PYTHONCOERCECLOCALE

Если в качестве значения переменной указывается «0», то основное приложение командной строки Python будет пропускать приведение устаревших локалей C и POSIX на основе ASCII к более действенной альтернативе на основе UTF-8.

Если значение переменной не установлено (или не равно «0»), то переменная окружения переопределения локали LC_ALL тоже не устанавливается, а текущая локаль, указанная для категории LC_CTYPE, является либо локалью по умолчанию C, либо явно ASCII-основанной локали POSIX, то Python CLI будет пытаться настроить следующие локали для категории LC_CTYPE в порядке, который был указан перед загрузкой среды выполнения интерпретатора.

Для целей отладки установка PYTHONCOERCECLOCALE=warn даст результат, при котором Python будет выдавать предупреждающие сообщения на stderr, если будет активировано принуждение локали, или если языковой стандарт, вызывающий приведение, всё ещё активен при инициализации среды выполнения Python.

  • PYTHONDEVMODE

Когда для такой переменной задается непустая строка, то активируется «режим разработки» Python. (См. опцию -X dev)

  • PYTHONUTF8

Если для этой переменной задано значение «1», то это активирует режим интерпретатора UTF-8, где UTF-8 применяется, как кодировка текста для интерфейсов системы, независимо от текущей настройки локали.

Если задано значение «0», то интерпретатор будет работать в режиме с учётом локали по умолчанию.

Установка любой другой непустой строки будет вызывать ошибку при инициализации интерпретатора.

Работа с переменными окружения Python

  • Считывание одной/всех переменных окружения

Код, указанный ниже, помогает прочесть и вывести одну конкретную или же все переменные окружения. Для того чтобы сделать вывод имен и значений всех переменных, применяют цикл FOR. Далее выводится значение переменной HOME.

# Импортируем модуль os
import os
# Создаём цикл, чтобы вывести все переменные среды
print(«The keys and values of all environment variables:»)
for key in os.environ:
print(key, ‘=>’, os.environ[key])
# Выводим значение одной переменной
print(«The value of HOME is: «, os.environ[‘HOME’])

Если выполнить этот скрипт, то можно увидеть следующее: сначала был получен перечень всех переменных окружения, а потом — значение переменной HOME.

Считывание одной/всех переменных окружения
Считывание одной/всех переменных окружения
  • Проверка присвоения переменной окружения ее значения

Для проверки переменных создадим Python-файл с нижеуказанным скриптом. Модуль OS будем использовать для чтения значений переменных. Модуль SYS – для завершения работы приложения.

Бесконечный цикл while будет без остановки принимать имена переменных от пользователя. Также цикл будет проверять их значения до того момента, как пользователь не введет имя такой переменной, значение для которой не присвоено.

Если пользователь вводит имя переменной окружения с указанным значением, то это значение будет выведено. В противном случае — будет выведено сообщение об ошибке, и процесс прервется.

# Импортируем модуль os
import os
# Импортируем модуль sys
import sys
while True:
# Принимаем имя переменной среды
key_value = input(«Enter the key of the environment variable:»)
# Проверяем, инициализирована ли переменная
try:
if os.environ[key_value]:
print(«The value of», key_value, » is «, os.environ[key_value])
# Если переменной не присвоено значение, то ошибка
except KeyError:
print(key_value, ‘environment variable is not set.’)
# Завершаем процесс выполнения скрипта
sys.exit(1)

Итог работы скрипта можно увидеть на скрине. В первом случае вводилось имя переменной с определенным значением. Во втором — имя переменной с неустановленным значением. Согласно результату, переменная HOME была определена, и ее значение появилось в консоли. Для переменной API_KEY значение не указывалось, поэтому скрипт вывел сообщение и прекратил работу.

Проверка присвоения переменной окружения ее значения
Проверка присвоения переменной окружения ее значения
  • Проверка переменной на истинность

Создадим файл в Python с нижеуказанным кодом. Чтобы проверить переменную DEBUG на истину, используем функцию get(). В соответствии со значениями переменной программа будет выводить различные сообщения.

# Импортируем модуль os
import os
# Проверяем значение переменной среды
if os.environ.get(‘DEBUG’) == ‘True’:
print(‘Debug mode is on’)
else:
print(‘Debug mode is off’)

При значении переменной DEBUG – False, итог работы кода будет соответствовать скрину. Используя функцию setdefault, можно менять значение переменной.

Проверка переменной на истинность
Проверка переменной на истинность
  • Наделение переменной окружения значением

Чтобы любой переменной окружения присвоить значение, используют функцию setdefault().

Создадим код, изменяющий значение переменной DEBUG на True (по умолчанию установлено False), применяя функцию setdefault(). После присвоения значения осуществим проверку функцией get().

При верном написании кода появится сообщение «Режим отладки включен». При ошибочном – «Режим отладки выключен».

# Импортируем модуль os
import os
# Задаём значение переменной DEBUG
os.environ.setdefault(‘DEBUG’, ‘True’)
# Проверяем значение переменной
if os.environ.get(‘DEBUG’) == ‘True’:
print(‘Debug mode is on’)
else:
print(‘Debug mode is off’)

На скрине ниже показан результат: переменной DEBUG было задано значение True, поэтому появилось сообщение «Режим отладки включен».

Наделение переменной окружения значением
Наделение переменной окружения значением

Работа с библиотекой python-dotenv

Пакет python-dotenv предназначен для того, чтобы при новом запуске терминала не тратить время на внесение переменных окружения вручную. Становится возможным загружать их из файла .env в корневом каталоге приложения.

Установим пакет:

pip install python-dotenv

Создадим файл .env с теми переменными окружения, которые нужны нашему приложению. Помните, что .env-файл не нужно хранить в системе контроля версий, добавьте его в .gitignore.

import os

from dotenv import load_dotenv

dotenv_path = os.path.join(os.path.dirname(__file__), ‘.env’)

if os.path.exists(dotenv_path):

load_dotenv(dotenv_path)

Такой файл .env можно применять для всех переменных конфигурации, но для переменных окружения FLASK_APP и FLASK_DEBUG использовать его нельзя. Дело в том, что без этих переменных не обойтись уже в начале загрузки приложения.

Итак, теперь вы понимаете, с какой целью используются и как применяются переменные окружения Python.

Оцените статью
Рейтинг: 5
( голосов 1 )
Поделиться статьей
Добавить комментарий

Забрать
гарантированный
подарок

Получите бесплатно подборку файлов от GeekBrains:

Осталось 17 мест

Поздравляем! Вы выиграли 2-х дневный интенсив "Путь в IT". Чтобы закрепить подарок и получить к нему доступ, заполните информацию в открывшемся окне

×
Петр Озеров
Петр Озеров печатает ...