configparserから設定を取得する時のルール

Question

前提条件

業務で購買データを分析するツールの作成をしております。
ツールの仕様と致しましては、入力画面より「商品名・期間」などを入力すると、
SQLで取得した購買データを元に分析した結果を表示するというものです。

またツールはFlaskで作成します。

悩んでいる部分

この処理の中で、データベースを叩く部分はdatabaseのクラスに持たせたいと思っています。

※ソースコードは所々改変しています。

request_data = {
    "id":request.form["login_id"],
    "password":rewuest.form["login_password"],
    "goods_name":request.form["goods_name"],
    "date_start":request.form["date_start"] + " 00:00:00",
    "date_end":request.form["date_end"] + " 00:00:00",
}

db_manager = TeradataConect(request_data,CONFIG_PATH)

入力フォームのデータとコンフィグのパスを指定してオブジェクト化します。

このときに、configデータの読み込み方と、命名規則に関して悩んでいます。

変数宣言

1. クラス変数で読み込むべきか
2. インスタンス変数で読み込むべきか

また、ドライバやDBの情報のため、書き換えを行わないので大文字で宣言すべきかで悩んでいます。

今は下記のようにデータベースへの接続情報といった、他の関数で使用する部分のみを
インスタンス変数、かつ大文字表記で宣言する形にしています。

configparserを使った開発でのルールや規則などがございましたらご教授頂けますと幸いです。
以上より、よろしくお願い致します。

class DatabaseConect:
    def __init__(self,request_data,config_path):
        inifile = configparser.ConfigParser()
        inifile.read(config_path, 'UTF-8')

        # config read
        DRIVER = inifile.get('odbc', 'driver')
        CHARACTER_SET = inifile.get('odbc', 'character_set')

        #sql folder read
        MAIN_SQL_FOLDER_PATH = inifile.get('folder_path', 'main_sql')
        INIT_TABLE_SQL_FOLDER_PATH = inifile.get('folder_path', 'init_table_sql')

        # input setting
        self.CONNECT_INFO = "DRIVER="+DRIVER+";CharacterSet="+CHARACTER_SET

　　　　（省略）

Answer 1

ルールや規則ではなく単なるコツなんですが、各セクションをまとめて関数なりクラスなりの名前付き引数に直接渡せるように、設定ファイルの方を上手く設計するとコードがスッキリします。

from configparser import ConfigParser

inifile = """\
[database]
driver = foo
charset = bar
"""

config = ConfigParser()
config.read_string(inifile)

print("DRIVER={driver};CharacterSet={charset}".format(**config["database"]))
# -> 'DRIVER=foo;CharacterSet=bar'

Comments

[shake123]

YouheiSakurai様
ご回答頂きありがとうございます。

回答の方をまとめさせて頂きますと、現行クラスの設計方法ではなく、
config側を工夫するということですね。

そもそもクラス変数やインスタンス変数などに逐一再代入するのではなく、
configとして受け取り、**config["database"]のように使うのですね。
(現状だとinit部分でself.configとして受け取るのが正しいかな・・・)

設計思想の部分が疎いので勉強になりました！
ありがとうございます！

[YouheiSakurai]

__init__(self, driver, charset)みたいにしておいてインスタンスを作るときに「クラス(**config["database"])」みたいにすると再代入地獄を上手く避けられるのでオススメです。

[shake123]

あ、なるほど！
確かにその形式だと綺麗で見通しが良いですね！

ご丁寧にお答え頂きありがとうございました。