cmdbox.app.commons package

Submodules

cmdbox.app.commons.cache module

class cmdbox.app.commons.cache.MemoryCache[source]

Bases: object

メモリ上にデータをキャッシュするクラス。 キャッシュは識別キーごとに管理され、有効期限(秒)を設定できます。

clear() → None[source]

全キャッシュを削除します。

delete(key: str) → None[source]

キャッシュからデータを削除します。

Parameters:

key (str) -- キャッシュキー

exists(key: str) → bool[source]

有効なキャッシュが存在するかどうかを確認します。

Parameters:

key (str) -- キャッシュキー

Returns:

有効なキャッシュが存在する場合は True

Return type:

bool

get(key: str) → Any | None[source]

キャッシュからデータを取得します。 キャッシュが存在しない、または有効期限切れの場合は None を返します。

Parameters:

key (str) -- キャッシュキー

Returns:

キャッシュされたデータ、または None

Return type:

Union[Any, None]

refresh(key: str, timeout: float) → bool[source]

キャッシュの有効期限を更新します。

Parameters:
  • key (str) -- キャッシュキー

  • timeout (float) -- 延長する有効期限(秒)

Returns:

キャッシュが存在した場合は True、存在しない場合は False

Return type:

bool

set(key: str, value: Any, timeout: float) → None[source]

データをキャッシュに保存します。

Parameters:
  • key (str) -- キャッシュキー

  • value (Any) -- キャッシュするデータ

  • timeout (float) -- 有効期限(秒)

cmdbox.app.commons.cache.apprun_cache(func: Callable = None, args_key: str = None, cache_key_fn: Callable = None, exclude_fn: Callable = None) → Callable[source]

list系コマンドの実行結果をキャッシュするデコレーター。 list系コマンド実行関数に適用することで、コマンドの実行前にキャッシュを確認し、実行後にキャッシュを更新します。

Parameters:
  • func (Callable) -- コマンドの実行関数。引数なしで使用された場合はNone。

  • args_key (str) -- キャッシュキーを決定するための引数名。argsからこの引数の値を取得してキャッシュキーとして使用します。指定しなかった場合はデフォルトのキャッシュキー 'default' が使用されます。

  • cache_key_fn (Callable) -- キャッシュキーを決定するための関数。引数はselfとargsで、戻り値をキャッシュキーとして使用します。指定しなかった場合はargs_keyが使用されます。

  • exclude_fn (Callable) -- キャッシュから除外する条件を判定する関数。引数はargsでTrueを返すと除外します。指定しなかった場合は全ての結果がキャッシュされます。

Returns:

デコレーターでラップされた関数

Return type:

Callable

cmdbox.app.commons.cache.async_apprun_cache(func: Callable = None, args_key: str = None, cache_key_fn: Callable = None, exclude_fn: Callable = None) → Callable[source]

list系コマンドの実行結果をキャッシュするデコレーター。 list系コマンド実行関数に適用することで、コマンドの実行前にキャッシュを確認し、実行後にキャッシュを更新します。

Parameters:
  • func (Callable) -- コマンドの実行関数。引数なしで使用された場合はNone。

  • args_key (str) -- キャッシュキーを決定するための引数名。argsからこの引数の値を取得してキャッシュキーとして使用します。指定しなかった場合はデフォルトのキャッシュキー 'default' が使用されます。

  • cache_key_fn (Callable) -- キャッシュキーを決定するための関数。引数はselfとargsで、戻り値をキャッシュキーとして使用します。指定しなかった場合はargs_keyが使用されます。

  • exclude_fn (Callable) -- キャッシュから除外する条件を判定する関数。引数はargsでTrueを返すと除外します。指定しなかった場合は全ての結果がキャッシュされます。

Returns:

デコレーターでラップされた関数

Return type:

Callable

cmdbox.app.commons.convert module

cmdbox.app.commons.convert.b64str2bytes(b64str: str) → bytes[source]

Base64文字列をバイト列に変換します。

Parameters:

b64str (str) -- Base64形式の文字列

Returns:

バイト列

Return type:

bytes

cmdbox.app.commons.convert.b64str2npy(b64str: str, shape: Tuple = None, dtype: str = 'uint8') → ndarray[source]

Base64エンコードされた文字列からndarrayを復元します。

Parameters:
  • b64str (str) -- Base64エンコードされた文字列

  • shape (tuple) -- ndarrayの形状

  • dtype (str, optional) -- ndarrayのデータ型. Defaults to 'uint8'.

Returns:

復元したndarray

Return type:

np.ndarray

cmdbox.app.commons.convert.b64str2str(b64str: str) → str[source]

Base64エンコードされた文字列をデコードします。 b64strにNoneを指定した場合はNoneを返します。 b64strに'None'を指定した場合はNoneを返します。

Parameters:

b64str (str) -- Base64エンコードされた文字列

Returns:

デコードされた文字列

Return type:

str

cmdbox.app.commons.convert.bgr2rgb(npy: ndarray) → ndarray[source]

BGRのndarrayをRGBに変換します。

Parameters:

npy (np.ndarray) -- BGRのndarray

Returns:

RGBのndarray

Return type:

np.ndarray

cmdbox.app.commons.convert.bytes2b64str(img: bytes) → str[source]

画像のバイト列をBase64エンコードします。

Parameters:

img (bytes) -- 画像のバイト列

Returns:

Base64エンコードされた文字列

Return type:

str

cmdbox.app.commons.convert.img2byte(image: Image, format: str = 'jpeg') → bytes[source]

画像をバイト列に変換します。

Parameters:
  • image (Image.Image) -- PILのImageオブジェクト

  • format (str, optional) -- 画像のフォーマット. Defaults to 'jpeg'.

Returns:

画像のバイト列

Return type:

bytes

cmdbox.app.commons.convert.img2npy(image: Image, dtype: str = 'uint8') → ndarray[source]

PILのImageオブジェクトをndarrayに変換します。

Parameters:
  • image (Image.Image) -- PILのImageオブジェクト

  • dtype (str, optional) -- ndarrayのデータ型. Defaults to 'uint8'.

Returns:

ndarray

Return type:

np.ndarray

cmdbox.app.commons.convert.imgbytes2img(img: bytes) → <module 'PIL.ImageFile' from 'F:\\devenv\\cmdbox\\.venv\\Lib\\site-packages\\PIL\\ImageFile.py'>[source]

画像のバイト列をPILのImageオブジェクトに変換します。

Parameters:

img (bytes) -- 画像のバイト列

Returns:

PILのImageオブジェクト

Return type:

ImageFile

cmdbox.app.commons.convert.imgbytes2npy(img: bytes, dtype: str = 'uint8') → ndarray[source]

画像のバイト列をndarrayに変換します。

Parameters:
  • img (bytes) -- 画像のバイト列

  • dtype (str, optional) -- ndarrayのデータ型. Defaults to 'uint8'.

Returns:

ndarray

Return type:

np.ndarray

cmdbox.app.commons.convert.imgbytes2thumbnail(img: bytes, size: Tuple[float, float]) → Image[source]

画像のバイト列をサムネイルに変換します。

