genvid.toolbox.ConfigurationLoader¶
-
class
genvid.toolbox.ConfigurationLoader(tool: genvid.toolbox.basetool.BaseTool, renderer: typing.Union[typing.Callable[[typing.Union[pathlib.Path, str], typing.Union[typing.Mapping[str, str], NoneType]], typing.Any], NoneType] = None)¶ ベースクラス:
object本クラスは、テンプレートで記述されたコンフィギュレーションをロードまたはアップデートするためのメソッドを提供します。
バージョン 1.33.0 で追加.
-
TemplateRenderer= typing.Callable[[typing.Union[pathlib.Path, str], typing.Union[typing.Mapping[str, str], NoneType]], typing.Any]¶
-
load_config_folder(source: typing.Union[pathlib.Path, str], *, env: typing.Union[typing.Mapping[str, str], NoneType] = None, job_template_dir: typing.Union[pathlib.Path, str, NoneType] = None, with_consul_template: bool = False) → dict¶ ソースから設定ファイル (ディレクトリの中のすべてのファイル、または特定のひとつのファイル) を読み込み、そのファイルを返す。
パラメータ: - source – 設定ファイル/フォルダのパス。
- with_consul_template – true に設定されている場合にのみ、設定ファイル (ソースがディレクトリの場合) に対して consul-template を実行し使用する。
- job_template_dir – nomad テンプレートが読み込まれるフォルダへのパス。指定されていない場合、ジョブは読み込まれません。
- env –
consul-templateで使用するオプションの環境。ない場合、デフォルトの環境が使用されます。
戻り値: set_config()で直接使用するとができる辞書としての設定。例外: FileNotFoundError –
job_template_dirがNoneでなく、有効なディレクトリでない場合バージョン 1.30.0 で追加.
バージョン 1.33.0 で変更:
ProjectToolから移動しました。
-
load_nomad_job_template(name, job_folder: typing.Union[pathlib.Path, str])¶ 特定のディレクトリから nomad ジョブのテンプレートを読み込みます。拡張子が .nomad.tmpl のファイルのみ読み込みます。
パラメータ: - name – ファイル名 (拡張子なし)
- job_folder – ジョブが格納されたディレクトリのパス。
バージョン 1.30.0 で追加: job_folder として
pathlib.Pathのサポートを追加。バージョン 1.33.0 で変更:
ProjectToolから移動しました。
-
update_config(config: dict, isLocal: bool)¶ 指定の設定を更新する。
パラメータ: - config – 更新する設定。
- isLocal – ローカルクラスタまたはリモートクラスタの場合
戻り値: 更新された設定。
バージョン 1.31.0 で追加.
バージョン 1.33.0 で変更:
ProjectToolから移動しました。
-
-
class
project.ConfigurationLoader¶