note.nkmk.me

Pythonで環境変数を取得・追加・上書き・削除（os.environ）

Modified: | Tags: Python

Pythonのプログラムの中で環境変数を取得して確認したり、設定（追加・上書き）、削除したりするにはos.environを使う。環境変数の設定や削除による変更はそのPythonプログラムの中でのみ有効。システムの環境変数が書き換わるわけではない。

目次

osモジュールをインポートして使う。標準ライブラリなので追加のインストールは不要。ここでは環境変数による処理結果の違いを示す例のためにsubprocessモジュールもインポートしている。subprocessモジュールも標準ライブラリに含まれている。

import os
import subprocess
source: os_environ_getenv.py

os.environ

os.environの型はos._Environ。

print(type(os.environ))
# <class 'os._Environ'>
source: os_environ_getenv.py

os._Environはキーkeyと値valueが対になったマップ型で、辞書（dict）と同様のメソッドを持つ。環境変数名がkey、その値がvalueになっている。

os.environの内容はosモジュールをインポートした時点で読み込まれる。プログラムの実行中に他の手段でシステムの環境変数が変更されてもos.environの内容は更新されない。

print()で一覧が表示される（ここでは省略）。

# print(os.environ)
source: os_environ_getenv.py

辞書と同様にkeys()やvalues()などのメソッドを使ったり、inでキーや値の存在確認をしたりできる。

キー、値の処理も基本的には辞書と同じ。以下に例とともに示す。

環境変数を取得・確認

os.environ[]

os.environ[環境変数名]で環境変数の値を取得できるが、存在しない環境変数名を指定するとエラーKeyErrorになる。

print(os.environ['LANG'])
# ja_JP.UTF-8

# print(os.environ['NEW_KEY'])
# KeyError: 'NEW_KEY'
source: os_environ_getenv.py

os.environ.get()

os.environのget()メソッドを使うと、環境変数が存在しない場合にNoneまたは指定したデフォルト値を取得できる。これも辞書と同じ。

print(os.environ.get('LANG'))
# ja_JP.UTF-8

print(os.environ.get('NEW_KEY'))
# None

print(os.environ.get('NEW_KEY', 'default'))
# default
source: os_environ_getenv.py

os.getenv()

os.getenv()という関数も用意されている。

get()メソッドと同様、キーが存在しない場合はNoneまたは指定したデフォルト値を返す。環境変数の値を取得して確認するだけならこの関数が便利。

print(os.getenv('LANG'))
# ja_JP.UTF-8

print(os.getenv('NEW_KEY'))
# None

print(os.getenv('NEW_KEY', 'default'))
# default
source: os_environ_getenv.py

環境変数を設定（追加・上書き）

os.environ[環境変数名]に値を代入すると環境変数を設定できる。

新しい環境変数名を指定するとその環境変数が新たに追加され、既存の環境変数名を指定するとその環境変数の値が上書きされる。

os.environ['NEW_KEY'] = 'test'

print(os.environ['NEW_KEY'])
# test

os.environ['NEW_KEY'] = 'test2'

print(os.environ['NEW_KEY'])
# test2
source: os_environ_getenv.py

なお、冒頭に書いたように、環境変数の追加や上書きによる変更はそのPythonプログラムの中でのみ有効。システムの環境変数が書き換わるわけではない。

文字列以外を代入するとエラーTypeErrorになるので注意。数値を代入したい場合も文字列として指定する。

# os.environ['NEW_KEY'] = 100
# TypeError: str expected, not int

os.environ['NEW_KEY'] = '100'
source: os_environ_getenv.py

os.putenv()という関数も用意されているが、os.putenv()で設定した場合はos.environの値が更新されないため、上の例のようにos.environのキー（環境変数名）を指定して値を代入するほうが望ましいとのこと。

注釈: putenv() を直接呼び出しても os.environ の内容は変わらないので、 os.environ を直接変更する方が良いです。 os.environ — Python 3.11.4 ドキュメント

注意: OSによってはメモリリークの原因になる場合あり

OSによっては値の変更がメモリリークの原因になる場合があるので要注意。