Parameters:
  • img (bytes) -- 画像のバイト列

  • size (Tuple[float, float]) -- サムネイルのサイズ(width, height)

Returns:

サムネイル

Return type:

Image.Image

cmdbox.app.commons.convert.imgfile2npy(fp, dtype: str = 'uint8') → ndarray[source]

画像ファイルをndarrayに変換します。

Parameters:
  • fp ([type]) -- 画像ファイルのパス

  • dtype (str, optional) -- ndarrayのデータ型. Defaults to 'uint8'.

Returns:

ndarray

Return type:

np.ndarray

cmdbox.app.commons.convert.npy2b64str(npy: ndarray) → str[source]

ndarrayをBase64エンコードした文字列を返します。

Parameters:

npy (np.ndarray) -- ndarray

Returns:

Base64エンコードされた文字列

Return type:

str

cmdbox.app.commons.convert.npy2img(npy: ndarray) → Image[source]

ndarrayをPILのImageオブジェクトに変換します。

Parameters:

npy (np.ndarray) -- ndarray

Returns:

PILのImageオブジェクト

Return type:

Image.Image

cmdbox.app.commons.convert.npy2imgfile(npy, output_image_file: Path = None, image_type: str = 'jpeg') → bytes[source]

ndarrayを画像bytesに変換しoutput_image_fileに保存します。 output_image_fileが省略された場合は保存されません

Parameters:
  • npy ([type]) -- ndarray

  • output_image_file (Path) -- 保存先の画像ファイルパス

Returns:

画像のバイト列

Return type:

bytes

cmdbox.app.commons.convert.npybytes2npy(npy: bytes) → ndarray[source]

バイト列からndarrayを読み込みます。

Parameters:

npy (bytes) -- ndarrayのバイト列

Returns:

読み込んだndarray

Return type:

np.ndarray

cmdbox.app.commons.convert.npyfile2npy(fp) → ndarray[source]

npyファイルからndarrayを読み込みます。

Parameters:

fp ([type]) -- npyファイルのパス

Returns:

読み込んだndarray

Return type:

np.ndarray

cmdbox.app.commons.convert.str2b64str(s: str) → str[source]

文字列をBase64エンコードします。 sにNoneを指定した場合はNoneを返します。

Parameters:

s (str) -- 文字列

Returns:

Base64エンコードされた文字列

Return type:

str

cmdbox.app.commons.convert.urlencode(s: str) → str[source]

文字列をURLエンコードします。

Parameters:

s (str) -- 文字列

Returns:

URLエンコードされた文字列

Return type:

str

cmdbox.app.commons.limiter module

class cmdbox.app.commons.limiter.LimitedFeature(appcls, ver, language: str = None)[source]

Bases: Feature

コマンドの実行制限を検証する機能の基底クラス。

apprun_count(data_dir: Path, logger: Logger, args: Namespace, msg: Dict[str, Any]) → int[source]

apprunの実行結果として実行回数を取得します。 デフォルトの実装では、1 を返します。 このメソッドを拡張して、コマンドの引数やセッション情報などから実行回数を算出する処理を実装できます。

Parameters:
  • data_dir (Path) -- データディレクトリのパス

  • logger (logging.Logger) -- ロガー

  • args (argparse.Namespace) -- コマンドの引数

  • msg (Dict[str, Any]) -- apprunの処理結果

Returns:

実行回数

Return type:

int

apprun_credit(data_dir: Path, logger: Logger, args: Namespace, msg: Dict[str, Any]) → int[source]

apprunの実行結果として使用クレジット数を取得します。 デフォルトの実装では、0 を返します。 このメソッドを拡張して、コマンドの引数やセッション情報などから使用クレジット数を算出する処理を実装できます。

Parameters:
  • data_dir (Path) -- データディレクトリのパス

  • logger (logging.Logger) -- ロガー

  • args (argparse.Namespace) -- コマンドの引数

  • msg (Dict[str, Any]) -- apprunの処理結果

Returns:

使用クレジット数

Return type:

int

apprun_input_bytes(data_dir: Path, logger: Logger, args: Namespace, msg: Dict[str, Any]) → int[source]

apprunの実行結果として入力バイト数を取得します。 デフォルトの実装では、argsを文字列に変換してUTF-8でエンコードしたバイト数を返します。 このメソッドを拡張して、コマンドの引数やセッション情報などから入力バイト数を算出する処理を実装できます。

Parameters:
  • data_dir (Path) -- データディレクトリのパス

  • logger (logging.Logger) -- ロガー

  • args (argparse.Namespace) -- コマンドの引数

  • msg (Dict[str, Any]) -- apprunの処理結果

Returns:

入力バイト数

Return type:

int

apprun_output_bytes(data_dir: Path, logger: Logger, args: Namespace, msg: Dict[str, Any]) → int[source]

apprunの実行結果として出力バイト数を取得します。 デフォルトの実装では、msgを文字列に変換してUTF-8でエンコードしたバイト数を返します。 このメソッドを拡張して、コマンドの引数やセッション情報などから出力バイト数を算出する処理を実装できます。

Parameters:
  • data_dir (Path) -- データディレクトリのパス

  • logger (logging.Logger) -- ロガー

  • args (argparse.Namespace) -- コマンドの引数

  • msg (Dict[str, Any]) -- apprunの処理結果

Returns:

出力バイト数

Return type:

int

apprun_process_bytes(data_dir: Path, logger: Logger, args: Namespace, msg: Dict[str, Any]) → int[source]

apprunの実行結果として処理バイト数を取得します。 デフォルトの実装では、0 を返します。 このメソッドを拡張して、コマンドの引数やセッション情報などから処理バイト数を算出する処理を実装できます。

Parameters:
  • data_dir (Path) -- データディレクトリのパス

  • logger (logging.Logger) -- ロガー

  • args (argparse.Namespace) -- コマンドの引数

  • msg (Dict[str, Any]) -- apprunの処理結果

Returns:

処理バイト数

Return type:

int

apprun_registrations(data_dir: Path, logger: Logger, args: Namespace, msg: Dict[str, Any]) → int[source]

apprunの実行結果として登録数(又は登録サイズ)を取得します。 デフォルトの実装では、0 を返します。 このメソッドを拡張して、コマンドの引数やセッション情報などから登録数を算出する処理を実装できます。

Parameters:
  • data_dir (Path) -- データディレクトリのパス

  • logger (logging.Logger) -- ロガー

  • args (argparse.Namespace) -- コマンドの引数

  • msg (Dict[str, Any]) -- apprunの処理結果

Returns:

登録数

Return type:

int

svrun_count(data_dir: Path, logger: Logger, opt: Dict[str, Any], msg: Dict | str) → int[source]

svrunの実行結果として実行回数を取得します。 デフォルトの実装では、1 を返します。 このメソッドを拡張して、コマンドの引数やセッション情報などから実行回数を算出する処理を実装できます。

Parameters:
  • data_dir (Path) -- データディレクトリのパス

  • logger (logging.Logger) -- ロガー

  • opt (Dict[str, Any]) -- コマンドのオプション

  • msg (Union[Dict, str]) -- svrunの処理結果

