設定ファイルを考えてみよう

環境変数を利用する

設定情報を環境変数に設定しておくと柔軟なプログラムを書くことができます。

例えば次のようなときなどです...

パスワードやアクセストークンをハードコーディングしたくない

本番環境と開発環境をうまく切り替えたい

Linux系プラットフォームで、シェルの環境変数として MAIL_PASSWORD を設定したとします。

code: bash

export MAIL_PASSWORD='MY_SECRET_PASSWORD'

これを python から次のように設定された値を取得することができます。

code: sample.py

import os

mail_password = os.environ.get("MAIL_PASSWORD", None)

ただし、設定する環境変数の数が多くなってくると、シェル側でファイルにしておき、

code: bash

source $HOME/my_env.sh

python sample.py

python-dotenv を使った環境変数の読み込み

python-dotenv がインストールされていれば、環境変数を設定を自動化することができます。

まず python-dotenv をインストールしておきましょう。

code: bash

$ pip install python-dotenv

code: python

import os

from dotenv import load_dotenv

load_dotenv(verbose=True)

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

load_dotenv(dotenv_path)

python 側のコードはすこし増えますが、毎回シェル側のコマンドを実行する必要がなくなります。

python-dotenv の利用例

あるサービスを提供するようなプログラムでは、開発環境と本番環境と区別したいけれど、

コードの修正は可能なかぎり避けたいというようなことがあります。

こうしたときに、python-dotenv が便利になります。

次のコードはLinuxの systemd で起動されるWebサービスの一例です。

code: bash

Description=regist_sshpubkey daemon

Requires=regist_sshpubkey.socket

After=network.target

PIDFile=/run/gunicorn/pid

Usder=webapp

Group=webapp

RuntimeDirectory=gunicorn

WorkingDirectory=/var/webapp/projects/regist_sshpubkey/

ExecStart=/var/webapp/projects/regist_sshpubkey/RUN_APP.sh

ExecReload=/bin/kill -s HUP $MAINPID

ExecStop=/bin/kill -s TERM $MAINPID

PrivateTmp=true

WantedBy=multi-user.target

code: bash

MYHOST=$( hostname -s )

CONDADIR=/opt/anaconda3

BASEDIR=$( dirname $0 )

APP_HOME=/var/webapp

CONDAENV=${APP_HOME}/.conda/envs/webapp

. "${CONDADIR}/etc/profile.d/conda.sh"

else

export PATH="${CONDADIR}/bin:$PATH"

fi

conda activate ${CONDAENV} && {

case "${MYHOST}" in

useradm|user_adm)

cp ${BASEDIR}/dot.env.production ${BASEDIR}/.env

;;

*)

cp ${BASEDIR}/dot.env.debug ${BASEDIR}/.env

;;

esac

source ${BASEDIR}/.env

GUNICORN=$( which gunicorn)

exec ${GUNICORN} app:app -b ${APP_HOST}:${APP_PORT} \

--config ${BASEDIR}/scripts/gunicorn_config.py

}

切り替えています。

pydantic を使った環境変数の読み込み

シェルの環境変数から情報を読み込むと、設定情報を文字列として取得できます。

これでも良いのですが、整数や浮動小数点として扱いたいときはどこかで変換する必要がでてきます。

こうしたときは、pydantic を使うとデフォルト値をセットしたり、指定した型に変換してくれます。また、 python-dotenv がインストールされていれば、環境変数から読み取ってくれます。

まず pydantic をインストールしておきましょう。

code: bash

$ pip install pydantic

実際にコードを見てみましょう。

code: baseconfig.py

import os

import pydantic

basedir = os.path.abspath(os.path.dirname(__file__))

class BaseSettings(pydantic.BaseSettings):

class Config:

env_prefix = ""

env_file = "myapp.env"

env_file_encoding = "utf-8"

use_enum_values = True

code: config.py

from baseconfig import basedir, BaseSettings

from typing import Optional

class MAILSettings(BaseSettings):

MAIL_SERVER: str = "smtp.gmail.com"

MAIL_PORT: int = 587

MAIL_USE_TLS: bool = True

MAIL_USE_SSL: bool = False

# for debug

MAIL_DEBUG: bool = False

MAIL_SUPPRESS_SEND: bool = False

使うときは、次のようにします。

code: python

...: from config import MAILSettings

...:

...: conf = MAILSettings()

...: print(conf.MAIL_PORT)

...: print(type(conf.MAIL_PORT))

587

<class 'int'>

参照するときも、クラス変数にアクセスするだけなので簡単ですね。

python 標準モジュール typing にはいろいろな型のタイプヒントを提供しています。

code: python

from pydantic_choices import choice