genvid.toolbox.ConfigurationLoader

class genvid.toolbox.ConfigurationLoader(tool: BaseTool, renderer: Optional[Callable[[Union[Path, str], Optional[Mapping[str, str]]], Any]] = None)

ベースクラス: object

本クラスは、テンプレートで記述されたコンフィギュレーションをロードまたはアップデートするためのメソッドを提供します。

バージョン 1.33.0 で追加.

TemplateRenderer

Callable[[Union[Path, str], Optional[Mapping[str, str]]], Any]の別名です。

load_config_folder(source: Union[Path, str], *, env: Optional[Mapping[str, str]] = None, job_template_dir: Optional[Union[Path, str]] = 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_dirNone でなく、有効なディレクトリでない場合

バージョン 1.30.0 で追加.

バージョン 1.33.0 で変更: ProjectTool から移動しました。

load_nomad_job_template(name, job_folder: Union[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

genvid.toolbox.ConfigurationLoader の実装