Returns:

実行回数

Return type:

int

svrun_credit(data_dir: Path, logger: Logger, opt: Dict[str, Any], msg: Dict | str) → int[source]

svrunの実行結果として使用クレジット数を取得します。 デフォルトの実装では、0 を返します。 このメソッドを拡張して、コマンドの引数やセッション情報などから使用クレジット数を算出する処理を実装できます。

Parameters:
  • data_dir (Path) -- データディレクトリのパス

  • logger (logging.Logger) -- ロガー

  • opt (Dict[str, Any]) -- コマンドのオプション

  • msg (Union[Dict, str]) -- svrunの処理結果

Returns:

使用クレジット数

Return type:

int

svrun_input_bytes(data_dir: Path, logger: Logger, opt: Dict[str, Any], msg: List[str]) → int[source]

svrunの実行結果として入力バイト数を取得します。 デフォルトの実装では、msgをスペースで結合した文字列のバイト数を返します。 このメソッドを拡張して、コマンドの引数やセッション情報などから入力バイト数を算出する処理を実装できます。

Parameters:
  • data_dir (Path) -- データディレクトリのパス

  • logger (logging.Logger) -- ロガー

  • opt (Dict[str, Any]) -- コマンドのオプション

  • msg (List[str]) -- svrunに渡されるmsg

Returns:

入力バイト数

Return type:

int

svrun_output_bytes(data_dir: Path, logger: Logger, opt: Dict[str, Any], msg: List[str], msg_size: int) → int[source]

svrunの実行結果として出力バイト数を取得します。 デフォルトの実装では、msg_sizeを返します。 このメソッドを拡張して、コマンドの引数やセッション情報などから出力バイト数を算出する処理を実装できます。

Parameters:
  • data_dir (Path) -- データディレクトリのパス

  • logger (logging.Logger) -- ロガー

  • opt (Dict[str, Any]) -- コマンドのオプション

  • msg (List[str]) -- svrunに渡されるmsg

  • msg_size (int) -- svrunに渡されるmsgのサイズ

Returns:

出力バイト数

Return type:

int

svrun_parse_options(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) → Dict[str, Any][source]

svrunに渡される引数を解析して、コマンドの実行制限チェックに必要な情報を取得します。 デフォルトの実装では、Redis クライアントの接続情報とコマンドのモード・コマンド名のみを取得します。 このメソッドを拡張して、コマンドの引数やセッション情報など、より詳細な情報を取得する処理を実装できます。

Parameters:
  • data_dir (Path) -- データディレクトリのパス

  • logger (logging.Logger) -- ロガー

  • redis_cli (redis_client.RedisClient) -- Redisクライアント

  • msg (List[str]) -- メッセージ

  • sessions (Dict[str, Dict[str, Any]]) -- セッション情報

Returns:

解析結果

Return type:

Dict[str, Any]

svrun_process_bytes(data_dir: Path, logger: Logger, opt: Dict[str, Any], msg: Dict | str) → int[source]

svrunの実行結果として処理バイト数を取得します。 デフォルトの実装では、0 を返します。 このメソッドを拡張して、コマンドの引数やセッション情報などから処理バイト数を算出する処理を実装できます。

Parameters:
  • data_dir (Path) -- データディレクトリのパス

  • logger (logging.Logger) -- ロガー

  • opt (Dict[str, Any]) -- コマンドのオプション

  • msg (Union[Dict, str]) -- svrunの処理結果

Returns:

処理バイト数

Return type:

int

svrun_registrations(data_dir: Path, logger: Logger, opt: Dict[str, Any], msg: Dict | str) → int[source]

svrunの実行結果として登録数(又は登録サイズ)を取得します。 デフォルトの実装では、0 を返します。 このメソッドを拡張して、コマンドの引数やセッション情報などから登録数を算出する処理を実装できます。

Parameters:
  • data_dir (Path) -- データディレクトリのパス

  • logger (logging.Logger) -- ロガー

  • opt (Dict[str, Any]) -- コマンドのオプション

  • msg (Union[Dict, str]) -- svrunの処理結果

Returns:

登録数

Return type:

int

class cmdbox.app.commons.limiter.Limiter(redis_client: RedisClient | None = None, flush_interval: float = 60.0, reload_interval: float = 60.0)[source]

Bases: object

コマンド実行に対する量的制限をチェックするクラス。

cmdbox_limiter_save で保存した制限設定をロードし、 コマンド実行前の制限チェックおよび実行後のカウンタ更新を行います。

制限設定は data_dir/.limiter/limiter-{name}.json に保存されており、 カウンタは data_dir/.limiter/counter-{name}.json に保存されます。

CHECK_ALLOW = 0
CHECK_DENY = 1
CHECK_NOT_APPLICABLE = 2
CONFIG_PREFIX = 'limiter-'
COUNTER_PREFIX = 'counter-'
COUNTER_VALKEYS = ['total_count', 'total_time', 'total_input', 'total_process', 'total_output', 'total_credits', 'total_registrations']
LIMITER_DIR = '.limiter'
REDIS_CONFIG_HASH = 'limiter:config'
REDIS_COUNTER_HASH = 'limiter:counter'
check(*, feat: LimitedFeature, data_dir: Path, logger: Logger, command_options: Dict[str, Any], current_registrations: int, scope: str = 'server') → Tuple[int, str | None][source]

コマンド実行が量的制限に違反していないかをチェックします。

マッチするすべての制限設定に対してチェックを行い、 複数の設定がマッチした場合は、すべての設定に違反している場合のみ (非0, メッセージ) を返します。 1 つ以上の設定がパスした場合は (0, None) を返します。 すべての制限をパスした場合は (0, None) を返します。

登録最大数のチェックには get_current_registrations() を呼び出します。

Parameters:
  • feat (LimitedFeature) -- 制限対象の機能

  • data_dir (Path) -- データディレクトリ

  • logger (logging.Logger) -- ロガー

  • command_options (Dict[str, Any]) -- 実行コマンドのオプション

  • current_registrations (int) -- 現在の登録数

  • scope (str) -- 対象とする制限設定のスコープ。'server' または 'client' のみ有効。

Returns:

許可する場合は Limiter.CHECK_ALLOW、制限違反の場合は Limiter.CHECK_DENY 、制限が適用されない場合は Limiter.CHECK_NOT_APPLICABLE を返します。 2 番目の要素は、制限違反の場合に表示するメッセージです。 3 番目の要素は、制限違反した制限設定の limiter_name のリストです。

Return type:

Tuple[int, Optional[str], List[str]]

Raises:

ValueError -- scope が 'server' でも 'client' でもない場合。

classmethod getInstance(redis_client: RedisClient | None = None, flush_interval: float = 60.0, reload_interval: float = 60.0) → Limiter[source]

Limiter のインスタンスを取得します。

