Python プロジェクトに取り組んだことがあるなら、おそらく設定を提供するためのさまざまな方法に遭遇したことがあるでしょう。ここではすべての方法を説明するつもりはありませんが、いくつか例を挙げます。

• .ini ファイルの使用
• Pythonクラスを使用する
• .env ファイルの使用
• JSONまたはXMLファイルを使用する
• yamlファイルを使用する

私は通常、yaml 構成で作業することを好みます。これは非常に便利で使いやすいと思うからです。また、yaml ファイルは docker-compose 構成などでも使用されるため、ほとんどの人が使い慣れているものであることも気に入っています。

yaml 解析にはPyYAML Python ライブラリを使用します。

この記事では、yaml ファイルのケースについて説明し、具体的には、パスワード、ホスト、ユーザー名などの秘密をそのファイルに直接保存しないようにするにはどうすればよいかについて説明します。

次のような非常に単純な yaml ファイル構成の例があるとします。

database:
 name: database_name
 user: me
 password: very_secret_and_complex
 host: localhost
 port: 5432
ws:
 user: username
 password: very_secret_and_complex_too
 host: localhost

PyYAML が環境変数を解決できるようにするには、主に次の 3 つのものが必要です。

• 環境変数を識別するための正規表現パターン、例：pattern = re.compile(‘.*?\${(\w+)}.*?’)
• 解析する環境変数 (または複数の環境変数) があることを示すタグ (例: ) !ENV。
• そして、ローダーが環境変数を解決するために使用する関数

環境変数を使用した YAML 構成の例:

database:
 name: database_name
 user: !ENV ${DB_USER}
 password: !ENV ${DB_PASS}
 host: !ENV ${DB_HOST}
 port: 5432
ws:
 user: !ENV ${WS_USER}
 password: !ENV ${WS_PASS}
 host: !ENV ‘https://${CURR_ENV}.ws.com.local'

ws:
 user: !ENV ${WS_USER}
 password: !ENV ${WS_PASS}
 host: !ENV 'https://${CURR_ENV}.ws.com.${MODE}'  # multiple env var

まず環境変数を設定します。たとえば、次のようになりますDB_PASS:

export DB_PASS=very_secret_and_complex

read -s ‘Database password: ‘ db_pass
export DB_PASS=$db_pass
    
      

python use_env_variables_in_config_example.py -c /path/to/yaml

コード内で、conf を使用して操作を行います。たとえば、次のようにしてデータベース パスワードにアクセスします。conf['database']['DB_PASS']

これがお役に立てば幸いです。ご意見、ご質問、訂正、ご提案などありましたら、ぜひお聞かせください :)

便利なリンク