genvid.toolbox.ConsulTemplate

class genvid.toolbox.ConsulTemplate(executable: typing.Union[pathlib.Path, str, NoneType] = None)

ベースクラス: object

consul-template の薄いラッパー API。

class OptionKind

ベースクラス: enum.Enum

consul-template に異なるオプションを記述するために使用します。

このラッパーの中には、オプションレベルでの強制が必要なものがあるため、この記述が必要になります。以下のような記述が存在します。

• FLAG - オプションがフラグとしてサポートされます (値はなし)。
• TAKES_VALUE - オプションはサポートされており、値が必要です。
• DISABLED - オプションは直接使用できません。

FLAG = 0

TAKES_VALUE = 1

DISABLED = 2

executable

consul-template バイナリロケーション。

version

consul-template --version のバージョン文字列を取得。

オプションは他のすべてのメソッドで無効になっているため、この API を介してバージョンを取得する唯一の方法です。

once(*, env: typing.Union[typing.Mapping[str, str], NoneType] = None, **kwargs) → genvid.toolbox.consul_template.ConsulTemplateOutput

非デーモンで consul-template を実行。

consul-template は、 --once オプションが自動的に追加されたサブプロセスで起動されます。正確な動作は kwargs に渡されたオプションに依存します (コマンドの詳細については consul-template の -h で確認できます)。

パラメータ:

• env – 指定された環境でサブプロセスを実行します。テンプレートが環境変数に大きく依存している場合に特に便利です。 .. 注意:: スクリプトが全てのキー/値を自動的に文字列に変換します。
• kwargs – consul-template によって認識され、 ConsulTemplate.OptionKind.DISABLED としてマークされていないパラメータ。 .. seealso:: サポートされるオプションの一覧は consul-template -h の出力で確認してください。 once オプションは自動的に追加されるので、引数に再度追加しないでください。受け入れられないもう一つのオプションは version です。

例外:

• ConsulTemplateUseOfDisabledOption – キーワード引数のいずれかが、明示的に無効化されているオプション名と一致する場合。
• ConsulTemplateUseOfUnknownOption – キーワード引数のいずれかが、 consul-template の既知のオプションと一致しない場合。
• ConsulTemplateInvalidUseOfFlag – フラグオプションが、bool ではない None 以外の値で使用されている場合。
• ConsulTemplateExecutionFailed – consul-template プロセスが 0 以外の終了コードを返した場合。

戻り値:

ConsulTemplateOutput オブジェクトは、consul-template の実行後に返される状態を保持します。

バージョン 1.22.0 で追加.

class consul_template.ConsulTemplate

genvid.toolbox.ConsulTemplate の実装