Parameters:
  • redis_client (Optional[redis_client.RedisClient]) -- Redis クライアント。 None の場合はファイルのみを使用します(従来動作)。

  • flush_interval (float) -- カウンタおよび設定キャッシュをファイルに書き込む間隔(秒)。 Redis が有効な場合、カウンタはこの間隔でファイルに永続化されます。 設定キャッシュはこの間隔で TTL が切れ、次回 load_configs() 時に ファイルから再ロードされます。デフォルトは 60 秒。

  • reload_interval (float) -- 設定をRedisからではなくファイルから再ロードする間隔(秒)。 Redis が有効な場合、load_configs() 呼び出し時に最終更新からこの間隔以上経過している場合は、 ファイルから再ロードされます。デフォルトは 60 秒。

Returns:

Limiter のインスタンス

Return type:

Limiter

load_configs(data_dir: Path, scope: str = 'server') → List[Dict[str, Any]][source]

data_dir 以下のすべての制限設定をロードします。

Redis が有効な場合はまず Redis キャッシュを参照します。 キャッシュが期限切れまたは未登録の場合はファイルから読み込み、 reload_interval 秒間有効なキャッシュとして Redis に保存します。

Parameters:
  • data_dir (Path) -- データディレクトリ

  • scope (str) -- スコープ。'server' または 'client'(デフォルト: 'server')

Returns:

制限設定のリスト

Return type:

List[Dict[str, Any]]

load_counter(data_dir: Path, limiter_name: str, scope: str = 'server', load_history: bool = False) → Dict[str, Any][source]

指定した制限設定のカウンタをロードします。

Redis が有効な場合は Redis から取得します。 Redis にデータがない場合はファイルから読み込みます。 どちらにもデータがない場合は初期値を返します。

Parameters:
  • data_dir (Path) -- データディレクトリ

  • limiter_name (str) -- 制限設定の識別名

  • scope (str) -- スコープ。'server' または 'client'(デフォルト: 'server')

  • load_history (bool) -- カウンタの履歴も読み込むかどうか

Returns:

カウンタ

Return type:

Dict[str, Any]

matches(config: Dict[str, Any], command_options: Dict[str, Any]) → bool[source]

制限設定が現在のコマンドコンテキストに適合するかどうかを判定します。

target_mode が指定されている場合、command_options の mode と一致する場合にマッチします。 target_cmd が指定されている場合、command_options の cmd と一致する場合にマッチします。 target_option に設定された各 key/val がすべて command_options と一致する場合にマッチします。 いずれも未設定の場合はすべてのコマンドに適合します。

Parameters:
  • config (Dict[str, Any]) -- 制限設定

  • command_options (Dict[str, Any]) -- 実行コマンドのオプション(例: {'mode': 'llm', 'cmd': 'chat'})

Returns:

制限設定が適合する場合は True

Return type:

bool

needs_reset(config: Dict[str, Any], counter: Dict[str, Any]) → bool[source]

カウンタのリセットが必要かどうかを判定します。

reset_datetime を起点として reset_period_unit と reset_period_qty で定義された周期ごとにリセットが必要かどうかを判定します。

reset_period_unit/reset_period_qty が未設定の場合は、 reset_datetime を1回限りのリセット日時として扱います。

Parameters:
  • config (Dict[str, Any]) -- 制限設定

  • counter (Dict[str, Any]) -- 現在のカウンタ

Returns:

リセットが必要な場合は True

Return type:

bool

reset_counter(limiter_name: str) → Dict[str, Any][source]

カウンタをリセットした新しいカウンタを返します。

Parameters:

limiter_name (str) -- 制限設定の識別名

Returns:

リセット後のカウンタ

Return type:

Dict[str, Any]

save_counter(data_dir: Path, limiter_name: str, counter: Dict[str, Any], scope: str = 'server', max_history_interval: int | None = None) → None[source]

指定した制限設定のカウンタを保存します。

Redis が有効な場合は Redis に即時書き込みし、 flush_interval 秒以上経過した場合のみファイルにも書き込みます。 Redis が無効な場合は常にファイルに書き込みます。

Parameters:
  • data_dir (Path) -- データディレクトリ

  • limiter_name (str) -- 制限設定の識別名

  • counter (Dict[str, Any]) -- 保存するカウンタ

  • scope (str) -- スコープ。'server' または 'client'(デフォルト: 'server')

  • max_history_interval (Optional[int]) -- 履歴保持最大期間(秒)。指定した場合、ファイル保存後に古い履歴を削除します。

update(*, feat: LimitedFeature, deny_limiter_names: List[str], data_dir: Path, logger: Logger, command_options: Dict[str, Any], count: int = 1, exec_time: float = 0.0, input_bytes: int = 0, process_bytes: int = 0, output_bytes: int = 0, credits: int = 0, registrations: int = 0, scope: str = 'server') → None[source]

コマンド実行後にカウンタを更新します。

マッチするすべての制限設定のカウンタに対して、 実行回数・実行時間・入出力バイト数を加算して保存します。

Parameters:
  • feat (LimitedFeature) -- 対象の機能

  • deny_limiter_names (List[str]) -- 違反した制限設定の limiter_name のリスト

  • data_dir (Path) -- データディレクトリ

  • logger (logging.Logger) -- ロガー

  • command_options (Dict[str, Any]) -- 実行コマンドのオプション

  • count (int) -- 実行回数(デフォルトは 1)

  • exec_time (float) -- 実行時間(秒)

  • input_bytes (int) -- 入力バイト数

  • process_bytes (int) -- 処理バイト数

  • output_bytes (int) -- 出力バイト数

  • credits (int) -- 使用クレジット数

  • registrations (int) -- 登録数(又は登録サイズ)

  • scope (str) -- スコープ。'server' または 'client'(デフォルト: 'server')

cmdbox.app.commons.limiter.apprun_check_limit(func: Callable) → Callable[source]

コマンドの実行制限を検証するデコレーター。 LimitedFeature を継承したクラスのコマンド実行関数に適用することで、コマンドの実行前に制限チェックを行い、実行後にカウンタを更新します。 それ以外の関数に適用された場合は、単純に元の関数を実行します。

Parameters:

func (Callable) -- コマンドの実行関数

Returns:

デコレーターでラップされた関数

Return type:

Callable

cmdbox.app.commons.limiter.async_apprun_check_limit(func: Callable) → Callable[source]

コマンドの実行制限を検証するデコレーター。 LimitedFeature を継承したクラスのコマンド実行関数に適用することで、コマンドの実行前に制限チェックを行い、実行後にカウンタを更新します。 それ以外の関数に適用された場合は、単純に元の関数を実行します。

Parameters:

func (Callable) -- コマンドの実行関数

Returns:

デコレーターでラップされた関数

Return type:

Callable

cmdbox.app.commons.limiter.async_svrun_check_limit(func: Callable) → Callable[source]

コマンドの実行制限を検証するデコレーター。 LimitedFeature を継承したクラスのサーバー側コマンド実行関数に適用することで、コマンドの実行前に制限チェックを行い、実行後にカウンタを更新します。 それ以外の関数に適用された場合は、単純に元の関数を実行します。

Parameters:

func (Callable) -- サーバー側コマンドの実行関数

Returns:

デコレーターでラップされた関数

Return type:

Callable

cmdbox.app.commons.limiter.svrun_check_limit(func: Callable) → Callable[source]

