djnago-environにおける環境変数の取り扱い方法について

Question

djnago-environについてQiita記事を参照していましたら、「env = environ.Env()を行った段階でenvに文字列リテラルを渡す事でホスト側の環境変数が取得可能」との記述がありました。
しかし、英語に慣れていないのもあり、GitHubや公式ドキュメントを探しても、このようなことがどの部分に記載されているのかが、分かりませんでした。
今後、こういったライブラリのドキュメントを読み込む際の参考にもしたいと考えている為、ドキュメントに詳細に記載されている場所がありましたら教えて頂けましたら幸いです。

Answer 1

質問自体に対する回答

強いて上げるとすれば、「Feature Support」というセクションにある以下の説明が該当するかな？と思います。

Fill os.environ with .env file variables

※雑な翻訳: os.environ に .envファイルの中身を詰める

これを「read_envなどで読み込む前からos.environ相当にEnvからアクセスできる」と考えれば、一応理屈に合うかなと思います。

補足: コードとしての実態

以下は、実際にdjango-environの挙動を今回の質問に関する部分に絞って追ったものです。

django-environのような単機能ライブラリだと、ソースを読むのも一つの手かなと思うので、
ドキュメントの記載確認をする以外の選択肢として捉えてもらえれば。

django-environのEnvクラス

django-environのEnvクラスはここで定義されています。

※以下、ソースから回答としてピックアップする主要な箇所のみを抜粋

import os

## 略

class Env(object):
    ## 略 
    ENVIRON = os.environ

    def bool(self, var, default=NOTSET):
        """
        :rtype: bool
        """
        return self.get_value(var, cast=bool, default=default)

    def get_value(self, var, cast=None, default=NOTSET, parse_default=False):
        ## 略
        try:
            value = self.ENVIRON[var]
        except KeyError:
            if default is self.NOTSET:
                error_msg = "Set the {0} environment variable".format(var)
                raise ImproperlyConfigured(error_msg)

            value = default
        ## 略
        return value

実際の利用における動き

django-environで通常取得に使うメソッドは全部get_valueを内部利用しているのですが、
ここで参照しているのはself.ENVIRONというプロパティです。

このプロパティはクラス変数となっており、Envクラスの定義を読むタイミングで環境変数の辞書であるos.environがセットされています。

そのため、environ.Env()などのようにインスタンスを生成した時点で、もともとの環境変数を参照可能になっています。

Comments

[ruuuu]

ご回答ありがとうございます。
>ソースを読むのも一つの手かなと思うので、
ドキュメントの記載確認をする以外の選択肢として捉えてもらえれば。
こちらですが、ライブラリのコードは難しく感じることが多く、把握が難しいことから、あまりソースから読み取るということは選択肢にいれていなかったのですが、ドキュメントのみではなくソースから理解をするという部分もきちんと理解する為には、必要にはなってきますよね...