基本設定を指定したclassを継承して、設定の上書きと従属変数の自動更新を実現したい

Question

実現したいこと

テスト環境と本番環境など、実行状況に応じてファイルの保存先を変更したいと思っており（例えば、テスト環境とデフォルト環境で保存フォルダを変えたい）、classと継承を使って実装しようと思っています。

このとき、file_pathはsave_directoryに従属して決まるので、save_directoryが更新されたら自動的にfile_pathも更新したいと思っています。下の例で言えば、testconfig.file_pathが自動的にtest/result.txtになるようにしたいのですが、どのように実装したらいいでしょうか？

この方法に限らず、そもそもこういう方法を使った方がいい、というアドバイスでも助かります！

該当のソースコード

from dataclasses import dataclass

@dataclass
class BaseConfig():
    save_directory = 'default'
    file_path = Path(save_directory, 'result.txt')

class TestConfig(BaseConfig):
    save_directory = 'test'


testconfig = TestConfig()
print(testconfig.save_directory)  # 'test’であり想定通り
print(testconfig.file_path) # default/result.txtとなるが、本当はtest/result.txtになってほしい。

Answer 1

「プロパティ」として処理を定義すると受け取ることができるかと思います。

from dataclasses import dataclass

@dataclass
class BaseConfig():
    save_directory: str = 'default'
    # ↓「プロパティ」として処理を追加
    @property
    def file_path(self):
        return Path(save_directory, 'result.txt')

# ↓dataclassアノテーション追加
@dataclass
class TestConfig(BaseConfig):
    save_directory: str = 'test'

testconfig = TestConfig()
print(testconfig.save_directory)  # 'test’であり想定通り
print(testconfig.file_path)

Comments

[MagMag]

ありがとうございます！ただ、実際はsave_directoryに従属するファイル名が10以上ある状態です（シンプルに質問書いたつもりですが、要件が正確でなく恐縮です）。

プロパティの使い方は初めて知ったのですが、更新したいfile_pathが複数あり、@propertyの関数を列挙することで可読性を下げたくない場合、file_pathをまとめて更新するメソッドを定義し、継承後のインスタンス（testconfig）を作った後にこのpath_reloaderを手動で呼び出す方法は思いついたのですが、これ以外の方法はあったりしますでしょうか？

[Matsumon0104]

要件がよくわからないので、なんとも言えませんが、ここまで伺った仕様でdataclassを利用するのであれば、継承しないで、そのままBaseConfigのコンストラクタに初期値を入れ込んであげて別インスタンスを作成するというのはダメなのでしょうか？

@dataclass
class BaseConfig():
save_directory: str = ''
file_name: list = field(default_factory=list)

@property
def file_path(self):
# ここは配列からパスを組み立てる処理に変更
return Path(save_directory, 'result.txt')

baseconfig = BaseConfig(save_directory='dir', file_name=['a.txt', 'b.txt'])
textconfig = BaseConfig(save_directory='test', file_name=['1.txt', '2.txt'])

[MagMag]

おっしゃるとおり、継承にこだわらない方が今回の要件としてはいいかと思いました。アドバイスありがとうございます！

Answer 2

file_pathを返す関数を@propertyで装飾すればよいかと思います。

from dataclasses import dataclass
from pathlib import Path

@dataclass
class BaseConfig():
    save_directory = 'default'

    @property
    def file_path(self):
        return Path(self.save_directory, 'result.txt')

class TestConfig(BaseConfig):
    save_directory = 'test'

for c in [BaseConfig(), TestConfig()]:
    print(c.save_directory)
    print(c.file_path)

"""
default
default\result.txt
test
test\result.txt
"""

Comments

[MagMag]

（Matsumon0104さんへのコメントと同じコメントです）

ありがとうございます！ただ、実際はsave_directoryに従属するファイル名が10以上ある状態です（シンプルに質問書いたつもりですが、要件が正確でなく恐縮です）。

プロパティの使い方は初めて知ったのですが、更新したいfile_pathが複数あり、@propertyの関数を列挙することで可読性を下げたくない場合、file_pathをまとめて更新するメソッドを定義し、継承後のインスタンス（testconfig）を作った後にこのpath_reloaderを手動で呼び出す方法は思いついたのですが、これ以外の方法はあったりしますでしょうか？

[can110]

path_reloaderと同じ処理をsave_directoryのsetter関数を定義してやればよいかと思います。

[MagMag]

ありがとうございます！