コマンドの実行制限を検証するデコレーター。 LimitedFeature を継承したクラスのサーバー側コマンド実行関数に適用することで、コマンドの実行前に制限チェックを行い、実行後にカウンタを更新します。 それ以外の関数に適用された場合は、単純に元の関数を実行します。

Parameters:

func (Callable) -- サーバー側コマンドの実行関数

Returns:

デコレーターでラップされた関数

Return type:

Callable

cmdbox.app.commons.loghandler module

class cmdbox.app.commons.loghandler.ColorfulStreamHandler(stream=None)[source]

Bases: StreamHandler

コンソールにカラフルなログメッセージを出力します。

console = <console width=149 ColorSystem.TRUECOLOR>
emit(record: LogRecord) → None[source]

Emit a record.

If a formatter is specified, it is used to format the record. The record is then written to the stream with a trailing newline. If exception information is present, it is formatted using traceback.print_exception and appended to the stream. If the stream has an 'encoding' attribute, it is used to determine how to do the output to the stream.

class cmdbox.app.commons.loghandler.Colors[source]

Bases: object

BackgroundBlack = 40
BackgroundBlue = 44
BackgroundCyan = 46
BackgroundDarkGray = 100
BackgroundDefault = 49
BackgroundGreen = 42
BackgroundLightBlue = 104
BackgroundLightCyan = 106
BackgroundLightGray = 47
BackgroundLightGreen = 102
BackgroundLightMagenta = 105
BackgroundLightRed = 101
BackgroundLightYellow = 103
BackgroundMagenta = 45
BackgroundRed = 41
BackgroundWhite = 107
BackgroundYellow = 43
Black = 30
Blue = 34
Bold = 1
Cyan = 36
D = ';'
DarkGray = 90
Default = 39
Dim = 2
E = 'm'
Green = 32
Hidden = 8
LightBlue = 94
LightCyan = 96
LightGray = 37
LightGreen = 92
LightMagenta = 95
LightRed = 91
LightYellow = 93
Magenta = 35
Red = 31
ResetAll = 0
ResetBold = 21
ResetDim = 22
ResetHidden = 28
ResetReverse = 27
ResetUnderlined = 24
Reverse = 7
S = '\x1b['
Underlined = 4
White = 97
Yellow = 33
error_word = re.compile('ERROR|ALERT|CRITICAL|FATAL|ABORT|FAILED', re.IGNORECASE)
option_word = re.compile('MODE|CMD|SVNAME|GROUPS|FWPATH', re.IGNORECASE)
product_word = re.compile('CMDBOX|IINFER|USOUND|GAIAN', re.IGNORECASE)
success_word = re.compile('SUCCESS|OK|PASSED|DONE|COMPLETE|START|FINISH|OPEN|CONNECTED|ALLOW|EXEC', re.IGNORECASE)
warning_word = re.compile('WARNING|WARN|CAUTION|NOTICE|STOP|DISCONNECTED|DENY', re.IGNORECASE)
class cmdbox.app.commons.loghandler.LogLevelHighlighter[source]

Bases: ReprHighlighter

ログメッセージのログレベルをハイライトします。

class cmdbox.app.commons.loghandler.LogRecordRequestHandler(request, client_address, server)[source]

Bases: StreamRequestHandler

ログリクエストを処理するためのハンドラ

handle()[source]

ログリクエストを処理します。

handleLogRecord(record)[source]
setup()[source]
unPickle(data)[source]
class cmdbox.app.commons.loghandler.LogRecordTCPServer(logname, host='localhost', port=9020, handler=<class 'cmdbox.app.commons.loghandler.LogRecordRequestHandler'>, debug=False)[source]

Bases: ThreadingTCPServer

ログレコードを受信するためのTCPサーバー。

allow_reuse_address = True
serve_until_stopped()[source]
class cmdbox.app.commons.loghandler.SocketHandler(host, port)[source]

Bases: SocketHandler

emit(record: LogRecord) → None[source]

Emit a record.

Pickles the record and writes it to the socket in binary format. If there is an error with the socket, silently drop the packet. If there was a problem with the socket, re-establishes the socket.

class cmdbox.app.commons.loghandler.TimedRotatingFileHandler(filename, when='h', interval=1, backupCount=0, encoding=None, delay=False, utc=False, atTime=None, errors=None)[source]

Bases: TimedRotatingFileHandler

doRollover() → None[source]

Windows 上で os.rename が失敗するケースに備えたフォールバック実装。 まず親クラス実装を試み、PermissionError の場合はファイルのコピーで代替する。

emit(record: LogRecord) → None[source]

ログ出力時に例外(特に Windows の PermissionError)で処理が止まらないように保護します。 - 通常は親クラスの emit を呼ぶ - PermissionError 等で回転に失敗した場合はフォールバックして標準エラーへ出力し、処理を継続する

cmdbox.app.commons.loghandler.colorize(s: str, *colors: int) → str[source]
cmdbox.app.commons.loghandler.colorize_msg(msg) → str[source]

cmdbox.app.commons.module module

cmdbox.app.commons.module.class_for_name(class_full_name: str)[source]

クラス名からクラスを取得します。

Parameters:

class_full_name (str) -- クラスフルパス名

Returns:

クラス

Return type:

[type]

cmdbox.app.commons.module.get_module_list(package_name) → List[str][source]

パッケージ内のモジュール名のリストを取得します。

Parameters:

package_name (str) -- パッケージ名

Returns:

モジュール名のリスト

Return type:

List[str]

cmdbox.app.commons.module.load_features(package_name: str, prefix: str = 'cmdbox_', excludes: list = [], ref_options=None, appcls=None, ver=None, language: str = None) → Dict[str, Any][source]

フィーチャーを読み込みます。

Parameters:
  • package_name (str) -- パッケージ名

  • prefix (str, optional) -- プレフィックス. Defaults to "cmdbox_".

  • excludes (list, optional) -- 除外するモジュール名のリスト. Defaults to [].

  • ref_options (options.Options, optional) -- 参照用のオプション. Defaults to None.

  • appcls ([type], optional) -- アプリケーションクラス. Defaults to None.

  • ver ([type], optional) -- バージョンモジュール. Defaults to None.

  • language (str, optional) -- 言語設定. Defaults to None.

Returns:

フィーチャーのリスト

Return type:

Dict[str, Any]

cmdbox.app.commons.module.load_webfeatures(package_name: str, prefix: str = 'cmdbox_web_', excludes: list = [], appcls=None, ver=None, language: str = None, logger: Logger = None) → List[Any][source]

Webフィーチャーを読み込みます。

Parameters:
  • package_name (str) -- パッケージ名

  • prefix (str, optional) -- プレフィックス. Defaults to "cmdbox_web_".

  • excludes (list, optional) -- 除外するモジュール名のリスト. Defaults to [].

  • appcls ([type], optional) -- アプリケーションクラス. Defaults to None.

  • ver ([type], optional) -- バージョンモジュール. Defaults to None.

  • language (str, optional) -- 言語設定. Defaults to None.

  • logger ([type], optional) -- ロガー. Defaults to None.

Returns:

Webフィーチャーのリスト

Return type:

