blueprintpy.cli

blueprintpy CLIツール

blueprintpy.cli.blueprint() int

コマンド blueprint を提供する関数. KeyboardInterrupt (^C) のみがこの関数でハンドルされ, それ以外の処理は 関数 cli.main() が担当しています.

戻り値

終了コード

戻り値の型

int

サブパッケージ

モジュール

blueprintpy.cli.cli

blueprintpy CLIツールのメインモジュール

blueprintpy.cli.cli.main() int

コマンド blueprint の実装.コマンドライン引数を処理し、テンプレート展開処理を実行します.

戻り値

終了コード

戻り値の型

int

blueprintpy.cli.config_loader

class blueprintpy.cli.config_loader.ConfigLoader

ベースクラス: object

テンプレート構成ローダ

static load(config_json_str: str) Config

json形式のテンプレート構成情報からテンプレート構成を生成します.

パラメータ

config_json_str (str) -- json形式のテンプレート構成情報

例外
  • KeyError -- 構成情報に必要なプロパティが含まれていなかった場合.

  • ValueError -- 構成情報に不正な値が含まれていた場合.

  • ModuleNotFoundError, ImportError -- 引数ハンドラのインポートに失敗した場合.

戻り値

生成結果

戻り値の型

Config

blueprintpy.cli.config_serializer

class blueprintpy.cli.config_serializer.ConfigSerializer

ベースクラス: object

テンプレート構成シリアライザ

static serialize(config: Config) Dict[str, Any]

テンプレート構成オブジェクトをシリアライズし、辞書形式に変換します.

パラメータ

config (Config) -- シリアライズする構成オブジェクト

戻り値

シリアライズ結果

戻り値の型

Dict[str, Any]