注釈: FreeBSD と Mac OS X を含む一部のプラットフォームでは、 environ の値を変更するとメモリリークの原因になる場合があります。
os.environ — Python 3.11.4 ドキュメント

これはOS自体のputenv()の仕様によるもの。

Successive calls to setenv() or putenv() assigning a differently sized value to the same name will result in a memory leak. The FreeBSD semantics for these functions (namely, that the contents of value are copied and that old values remain accessible indefinitely) make this bug unavoidable. Mac OS X Manual Page For putenv(3)

環境変数を削除

環境変数を削除するにはos.environのpop()メソッドやdel文を使う。辞書と同じ。詳細は以下の記事を参照。

pop()の例。

pop()は削除した環境変数の値を返す。デフォルトでは存在しない環境変数を指定するとエラーKeyErrorになるが、第二引数を指定すると環境変数が存在しない場合にその値を返す。

os.environ['NEW_KEY'] = '100'

print(os.environ.pop('NEW_KEY'))
# 100

print(os.getenv('NEW_KEY'))
# None

# print(os.environ.pop('NEW_KEY'))
# KeyError: 'NEW_KEY'

print(os.environ.pop('NEW_KEY', None))
# None
source: os_environ_getenv.py

delの例。

環境変数が存在しない場合はエラーKeyError。

os.environ['NEW_KEY'] = '100'

del os.environ['NEW_KEY']

print(os.getenv('NEW_KEY'))
# None

# del os.environ['NEW_KEY']
# KeyError: 'NEW_KEY'
source: os_environ_getenv.py

os.unsetenv()という関数も用意されているが、os.putenv()と同様にos.unsetenv()で削除した場合はos.environの値が更新されないため、上の例のようにos.environのキー（環境変数名）を指定して削除するほうが望ましいとのこと。

os.environ のアイテムの削除を行うと、自動的に unsetenv() の対応する呼び出しに変換されます。直接 unsetenv() を呼び出した場合 os.environ は更新されないため、実際には os.environ のアイテムを削除する方が望ましい操作です。
os.unsetenv() — Python 3.11.4 ドキュメント

環境変数の削除についてもそのPythonプログラムの中でのみ有効。システムの環境変数が削除されるわけではない。

os.environによる環境変数変更の影響

繰り返し書いているようにos.environで環境変数を変更（設定・削除）してもシステムの環境変数が変更されるわけではないが、プログラム中で起動されるサブプロセスには影響を与える。

言語設定の環境変数LANGによって日時を表示するコマンドdateの結果が変わる例を示す。Windowsでは環境変数LANGがなくdateコマンドの内容も違うため以下のコードは期待通りに動作しないので注意。

subprocessモジュールでdateコマンドを呼び出している。

LANGの値によってdateの出力結果が変わる。

print(os.getenv('LANG'))
# ja_JP.UTF-8

print(subprocess.check_output('date', encoding='utf-8'))
# 2023年 7月 9日 日曜日 22時47分58秒 JST
# 

os.environ['LANG'] = 'en_US'

print(subprocess.check_output('date', encoding='utf-8'))
# Sun Jul  9 22:47:58 JST 2023
#
source: os_environ_getenv.py

なお、ここでは説明のためos.environで環境変数LANGを変更しているが、Pythonにはロケールを制御するlocaleモジュールが用意されている。localeモジュールの利用例は以下の記事を参照。

環境変数に応じた処理の切り替え

環境変数の値に応じて処理を切り替えることができる。

言語設定の環境変数LANGによって出力を変更する例を示す。ここでは文字列が指定した文字列で始まるかどうかを判定するstartswith()メソッドを使っているが、完全一致で判定したい場合は==で比較すればよい。

os.environ['LANG'] = 'ja_JP'

if os.getenv('LANG').startswith('ja'):
    print('こんにちは')
else:
    print('Hello')
# こんにちは

os.environ['LANG'] = 'en_US'

if os.getenv('LANG').startswith('ja'):
    print('こんにちは')
else:
    print('Hello')
# Hello
source: os_environ_getenv.py

そのほか、例えば開発環境と本番環境を示す環境変数が設定されている場合などはその値を取得して処理を切り替えたりできる。

関連カテゴリー

関連記事