Dict[feature.WebFeature]

cmdbox.app.commons.redis_client module

class cmdbox.app.commons.redis_client.RedisClient(logger: Logger, host: str = 'localhost', port: int = 6379, password: str = None, svname: str = 'server', org_svname: str = None)[source]

Bases: object

async asend_cmd(cmd: str, params: List[str], retry_count: int = 20, retry_interval: int = 5, outstatus: bool = False, timeout: int = 60, nowait: bool = False)[source]

コマンドをRedisサーバーに送信し、応答を取得します。 nowait=Trueの場合は、応答を待たずにスレッドで実行します。 その場合、応答は受信できません。

Parameters:
  • cmd (str) -- コマンド

  • params (List[str]) -- コマンドのパラメータ

  • retry_count (int, optional) -- リトライ回数. Defaults to 20.

  • retry_interval (int, optional) -- リトライ間隔. Defaults to 5.

  • outstatus (bool, optional) -- ステータスを出力する. Defaults to False.

  • timeout (int, optional) -- タイムアウト時間. Defaults to 60.

  • nowait (bool, optional) -- 応答を待たない. Defaults to False.

Returns:

Redisサーバーからの応答

Return type:

dict

async asend_cmd_sse(cmd: str, params: List[str], retry_count: int = 20, retry_interval: int = 5, outstatus: bool = False, timeout: int = 60, nowait: bool = False, sse: bool = True)[source]

コマンドをRedisサーバーに送信し、応答を取得します(非同期版)。 nowait=Trueの場合は、応答を待たずに実行します。 その場合、応答は受信できません。

Parameters:
  • cmd (str) -- コマンド

  • params (List[str]) -- コマンドのパラメータ

  • retry_count (int, optional) -- リトライ回数. Defaults to 20.

  • retry_interval (int, optional) -- リトライ間隔. Defaults to 5.

  • outstatus (bool, optional) -- ステータスを出力する. Defaults to False.

  • timeout (int, optional) -- タイムアウト時間. Defaults to 60.

  • nowait (bool, optional) -- 応答を待たない. Defaults to False.

  • sse (bool, optional) -- サーバーサイドからの終了メッセージを受けるまで連続してレスポンスを受け取る. Defaults to False.

Returns:

Redisサーバーからの応答

Return type:

dict

blpop(name: str, timeout: int = 1)[source]
check_server(find_svname: bool = False, retry_count: int = 20, retry_interval: int = 5, outstatus: bool = False)[source]

Redisサーバーにpingを送信し、応答があるか確認する

Parameters:
  • find_svname (bool, optional) -- サーバー名が存在するか確認する. Defaults to False.

  • retry_count (int, optional) -- リトライ回数. Defaults to 20.

  • retry_interval (int, optional) -- リトライ間隔. Defaults to 5.

  • outstatus (bool, optional) -- ステータスを出力する. Defaults to False.

Returns:

接続成功時はTrue、失敗時はFalse

Return type:

bool

close()[source]
connect()[source]

Redisに接続します。

delete(name: str)[source]
exists(name: str)[source]
get(name: str)[source]
hdel(name: str, key: str)[source]
hexists(name: str, key: str)[source]
hget(name: str, key: str)[source]
hgetall(name: str)[source]
hset(name: str, key: str, value)[source]
keys(pattern: str)[source]
list_server() → List[Dict[str, Any]][source]

起動しているサーバーリストを取得する

Returns:

サーバーのリスト

Return type:

List[Dict[str, Any]]

lpop(name: str)[source]
pipeline(transaction: bool = True, shard_hint=None)[source]
receive_showimg()[source]
rpush(name: str, value: dict, pfkey: str = 'svrun', tm: float = 0.0)[source]
send_cmd(cmd: str, params: List[str], retry_count: int = 20, retry_interval: int = 5, outstatus: bool = False, timeout: int = 60, nowait: bool = False)[source]

コマンドをRedisサーバーに送信し、応答を取得します。 nowait=Trueの場合は、応答を待たずにスレッドで実行します。 その場合、応答は受信できません。

Parameters:
  • cmd (str) -- コマンド

  • params (List[str]) -- コマンドのパラメータ

  • retry_count (int, optional) -- リトライ回数. Defaults to 20.

  • retry_interval (int, optional) -- リトライ間隔. Defaults to 5.

  • outstatus (bool, optional) -- ステータスを出力する. Defaults to False.

  • timeout (int, optional) -- タイムアウト時間. Defaults to 60.

  • nowait (bool, optional) -- 応答を待たない. Defaults to False.

Returns:

Redisサーバーからの応答

Return type:

dict

send_cmd_sse(cmd: str, params: List[str], retry_count: int = 20, retry_interval: int = 5, outstatus: bool = False, timeout: int = 60, nowait: bool = False, sse: bool = True)[source]

コマンドをRedisサーバーに送信し、応答を取得します。 nowait=Trueの場合は、応答を待たずにスレッドで実行します。 その場合、応答は受信できません。

Parameters:
  • cmd (str) -- コマンド

  • params (List[str]) -- コマンドのパラメータ

  • retry_count (int, optional) -- リトライ回数. Defaults to 20.

  • retry_interval (int, optional) -- リトライ間隔. Defaults to 5.

  • outstatus (bool, optional) -- ステータスを出力する. Defaults to False.

  • timeout (int, optional) -- タイムアウト時間. Defaults to 60.

  • nowait (bool, optional) -- 応答を待たない. Defaults to False.

  • sse (bool, optional) -- サーバーサイドからの終了メッセージを受けるまで連続してレスポンスを受け取る. Defaults to False.

Returns:

Redisサーバーからの応答

Return type:

dict

send_showimg(cmd: str, outputs: Dict[str, Any], output_image: Image = None, maxrecsize: int = 200)[source]

後処理結果をRedisサーバーに送信する

Parameters:
  • cmd (str) -- コマンド

  • outputs (Dict[str, Any]) -- 後処理結果

  • output_image (Image.Image, optional) -- 画像データ. Defaults to None.

  • maxrecsize (int, optional) -- 最大レコードサイズ. Defaults to 200.

cmdbox.app.commons.resdata module

class cmdbox.app.commons.resdata.Base[source]

Bases: BaseModel

コマンドの実行結果を表すクラス

classmethod forbid_off()[source]

定義されていないフィールドを許可するためのConfigDictを返すクラスメソッド :returns: 定義されていないフィールドを許可するConfigDict :rtype: ConfigDict

classmethod forbid_on()[source]

定義されていないフィールドを禁止するためのConfigDictを返すクラスメソッド :returns: 定義されていないフィールドを禁止するConfigDict :rtype: ConfigDict

classmethod get_model_info() → Dict[str, Any][source]

モデルの情報を取得するメソッド :returns: モデルの情報を表す辞書 :rtype: dict

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class cmdbox.app.commons.resdata.Data(*, save_mode: str | None = None, performance: List[KeyVal] | None = None)[source]

Bases: Base

コマンドの実行結果のデータを表すクラス

