[Django] django-environ を使用する際に、OSに設定されている環境変数名と全く同じ変数名の環境変数を.envに記載した場合にも、.envの値を読み取りたい

Question

そもそもできないんじゃないか、、、、とも思っていますが、誰かご存じかもしれないので念のため確認します。

やりたいこと

タイトルの通りです。

たとえば、OSにUSERという環境変数が設定されており、hogeだとします。
そして、.envファイルにもUSERという環境変数を設定し、そこにはuserという値を設定したとします。

このときに、userという値を読み取りたいです。
しかし、実際にはhogeという値しか読み取ることができませんでした。

ちなみにですが、OSに設定されていない環境変数であれば.envに設定した値を正しく読み取れることは確認できています。

あくまでも、OSと.envで重複する環境変数を設定している場合のみの問題になります。

試したこと

OSと.envどちらを優先させるかを指定するようなオプションがないか調べるため、公式ドキュメントでread_env()メソッドを調べてみましたが、それらしいオプションは見つかりませんでした。

https://django-environ.readthedocs.io/en/latest/index.html?highlight=read_env#environ.environ.Env.read_env

代替策を渋る理由

まぁ、

• 環境変数名変えたら？
• OSの環境変数消したら？

という話なのは薄々感じています。

感じてはいるんですが、複数のアプリケーション、複数種類のDBが動くOSにおいて、複数のアプリケーションの.env内で同じ環境変数名を使えたらいいな...というのが希望です。

（既に構築されていたアプリケーションがOSの環境変数を使っている模様...しかも、それがどのアプリケーションの環境変数なのかわからない.....

追記（2021/07/24）

こちらの記事に、python-dotenvであれば、OSの環境変数を上書きできるとの情報が載っていました。

https://maku77.github.io/python/env/dotenv.html

以下のようにして実施できるようです。

from dotenv import load_dotenv
load_dotenv(override=True)

これと同じことを、django-environで行いたいだけなので、おそらく何かしら方法はあるはず（ちょっと時間がないのでここまでの記載にとどめておきますが、後で調べる予定です）

Answer 1

回答としての結論

多分ですが、django-environを素直に利用する範囲においては、「USERを.envで上書きする」ことは難しい気がします。

理由：read_envの仕組み

read_envの内部でやっていることは、大まかに書くと次のとおりです。

• 指定された引数に基づいて、env_fileの読み込みを行い
• os.environで未使用なキーに対して、初期値を与える
• 更にoverridesの内容が存在した場合に、未使用なキーに対して初期値を与える

※django-environのソースより
※内部的にはcls.ENVIRONに対する処理ですが、Envクラスではos.environが指定されているので同じとみなします

重要なのはos.environ[key] = valueではなくos.environ.setdefault(key, value)としているところです。
この実装のため、Djangoアプリケーション実行までに用意されている環境変数は原則として上書き利用することは出来ません。

無理やりする例

一見スマートに見えそうな解決方法を試しに考えてはみました。
...があまり意味がないか、django-environが本質的にやりたいことを捻じ曲げてそうな気はします

django-environのread_envを書き換えたクラスを用意する

import os
from environ import Env

class MyEnv(Env):
    ENVIRON = {}

    @classmethod
    def read_env(cls, env_file=None, **overrides):
        super(MyEnv, cls).read_env()
        for k, v in os.environ.items():
            cls.ENVIRON.setdefault(k, v)

上記のように、「ENVIRONの管理をos.environではなく自前dictにする」「read_envないで後追いでos.environを取り込む」とすることで、.envの方を優先的に利用することが出来ます。
この実装だと、環境変数にあったとしても.envが優先されるため、ファイルの中身を利用可能です。

※問題点として、read_envの呼び出しが必須になります
※read_envをsuper経由ではなく「setdefaultを使わない版に再実装」でも問題ないです

Comments

[siruku6]

内部の実装にまで踏み込んだ回答をありがとうございます。

仮にできるとしても、非合理的な面のある方法になってしまうということ、把握しました。

素直に、djangoアプリケーションでもpython-dotenvも併用すればいいのではないかという気もしてきました。。

そもそも、OS上に大量に環境変数のある環境を使っているのが悪いのですが、、、、、
そこはどうしようもないというか、影響力を行使できないところなので、上手い方法を探っていきます。

Answer 2

個人的な意見ですが、共通する変数、つまり定数のようなもののみPCの環境変数にするのが良いと思います。

実際、APIキーや、DBの情報もろもろは定数化されないはずです。

つまりkey:valueとすると、一種類のkeyに複数種類のvalueが存在することになります。

よって、プロジェクトごとの.envをおすすめします。
gitで管理しないように注意すればいいです。

Comments

[siruku6]

ありがとうございます。
私も、理想的にはそのようにするのが望ましいと感じております。
新しく構築するアプリケーションの環境変数は、.envに記載するつもりでおります。

ただ残念ながら、既に構築されているいずれかのアプリケーションがOS上に環境変数を設定しており、その変数を使用しているアプリケーションがどれなのかわかりません。

そして、その、OSに設定されているのと同じ名前の環境変数を.envに記載して使いたいのです。
django-environにおいて、それを実現する方法はないのでしょうか、というのがこの質問の趣旨になります。