model_config = {'extra': 'forbid'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

performance: List[KeyVal] | None
save_mode: str | None
class cmdbox.app.commons.resdata.KeyVal(*, key: str, val: Any | None = None)[source]

Bases: Base

キーと値のペアを表すクラス

key: str
model_config = {'extra': 'forbid'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

value: Any | None
class cmdbox.app.commons.resdata.NamePath(*, name: str, path: Path | str | None = None)[source]

Bases: Base

名前とパスのペアを表すクラス

model_config = {'extra': 'forbid'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str
path: Path | str | None
class cmdbox.app.commons.resdata.Result(*, success: Data | str | bool | None = None, warn: Dict[str, Any] | List[Any] | Data | str | bool | None = None, error: Dict[str, Any] | List[Any] | Data | str | bool | None = None, output_schema: Dict[str, Any] | None = None, end: bool | None = None)[source]

Bases: Base

コマンドの実行結果を表すクラス

end: bool | None
error: Dict[str, Any] | List[Any] | Data | str | bool | None
model_config = {'extra': 'forbid'}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

output_schema: Dict[str, Any] | None
success: Data | str | bool | None
warn: Dict[str, Any] | List[Any] | Data | str | bool | None

cmdbox.app.commons.testable module

class cmdbox.app.commons.testable.TestCase(*, name: str, description: str | None = None, args: Namespace, exec_cmd: Callable[[Logger, Namespace, float, List[Dict[str, float]], Any], Any] | None = None, output: Tuple[int, Dict[str, Any], Any], assertion: Callable[[Logger, Namespace, float, List[Dict[str, float]], Any, Tuple[int, Dict[str, Any], Any], Tuple[int, Dict[str, Any], Any]], Any] | None = None)[source]

Bases: Base

テストケースを表すクラス

args: Namespace
assertion: Callable[[Logger, Namespace, float, List[Dict[str, float]], Any, Tuple[int, Dict[str, Any], Any], Tuple[int, Dict[str, Any], Any]], Any] | None
description: str | None
exec_cmd: Callable[[Logger, Namespace, float, List[Dict[str, float]], Any], Any] | None
model_config = {'arbitrary_types_allowed': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

name: str
output: Tuple[int, Dict[str, Any], Any]
class cmdbox.app.commons.testable.UnitTestable(appcls, ver, language: str = None)[source]

Bases: Feature

assertion(logger: Logger, test_args: Namespace, tm: float, pf: List[Dict[str, float]], _bef: Any, _res: Tuple[int, Dict[str, Any], Any], output: Tuple[int, Dict[str, Any], Any]) → None[source]

テスト結果を検証するためのメソッド :param logger: ロガーオブジェクト :type logger: logging.Logger :param test_args: コマンドの引数を含むNamespaceオブジェクト :type test_args: argparse.Namespace :param tm: コマンドの実行時間を測定するためのタイムスタンプ :type tm: float :param pf: コマンドの実行時間を測定するためのパフォーマンスデータのリスト :type pf: List[Dict[str, float]] :param _bef: 前処理の結果 :type _bef: Any :param _res: コマンドの実行結果(リターンコード、メッセージ、オブジェクト) :type _res: Tuple[int, Dict[str, Any], Any] :param output: 期待される出力(リターンコード、メッセージ、オブジェクト) :type output: Tuple[int, Dict[str, Any], Any]

Returns:

None

create_base_args(logger: Logger, args: Namespace) → Namespace[source]

テストケースの基本的な引数を作成するためのメソッド :param logger: ロガーオブジェクト :type logger: logging.Logger :param args: コマンドの引数を含むNamespaceオブジェクト :type args: argparse.Namespace

Returns:

テストケースの基本的な引数を含むNamespaceオブジェクト

Return type:

argparse.Namespace

create_tests(logger: Logger, base_args: Namespace, tm: float, pf: List[Dict[str, float]]) → List[TestCase][source]

テストケースを作成するためのメソッド :returns: テストケースのリスト :rtype: List[TestCase]

exec_after(logger: Logger, args: Namespace, tm: float, pf: List[Dict[str, float]], _bef: Any) → Any[source]

テストケースの後処理を実行するためのメソッド :param logger: ロガーオブジェクト :type logger: logging.Logger :param args: コマンドの引数を含むNamespaceオブジェクト :type args: argparse.Namespace :param tm: コマンドの実行時間を測定するためのタイムスタンプ :type tm: float :param pf: コマンドの実行時間を測定するためのパフォーマンスデータのリスト :type pf: List[Dict[str, float]] :param _bef: 前処理の結果 :type _bef: Any

Returns:

後処理の結果

Return type:

Any

exec_before(logger: Logger, args: Namespace, tm: float, pf: List[Dict[str, float]]) → Any[source]

前処理を実行するためのメソッド :param logger: ロガーオブジェクト :type logger: logging.Logger :param args: コマンドの引数を含むNamespaceオブジェクト :type args: argparse.Namespace :param tm: コマンドの実行時間を測定するためのタイムスタンプ :type tm: float :param pf: コマンドの実行時間を測定するためのパフォーマンスデータのリスト :type pf: List[Dict[str, float]]

Returns:

前処理の結果

Return type:

Any

exec_cmd(logger: Logger, test_args: Namespace, tm: float, pf: List[Dict[str, float]], _bef: Any) → Tuple[int, Dict[str, Any], Any][source]

コマンドを実行するためのメソッド :param logger: ロガーオブジェクト :type logger: logging.Logger :param test_args: コマンドの引数を含むNamespaceオブジェクト :type test_args: argparse.Namespace :param tm: コマンドの実行時間を測定するためのタイムスタンプ :type tm: float :param pf: コマンドの実行時間を測定するためのパフォーマンスデータのリスト :type pf: List[Dict[str, float]] :param _bef: 前処理の結果 :type _bef: Any

Returns:

コマンドの実行結果(リターンコード、メッセージ、オブジェクト)

Return type:

Tuple[int, Dict[str, Any], Any]

run_tests(logger: Logger, args: Namespace, tm: float, pf: List[Dict[str, float]] = []) → Tuple[int, Dict[str, Any], Any][source]

テストケースを実行するためのメソッド :param logger: ロガーオブジェクト :type logger: logging.Logger :param args: コマンドの引数を含むNamespaceオブジェクト :type args: argparse.Namespace :param tm: コマンドの実行時間を測定するためのタイムスタンプ :type tm: float :param pf: コマンドの実行時間を測定するためのパフォーマンスデータのリスト :type pf: List[Dict[str, float]]

Returns:

テストの実行結果(リターンコード、メッセージ、オブジェクト)

Return type:

Tuple[int, Dict[str, Any], Any]

cmdbox.app.commons.validator module

class cmdbox.app.commons.validator.Validator(appcls, ver, language: str = None)[source]

Bases: Feature

cleaning_test() → None[source]

テスト用のクリーンアップ処理を行います

custom_validators() → List[Callable[[Logger, str, str, Any, str], Tuple[int, Dict[str, Any], Any]]][source]

オプションの値の妥当性を検証するカスタムバリデータのリストを返します

Returns:

バリデータのリスト

Return type:

List[Callable[[logging.Logger, str, str, Any, str], Tuple[int, Dict[str, Any], Any]]]

init_test() → None[source]

テスト用の初期化処理を行います

output_schema() → type[source]

コマンドの実行結果スキーマを表すクラスを返します

Returns:

結果のスキーマクラス

Return type:

type

parse_output(output: Any) → Any[source]

コマンドの実行結果をパースします

Parameters:

output (Any) -- コマンドの実行結果

Returns:

パース後の結果

Return type:

Any

regs_ctrlchar = re.compile('[\\x00-\\x08\\x0B\\x0C\\x0E-\\x1F\\x7F-\\x9F]')
valid(logger: Logger, args: Namespace, tm: float, pf: List[Dict[str, float]] = []) → Tuple[int, Dict[str, Any], Any][source]

コマンドの引数の妥当性を検証します

Parameters:
  • logger (logging.Logger) -- ロガー

  • args (argparse.Namespace) -- 引数

  • tm (float) -- 実行開始時間

  • pf (List[Dict[str, float]]) -- 呼出元のパフォーマンス

Returns:

終了コード, 結果, オブジェクト

Return type:

Tuple[int, Dict[str, Any], Any]

valid_data(logger: Logger, opt: str, type: str, val: Any, fileio: str) → Tuple[int, Dict[str, Any], Any][source]

--dataオプションの値の妥当性を検証します

Parameters:
  • logger (logging.Logger) -- ロガー

  • opt (str) -- オプション名

  • type (str) -- オプションの型

  • val (Any) -- オプションの値

  • fileio (str) -- ファイル入出力の種別 ('in' or 'out')

Returns:

終了コード, 結果, オブジェクト

Return type:

Tuple[int, Dict[str, Any], Any]

valid_file_exist(logger: Logger, opt: str, type: str, val: Any, fileio: str) → Tuple[int, Dict[str, Any], Any][source]

ファイルの存在の妥当性を検証します

Parameters:
  • logger (logging.Logger) -- ロガー

  • opt (str) -- オプション名

  • type (str) -- オプションの型

  • val (Any) -- オプションの値

  • fileio (str) -- ファイル入出力の種別 ('in' or 'out')

Returns:

終了コード, 結果, オブジェクト

Return type:

Tuple[int, Dict[str, Any], Any]

valid_name(logger: Logger, opt: str, type: str, val: Any, fileio: str) → Tuple[int, Dict[str, Any], Any][source]

--nameオプションの値の妥当性を検証します

Parameters:
  • logger (logging.Logger) -- ロガー

  • opt (str) -- オプション名

  • type (str) -- オプションの型

  • val (Any) -- オプションの値

  • fileio (str) -- ファイル入出力の種別 ('in' or 'out')

Returns:

終了コード, 結果, オブジェクト

Return type:

Tuple[int, Dict[str, Any], Any]

valid_signin_file(logger: Logger, opt: str, type: str, val: Any, fileio: str) → Tuple[int, Dict[str, Any], Any][source]

--signin_fileオプションの値の妥当性を検証します

Parameters:
  • logger (logging.Logger) -- ロガー

  • opt (str) -- オプション名

  • type (str) -- オプションの型

  • val (Any) -- オプションの値

  • fileio (str) -- ファイル入出力の種別 ('in' or 'out')

Returns:

終了コード, 結果, オブジェクト

Return type:

Tuple[int, Dict[str, Any], Any]

valid_str_ctrlchar(logger: Logger, opt: str, type: str, val: Any, fileio: str) → Tuple[int, Dict[str, Any], Any][source]

文字列に制御文字が含まれていないかの妥当性を検証します

Parameters:
  • logger (logging.Logger) -- ロガー

  • opt (str) -- オプション名

  • type (str) -- オプションの型

  • val (Any) -- オプションの値

  • fileio (str) -- ファイル入出力の種別 ('in' or 'out')

Returns:

終了コード, 結果, オブジェクト

Return type:

Tuple[int, Dict[str, Any], Any]

valid_str_max_length(logger: Logger, opt: str, type: str, val: Any, fileio: str) → Tuple[int, Dict[str, Any], Any][source]

文字列の最大長の妥当性を検証します

Parameters:
  • logger (logging.Logger) -- ロガー

  • opt (str) -- オプション名

  • type (str) -- オプションの型

  • val (Any) -- オプションの値

  • fileio (str) -- ファイル入出力の種別 ('in' or 'out')

Returns:

終了コード, 結果, オブジェクト

Return type:

Tuple[int, Dict[str, Any], Any]

valid_type(logger: Logger, opt: str, type: str, val: Any, fileio: str) → Tuple[int, Dict[str, Any], Any][source]

オプションの型の妥当性を検証します

Parameters:
  • logger (logging.Logger) -- ロガー

  • opt (str) -- オプション名

  • type (str) -- オプションの型

  • val (Any) -- オプションの値

  • fileio (str) -- ファイル入出力の種別 ('in' or 'out')

Returns:

終了コード, 結果, オブジェクト

Return type:

Tuple[int, Dict[str, Any], Any]

static validate_safe_path(base_dir: Path, relative_path: str, allow_absolute: bool = False) → Tuple[bool, str][source]

相対パスがベースディレクトリの外に出ていないかバリデーション(パストラバーサル対策)

Parameters:
  • base_dir (Path) -- ベースディレクトリ(絶対パス)

  • relative_path (str) -- チェックする相対パス(ユーザー入力)

  • allow_absolute (bool) -- 絶対パスを許可するか(デフォルト: False)

Returns:

(有効性, エラーメッセージ)

有効な場合: (True, "") 無効な場合: (False, エラーメッセージ)

Return type:

Tuple[bool, str]

validator_type_castfunc = {'bool': <function Validator.<lambda>>, 'date': <function Validator.<lambda>>, 'datetime': <function Validator.<lambda>>, 'dict': <function Validator.<lambda>>, 'dir': <function Validator.<lambda>>, 'file': <function Validator.<lambda>>, 'float': <function Validator.<lambda>>, 'int': <function Validator.<lambda>>, 'passwd': <function Validator.<lambda>>, 'str': <function Validator.<lambda>>, 'text': <function Validator.<lambda>>}
validator_types = {'bool': [<class 'bool'>], 'date': [<class 'str'>], 'datetime': [<class 'str'>], 'dict': [<class 'dict'>], 'dir': [<class 'str'>, <class 'pathlib.Path'>], 'file': [<class 'str'>, <class 'pathlib.Path'>], 'float': [<class 'float'>], 'int': [<class 'int'>], 'passwd': [<class 'str'>], 'str': [<class 'str'>], 'text': [<class 'str'>]}
cmdbox.app.commons.validator.apprun_check(func: Callable) → Callable[source]

コマンドの引数の妥当性を検証するデコレーター

Parameters:

func (Callable) -- コマンドの実行関数

Returns:

デコレーターでラップされた関数

Return type:

Callable

cmdbox.app.commons.validator.async_apprun_check(func: Callable) → Callable[source]

コマンドの引数の妥当性を検証するデコレーター

Parameters:

func (Callable) -- コマンドの実行関数

Returns:

デコレーターでラップされた関数

Return type:

Callable

Module contents