cmdbox.app.features.cli package
Subpackages
- cmdbox.app.features.cli.agent package
- Submodules
- cmdbox.app.features.cli.agent.agant_base module
- cmdbox.app.features.cli.agent.dangerous_sequence module
- cmdbox.app.features.cli.agent.detection_malicious_keyword module
- cmdbox.app.features.cli.agent.detection_sql_injection module
- cmdbox.app.features.cli.agent.detection_template_injection module
- cmdbox.app.features.cli.agent.javascript_injection module
- cmdbox.app.features.cli.agent.prompt_injection_common module
- Module contents
- cmdbox.app.features.cli.audit package
- cmdbox.app.features.cli.cmdbox package
- Submodules
- cmdbox.app.features.cli.cmdbox.cmdbox_base module
CmdboxBaseCmdboxBase.copy_scripts()CmdboxBase.down()CmdboxBase.exec()CmdboxBase.get_imgname()CmdboxBase.get_option()CmdboxBase.load()CmdboxBase.logs()CmdboxBase.make_compose_default()CmdboxBase.make_compose_pgsql()CmdboxBase.make_compose_redis()CmdboxBase.make_compose_server()CmdboxBase.reboot()CmdboxBase.save()CmdboxBase.uninstall()CmdboxBase.up()
- Module contents
- cmdbox.app.features.cli.datasource package
- Submodules
- cmdbox.app.features.cli.datasource.datasource_base module
DatasourceBaseDatasourceBase.DBTYPESDatasourceBase.DBTYPE_PGDatasourceBase.DBTYPE_SQLITEDatasourceBase.build_where()DatasourceBase.fetch_as_dicts()DatasourceBase.get_context()DatasourceBase.is_dbtype_postgresql()DatasourceBase.is_dbtype_sqlite()DatasourceBase.load_datasource()DatasourceBase.qualified_name()DatasourceBase.route_apprun()DatasourceBase.save_datasource()DatasourceBase.validate_col_type()DatasourceBase.validate_columns()DatasourceBase.validate_identifier()DatasourceBase.validate_order_by()
- Module contents
- cmdbox.app.features.cli.excel package
- cmdbox.app.features.cli.rag package
- cmdbox.app.features.cli.test package
- Submodules
- cmdbox.app.features.cli.test.gen_cli_docs module
- cmdbox.app.features.cli.test.gen_cli_spec module
- cmdbox.app.features.cli.test.gen_test_spec module
- cmdbox.app.features.cli.test.run_spec module
- Module contents
Submodules
cmdbox.app.features.cli.cmdbox_a2asv_reload module
- class cmdbox.app.features.cli.cmdbox_a2asv_reload.A2asvReload(appcls, ver, language: str = None)[source]
Bases:
OneshotResultEdgeFeature,Validator
cmdbox.app.features.cli.cmdbox_a2asv_start module
cmdbox.app.features.cli.cmdbox_a2asv_stop module
- class cmdbox.app.features.cli.cmdbox_a2asv_stop.A2asvStop(appcls, ver, language: str = None)[source]
Bases:
UnsupportEdgeFeature,Validator
cmdbox.app.features.cli.cmdbox_agent_agent_del module
- class cmdbox.app.features.cli.cmdbox_agent_agent_del.AgentAgentDel(appcls, ver, language: str = None)[source]
Bases:
OneshotResultEdgeFeature,Validator- async apprun(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]
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int[source]
この機能のサーバー側の実行を行います
- 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:
int
cmdbox.app.features.cli.cmdbox_agent_agent_list module
- class cmdbox.app.features.cli.cmdbox_agent_agent_list.AgentAgentList(appcls, ver, language: str = None)[source]
Bases:
OneshotResultEdgeFeature,Validator- async apprun(logger: Logger, args: Namespace, tm: float, pf: List[Dict[str, float]] = []) Tuple[int, Dict[str, Any], Any]
この機能の実行を行います
- Parameters:
logger (logging.Logger) -- ロガー
args (argparse.Namespace) -- 引数
tm (float) -- 実行開始時間
pf (List[Dict[str, float]]) -- 呼出元のパフォーマンス情報
- Returns:
終了コード, 結果, オブジェクト
- Return type:
Tuple[int, Dict[str, Any], Any]
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int[source]
サーバー側で受け取ったlistコマンドを処理します。
cmdbox.app.features.cli.cmdbox_agent_agent_load module
- class cmdbox.app.features.cli.cmdbox_agent_agent_load.AgentAgentLoad(appcls, ver, language: str = None)[source]
Bases:
OneshotResultEdgeFeature,Validator- async apprun(logger: Logger, args: Namespace, tm: float, pf: List[Dict[str, float]] = []) Tuple[int, Dict[str, Any], Any]
この機能の実行を行います
- Parameters:
logger (logging.Logger) -- ロガー
args (argparse.Namespace) -- 引数
tm (float) -- 実行開始時間
pf (List[Dict[str, float]]) -- 呼出元のパフォーマンス情報
- Returns:
終了コード, 結果, オブジェクト
- Return type:
Tuple[int, Dict[str, Any], Any]
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int[source]
この機能のサーバー側の実行を行います
- 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:
int
cmdbox.app.features.cli.cmdbox_agent_agent_save module
- class cmdbox.app.features.cli.cmdbox_agent_agent_save.AgentAgentSave(appcls, ver, language=None)[source]
Bases:
AgentBase,Validator,LimitedFeature- async apprun(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]
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int
この機能のサーバー側の実行を行います
- 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:
int
- svrun_registrations(data_dir, logger, opt, msg)[source]
svrunの実行結果として登録数(又は登録サイズ)を取得します。 デフォルトの実装では、0 を返します。 このメソッドを拡張して、コマンドの引数やセッション情報などから登録数を算出する処理を実装できます。
- Parameters:
data_dir (Path) -- データディレクトリのパス
logger (logging.Logger) -- ロガー
opt (Dict[str, Any]) -- コマンドのオプション
msg (Union[Dict, str]) -- svrunの処理結果
- Returns:
登録数
- Return type:
int
cmdbox.app.features.cli.cmdbox_agent_chat module
- class cmdbox.app.features.cli.cmdbox_agent_chat.AgentChat(appcls, ver, language: str = None)[source]
Bases:
AgentBase,Validator,LimitedFeature- SET_MODEL_RESPONSE_INSTRUCTION = 'IMPORTANT: You have access to other tools, but you must provide your final response using the set_model_response tool with the required structured format. After using any other tools needed to complete the task, always call set_model_response with your final answer in the specified schema format.'
- async after_chat_run(*, logger: Logger, data_dir: Path, redis_cli: RedisClient, payload: Dict[str, Any], agent_session: Any, reskey: str, chat_ctx: Any) int[source]
Runnerのrun_asyncを実行した直後の拡張ポイントです。
- Parameters:
logger (logging.Logger) -- ロガー
data_dir (Path) -- データディレクトリパス
redis_cli (redis_client.RedisClient) -- Redisクライアント
payload (Dict[str, Any]) -- クライアントからのリクエスト情報
agent_session (Any) -- エージェントセッション
reskey (str) -- レスポンスキー
chat_ctx (Any) -- _before_chat_run で返した値
- Returns:
ステータス
- Return type:
int
- async apprun(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]
- async async_apprun_generate(logger: Logger, host: str, port: int, password: str, svname: str, retry_interval: int, retry_count: int, timeout: int, runner_name: str, user_name: str, session_id: str, a2asv_apikey: str, mcpserver_apikey: str, message: str, call_tts: bool, reasoning_effort: str, signin_user: str = None, signin_groups: List[str] = [], agent_instruction: str = None, agent_system_instruction: str = None)[source]
Agentチャットを実行します
- Parameters:
logger (logging.Logger) -- ロガー
host (str) -- Redisホスト
port (int) -- Redisポート
password (str) -- Redisパスワード
svname (str) -- サービス名
retry_interval (int) -- 再接続インターバル秒数
retry_count (int) -- 再接続回数
timeout (int) -- タイムアウト秒数
runner_name (str) -- Runner設定名
user_name (str) -- ユーザー名
session_id (str) -- セッションID
a2asv_apikey (str) -- A2A Server API Key
mcpserver_apikey (str) -- MCPサーバーAPI Key
message (str) -- メッセージ
call_tts (bool) -- TTS機能を呼び出すかどうか
reasoning_effort (str) -- エージェントで思考の深さ
signin_user (str) -- サインインしているユーザー
signin_groups (List[str]) -- サインインしているユーザーの所属グループ
agent_instruction (str) -- エージェントへの指示
agent_system_instruction (str) -- エージェントのシステム指示
- Yields:
Tuple[int, Any] -- 処理結果ステータスと内容
- async before_chat_run(*, logger: Logger, data_dir: Path, redis_cli: RedisClient, payload: Dict[str, Any], agent_session: Any, reskey: str) Any[source]
Runnerのrun_asyncを実行する直前の拡張ポイントです。
- Parameters:
logger (logging.Logger) -- ロガー
data_dir (Path) -- データディレクトリパス
redis_cli (redis_client.RedisClient) -- Redisクライアント
payload (Dict[str, Any]) -- クライアントからのリクエスト情報
agent_session (Any) -- エージェントセッション
reskey (str) -- レスポンスキー
- Returns:
chat_ctx。後続の _after_chat_run で受け取る値。
- Return type:
Any
- create_agent(*, logger: Logger, data_dir: Path, disable_remote_agent: bool, agent_conf: Dict[str, Any], llm_conf: Dict[str, Any], mcpsv_confs: List[Dict[str, Any]], payload: Dict[str, Any]) Any[source]
エージェントを作成します。
- Parameters:
logger (logging.Logger) -- ロガー
data_dir (Path) -- データディレクトリパス
disable_remote_agent (bool) -- リモートエージェントを無効化するかどうか
agent_conf (Dict[str, Any]) -- エージェント設定
llm_conf (Dict[str, Any]) -- LLM設定
mcpsv_confs (List[Dict[str, Any]]) -- MCPサーバー設定リスト
payload (Dict[str, Any]) -- クライアントからのリクエスト情報
- Returns:
エージェント
- Return type:
- create_agent_before_model_callback(llm_conf: Dict[str, Any]) Callable | None[source]
Agentに設定する before_model_callback を作成します。
supports_native_output_schema_with_tools() が False のプロバイダーに対して、 google-adk が選んだ native 経路を取り消し、set_model_response ツール経路へ 切り替えるコールバックを返します。google-adk 側の後処理は set_model_response という名前の function response だけを見ているため、ツールを手動で足しても 最終回答の組み立ては通常どおり動作します。
- Parameters:
llm_conf (Dict[str, Any]) -- LLM設定
- Returns:
before_model_callback。切り替え不要なら None
- Return type:
Optional[Callable]
- create_agent_output_schema() type[source]
Agentの出力スキーマを作成します。 JSON形式での出力構造を定義します。
- Returns:
pydantic BaseModel のサブクラス (AgentOutput)
- Return type:
type
- create_agent_planner(agent_conf: Dict[str, Any], llm_conf: Dict[str, Any], reasoning_effort: str) Any[source]
エージェントのプランナーを作成します。 :param agent_conf: エージェント設定 :type agent_conf: Dict[str, Any] :param llm_conf: LLM設定 :type llm_conf: Dict[str, Any] :param reasoning_effort: エージェントの思考の深さ :type reasoning_effort: str
- Returns:
プランナー
- Return type:
Planner
- create_agent_tools(logger: Logger, data_dir: Path, agent_conf: Dict[str, Any], mcpsv_confs: List[Dict[str, Any]], payload: Dict[str, Any]) List[Any][source]
Agent用ツール群(MCP + Skill)を作成します
- Parameters:
logger (logging.Logger) -- ロガー
data_dir (Path) -- データディレクトリパス
agent_conf (Dict[str, Any]) -- エージェント設定
mcpsv_confs (List[Dict[str, Any]]) -- MCPサーバー設定リスト
payload (Dict[str, Any]) -- クライアントからのリクエスト情報
- Returns:
Agentへ渡すツール一覧
- Return type:
List[Any]
- create_artifact_service(*, logger: Logger, artifact_root_dir: Path) Any[source]
Artifactサービスを作成します
- Parameters:
logger (logging.Logger) -- ロガー
artifact_root_dir (Path) -- アーティファクトのルートディレクトリ
- Returns:
Artifactサービス
- Return type:
BaseArtifactService
- async create_runner_plugin(*, logger: Logger, data_dir: Path, redis_cli: RedisClient, payload: Dict[str, Any], agent_session: Any, reskey: str) List[Any][source]
Runner用のプラグインを作成します。
Google ADK 公式の BasePlugin インターフェースを使用して、 プロンプトインジェクション攻撃を検知・遮断するプラグインを作成します。
- Parameters:
logger (logging.Logger) -- ロガー
data_dir (Path) -- データディレクトリパス
redis_cli (redis_client.RedisClient) -- Redisクライアント
payload (Dict[str, Any]) -- クライアントからのリクエスト情報
agent_session (Any) -- エージェントセッション
reskey (str) -- レスポンスキー
- Returns:
作成したプラグインのリスト
- Return type:
List[Any]
- create_tool_mcpsv(logger: Logger, mcpsv_confs: List[Dict[str, Any]], payload: Dict[str, Any]) List[Any][source]
MCPサーバーツールを作成します :param logger: ロガー :type logger: logging.Logger :param mcpsv_confs: MCPサーバー設定リスト :type mcpsv_confs: List[Dict[str, Any]] :param payload: クライアントからのリクエスト情報 :type payload: Dict[str, Any]
- Returns:
MCPToolsetのリスト
- Return type:
List[MCPToolset]
- create_tool_skills(logger: Logger, data_dir: Path, agent_conf: Dict[str, Any]) List[Any][source]
SkillToolset を作成します
- Parameters:
logger (logging.Logger) -- ロガー
data_dir (Path) -- データディレクトリパス
agent_conf (Dict[str, Any]) -- エージェント設定
- Returns:
SkillToolset のリスト
- Return type:
List[Any]
- async error_chat_run(*, logger: Logger, data_dir: Path, redis_cli: RedisClient, payload: Any, agent_session: Any, chat_ctx: Any, reskey: str, exc: Exception) int[source]
Runnerのrun_async実行中に例外が発生した場合の拡張ポイントです。
- Parameters:
logger (logging.Logger) -- ロガー
data_dir (Path) -- データディレクトリパス
redis_cli (redis_client.RedisClient) -- Redisクライアント
payload (Any) -- クライアントからのリクエスト情報
agent_session (Any) -- エージェントセッション
chat_ctx (Any) -- _before_chat_run で返した値
reskey (str) -- レスポンスキー
exc (Exception) -- 発生した例外
- Returns:
ステータス
- Return type:
int
- get_reasoning_effort(agent_conf: Dict[str, Any], payload: Dict[str, Any]) str[source]
エージェントの思考の深さを取得します :param agent_conf: エージェント設定 :type agent_conf: Dict[str, Any] :param payload: クライアントからのリクエスト情報 :type payload: Dict[str, Any]
- Returns:
reasoning_effortの設定
- Return type:
str
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- prepare_agent_conf(agent_conf: Dict[str, Any], payload: Dict[str, Any]) Dict[str, Any][source]
Agent設定を準備します。payloadの内容をagent_confに反映させます。
- Parameters:
agent_conf (Dict[str, Any]) -- エージェント設定
payload (Dict[str, Any]) -- クライアントからのリクエスト情報
- Returns:
更新後のエージェント設定
- Return type:
Dict[str, Any]
- supports_native_output_schema_with_tools(llm_conf: Dict[str, Any]) bool[source]
output_schema を tools と同一リクエストで送れるプロバイダーかどうかを返します。
google-adk は output_schema の適用方法を2通り持ちます。native 経路は response_format(json_schema) としてリクエストに載せる方法、tool 経路は スキーマをパラメータに持つ set_model_response ツールとして公開する方法です。 google.adk.utils.output_schema_utils.can_use_output_schema_with_tools() は LiteLlm インスタンスに対して常に True を返すため、常に native が選ばれます。
しかし native 経路が使えるのは OpenAI / Azure OpenAI のようなマネージド API に 限られます。ローカル推論サーバー(ollama / vLLM 等)は response_format を guided decoding で実装しており、その文法はツール呼び出し形式の生成を禁止するため、 両方を同時に送るとツール呼び出しが一切できなくなります(モデルはスキーマだけを 埋めて回答し、実行していないツールの結果を捏造します)。
False を返したプロバイダーには create_agent_before_model_callback() が tool 経路へ切り替えるコールバックを設定します。
- Parameters:
llm_conf (Dict[str, Any]) -- LLM設定
- Returns:
native 経路が使えるなら True
- Return type:
bool
- async svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int
この機能のサーバー側の実行を行います
- 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:
int
- svrun_credit(data_dir, logger, opt, msg)[source]
svrunの実行結果として使用クレジット数を取得します。 デフォルトの実装では、0 を返します。 このメソッドを拡張して、コマンドの引数やセッション情報などから使用クレジット数を算出する処理を実装できます。
- Parameters:
data_dir (Path) -- データディレクトリのパス
logger (logging.Logger) -- ロガー
opt (Dict[str, Any]) -- コマンドのオプション
msg (Union[Dict, str]) -- svrunの処理結果
- Returns:
使用クレジット数
- Return type:
int
- svrun_output_bytes(data_dir, logger, opt, msg, msg_size)[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
- class cmdbox.app.features.cli.cmdbox_agent_chat.AgentOutput(*, success: bool | None = None, command: str | None = None, parameters_json: str | None = None, result_json: str | None = None, error: str | None = None, message: str | List[AgentOutputContent] | None = None)[source]
Bases:
BaseModelAgentの出力スキーマ。
google-adk の output_schema には dict も渡せますが、SetModelResponseTool は type[BaseModel] のときだけフィールド毎の型付きツール宣言を生成します。dict を渡すと google-adk<=2.3.0 では宣言生成時に例外、2.4.0 以降は検証なしの単一パラメータ (response: object) に退化し、モデルは埋めるべき構造を知らされません。
全フィールドを Optional にしています。必須にすると、コマンドを実行しない通常の 会話ターンでモデルが command / result_json を捏造せざるを得なくなり、捏造しなければ pydantic の検証エラーがそのまま最終回答として利用者に返ります。
なお tool 経路では SetModelResponseTool がツール宣言を model_fields[].annotation だけから組み立て直すため、下記の description と既定値はモデルに渡りません (フィールド名6個が、すべて required として提示されます)。いずれも実害はありません: フィールド名自体が内容を表しており、どのフィールドに何を入れるかは agent_instruction 側で指示するのが本来の役割で、応答の検証は従来どおり本モデルで行われます。 native 経路ではスキーマがそのまま送られ、description も届きます。
- command: str | None
- error: str | None
- message: str | List[AgentOutputContent] | None
- model_config = {}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
- parameters_json: str | None
- result_json: str | None
- success: bool | None
- class cmdbox.app.features.cli.cmdbox_agent_chat.AgentOutputContent(*, content_type: str | None = None, content_name: str | None = None, content_link: str | None = None, content_body_b64: str | None = None)[source]
Bases:
BaseModelAgentの出力内容のスキーマ。
- content_body_b64: str | None
- content_link: str | None
- content_name: str | None
- content_type: str | None
- model_config = {}
Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].
cmdbox.app.features.cli.cmdbox_agent_mcp_client module
- class cmdbox.app.features.cli.cmdbox_agent_mcp_client.AgentMcpClient(appcls, ver, language: str = None)[source]
Bases:
UnsupportEdgeFeature,Validator,LimitedFeature- async apprun(logger: Logger, args: Namespace, tm: float, pf: List[Dict[str, float]] = []) Tuple[int, Dict[str, Any], Any]
この機能の実行を行います
- Parameters:
logger (logging.Logger) -- ロガー
args (argparse.Namespace) -- 引数
tm (float) -- 実行開始時間
pf (List[Dict[str, float]]) -- 呼出元のパフォーマンス情報
- Returns:
終了コード, 結果, オブジェクト
- Return type:
Tuple[int, Dict[str, Any], Any]
- apprun_credit(data_dir, logger, args, msg)[source]
apprunの実行結果として使用クレジット数を取得します。 デフォルトの実装では、0 を返します。 このメソッドを拡張して、コマンドの引数やセッション情報などから使用クレジット数を算出する処理を実装できます。
- Parameters:
data_dir (Path) -- データディレクトリのパス
logger (logging.Logger) -- ロガー
args (argparse.Namespace) -- コマンドの引数
msg (Dict[str, Any]) -- apprunの処理結果
- Returns:
使用クレジット数
- Return type:
int
cmdbox.app.features.cli.cmdbox_agent_mcp_proxy module
- class cmdbox.app.features.cli.cmdbox_agent_mcp_proxy.AgentMcpProxy(appcls, ver, language: str = None)[source]
Bases:
UnsupportEdgeFeature,Validator,LimitedFeature- apprun(logger: Logger, args: Namespace, tm: float, pf: List[Dict[str, float]] = []) Tuple[int, Dict[str, Any], Any]
この機能の実行を行います
- Parameters:
logger (logging.Logger) -- ロガー
args (argparse.Namespace) -- 引数
tm (float) -- 実行開始時間
pf (List[Dict[str, float]]) -- 呼出元のパフォーマンス情報
- Returns:
終了コード, 結果, オブジェクト
- Return type:
Tuple[int, Dict[str, Any], Any]
- apprun_credit(data_dir, logger, args, msg)[source]
apprunの実行結果として使用クレジット数を取得します。 デフォルトの実装では、0 を返します。 このメソッドを拡張して、コマンドの引数やセッション情報などから使用クレジット数を算出する処理を実装できます。
- Parameters:
data_dir (Path) -- データディレクトリのパス
logger (logging.Logger) -- ロガー
args (argparse.Namespace) -- コマンドの引数
msg (Dict[str, Any]) -- apprunの処理結果
- Returns:
使用クレジット数
- Return type:
int
cmdbox.app.features.cli.cmdbox_agent_mcpsv_del module
- class cmdbox.app.features.cli.cmdbox_agent_mcpsv_del.AgentMcpDel(appcls, ver, language: str = None)[source]
Bases:
OneshotResultEdgeFeature,Validator- async apprun(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]
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int[source]
この機能のサーバー側の実行を行います
- 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:
int
cmdbox.app.features.cli.cmdbox_agent_mcpsv_list module
- class cmdbox.app.features.cli.cmdbox_agent_mcpsv_list.AgentMcpList(appcls, ver, language: str = None)[source]
Bases:
OneshotResultEdgeFeature,Validator- async apprun(logger: Logger, args: Namespace, tm: float, pf: List[Dict[str, float]] = []) Tuple[int, Dict[str, Any], Any]
この機能の実行を行います
- Parameters:
logger (logging.Logger) -- ロガー
args (argparse.Namespace) -- 引数
tm (float) -- 実行開始時間
pf (List[Dict[str, float]]) -- 呼出元のパフォーマンス情報
- Returns:
終了コード, 結果, オブジェクト
- Return type:
Tuple[int, Dict[str, Any], Any]
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int[source]
この機能のサーバー側の実行を行います
- 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:
int
cmdbox.app.features.cli.cmdbox_agent_mcpsv_load module
- class cmdbox.app.features.cli.cmdbox_agent_mcpsv_load.AgentMcpLoad(appcls, ver, language: str = None)[source]
Bases:
OneshotResultEdgeFeature,Validator- async apprun(logger: Logger, args: Namespace, tm: float, pf: List[Dict[str, float]] = []) Tuple[int, Dict[str, Any], Any]
この機能の実行を行います
- Parameters:
logger (logging.Logger) -- ロガー
args (argparse.Namespace) -- 引数
tm (float) -- 実行開始時間
pf (List[Dict[str, float]]) -- 呼出元のパフォーマンス情報
- Returns:
終了コード, 結果, オブジェクト
- Return type:
Tuple[int, Dict[str, Any], Any]
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int[source]
この機能のサーバー側の実行を行います
- 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:
int
cmdbox.app.features.cli.cmdbox_agent_mcpsv_save module
- class cmdbox.app.features.cli.cmdbox_agent_mcpsv_save.AgentMcpSave(appcls, ver, language: str = None)[source]
Bases:
OneshotResultEdgeFeature,Validator,LimitedFeature- async apprun(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]
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int
この機能のサーバー側の実行を行います
- 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:
int
- svrun_registrations(data_dir, logger, opt, msg)[source]
svrunの実行結果として登録数(又は登録サイズ)を取得します。 デフォルトの実装では、0 を返します。 このメソッドを拡張して、コマンドの引数やセッション情報などから登録数を算出する処理を実装できます。
- Parameters:
data_dir (Path) -- データディレクトリのパス
logger (logging.Logger) -- ロガー
opt (Dict[str, Any]) -- コマンドのオプション
msg (Union[Dict, str]) -- svrunの処理結果
- Returns:
登録数
- Return type:
int
cmdbox.app.features.cli.cmdbox_agent_runner_del module
- class cmdbox.app.features.cli.cmdbox_agent_runner_del.AgentRunnerDel(appcls, ver, language: str = None)[source]
Bases:
OneshotResultEdgeFeature,Validator- async apprun(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]
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int[source]
この機能のサーバー側の実行を行います
- 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:
int
cmdbox.app.features.cli.cmdbox_agent_runner_list module
- class cmdbox.app.features.cli.cmdbox_agent_runner_list.AgentRunnerList(appcls, ver, language: str = None)[source]
Bases:
OneshotResultEdgeFeature,Validator- async apprun(logger: Logger, args: Namespace, tm: float, pf: List[Dict[str, float]] = []) Tuple[int, Dict[str, Any], Any]
この機能の実行を行います
- Parameters:
logger (logging.Logger) -- ロガー
args (argparse.Namespace) -- 引数
tm (float) -- 実行開始時間
pf (List[Dict[str, float]]) -- 呼出元のパフォーマンス情報
- Returns:
終了コード, 結果, オブジェクト
- Return type:
Tuple[int, Dict[str, Any], Any]
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int[source]
サーバー側で受け取ったlistコマンドを処理します。
cmdbox.app.features.cli.cmdbox_agent_runner_load module
- class cmdbox.app.features.cli.cmdbox_agent_runner_load.AgentRunnerLoad(appcls, ver, language: str = None)[source]
Bases:
OneshotResultEdgeFeature,Validator- async apprun(logger: Logger, args: Namespace, tm: float, pf: List[Dict[str, float]] = []) Tuple[int, Dict[str, Any], Any]
この機能の実行を行います
- Parameters:
logger (logging.Logger) -- ロガー
args (argparse.Namespace) -- 引数
tm (float) -- 実行開始時間
pf (List[Dict[str, float]]) -- 呼出元のパフォーマンス情報
- Returns:
終了コード, 結果, オブジェクト
- Return type:
Tuple[int, Dict[str, Any], Any]
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int[source]
この機能のサーバー側の実行を行います
- 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:
int
cmdbox.app.features.cli.cmdbox_agent_runner_save module
- class cmdbox.app.features.cli.cmdbox_agent_runner_save.AgentRunnerSave(appcls, ver, language=None)[source]
Bases:
OneshotResultEdgeFeature,Validator,LimitedFeature- async apprun(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]
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int
この機能のサーバー側の実行を行います
- 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:
int
- svrun_registrations(data_dir, logger, opt, msg)[source]
svrunの実行結果として登録数(又は登録サイズ)を取得します。 デフォルトの実装では、0 を返します。 このメソッドを拡張して、コマンドの引数やセッション情報などから登録数を算出する処理を実装できます。
- Parameters:
data_dir (Path) -- データディレクトリのパス
logger (logging.Logger) -- ロガー
opt (Dict[str, Any]) -- コマンドのオプション
msg (Union[Dict, str]) -- svrunの処理結果
- Returns:
登録数
- Return type:
int
cmdbox.app.features.cli.cmdbox_agent_session_del module
- class cmdbox.app.features.cli.cmdbox_agent_session_del.AgentSessionDel(appcls, ver, language: str = None)[source]
-
- async apprun(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]
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- async svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]])[source]
この機能のサーバー側の実行を行います
- 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:
int
cmdbox.app.features.cli.cmdbox_agent_session_list module
- class cmdbox.app.features.cli.cmdbox_agent_session_list.AgentSessionList(appcls, ver, language: str = None)[source]
-
- async apprun(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]
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- async svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]])[source]
この機能のサーバー側の実行を行います
- 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:
int
cmdbox.app.features.cli.cmdbox_audit_createdb module
- class cmdbox.app.features.cli.cmdbox_audit_createdb.AuditCreatedb(appcls, ver, language: str = None)[source]
Bases:
UnsupportEdgeFeature,Validator- async apprun(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]
- createdb(reskey: str, pg_host: str, pg_port: int, pg_user: str, pg_password: str, pg_dbname: str, new_pg_dbname: str, data_dir: Path, logger: Logger, redis_cli: RedisClient) int[source]
監査ログデータベースを作成する
- Parameters:
reskey (str) -- レスポンスキー
pg_host (str) -- PostgreSQLホスト
pg_port (int) -- PostgreSQLポート
pg_user (str) -- PostgreSQLユーザー
pg_password (str) -- PostgreSQLパスワード
pg_dbname (str) -- PostgreSQLデータベース名
new_pg_dbname (str) -- 新しいPostgreSQLデータベース名
data_dir (Path) -- データディレクトリ
logger (logging.Logger) -- ロガー
redis_cli (redis_client.RedisClient) -- Redisクライアント
- Returns:
レスポンスコード
- Return type:
int
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int[source]
この機能のサーバー側の実行を行います
- 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:
int
cmdbox.app.features.cli.cmdbox_audit_delete module
- class cmdbox.app.features.cli.cmdbox_audit_delete.AuditDelete(appcls, ver, language: str = None)[source]
-
- async apprun(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]
- delete(reskey: str, delete_audit_type: str, delete_clmsg_id: str, delete_clmsg_sdate: str, delete_clmsg_edate: str, delete_clmsg_src: str, delete_clmsg_title: str, delete_clmsg_user: str, delete_clmsg_body: Dict[str, Any], delete_clmsg_tag: List[str], delete_svmsg_id: str, delete_svmsg_sdate: str, delete_svmsg_edate: str, pg_enabled: bool, pg_host: str, pg_port: int, pg_user: str, pg_password: str, pg_dbname: str, data_dir: Path, logger: Logger, redis_cli: RedisClient) int[source]
監査ログを検索する
- Parameters:
reskey (str) -- レスポンスキー
delete_audit_type (str) -- 監査の種類
delete_clmsg_id (str) -- クライアントメッセージID
delete_clmsg_sdate (str) -- クライアントメッセージ発生日時(開始)
delete_clmsg_edate (str) -- クライアントメッセージ発生日時(終了)
delete_clmsg_src (str) -- クライアントメッセージの発生源
delete_clmsg_title (str) -- クライアントメッセージのタイトル
delete_clmsg_user (str) -- クライアントメッセージの発生させたユーザー
delete_clmsg_body (Dict[str, Any]) -- クライアントメッセージの本文
delete_clmsg_tag (List[str]) -- クライアントメッセージのタグ
delete_svmsg_id (str) -- サーバーメッセージID
delete_svmsg_sdate (str) -- サーバーメッセージ発生日時(開始)
delete_svmsg_edate (str) -- サーバーメッセージ発生日時(終了)
pg_enabled (bool) -- PostgreSQLを使用する場合はTrue
pg_host (str) -- PostgreSQLホスト
pg_port (int) -- PostgreSQLポート
pg_user (str) -- PostgreSQLユーザー
pg_password (str) -- PostgreSQLパスワード
pg_dbname (str) -- PostgreSQLデータベース名
data_dir (Path) -- データディレクトリ
logger (logging.Logger) -- ロガー
redis_cli (redis_client.RedisClient) -- Redisクライアント
- Returns:
レスポンスコード
- Return type:
int
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int[source]
この機能のサーバー側の実行を行います
- 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:
int
cmdbox.app.features.cli.cmdbox_audit_search module
- class cmdbox.app.features.cli.cmdbox_audit_search.AuditSearch(appcls, ver, language: str = None)[source]
-
- async apprun(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]
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- search(*, reskey: str, select: Dict[str, str], select_date_format: str, groupby: List[str], groupby_date_format: str, sort: Dict[str, str], offset: int, limit: int, filter_audit_type: List[str], filter_clmsg_id: str, filter_clmsg_sdate: str, filter_clmsg_edate: str, filter_clmsg_src: str, filter_clmsg_title: str, filter_clmsg_user: str, filter_clmsg_body: Dict[str, Any], filter_clmsg_tag: List[str], filter_svmsg_id: str, filter_svmsg_sdate: str, filter_svmsg_edate: str, exclude_audit_type: List[str], exclude_clmsg_src: List[str], exclude_clmsg_title: List[str], exclude_clmsg_user: List[str], exclude_clmsg_body: Dict[str, Any], exclude_clmsg_tag: List[str], pg_enabled: bool, pg_host: str, pg_port: int, pg_user: str, pg_password: str, pg_dbname: str, data_dir: Path, logger: Logger, redis_cli: RedisClient) int[source]
監査ログを検索する
- Parameters:
reskey (str) -- レスポンスキー
select (Dict[str, str]) -- 取得項目
select_date_format (str) -- 取得項目の日時フォーマット
groupby (List[str]) -- グループ化項目
groupby_date_format (str) -- グループ化項目の日時フォーマット
sort (Dict[str, str]) -- ソート条件
offset (int) -- 取得する行の開始位置
limit (int) -- 取得する行数
filter_audit_type (List[str]) -- 監査の種類(複数可)
filter_clmsg_id (str) -- クライアントメッセージID
filter_clmsg_sdate (str) -- クライアントメッセージ発生日時(開始)
filter_clmsg_edate (str) -- クライアントメッセージ発生日時(終了)
filter_clmsg_src (str) -- クライアントメッセージの発生源
filter_clmsg_title (str) -- クライアントメッセージのタイトル
filter_clmsg_user (str) -- クライアントメッセージの発生させたユーザー
filter_clmsg_body (Dict[str, Any]) -- クライアントメッセージの本文
filter_clmsg_tag (List[str]) -- クライアントメッセージのタグ
filter_svmsg_id (str) -- サーバーメッセージID
filter_svmsg_sdate (str) -- サーバーメッセージ発生日時(開始)
filter_svmsg_edate (str) -- サーバーメッセージ発生日時(終了)
exclude_audit_type (List[str]) -- 除外条件の監査の種類(複数可)
exclude_clmsg_src (List[str]) -- 除外条件のクライアントメッセージの発生源
exclude_clmsg_title (List[str]) -- 除外条件のクライアントメッセージのタイトル
exclude_clmsg_user (List[str]) -- 除外条件のクライアントメッセージの発生させたユーザー
exclude_clmsg_body (Dict[str, Any]) -- 除外条件のクライアントメッセージの本文
exclude_clmsg_tag (List[str]) -- 除外条件のクライアントメッセージのタグ
pg_enabled (bool) -- PostgreSQLを使用する場合はTrue
pg_host (str) -- PostgreSQLホスト
pg_port (int) -- PostgreSQLポート
pg_user (str) -- PostgreSQLユーザー
pg_password (str) -- PostgreSQLパスワード
pg_dbname (str) -- PostgreSQLデータベース名
data_dir (Path) -- データディレクトリ
logger (logging.Logger) -- ロガー
redis_cli (redis_client.RedisClient) -- Redisクライアント
- Returns:
レスポンスコード
- Return type:
int
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int[source]
この機能のサーバー側の実行を行います
- 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:
int
cmdbox.app.features.cli.cmdbox_audit_write module
- class cmdbox.app.features.cli.cmdbox_audit_write.AuditWrite(appcls, ver, language=None)[source]
-
- RETENTION_CLEANUP_INTERVAL_SEC = 300
- async apprun(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]
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int[source]
この機能のサーバー側の実行を行います
- 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:
int
- write(conn, *, reskey: str, audit_type: str, clmsg_id: str, clmsg_date: str, clmsg_src: str, clmsg_title: str, clmsg_user: str, clmsg_body: str, clmsg_tag: str, svmsg_id: str, pg_enabled: bool, retention_period_days: int, logger: Logger, redis_cli: RedisClient) int[source]
監査ログを書き込む
- Parameters:
conn -- データベース接続
reskey (str) -- レスポンスキー
audit_type (str) -- 監査の種類
clmsg_id (str) -- クライアントメッセージID
clmsg_date (str) -- クライアントメッセージ発生日時
clmsg_src (str) -- クライアントメッセージの発生源
clmsg_title (str) -- クライアントメッセージのタイトル
clmsg_user (str) -- クライアントメッセージの発生させたユーザー
clmsg_body (str) -- クライアントメッセージの本文
clmsg_tag (str) -- クライアントメッセージのタグ
svmsg_id (str) -- サーバーメッセージID
pg_enabled (bool) -- PostgreSQLを使用する場合はTrue
retention_period_days (int) -- 監査を保存する日数
logger (logging.Logger) -- ロガー
redis_cli (redis_client.RedisClient) -- Redisクライアント
- Returns:
レスポンスコード
- Return type:
int
cmdbox.app.features.cli.cmdbox_client_file_copy module
- class cmdbox.app.features.cli.cmdbox_client_file_copy.ClientFileCopy(appcls, ver, language: str = None)[source]
Bases:
UnsupportEdgeFeature,Validator,LimitedFeature- apprun(logger: Logger, args: Namespace, tm: float, pf: List[Dict[str, float]] = []) Tuple[int, Dict[str, Any], Any]
この機能の実行を行います
- Parameters:
logger (logging.Logger) -- ロガー
args (argparse.Namespace) -- 引数
tm (float) -- 実行開始時間
pf (List[Dict[str, float]]) -- 呼出元のパフォーマンス情報
- Returns:
終了コード, 結果, オブジェクト
- Return type:
Tuple[int, Dict[str, Any], Any]
- apprun_registrations(data_dir, logger, args, msg)[source]
apprunの実行結果として登録数(又は登録サイズ)を取得します。 デフォルトの実装では、0 を返します。 このメソッドを拡張して、コマンドの引数やセッション情報などから登録数を算出する処理を実装できます。
- Parameters:
data_dir (Path) -- データディレクトリのパス
logger (logging.Logger) -- ロガー
args (argparse.Namespace) -- コマンドの引数
msg (Dict[str, Any]) -- apprunの処理結果
- Returns:
登録数
- Return type:
int
- file_copy(reskey: str, from_path: str, to_path: str, overwrite: bool, from_fwpaths: List[str], to_fwpaths: List[str], from_rjpaths: List[str], to_rjpaths: List[str], meta: Dict[str, Any], data_dir: Path, logger: Logger, redis_cli: RedisClient, sessions: Dict[str, Dict[str, Any]]) int[source]
ファイルをコピーする
- Parameters:
reskey (str) -- レスポンスキー
from_path (str) -- コピー元ファイルパス
to_path (str) -- コピー先ファイルパス
overwrite (bool) -- 上書きするかどうか
from_fwpaths (List[str], optional) -- 範囲内かどうかを示すパスのリスト. Defaults to None.
to_fwpaths (List[str], optional) -- 範囲内かどうかを示すパスのリスト. Defaults to None.
from_rjpaths (List[str], optional) -- 範囲外かどうかを示すパスのリスト. Defaults to None.
to_rjpaths (List[str], optional) -- 範囲外かどうかを示すパスのリスト. Defaults to None.
meta (Dict[str, Any], optional) -- メタデータ. Defaults to None.
data_dir (Path) -- データディレクトリ
logger (logging.Logger) -- ロガー
redis_cli (redis_client.RedisClient) -- Redisクライアント
sessions (Dict[str, Dict[str, Any]]) -- セッション情報
- Returns:
レスポンスコード
- Return type:
int
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int
この機能のサーバー側の実行を行います
- 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:
int
- svrun_registrations(data_dir, logger, opt, msg)[source]
svrunの実行結果として登録数(又は登録サイズ)を取得します。 デフォルトの実装では、0 を返します。 このメソッドを拡張して、コマンドの引数やセッション情報などから登録数を算出する処理を実装できます。
- Parameters:
data_dir (Path) -- データディレクトリのパス
logger (logging.Logger) -- ロガー
opt (Dict[str, Any]) -- コマンドのオプション
msg (Union[Dict, str]) -- svrunの処理結果
- Returns:
登録数
- Return type:
int
cmdbox.app.features.cli.cmdbox_client_file_download module
- class cmdbox.app.features.cli.cmdbox_client_file_download.ClientFileDownload(appcls, ver, language=None, meta_chk=True)[source]
Bases:
OneshotEdgeFeature,Validator,LimitedFeature- apprun(logger: Logger, args: Namespace, tm: float, pf: List[Dict[str, float]] = []) Tuple[int, Dict[str, Any], Any]
この機能の実行を行います
- Parameters:
logger (logging.Logger) -- ロガー
args (argparse.Namespace) -- 引数
tm (float) -- 実行開始時間
pf (List[Dict[str, float]]) -- 呼出元のパフォーマンス情報
- Returns:
終了コード, 結果, オブジェクト
- Return type:
Tuple[int, Dict[str, Any], Any]
- file_download(reskey: str, current_path: str, img_thumbnail: float, fwpaths: List[str], rjpaths: List[str], meta_chk: bool, meta: Dict[str, Any], etag: str, data_dir: Path, logger: Logger, redis_cli: RedisClient, sessions: Dict[str, Dict[str, Any]]) int[source]
ファイルをダウンロードする
- Parameters:
reskey (str) -- レスポンスキー
current_path (str) -- ファイルパス
fwpaths (List[str]) -- 範囲内かどうかを示すパスのリスト
rjpaths (List[str]) -- 範囲外かどうかを示すパスのリスト
meta_chk (bool) -- .metaディレクトリのチェックを行うかどうか
meta (Dict[str, Any]) -- メタデータ
img_thumbnail (float, optional) -- サムネイルサイズ. Defaults to 0.0.
etag (str, optional) -- ETag. Defaults to None.
data_dir (Path) -- データディレクトリ
logger (logging.Logger) -- ロガー
redis_cli (redis_client.RedisClient) -- Redisクライアント
sessions (Dict[str, Dict[str, Any]]) -- セッション情報
- Returns:
レスポンスコード
- Return type:
int
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int
この機能のサーバー側の実行を行います
- 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:
int
cmdbox.app.features.cli.cmdbox_client_file_is module
- class cmdbox.app.features.cli.cmdbox_client_file_is.ClientFileIs(appcls, ver, language: str = None)[source]
Bases:
OneshotResultEdgeFeature,Validator- apprun(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]
- file_is(reskey: str, file_func: str, svpath: str, from_path: str, to_path: str, fwpaths: List[str], rjpaths: List[str], from_fwpaths: List[str], to_fwpaths: List[str], from_rjpaths: List[str], to_rjpaths: List[str], data_dir: Path, logger: Logger, redis_cli: RedisClient, sessions: Dict[str, Dict[str, Any]]) int[source]
指定した操作が実行可能かどうかを確認する
- Parameters:
reskey (str) -- レスポンスキー
file_func (str) -- 操作種別
svpath (str) -- 操作対象パス
from_path (str) -- コピー・移動元パス
to_path (str) -- コピー・移動先パス
fwpaths (List[str]) -- 範囲内かどうかを示すパスのリスト
rjpaths (List[str]) -- 範囲外かどうかを示すパスのリスト
from_fwpaths (List[str]) -- コピー・移動元の範囲内パスのリスト
to_fwpaths (List[str]) -- コピー・移動先の範囲内パスのリスト
from_rjpaths (List[str]) -- コピー・移動元の範囲外パスのリスト
to_rjpaths (List[str]) -- コピー・移動先の範囲外パスのリスト
data_dir (Path) -- データディレクトリ
logger (logging.Logger) -- ロガー
redis_cli (redis_client.RedisClient) -- Redisクライアント
sessions (Dict[str, Dict[str, Any]]) -- セッション情報
- Returns:
レスポンスコード
- Return type:
int
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int[source]
この機能のサーバー側の実行を行います
- 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:
int
cmdbox.app.features.cli.cmdbox_client_file_list module
- class cmdbox.app.features.cli.cmdbox_client_file_list.ClientFileList(appcls, ver, language: str = None)[source]
Bases:
OneshotResultEdgeFeature,Validator- apprun(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]
- file_list(reskey: str, current_path: str, recursive: bool, fwpaths: List[str], rjpaths: List[str], listregs: str, data_dir: Path, logger: Logger, redis_cli: RedisClient, sessions: Dict[str, Dict[str, Any]], summary: bool = False) int[source]
ファイルリストを取得する
- Parameters:
reskey (str) -- レスポンスキー
current_path (str) -- ファイルパス
recursive (bool) -- 再帰的に取得するかどうか
fwpaths (List[str]) -- 範囲内かどうかを示すパスのリスト
rjpaths (List[str]) -- 範囲外かどうかを示すパスのリスト
listregs (str) -- リストアップする正規表現条件
data_dir (Path) -- データディレクトリ
logger (logging.Logger) -- ロガー
redis_cli (redis_client.RedisClient) -- Redisクライアント
sessions (Dict[str, Dict[str, Any]]) -- セッション情報
summary (bool) -- 要約情報を取得するかどうか
- Returns:
レスポンスコード
- Return type:
int
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int[source]
この機能のサーバー側の実行を行います
- 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:
int
cmdbox.app.features.cli.cmdbox_client_file_mkdir module
- class cmdbox.app.features.cli.cmdbox_client_file_mkdir.ClientFileMkdir(appcls, ver, language: str = None)[source]
Bases:
UnsupportEdgeFeature,Validator,LimitedFeature- apprun(logger: Logger, args: Namespace, tm: float, pf: List[Dict[str, float]] = []) Tuple[int, Dict[str, Any], Any]
この機能の実行を行います
- Parameters:
logger (logging.Logger) -- ロガー
args (argparse.Namespace) -- 引数
tm (float) -- 実行開始時間
pf (List[Dict[str, float]]) -- 呼出元のパフォーマンス情報
- Returns:
終了コード, 結果, オブジェクト
- Return type:
Tuple[int, Dict[str, Any], Any]
- file_mkdir(reskey: str, current_path: str, fwpaths: List[str], rjpaths: List[str], exist_ok: bool, data_dir: Path, logger: Logger, redis_cli: RedisClient, sessions: Dict[str, Dict[str, Any]]) int[source]
ディレクトリを作成する
- Parameters:
reskey (str) -- レスポンスキー
current_path (str) -- ディレクトリパス
fwpaths (List[str]) -- 範囲内かどうかを示すパスのリスト
rjpaths (List[str]) -- 範囲外かどうかを示すパスのリスト
exist_ok (bool) -- 既に存在する場合にエラーを出さないかどうか
data_dir (Path) -- データディレクトリ
logger (logging.Logger) -- ロガー
redis_cli (redis_client.RedisClient) -- Redisクライアント
sessions (Dict[str, Dict[str, Any]]) -- セッション情報
- Returns:
レスポンスコード
- Return type:
int
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int
この機能のサーバー側の実行を行います
- 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:
int
cmdbox.app.features.cli.cmdbox_client_file_move module
- class cmdbox.app.features.cli.cmdbox_client_file_move.ClientFileMove(appcls, ver, language: str = None)[source]
Bases:
UnsupportEdgeFeature,Validator,LimitedFeature- apprun(logger: Logger, args: Namespace, tm: float, pf: List[Dict[str, float]] = []) Tuple[int, Dict[str, Any], Any]
この機能の実行を行います
- Parameters:
logger (logging.Logger) -- ロガー
args (argparse.Namespace) -- 引数
tm (float) -- 実行開始時間
pf (List[Dict[str, float]]) -- 呼出元のパフォーマンス情報
- Returns:
終了コード, 結果, オブジェクト
- Return type:
Tuple[int, Dict[str, Any], Any]
- file_move(reskey: str, from_path: str, to_path: str, from_fwpaths: List[str], to_fwpaths: List[str], from_rjpaths: List[str], to_rjpaths: List[str], meta: Dict[str, Any], data_dir: Path, logger: Logger, redis_cli: RedisClient, sessions: Dict[str, Dict[str, Any]]) int[source]
ファイルを移動する
- Parameters:
reskey (str) -- レスポンスキー
from_path (str) -- 移動元ファイルパス
to_path (str) -- 移動先ファイルパス
from_fwpaths (List[str], optional) -- 移動元の範囲外パスのリスト.
to_fwpaths (List[str], optional) -- 移動先の範囲外パスのリスト.
from_rjpaths (List[str], optional) -- 移動元の範囲外パスのリスト.
to_rjpaths (List[str], optional) -- 移動先の範囲外パスのリスト.
meta (Dict[str, Any], optional) -- メタデータ. Defaults to None.
data_dir (Path) -- データディレクトリ
logger (logging.Logger) -- ロガー
redis_cli (redis_client.RedisClient) -- Redisクライアント
sessions (Dict[str, Dict[str, Any]]) -- セッション情報
- Returns:
レスポンスコード
- Return type:
int
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int
この機能のサーバー側の実行を行います
- 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:
int
cmdbox.app.features.cli.cmdbox_client_file_remove module
- class cmdbox.app.features.cli.cmdbox_client_file_remove.ClientFileRemove(appcls, ver, language: str = None)[source]
Bases:
UnsupportEdgeFeature,Validator- apprun(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]
- file_remove(reskey: str, current_path: str, fwpaths: List[str], rjpaths: List[str], notexist_ok: bool, data_dir: Path, logger: Logger, redis_cli: RedisClient, sessions: Dict[str, Dict[str, Any]]) int[source]
ファイルを削除する
- Parameters:
reskey (str) -- レスポンスキー
current_path (str) -- ファイルパス
fwpaths (List[str]) -- 範囲内パスのリスト
rjpaths (List[str]) -- 範囲外パスのリスト
notexist_ok (bool) -- ファイルが存在しない場合にエラーを出さないかどうか
data_dir (Path) -- データディレクトリ
logger (logging.Logger) -- ロガー
redis_cli (redis_client.RedisClient) -- Redisクライアント
sessions (Dict[str, Dict[str, Any]]) -- セッション情報
- Returns:
レスポンスコード
- Return type:
int
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int[source]
この機能のサーバー側の実行を行います
- 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:
int
cmdbox.app.features.cli.cmdbox_client_file_rmdir module
- class cmdbox.app.features.cli.cmdbox_client_file_rmdir.ClientFileRmdir(appcls, ver, language: str = None)[source]
Bases:
UnsupportEdgeFeature,Validator- apprun(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]
- file_rmdir(reskey: str, current_path: str, data_dir: Path, fwpaths: List[str], rjpaths: List[str], notexist_ok: bool, logger: Logger, redis_cli: RedisClient, sessions: Dict[str, Dict[str, Any]]) int[source]
ディレクトリを削除する
- Parameters:
reskey (str) -- レスポンスキー
current_path (str) -- ディレクトリパス
data_dir (Path) -- データディレクトリ
fwpaths (List[str]) -- 指定したパスが範囲内であるかどうかを判定するパスのリスト
rjpaths (List[str]) -- 指定したパスが範囲外であるかどうかを判定するパスのリスト
notexist_ok (bool) -- ディレクトリが存在しない場合にエラーを出さないかどうか
logger (logging.Logger) -- ロガー
redis_cli (redis_client.RedisClient) -- Redisクライアント
sessions (Dict[str, Dict[str, Any]]) -- セッション情報
- Returns:
レスポンスコード
- Return type:
int
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int[source]
この機能のサーバー側の実行を行います
- 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:
int
cmdbox.app.features.cli.cmdbox_client_file_tail module
- class cmdbox.app.features.cli.cmdbox_client_file_tail.ClientFileTail(appcls, ver, language: str = None)[source]
Bases:
OneshotResultEdgeFeature,Validator- apprun(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]
- file_tail(reskey: str, current_path: str, fwpaths: List[str], rjpaths: List[str], offset: int, lines: int, max_bytes: int, encoding: str, data_dir: Path, logger: Logger, redis_cli: RedisClient, sessions: Dict[str, Dict[str, Any]]) int[source]
ファイル末尾を取得する
- Parameters:
reskey (str) -- レスポンスキー
current_path (str) -- ファイルパス
fwpaths (List[str]) -- 範囲内かどうかを示すパスのリスト
rjpaths (List[str]) -- 範囲外かどうかを示すパスのリスト
offset (int) -- 読み取り開始オフセット
lines (int) -- 返却行数
max_bytes (int) -- 最大読み取りバイト数
encoding (str) -- 文字コード
data_dir (Path) -- データディレクトリ
logger (logging.Logger) -- ロガー
redis_cli (redis_client.RedisClient) -- Redisクライアント
sessions (Dict[str, Dict[str, Any]]) -- セッション情報
- Returns:
レスポンスコード
- Return type:
int
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int[source]
この機能のサーバー側の実行を行います
- 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:
int
cmdbox.app.features.cli.cmdbox_client_file_upload module
- class cmdbox.app.features.cli.cmdbox_client_file_upload.ClientFileUpload(appcls, ver, language=None, meta_chk=True)[source]
Bases:
UnsupportEdgeFeature,Validator,LimitedFeature- apprun(logger: Logger, args: Namespace, tm: float, pf: List[Dict[str, float]] = []) Tuple[int, Dict[str, Any], Any]
この機能の実行を行います
- Parameters:
logger (logging.Logger) -- ロガー
args (argparse.Namespace) -- 引数
tm (float) -- 実行開始時間
pf (List[Dict[str, float]]) -- 呼出元のパフォーマンス情報
- Returns:
終了コード, 結果, オブジェクト
- Return type:
Tuple[int, Dict[str, Any], Any]
- apprun_registrations(data_dir, logger, args, msg)[source]
apprunの実行結果として登録数(又は登録サイズ)を取得します。 デフォルトの実装では、0 を返します。 このメソッドを拡張して、コマンドの引数やセッション情報などから登録数を算出する処理を実装できます。
- Parameters:
data_dir (Path) -- データディレクトリのパス
logger (logging.Logger) -- ロガー
args (argparse.Namespace) -- コマンドの引数
msg (Dict[str, Any]) -- apprunの処理結果
- Returns:
登録数
- Return type:
int
- file_upload(reskey: str, current_path: str, file_name: str, file_data: bytes, mkdir: bool, overwrite: bool, fwpaths: List[str], rjpaths: List[str], meta_chk: bool, meta: Dict[str, Any], data_dir: Path, logger: Logger, redis_cli: RedisClient, sessions: Dict[str, Dict[str, Any]]) int[source]
ファイルをアップロードする
- Parameters:
reskey (str) -- レスポンスキー
current_path (str) -- ファイルパス
file_name (str) -- ファイル名
file_data (bytes) -- ファイルデータ
mkdir (bool) -- ディレクトリを作成するかどうか
overwrite (bool) -- 上書きするかどうか
fwpaths (List[str]) -- 範囲内パスのリスト
rjpaths (List[str]) -- 範囲外パスのリスト
meta_chk (bool) -- .metaディレクトリのチェックを行うかどうか
meta (Dict[str, Any]) -- メタデータ
data_dir (Path) -- データディレクトリ
logger (logging.Logger) -- ロガー
redis_cli (redis_client.RedisClient) -- Redisクライアント
sessions (Dict[str, Dict[str, Any]]) -- セッション情報
- Returns:
レスポンスコード
- Return type:
int
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int
この機能のサーバー側の実行を行います
- 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:
int
- svrun_registrations(data_dir, logger, opt, msg)[source]
svrunの実行結果として登録数(又は登録サイズ)を取得します。 デフォルトの実装では、0 を返します。 このメソッドを拡張して、コマンドの引数やセッション情報などから登録数を算出する処理を実装できます。
- Parameters:
data_dir (Path) -- データディレクトリのパス
logger (logging.Logger) -- ロガー
opt (Dict[str, Any]) -- コマンドのオプション
msg (Union[Dict, str]) -- svrunの処理結果
- Returns:
登録数
- Return type:
int
cmdbox.app.features.cli.cmdbox_client_http module
- class cmdbox.app.features.cli.cmdbox_client_http.ClientHttp(appcls, ver, language: str = None)[source]
Bases:
ResultEdgeFeature,Validator,LimitedFeature- apprun(logger: Logger, args: Namespace, tm: float, pf: List[Dict[str, float]] = []) Tuple[int, Dict[str, Any], Any]
この機能の実行を行います
- Parameters:
logger (logging.Logger) -- ロガー
args (argparse.Namespace) -- 引数
tm (float) -- 実行開始時間
pf (List[Dict[str, float]]) -- 呼出元のパフォーマンス情報
- Returns:
終了コード, 結果, オブジェクト
- Return type:
Tuple[int, Dict[str, Any], Any]
cmdbox.app.features.cli.cmdbox_client_server_info module
- class cmdbox.app.features.cli.cmdbox_client_server_info.ClientServerInfo(appcls, ver, language: str = None)[source]
Bases:
OneshotResultEdgeFeature,Validator- apprun(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]
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- server_info(reskey: str, data_dir: Path, logger: Logger, redis_cli: RedisClient, sessions: Dict[str, Dict[str, Any]]) int[source]
サーバー情報を取得する
- Parameters:
reskey (str) -- レスポンスキー
data_dir (Path) -- データディレクトリ
logger (logging.Logger) -- ロガー
redis_cli (redis_client.RedisClient) -- Redisクライアント
sessions (Dict[str, Dict[str, Any]]) -- セッション情報
- Returns:
レスポンスコード
- Return type:
int
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int[source]
この機能のサーバー側の実行を行います
- 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:
int
cmdbox.app.features.cli.cmdbox_client_time module
- class cmdbox.app.features.cli.cmdbox_client_time.ClientTime(appcls, ver, language: str = None)[source]
Bases:
OneshotResultEdgeFeature,Validator- apprun(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]
- edgerun(opt, tool, logger, timeout, prevres=None)[source]
この機能のエッジ側の実行を行います
- Parameters:
opt (Dict[str, Any]) -- オプション
tool (edge.Tool) -- 通知関数などedge側のUI操作を行うためのクラス
logger (logging.Logger) -- ロガー
timeout (int) -- タイムアウト時間
prevres (Any) -- 前コマンドの結果。pipeline実行の実行結果を参照する時に使用します。
- Yields:
Tuple[int, Dict[str, Any]] -- 終了コード, 結果
cmdbox.app.features.cli.cmdbox_cmd_check module
- class cmdbox.app.features.cli.cmdbox_cmd_check.CmdCheck(appcls, ver, language: str = None)[source]
Bases:
OneshotResultEdgeFeature,Validator- apprun(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]
cmdbox.app.features.cli.cmdbox_cmd_list module
- class cmdbox.app.features.cli.cmdbox_cmd_list.CmdList(appcls, ver, language: str = None)[source]
Bases:
OneshotResultEdgeFeature,Validator,UnitTestable- apprun(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]
- 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
cmdbox.app.features.cli.cmdbox_cmd_load module
- class cmdbox.app.features.cli.cmdbox_cmd_load.CmdLoad(appcls, ver, language: str = None)[source]
Bases:
OneshotResultEdgeFeature,Validator- apprun(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]
cmdbox.app.features.cli.cmdbox_cmdbox_down module
- class cmdbox.app.features.cli.cmdbox_cmdbox_down.CmdboxDown(appcls, ver, language: str = None)[source]
Bases:
CmdboxBase,Validator- apprun(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]
cmdbox.app.features.cli.cmdbox_cmdbox_exec module
- class cmdbox.app.features.cli.cmdbox_cmdbox_exec.CmdboxExec(appcls, ver, language: str = None)[source]
Bases:
CmdboxBase,Validator- apprun(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]
cmdbox.app.features.cli.cmdbox_cmdbox_info module
- class cmdbox.app.features.cli.cmdbox_cmdbox_info.CmdboxInfo(appcls, ver, language: str = None)[source]
Bases:
UnsupportEdgeFeature,Validator- apprun(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]
cmdbox.app.features.cli.cmdbox_cmdbox_initdata_install module
- class cmdbox.app.features.cli.cmdbox_cmdbox_initdata_install.CmdboxInitdataInstall(appcls, ver, language: str = None)[source]
Bases:
CmdboxBase,Validator- apprun(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]
cmdbox.app.features.cli.cmdbox_cmdbox_load module
- class cmdbox.app.features.cli.cmdbox_cmdbox_load.CmdboxLoad(appcls, ver, language: str = None)[source]
Bases:
CmdboxBase,Validator- apprun(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]
- get_scripts_path(container: str) Path[source]
コンテナ内にマウントするスクリプトの保存先を返します :param container: コンテナ名 :type container: str
- Returns:
スクリプトの保存先パス
- Return type:
Path
- make_compose(logger: Logger, compose_path: str | Path, container: str, imgname: str) Tuple[Dict[str, Any], Path][source]
docker-compose.ymlの内容を作成します
- Parameters:
logger (logging.Logger) -- ロガー
compose_path (Union[str, Path]) -- docker-compose.ymlのパス
container (str) -- コンテナ名
imgname (str) -- イメージ名
- Returns:
docker-compose.ymlの内容, docker-compose.ymlのパス
- Return type:
Tuple[Dict[str, Any], Path]
cmdbox.app.features.cli.cmdbox_cmdbox_logs module
- class cmdbox.app.features.cli.cmdbox_cmdbox_logs.CmdboxLogs(appcls, ver, language: str = None)[source]
Bases:
CmdboxBase,Validator- apprun(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]
cmdbox.app.features.cli.cmdbox_cmdbox_pgsql_install module
- class cmdbox.app.features.cli.cmdbox_cmdbox_pgsql_install.CmdboxPgSQLInstall(appcls, ver, language: str = None)[source]
Bases:
CmdboxBase,Validator- apprun(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]
cmdbox.app.features.cli.cmdbox_cmdbox_pgsql_load module
- class cmdbox.app.features.cli.cmdbox_cmdbox_pgsql_load.CmdboxPgsqlLoad(appcls, ver, language: str = None)[source]
Bases:
CmdboxBase,Validator- apprun(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]
cmdbox.app.features.cli.cmdbox_cmdbox_reboot module
- class cmdbox.app.features.cli.cmdbox_cmdbox_reboot.CmdboxReboot(appcls, ver, language: str = None)[source]
Bases:
CmdboxBase,Validator- apprun(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]
cmdbox.app.features.cli.cmdbox_cmdbox_redis_install module
- class cmdbox.app.features.cli.cmdbox_cmdbox_redis_install.CmdboxRedisInstall(appcls, ver, language: str = None)[source]
Bases:
CmdboxBase,Validator- apprun(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]
cmdbox.app.features.cli.cmdbox_cmdbox_redis_load module
- class cmdbox.app.features.cli.cmdbox_cmdbox_redis_load.CmdboxRedisLoad(appcls, ver, language: str = None)[source]
Bases:
CmdboxBase,Validator- apprun(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]
cmdbox.app.features.cli.cmdbox_cmdbox_save module
- class cmdbox.app.features.cli.cmdbox_cmdbox_save.CmdboxSave(appcls, ver, language: str = None)[source]
Bases:
CmdboxBase,Validator- apprun(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]
cmdbox.app.features.cli.cmdbox_cmdbox_server_install module
- class cmdbox.app.features.cli.cmdbox_cmdbox_server_install.CmdboxServerInstall(appcls, ver, language: str = None)[source]
Bases:
CmdboxBase,Validator- apprun(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]
- server_install(logger: Logger, args: Namespace, data: Path, install_cmdbox_tgt: str = None, install_from: str = None, install_no_python: bool = False, install_compile_python: bool = False, install_tag: str = None, install_use_gpu: bool = False, tts_engine: str = None, voicevox_ver: str = None, voicevox_whl: str = None, init_extra: List[str] = None, run_extra_pre: List[str] = None, run_extra_post: List[str] = None, install_extra: List[str] = None, compose_path: str = None, language: str = None) Dict[str, Any][source]
cmdboxが含まれるdockerイメージをインストールします。
- Parameters:
logger (logging.Logger) -- ロガー
args (argparse.Namespace) -- 引数
data (Path) -- cmdbox-serverのデータディレクトリ
install_cmdbox_tgt (str) -- cmdboxのインストール元
install_from (str) -- インストール元dockerイメージ
install_no_python (bool) -- pythonをインストールしない
install_compile_python (bool) -- pythonをコンパイルしてインストール
install_tag (str) -- インストールタグ
install_use_gpu (bool) -- GPUを使用するモジュール構成でインストールします。
tts_engine (str) -- TTSエンジンの指定
voicevox_ver (str) -- VoiceVoxのバージョン
voicevox_whl (str) -- VoiceVoxのwhlファイルの名前
init_extra (List[str]) -- from直後に実行するコマンド
run_extra_pre (List[str]) -- install_extraの実行前に実行するコマンド
run_extra_post (List[str]) -- install_extraの実行後に実行するコマンド
install_extra (List[str]) -- 追加でインストールするパッケージ
compose_path (str) -- docker-compose.ymlファイルパス
language (str) -- 言語コード
- Returns:
処理結果
- Return type:
dict
cmdbox.app.features.cli.cmdbox_cmdbox_server_load module
- class cmdbox.app.features.cli.cmdbox_cmdbox_server_load.CmdboxServerLoad(appcls, ver, language: str = None)[source]
Bases:
CmdboxBase,Validator- apprun(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]
cmdbox.app.features.cli.cmdbox_cmdbox_setup module
- class cmdbox.app.features.cli.cmdbox_cmdbox_setup.CmdboxSetup(appcls, ver, language=None)[source]
Bases:
OneshotEdgeFeature,Validator- apprun(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]
cmdbox.app.features.cli.cmdbox_cmdbox_uninstall module
- class cmdbox.app.features.cli.cmdbox_cmdbox_uninstall.CmdboxUninstall(appcls, ver, language: str = None)[source]
Bases:
CmdboxBase,Validator- apprun(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]
cmdbox.app.features.cli.cmdbox_cmdbox_up module
- class cmdbox.app.features.cli.cmdbox_cmdbox_up.CmdboxUp(appcls, ver, language: str = None)[source]
Bases:
CmdboxBase,Validator- apprun(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]
cmdbox.app.features.cli.cmdbox_datasource_data_delete module
- class cmdbox.app.features.cli.cmdbox_datasource_data_delete.DatasourceDataDelete(appcls, ver, language: str = None)[source]
Bases:
DatasourceBase,Validator- async apprun(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]
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int[source]
この機能のサーバー側の実行を行います
- 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:
int
cmdbox.app.features.cli.cmdbox_datasource_data_insert module
- class cmdbox.app.features.cli.cmdbox_datasource_data_insert.DatasourceDataInsert(appcls, ver, language: str = None)[source]
Bases:
DatasourceBase,Validator,LimitedFeature- async apprun(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]
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int
この機能のサーバー側の実行を行います
- 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:
int
- svrun_registrations(data_dir, logger, payload, msg)[source]
svrunの実行結果として登録数(又は登録サイズ)を取得します。 デフォルトの実装では、0 を返します。 このメソッドを拡張して、コマンドの引数やセッション情報などから登録数を算出する処理を実装できます。
- Parameters:
data_dir (Path) -- データディレクトリのパス
logger (logging.Logger) -- ロガー
opt (Dict[str, Any]) -- コマンドのオプション
msg (Union[Dict, str]) -- svrunの処理結果
- Returns:
登録数
- Return type:
int
cmdbox.app.features.cli.cmdbox_datasource_data_select module
- class cmdbox.app.features.cli.cmdbox_datasource_data_select.DatasourceDataSelect(appcls, ver, language: str = None)[source]
Bases:
DatasourceBase,Validator- async apprun(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]
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int[source]
この機能のサーバー側の実行を行います
- 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:
int
cmdbox.app.features.cli.cmdbox_datasource_data_update module
- class cmdbox.app.features.cli.cmdbox_datasource_data_update.DatasourceDataUpdate(appcls, ver, language: str = None)[source]
Bases:
DatasourceBase,Validator,LimitedFeature- async apprun(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]
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int
この機能のサーバー側の実行を行います
- 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:
int
cmdbox.app.features.cli.cmdbox_datasource_del module
- class cmdbox.app.features.cli.cmdbox_datasource_del.DatasourceDel(appcls, ver, language: str = None)[source]
Bases:
DatasourceBase,Validator- async apprun(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]
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int[source]
この機能のサーバー側の実行を行います
- 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:
int
cmdbox.app.features.cli.cmdbox_datasource_idx_create module
- class cmdbox.app.features.cli.cmdbox_datasource_idx_create.DatasourceIdxCreate(appcls, ver, language: str = None)[source]
Bases:
DatasourceBase,Validator- async apprun(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]
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int[source]
この機能のサーバー側の実行を行います
- 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:
int
cmdbox.app.features.cli.cmdbox_datasource_idx_drop module
- class cmdbox.app.features.cli.cmdbox_datasource_idx_drop.DatasourceIdxDrop(appcls, ver, language: str = None)[source]
Bases:
DatasourceBase,Validator- async apprun(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]
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int[source]
この機能のサーバー側の実行を行います
- 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:
int
cmdbox.app.features.cli.cmdbox_datasource_list module
- class cmdbox.app.features.cli.cmdbox_datasource_list.DatasourceList(appcls, ver, language: str = None)[source]
Bases:
DatasourceBase,Validator- async apprun(logger: Logger, args: Namespace, tm: float, pf: List[Dict[str, float]] = []) Tuple[int, Dict[str, Any], Any]
この機能の実行を行います
- Parameters:
logger (logging.Logger) -- ロガー
args (argparse.Namespace) -- 引数
tm (float) -- 実行開始時間
pf (List[Dict[str, float]]) -- 呼出元のパフォーマンス情報
- Returns:
終了コード, 結果, オブジェクト
- Return type:
Tuple[int, Dict[str, Any], Any]
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int[source]
この機能のサーバー側の実行を行います
- 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:
int
cmdbox.app.features.cli.cmdbox_datasource_load module
- class cmdbox.app.features.cli.cmdbox_datasource_load.DatasourceLoad(appcls, ver, language: str = None)[source]
Bases:
DatasourceBase,Validator- async apprun(logger: Logger, args: Namespace, tm: float, pf: List[Dict[str, float]] = []) Tuple[int, Dict[str, Any], Any]
この機能の実行を行います
- Parameters:
logger (logging.Logger) -- ロガー
args (argparse.Namespace) -- 引数
tm (float) -- 実行開始時間
pf (List[Dict[str, float]]) -- 呼出元のパフォーマンス情報
- Returns:
終了コード, 結果, オブジェクト
- Return type:
Tuple[int, Dict[str, Any], Any]
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int[source]
この機能のサーバー側の実行を行います
- 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:
int
cmdbox.app.features.cli.cmdbox_datasource_save module
- class cmdbox.app.features.cli.cmdbox_datasource_save.DatasourceSave(appcls, ver, language: str = None)[source]
Bases:
DatasourceBase,Validator,LimitedFeature- async apprun(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]
- apprun_registrations(data_dir, logger, args, msg)[source]
apprunの実行結果として登録数(又は登録サイズ)を取得します。 デフォルトの実装では、0 を返します。 このメソッドを拡張して、コマンドの引数やセッション情報などから登録数を算出する処理を実装できます。
- Parameters:
data_dir (Path) -- データディレクトリのパス
logger (logging.Logger) -- ロガー
args (argparse.Namespace) -- コマンドの引数
msg (Dict[str, Any]) -- apprunの処理結果
- Returns:
登録数
- Return type:
int
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int
この機能のサーバー側の実行を行います
- 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:
int
- svrun_registrations(data_dir, logger, opt, msg)[source]
svrunの実行結果として登録数(又は登録サイズ)を取得します。 デフォルトの実装では、0 を返します。 このメソッドを拡張して、コマンドの引数やセッション情報などから登録数を算出する処理を実装できます。
- Parameters:
data_dir (Path) -- データディレクトリのパス
logger (logging.Logger) -- ロガー
opt (Dict[str, Any]) -- コマンドのオプション
msg (Union[Dict, str]) -- svrunの処理結果
- Returns:
登録数
- Return type:
int
cmdbox.app.features.cli.cmdbox_datasource_tbl_create module
- class cmdbox.app.features.cli.cmdbox_datasource_tbl_create.DatasourceTblCreate(appcls, ver, language: str = None)[source]
Bases:
DatasourceBase,Validator- async apprun(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]
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int[source]
この機能のサーバー側の実行を行います
- 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:
int
cmdbox.app.features.cli.cmdbox_datasource_tbl_drop module
- class cmdbox.app.features.cli.cmdbox_datasource_tbl_drop.DatasourceTblDrop(appcls, ver, language: str = None)[source]
Bases:
DatasourceBase,Validator- async apprun(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]
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int[source]
この機能のサーバー側の実行を行います
- 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:
int
cmdbox.app.features.cli.cmdbox_edge_config module
- class cmdbox.app.features.cli.cmdbox_edge_config.EdgeConfig(appcls, ver, language: str = None)[source]
Bases:
UnsupportEdgeFeature,Validator- apprun(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]
cmdbox.app.features.cli.cmdbox_edge_start module
- class cmdbox.app.features.cli.cmdbox_edge_start.EdgeStart(appcls, ver, language: str = None)[source]
Bases:
UnsupportEdgeFeature,Validator- apprun(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]
- load_cmds(logger: Logger, args: Namespace) Tuple[int, List[Dict[str, Any]]][source]
コマンドファイルのタイトル一覧を取得する
- Parameters:
logger (logging.Logger) -- ロガー
args (argparse.Namespace) -- 引数
- Returns:
ステータスコード List[Dict[str, Any]]: コマンドファイルのタイトル一覧
- Return type:
status_code (int)
cmdbox.app.features.cli.cmdbox_excel_cell_details module
- class cmdbox.app.features.cli.cmdbox_excel_cell_details.ExcelCellDetails(appcls, ver, language: str = None)[source]
Bases:
ExcelBase- excel_proc(abspath: Path, args: Namespace, logger: Logger, tm: float, pf: List[Dict[str, float]] = []) Dict[str, Any][source]
Excel処理のベース
- Parameters:
abspath (Path) -- Excelファイルの絶対パス
args (argparse.Namespace) -- 引数
logger (logging.Logger) -- ロガー
tm (float) -- 処理時間
pf (List[Dict[str, float]]) -- パフォーマンス情報
- Returns:
結果
- Return type:
Dict[str, Any]
- get_cell_details(filepath: str, formula_data_only: bool, sheet_name: str, cell_name: List[str], cell_top_left: str, cell_bottom_right: str, output_detail_format: str, logger: Logger) Dict[str, Any][source]
指定したワークブックの単一セルの値、データ型、スタイル、コメント、数式、ハイパーリンクなどの詳細を取得します。
- Parameters:
filepath (str) -- ワークブックのパス
formula_data_only (bool) -- 数式データのみを参照するかどうか。このオプションはキャッシュされたデータが存在する場合に有効です。
sheet_name (str) -- 詳細情報を取得するシートの名前
cell_name (List[str]) -- 詳細情報を取得するセルの名前のリスト。例えば、A1、B2、R5987。
cell_top_left (str) -- 詳細情報を取得する範囲の左上セルの名前。例えば、A1、B2、R5987。
cell_bottom_right (str) -- 詳細情報を取得する範囲の右下セルの名前。例えば、A1、B2、R5987。
output_detail_format (str) -- 出力フォーマット。json`または`text。
logger (logging.Logger) -- ロガー
- Returns:
セルの詳細情報
- Return type:
dict
- get_svparam(args: Namespace) List[str][source]
サーバーに送信するパラメーターを返します
- Parameters:
args (argparse.Namespace) -- 引数
- Returns:
サーバーに送信するパラメーター
- Return type:
List[str]
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int[source]
この機能のサーバー側の実行を行います
- 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:
int
cmdbox.app.features.cli.cmdbox_excel_cell_search module
- class cmdbox.app.features.cli.cmdbox_excel_cell_search.ExcelCellSearch(appcls, ver, language: str = None)[source]
Bases:
ExcelBase- cell_search(filepath: str, formula_data_only: bool, sheet_name: str, cell_name: List[str], cell_top_left: str, cell_bottom_right: str, match_type: str, search_value: str, output_cell_format: str, logger: Logger) Dict[str, Any][source]
指定したワークブックのセルの値を検索します。
- Parameters:
filepath (str) -- ワークブックのパス
formula_data_only (bool) -- 数式データのみを参照するかどうか。このオプションはキャッシュされたデータが存在する場合に有効です。
sheet_name (str) -- 詳細情報を取得するシートの名前
cell_name (List[str]) -- 詳細情報を取得するセルの名前のリスト。例えば、A1、B2、R5987。
cell_top_left (str) -- 詳細情報を取得する左上セルの名前。例えば、A1、B2、R5987。
cell_bottom_right (str) -- 詳細情報を取得する右下セルの名前。 例えば、A1、B2、R5987。
match_type (str) -- 検索するセルの値に対するマッチ方法。full: 完全一致、partial: 部分一致、regex: 正規表現。
search_value (str) -- 検索するセルの値。
output_cell_format (str) -- 出力フォーマット。例えば、json、csv、 md、 html。
logger (logging.Logger) -- ロガー
- Returns:
セルの詳細情報
- Return type:
dict
- excel_proc(abspath: Path, args: Namespace, logger: Logger, tm: float, pf: List[Dict[str, float]] = []) Dict[str, Any][source]
Excel処理のベース
- Parameters:
abspath (Path) -- Excelファイルの絶対パス
args (argparse.Namespace) -- 引数
logger (logging.Logger) -- ロガー
tm (float) -- 処理時間
pf (List[Dict[str, float]]) -- パフォーマンス情報
- Returns:
結果
- Return type:
Dict[str, Any]
- get_svparam(args: Namespace) List[str][source]
サーバーに送信するパラメーターを返します
- Parameters:
args (argparse.Namespace) -- 引数
- Returns:
サーバーに送信するパラメーター
- Return type:
List[str]
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int[source]
この機能のサーバー側の実行を行います
- 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:
int
cmdbox.app.features.cli.cmdbox_excel_cell_values module
- class cmdbox.app.features.cli.cmdbox_excel_cell_values.ExcelCellValues(appcls, ver, language: str = None)[source]
Bases:
ExcelBase- cell_values(filepath: str, formula_data_only: bool, sheet_name: str, cell_name: List[str], cell_top_left: str, cell_bottom_right: str, cell_value: Dict[str, Any], output_cell_format: str, logger: Logger) Dict[str, Any][source]
指定したワークブックのセルの値を取得又は設定します。
- Parameters:
filepath (str) -- ワークブックのパス
formula_data_only (bool) -- 数式データのみを参照するかどうか。このオプションはキャッシュされたデータが存在する場合に有効です。
sheet_name (str) -- 詳細情報を取得するシートの名前
cell_name (List[str]) -- 詳細情報を取得するセルの名前のリスト。例えば、A1、B2、R5987。
cell_top_left (str) -- 詳細情報を取得する左上セルの名前。例えば、A1、B2、R5987。
cell_bottom_right (str) -- 詳細情報を取得する右下セルの名前。 例えば、A1、B2、R5987。
cell_value (Dict[str, Any]) -- セルに設定する値の辞書。キーがセルの名前、値が設定する値。
output_cell_format (str) -- 出力フォーマット。json、csv、 md。
logger (logging.Logger) -- ロガー
- Returns:
セルの詳細情報
- Return type:
dict
- excel_proc(abspath: Path, args: Namespace, logger: Logger, tm: float, pf: List[Dict[str, float]] = []) Dict[str, Any][source]
Excel処理のベース
- Parameters:
abspath (Path) -- Excelファイルの絶対パス
args (argparse.Namespace) -- 引数
logger (logging.Logger) -- ロガー
tm (float) -- 処理時間
pf (List[Dict[str, float]]) -- パフォーマンス情報
- Returns:
結果
- Return type:
Dict[str, Any]
- get_svparam(args: Namespace) List[str][source]
サーバーに送信するパラメーターを返します
- Parameters:
args (argparse.Namespace) -- 引数
- Returns:
サーバーに送信するパラメーター
- Return type:
List[str]
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int[source]
この機能のサーバー側の実行を行います
- 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:
int
cmdbox.app.features.cli.cmdbox_excel_sheet_list module
- class cmdbox.app.features.cli.cmdbox_excel_sheet_list.ExcelSheetList(appcls, ver, language: str = None)[source]
Bases:
ExcelBase- excel_proc(abspath: Path, args: Namespace, logger: Logger, tm: float, pf: List[Dict[str, float]] = []) Dict[str, Any][source]
Excel処理のベース
- Parameters:
abspath (Path) -- Excelファイルの絶対パス
args (argparse.Namespace) -- 引数
logger (logging.Logger) -- ロガー
tm (float) -- 処理時間
pf (List[Dict[str, float]]) -- パフォーマンス情報
- Returns:
結果
- Return type:
Dict[str, Any]
- get_svparam(args: Namespace) List[str][source]
サーバーに送信するパラメーターを返します
- Parameters:
args (argparse.Namespace) -- 引数
- Returns:
サーバーに送信するパラメーター
- Return type:
List[str]
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- sheet_list(filepath: str, logger: Logger) Dict[str, Any][source]
指定したワークブックのシート一覧を取得します。
- Parameters:
filepath (str) -- ワークブックのパス
logger (logging.Logger) -- ロガー
- Returns:
シートの情報
- Return type:
dict
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int[source]
この機能のサーバー側の実行を行います
- 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:
int
cmdbox.app.features.cli.cmdbox_extract_chunklet module
- class cmdbox.app.features.cli.cmdbox_extract_chunklet.ExtractChunklet(appcls, ver, language: str = None)[source]
Bases:
OneshotResultEdgeFeature,Validator,LimitedFeature- async apprun(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]
- apprun_credit(data_dir, logger, args, msg)[source]
apprunの実行結果として使用クレジット数を取得します。 デフォルトの実装では、0 を返します。 このメソッドを拡張して、コマンドの引数やセッション情報などから使用クレジット数を算出する処理を実装できます。
- Parameters:
data_dir (Path) -- データディレクトリのパス
logger (logging.Logger) -- ロガー
args (argparse.Namespace) -- コマンドの引数
msg (Dict[str, Any]) -- apprunの処理結果
- Returns:
使用クレジット数
- Return type:
int
- choice_chunk_max_token_counter(o: Dict[str, Any], webmode: bool, opt: Dict[str, Any]) Any[source]
オプションのchoiceを動的に生成する関数
- Parameters:
o (Dict[str, Any]) -- choice_fn関数が呼ばれたコマンドオプションのchoice定義
webmode (bool) -- Webモードかどうか
opt (Dict[str, Any]) -- このコマンドのすべてのコマンドオプションのchoice定義
- Returns:
choice情報
- Return type:
Any
- extract(abspath: Path, args: Namespace, logger: Logger, tm: float, pf: List[Dict[str, float]] = []) Dict[str, Any][source]
指定されたファイルからテキストを抽出します
- Parameters:
abspath (Path) -- 抽出対象ファイルの絶対パス
args (argparse.Namespace) -- 引数
logger (logging.Logger) -- ロガー
tm (float) -- 実行開始時間
pf (List[Dict[str, float]]) -- 呼出元のパフォーマンス情報
- Returns:
抽出結果
- Return type:
Dict[str, Any]
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int
この機能のサーバー側の実行を行います
- 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:
int
- svrun_credit(data_dir, logger, redis_cli, msg, sessions)[source]
svrunの実行結果として使用クレジット数を取得します。 デフォルトの実装では、0 を返します。 このメソッドを拡張して、コマンドの引数やセッション情報などから使用クレジット数を算出する処理を実装できます。
- Parameters:
data_dir (Path) -- データディレクトリのパス
logger (logging.Logger) -- ロガー
opt (Dict[str, Any]) -- コマンドのオプション
msg (Union[Dict, str]) -- svrunの処理結果
- Returns:
使用クレジット数
- Return type:
int
cmdbox.app.features.cli.cmdbox_extract_del module
- class cmdbox.app.features.cli.cmdbox_extract_del.ExtractDel(appcls, ver, language: str = None)[source]
Bases:
OneshotResultEdgeFeature,Validator- async apprun(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]
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int[source]
この機能のサーバー側の実行を行います
- 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:
int
cmdbox.app.features.cli.cmdbox_extract_list module
- class cmdbox.app.features.cli.cmdbox_extract_list.ExtractList(appcls, ver, language: str = None)[source]
Bases:
OneshotResultEdgeFeature,Validator- async apprun(logger: Logger, args: Namespace, tm: float, pf: List[Dict[str, float]] = []) Tuple[int, Dict[str, Any], Any]
この機能の実行を行います
- Parameters:
logger (logging.Logger) -- ロガー
args (argparse.Namespace) -- 引数
tm (float) -- 実行開始時間
pf (List[Dict[str, float]]) -- 呼出元のパフォーマンス情報
- Returns:
終了コード, 結果, オブジェクト
- Return type:
Tuple[int, Dict[str, Any], Any]
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int[source]
この機能のサーバー側の実行を行います
- 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:
int
cmdbox.app.features.cli.cmdbox_extract_load module
- class cmdbox.app.features.cli.cmdbox_extract_load.ExtractLoad(appcls, ver, language: str = None)[source]
Bases:
OneshotResultEdgeFeature,Validator- async apprun(logger: Logger, args: Namespace, tm: float, pf: List[Dict[str, float]] = []) Tuple[int, Dict[str, Any], Any]
この機能の実行を行います
- Parameters:
logger (logging.Logger) -- ロガー
args (argparse.Namespace) -- 引数
tm (float) -- 実行開始時間
pf (List[Dict[str, float]]) -- 呼出元のパフォーマンス情報
- Returns:
終了コード, 結果, オブジェクト
- Return type:
Tuple[int, Dict[str, Any], Any]
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int[source]
この機能のサーバー側の実行を行います
- 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:
int
cmdbox.app.features.cli.cmdbox_extract_pdfplumber module
- class cmdbox.app.features.cli.cmdbox_extract_pdfplumber.ExtractPdfplumber(appcls, ver, language: str = None)[source]
Bases:
OneshotResultEdgeFeature,Validator,LimitedFeature- async apprun(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]
- apprun_credit(data_dir, logger, args, msg)[source]
apprunの実行結果として使用クレジット数を取得します。 デフォルトの実装では、0 を返します。 このメソッドを拡張して、コマンドの引数やセッション情報などから使用クレジット数を算出する処理を実装できます。
- Parameters:
data_dir (Path) -- データディレクトリのパス
logger (logging.Logger) -- ロガー
args (argparse.Namespace) -- コマンドの引数
msg (Dict[str, Any]) -- apprunの処理結果
- Returns:
使用クレジット数
- Return type:
int
- extract(abspath: Path, args: Namespace, logger: Logger, tm: float, pf: List[Dict[str, float]] = []) Dict[str, Any][source]
指定されたファイルからテキストを抽出します
- Parameters:
abspath (Path) -- 抽出対象ファイルの絶対パス
args (argparse.Namespace) -- 引数
logger (logging.Logger) -- ロガー
tm (float) -- 実行開始時間
pf (List[Dict[str, float]]) -- 呼出元のパフォーマンス情報
- Returns:
抽出結果
- Return type:
Dict[str, Any]
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int
この機能のサーバー側の実行を行います
- 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:
int
- svrun_credit(data_dir, logger, redis_cli, msg, sessions)[source]
svrunの実行結果として使用クレジット数を取得します。 デフォルトの実装では、0 を返します。 このメソッドを拡張して、コマンドの引数やセッション情報などから使用クレジット数を算出する処理を実装できます。
- Parameters:
data_dir (Path) -- データディレクトリのパス
logger (logging.Logger) -- ロガー
opt (Dict[str, Any]) -- コマンドのオプション
msg (Union[Dict, str]) -- svrunの処理結果
- Returns:
使用クレジット数
- Return type:
int
cmdbox.app.features.cli.cmdbox_extract_save module
- class cmdbox.app.features.cli.cmdbox_extract_save.ExtractSave(appcls, ver, language: str = None)[source]
Bases:
OneshotResultEdgeFeature,Validator,LimitedFeature- async apprun(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]
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int
この機能のサーバー側の実行を行います
- 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:
int
- svrun_registrations(data_dir, logger, opt, msg)[source]
svrunの実行結果として登録数(又は登録サイズ)を取得します。 デフォルトの実装では、0 を返します。 このメソッドを拡張して、コマンドの引数やセッション情報などから登録数を算出する処理を実装できます。
- Parameters:
data_dir (Path) -- データディレクトリのパス
logger (logging.Logger) -- ロガー
opt (Dict[str, Any]) -- コマンドのオプション
msg (Union[Dict, str]) -- svrunの処理結果
- Returns:
登録数
- Return type:
int
cmdbox.app.features.cli.cmdbox_gui_start module
- class cmdbox.app.features.cli.cmdbox_gui_start.GuiStart(appcls, ver, language: str = None)[source]
Bases:
WebStart- apprun(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]
cmdbox.app.features.cli.cmdbox_gui_stop module
cmdbox.app.features.cli.cmdbox_limiter_billing_calc module
- class cmdbox.app.features.cli.cmdbox_limiter_billing_calc.LimiterBillingCalc(appcls, ver, language: str = None)[source]
Bases:
OneshotResultEdgeFeature,Validator- async apprun(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]
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int[source]
この機能のサーバー側の実行を行います
- 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:
int
cmdbox.app.features.cli.cmdbox_limiter_billing_load module
- class cmdbox.app.features.cli.cmdbox_limiter_billing_load.LimiterBillingLoad(appcls, ver, language: str = None)[source]
Bases:
OneshotResultEdgeFeature,Validator- async apprun(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]
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int[source]
この機能のサーバー側の実行を行います
- 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:
int
cmdbox.app.features.cli.cmdbox_limiter_counter module
- class cmdbox.app.features.cli.cmdbox_limiter_counter.LimiterCounter(appcls: str, ver: str, language: str)[source]
Bases:
OneshotResultEdgeFeature,Validator- async apprun(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]
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int[source]
この機能のサーバー側の実行を行います
- 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:
int
cmdbox.app.features.cli.cmdbox_limiter_del module
- class cmdbox.app.features.cli.cmdbox_limiter_del.LimiterDel(appcls, ver, language=None)[source]
Bases:
OneshotResultEdgeFeature,Validator- async apprun(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]
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int[source]
この機能のサーバー側の実行を行います
- 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:
int
cmdbox.app.features.cli.cmdbox_limiter_evidences module
- class cmdbox.app.features.cli.cmdbox_limiter_evidences.LimiterEvidences(appcls, ver, language: str = None)[source]
Bases:
OneshotResultEdgeFeature,Validator- async apprun(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]
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int[source]
この機能のサーバー側の実行を行います
- 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:
int
cmdbox.app.features.cli.cmdbox_limiter_list module
- class cmdbox.app.features.cli.cmdbox_limiter_list.LimiterList(appcls, ver, language: str = None)[source]
Bases:
OneshotResultEdgeFeature,Validator- async apprun(logger: Logger, args: Namespace, tm: float, pf: List[Dict[str, float]] = []) Tuple[int, Dict[str, Any], Any]
この機能の実行を行います
- Parameters:
logger (logging.Logger) -- ロガー
args (argparse.Namespace) -- 引数
tm (float) -- 実行開始時間
pf (List[Dict[str, float]]) -- 呼出元のパフォーマンス情報
- Returns:
終了コード, 結果, オブジェクト
- Return type:
Tuple[int, Dict[str, Any], Any]
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int[source]
この機能のサーバー側の実行を行います
- 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:
int
cmdbox.app.features.cli.cmdbox_limiter_load module
- class cmdbox.app.features.cli.cmdbox_limiter_load.LimiterLoad(appcls, ver, language: str = None)[source]
Bases:
OneshotResultEdgeFeature,Validator- async apprun(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]
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int[source]
この機能のサーバー側の実行を行います
- 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:
int
cmdbox.app.features.cli.cmdbox_limiter_plan_del module
- class cmdbox.app.features.cli.cmdbox_limiter_plan_del.LimiterPlanDel(appcls, ver, language: str = None)[source]
Bases:
OneshotResultEdgeFeature,Validator- async apprun(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]
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int[source]
この機能のサーバー側の実行を行います
- 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:
int
cmdbox.app.features.cli.cmdbox_limiter_plan_list module
- class cmdbox.app.features.cli.cmdbox_limiter_plan_list.LimiterPlanList(appcls, ver, language: str = None)[source]
Bases:
OneshotResultEdgeFeature,Validator- async apprun(logger: Logger, args: Namespace, tm: float, pf: List[Dict[str, float]] = []) Tuple[int, Dict[str, Any], Any]
この機能の実行を行います
- Parameters:
logger (logging.Logger) -- ロガー
args (argparse.Namespace) -- 引数
tm (float) -- 実行開始時間
pf (List[Dict[str, float]]) -- 呼出元のパフォーマンス情報
- Returns:
終了コード, 結果, オブジェクト
- Return type:
Tuple[int, Dict[str, Any], Any]
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int[source]
この機能のサーバー側の実行を行います
- 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:
int
cmdbox.app.features.cli.cmdbox_limiter_plan_load module
- class cmdbox.app.features.cli.cmdbox_limiter_plan_load.LimiterPlanLoad(appcls, ver, language=None)[source]
Bases:
OneshotResultEdgeFeature,Validator- async apprun(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]
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int[source]
この機能のサーバー側の実行を行います
- 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:
int
cmdbox.app.features.cli.cmdbox_limiter_plan_save module
- class cmdbox.app.features.cli.cmdbox_limiter_plan_save.LimiterPlanSave(appcls, ver, language=None)[source]
Bases:
OneshotResultEdgeFeature,Validator- async apprun(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]
- choice_limiters(o: Dict[str, Any], webmode: bool, opt: Dict[str, Any]) Any[source]
オプションのchoiceを動的に生成する関数
- Parameters:
o (Dict[str, Any]) -- choice_fn関数が呼ばれたコマンドオプションのchoice定義
webmode (bool) -- Webモードかどうか
opt (Dict[str, Any]) -- このコマンドのすべてのコマンドオプションのchoice定義
- Returns:
choice情報
- Return type:
Any
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int[source]
この機能のサーバー側の実行を行います
- 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:
int
cmdbox.app.features.cli.cmdbox_limiter_save module
- class cmdbox.app.features.cli.cmdbox_limiter_save.LimiterSave(appcls, ver, language=None)[source]
Bases:
OneshotResultEdgeFeature,Validator- async apprun(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]
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int[source]
この機能のサーバー側の実行を行います
- 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:
int
cmdbox.app.features.cli.cmdbox_limiter_targets module
- class cmdbox.app.features.cli.cmdbox_limiter_targets.LimiterTargets(appcls, ver, language=None)[source]
Bases:
OneshotResultEdgeFeature,Validator- async apprun(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]
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Any, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int[source]
この機能のサーバー側の実行を行います
- 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:
int
cmdbox.app.features.cli.cmdbox_llm_chat module
- class cmdbox.app.features.cli.cmdbox_llm_chat.LLMChat(appcls, ver, language=None)[source]
Bases:
OneshotResultEdgeFeature,Validator,LimitedFeature- async apprun(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]
- chat(data_dir: Path, logger: Logger, llmname: str, *, msg_role: str = None, msg_name: str = None, msg_text: str = None, msg_text_system: str = None, msg_text_param: Dict[str, Any] = None, msg_image_url: str = None, msg_audio: str = None, msg_audio_format: str = None, msg_video_url: str = None, msg_file_url: str = None, msg_file: str = None, msg_file_mime: str = None, msg_file_name: str = None, signin_user: str = None, signin_groups: List[str] = None) Tuple[int, List[Dict[str, Any]]][source]
LLMにチャットメッセージを送信します。
- Parameters:
data_dir (Path) -- データディレクトリのパス
logger (logging.Logger) -- ロガー
llmname (str) -- LLM設定の名前
msg_role (str, optional) -- メッセージ送信者の役割。
msg_name (str, optional) -- メッセージ送信者の名前。
msg_text (str, optional) -- 送信するテキストの内容。
msg_text_system (str, optional) -- 送信するシステムプロンプト。 {{AAA}} と表記すると AAA のパラメータを設定できます。なお {{msg_text}} と指定すると msg_text オプションの値が設定されます。
msg_text_param (Dict[str, Any], optional) -- 送信するテキストのパラメータ。
msg_image_url (str, optional) -- 送信する画像のURL。
msg_audio (str, optional) -- 送信する音声の内容。Base64エンコードされた文字列で指定します。
msg_audio_format (str, optional) -- 送信する音声のフォーマット。 wav, mp3, ogg, flac のいずれかを指定します。
msg_video_url (str, optional) -- 送信する動画のURL。
msg_file_url (str, optional) -- 送信するファイルのURL。
msg_file (str, optional) -- 送信するファイルの内容。Base64エンコードされた文字列で指定します。
msg_file_mime (str, optional) -- 送信するファイルのMIMEタイプ。
msg_file_name (str, optional) -- 送信するファイルの名前。
signin_user (str, optional) -- リクエスト元のユーザー。
signin_groups (List[str], optional) -- リクエスト元のユーザーグループのリスト。指定された場合、許可されているグループに含まれる設定のみを返します。
- Returns:
(ステータスコード, LLMからの応答メッセージのリスト)
- Return type:
Tuple[int, List[Dict[str, Any]]]
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int
この機能のサーバー側の実行を行います
- 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:
int
- svrun_credit(data_dir, logger, opt, msg)[source]
svrunの実行結果として使用クレジット数を取得します。 デフォルトの実装では、0 を返します。 このメソッドを拡張して、コマンドの引数やセッション情報などから使用クレジット数を算出する処理を実装できます。
- Parameters:
data_dir (Path) -- データディレクトリのパス
logger (logging.Logger) -- ロガー
opt (Dict[str, Any]) -- コマンドのオプション
msg (Union[Dict, str]) -- svrunの処理結果
- Returns:
使用クレジット数
- Return type:
int
cmdbox.app.features.cli.cmdbox_llm_del module
- class cmdbox.app.features.cli.cmdbox_llm_del.LLMDel(appcls, ver, language: str = None)[source]
Bases:
OneshotResultEdgeFeature,Validator- async apprun(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]
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int[source]
この機能のサーバー側の実行を行います
- 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:
int
cmdbox.app.features.cli.cmdbox_llm_embed module
- class cmdbox.app.features.cli.cmdbox_llm_embed.LLMEmbed(appcls, ver, language=None)[source]
Bases:
OneshotResultEdgeFeature,Validator,LimitedFeature- async apprun(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]
- embed(data_dir: Path, logger: Logger, llmname: str, *, input_text: str | List[str] = None) Tuple[int, Dict[str, Any]][source]
LLMにテキストのエンベディングを要求します。
- Parameters:
data_dir (Path) -- データディレクトリのパス
logger (logging.Logger) -- ロガー
llmname (str) -- LLM設定の名前
input_text (Union[str, List[str]], optional) -- エンベディングするテキスト。文字列またはリストで指定します。
- Returns:
(ステータスコード, エンベディング結果)
- Return type:
Tuple[int, Dict[str, Any]]
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int
この機能のサーバー側の実行を行います
- 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:
int
- svrun_credit(data_dir, logger, opt, msg)[source]
svrunの実行結果として使用クレジット数を取得します。 デフォルトの実装では、0 を返します。 このメソッドを拡張して、コマンドの引数やセッション情報などから使用クレジット数を算出する処理を実装できます。
- Parameters:
data_dir (Path) -- データディレクトリのパス
logger (logging.Logger) -- ロガー
opt (Dict[str, Any]) -- コマンドのオプション
msg (Union[Dict, str]) -- svrunの処理結果
- Returns:
使用クレジット数
- Return type:
int
cmdbox.app.features.cli.cmdbox_llm_list module
- class cmdbox.app.features.cli.cmdbox_llm_list.LLMList(appcls, ver, language: str = None)[source]
Bases:
OneshotResultEdgeFeature,Validator- async apprun(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]
- get_llmlist(kwd: str, data_dir: Path, redis_cli: RedisClient, groups: List[str] = None, cache_clear: bool = False) List[Dict[str, Any]][source]
保存されているLLM設定のリストを取得します。
- Parameters:
kwd (str) -- 検索キーワード
data_dir (Path) -- データディレクトリのパス
redis_cli (redis_client.RedisClient) -- Redisクライアントのインスタンス
groups (List[str], optional) -- リクエスト元のユーザーグループのリスト。指定された場合、許可されているグループに含まれる設定のみを返します。
cache_clear (bool, optional) -- Trueの場合、キャッシュをクリアして再読み込みします。デフォルトはFalse。
- Returns:
LLM設定のリスト
- Return type:
List[Dict[str, Any]]
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int[source]
サーバー側で受け取ったlistコマンドを処理します。
cmdbox.app.features.cli.cmdbox_llm_load module
- class cmdbox.app.features.cli.cmdbox_llm_load.LLMLoad(appcls, ver, language: str = None)[source]
Bases:
OneshotResultEdgeFeature,Validator- async apprun(logger: Logger, args: Namespace, tm: float, pf: List[Dict[str, float]] = []) Tuple[int, Dict[str, Any], Any]
この機能の実行を行います
- Parameters:
logger (logging.Logger) -- ロガー
args (argparse.Namespace) -- 引数
tm (float) -- 実行開始時間
pf (List[Dict[str, float]]) -- 呼出元のパフォーマンス情報
- Returns:
終了コード, 結果, オブジェクト
- Return type:
Tuple[int, Dict[str, Any], Any]
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- load(data_dir: Path, llmname: str) Dict[str, Any][source]
指定されたLLM設定をサーバーから読み込みます。
- Parameters:
data_dir (Path) -- データディレクトリのパス
llmname (str) -- 読み込むLLM設定の名前
- Returns:
読み込んだLLM設定の内容。
- Return type:
Dict[str, Any]
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int[source]
サーバー側で受け取ったloadコマンドを処理します。
cmdbox.app.features.cli.cmdbox_llm_proxy_start module
- class cmdbox.app.features.cli.cmdbox_llm_proxy_start.LlmProxyStart(appcls, ver, language: str = None)[source]
Bases:
UnsupportEdgeFeature,Validator- apprun(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]
cmdbox.app.features.cli.cmdbox_llm_proxy_stop module
- class cmdbox.app.features.cli.cmdbox_llm_proxy_stop.LlmProxyStop(appcls, ver, language: str = None)[source]
Bases:
UnsupportEdgeFeature,Validator
cmdbox.app.features.cli.cmdbox_llm_save module
- class cmdbox.app.features.cli.cmdbox_llm_save.LLMSave(appcls, ver, language: str = None)[source]
Bases:
OneshotResultEdgeFeature,Validator,LimitedFeature- async apprun(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]
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int
この機能のサーバー側の実行を行います
- 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:
int
- svrun_registrations(data_dir, logger, opt, msg)[source]
svrunの実行結果として登録数(又は登録サイズ)を取得します。 デフォルトの実装では、0 を返します。 このメソッドを拡張して、コマンドの引数やセッション情報などから登録数を算出する処理を実装できます。
- Parameters:
data_dir (Path) -- データディレクトリのパス
logger (logging.Logger) -- ロガー
opt (Dict[str, Any]) -- コマンドのオプション
msg (Union[Dict, str]) -- svrunの処理結果
- Returns:
登録数
- Return type:
int
cmdbox.app.features.cli.cmdbox_llm_translation module
- class cmdbox.app.features.cli.cmdbox_llm_translation.LLMTranslation(appcls, ver, language: str = None)[source]
Bases:
LLMChat- TRANSLATION_FILE = 'translation.json'
- async apprun(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]
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int
この機能のサーバー側の実行を行います
- 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:
int
- svrun_credit(data_dir, logger, opt, msg)[source]
svrunの実行結果として使用クレジット数を取得します。 デフォルトの実装では、0 を返します。 このメソッドを拡張して、コマンドの引数やセッション情報などから使用クレジット数を算出する処理を実装できます。
- Parameters:
data_dir (Path) -- データディレクトリのパス
logger (logging.Logger) -- ロガー
opt (Dict[str, Any]) -- コマンドのオプション
msg (Union[Dict, str]) -- svrunの処理結果
- Returns:
使用クレジット数
- Return type:
int
- translate(data_dir: Path, logger: Logger, llmname: str, words: List[str], target_lang: str, nosave: bool = False) Tuple[int, Dict[str, Any]][source]
単語リストを翻訳します。キャッシュに存在する単語はLLMを呼ばずに返します。
- Parameters:
data_dir (Path) -- データディレクトリのパス
logger (logging.Logger) -- ロガー
llmname (str) -- LLM設定の名前
words (List[str]) -- 翻訳する単語のリスト
target_lang (str) -- 翻訳先の言語コード
nosave (bool) -- 翻訳結果を保存しない場合はTrue
- Returns:
(ステータスコード, {success: {単語: 翻訳}} の辞書)
- Return type:
Tuple[int, Dict[str, Any]]
cmdbox.app.features.cli.cmdbox_mcpsv_start module
cmdbox.app.features.cli.cmdbox_mcpsv_stop module
- class cmdbox.app.features.cli.cmdbox_mcpsv_stop.McpsvStop(appcls, ver, language: str = None)[source]
Bases:
UnsupportEdgeFeature,Validator- apprun(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]
cmdbox.app.features.cli.cmdbox_omni_pred module
- class cmdbox.app.features.cli.cmdbox_omni_pred.OmniPred(appcls, ver, language: str = None)[source]
Bases:
OneshotResultEdgeFeature,Validator- async apprun(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]
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- pred(logger: Logger, payload: Namespace, tm: float, pf: List[Dict[str, float]] = []) Tuple[int, Dict[str, Any], Any][source]
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int[source]
サーバー側で受け取ったlistコマンドを処理します。
cmdbox.app.features.cli.cmdbox_rag_build module
- class cmdbox.app.features.cli.cmdbox_rag_build.RagBuild(appcls, ver, language: str = None)[source]
-
- async apprun(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]
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int[source]
この機能のサーバー側の実行を行います
- 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:
int
cmdbox.app.features.cli.cmdbox_rag_del module
- class cmdbox.app.features.cli.cmdbox_rag_del.RagDel(appcls, ver, language: str = None)[source]
Bases:
OneshotResultEdgeFeature,Validator- async apprun(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]
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int[source]
この機能のサーバー側の実行を行います
- 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:
int
cmdbox.app.features.cli.cmdbox_rag_list module
- class cmdbox.app.features.cli.cmdbox_rag_list.RagList(appcls, ver, language: str = None)[source]
Bases:
OneshotResultEdgeFeature,Validator- async apprun(logger: Logger, args: Namespace, tm: float, pf: List[Dict[str, float]] = []) Tuple[int, Dict[str, Any], Any]
この機能の実行を行います
- Parameters:
logger (logging.Logger) -- ロガー
args (argparse.Namespace) -- 引数
tm (float) -- 実行開始時間
pf (List[Dict[str, float]]) -- 呼出元のパフォーマンス情報
- Returns:
終了コード, 結果, オブジェクト
- Return type:
Tuple[int, Dict[str, Any], Any]
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int[source]
この機能のサーバー側の実行を行います
- 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:
int
cmdbox.app.features.cli.cmdbox_rag_load module
- class cmdbox.app.features.cli.cmdbox_rag_load.RagLoad(appcls, ver, language: str = None)[source]
Bases:
OneshotResultEdgeFeature,Validator- async apprun(logger: Logger, args: Namespace, tm: float, pf: List[Dict[str, float]] = []) Tuple[int, Dict[str, Any], Any]
この機能の実行を行います
- Parameters:
logger (logging.Logger) -- ロガー
args (argparse.Namespace) -- 引数
tm (float) -- 実行開始時間
pf (List[Dict[str, float]]) -- 呼出元のパフォーマンス情報
- Returns:
終了コード, 結果, オブジェクト
- Return type:
Tuple[int, Dict[str, Any], Any]
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int[source]
この機能のサーバー側の実行を行います
- 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:
int
cmdbox.app.features.cli.cmdbox_rag_regist module
- class cmdbox.app.features.cli.cmdbox_rag_regist.RagRegist(appcls, ver, language: str = None)[source]
Bases:
RAGBase,Validator,LimitedFeature- async apprun(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]
cmdbox.app.features.cli.cmdbox_rag_save module
- class cmdbox.app.features.cli.cmdbox_rag_save.RagSave(appcls, ver, language: str = None)[source]
Bases:
OneshotResultEdgeFeature,Validator,LimitedFeature- async apprun(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]
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int
この機能のサーバー側の実行を行います
- 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:
int
- svrun_registrations(data_dir, logger, opt, msg)[source]
svrunの実行結果として登録数(又は登録サイズ)を取得します。 デフォルトの実装では、0 を返します。 このメソッドを拡張して、コマンドの引数やセッション情報などから登録数を算出する処理を実装できます。
- Parameters:
data_dir (Path) -- データディレクトリのパス
logger (logging.Logger) -- ロガー
opt (Dict[str, Any]) -- コマンドのオプション
msg (Union[Dict, str]) -- svrunの処理結果
- Returns:
登録数
- Return type:
int
cmdbox.app.features.cli.cmdbox_rag_search module
- class cmdbox.app.features.cli.cmdbox_rag_search.RagSearch(appcls, ver, language: str = None)[source]
-
- async apprun(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]
cmdbox.app.features.cli.cmdbox_server_list module
- class cmdbox.app.features.cli.cmdbox_server_list.ServerList(appcls, ver, language: str = None)[source]
Bases:
OneshotResultEdgeFeature,Validator- apprun(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]
cmdbox.app.features.cli.cmdbox_server_start module
- class cmdbox.app.features.cli.cmdbox_server_start.ServerStart(appcls, ver, language: str = None)[source]
Bases:
UnsupportEdgeFeature,Validator- apprun(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]
cmdbox.app.features.cli.cmdbox_server_stop module
- class cmdbox.app.features.cli.cmdbox_server_stop.ServerStop(appcls, ver, language: str = None)[source]
Bases:
UnsupportEdgeFeature,Validator- apprun(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]
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int[source]
この機能のサーバー側の実行を行います
- 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:
int
cmdbox.app.features.cli.cmdbox_server_time module
- class cmdbox.app.features.cli.cmdbox_server_time.ServerTime(appcls, ver, language: str = None)[source]
Bases:
OneshotResultEdgeFeature,Validator- async apprun(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]
- edgerun(opt, tool, logger, timeout, prevres=None)[source]
この機能のエッジ側の実行を行います
- Parameters:
opt (Dict[str, Any]) -- オプション
tool (edge.Tool) -- 通知関数などedge側のUI操作を行うためのクラス
logger (logging.Logger) -- ロガー
timeout (int) -- タイムアウト時間
prevres (Any) -- 前コマンドの結果。pipeline実行の実行結果を参照する時に使用します。
- Yields:
Tuple[int, Dict[str, Any]] -- 終了コード, 結果
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int[source]
この機能のサーバー側の実行を行います
- 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:
int
cmdbox.app.features.cli.cmdbox_skill_create module
- class cmdbox.app.features.cli.cmdbox_skill_create.SkillCreate(appcls, ver, language: str = None)[source]
Bases:
OneshotResultEdgeFeature,Validator- apprun(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]
cmdbox.app.features.cli.cmdbox_skill_install module
- class cmdbox.app.features.cli.cmdbox_skill_install.SkillInstall(appcls, ver, language: str = None)[source]
Bases:
OneshotResultEdgeFeature,Validator- async apprun(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]
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int[source]
この機能のサーバー側の実行を行います
- 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:
int
cmdbox.app.features.cli.cmdbox_skill_list module
- class cmdbox.app.features.cli.cmdbox_skill_list.SkillList(appcls, ver, language: str = None)[source]
Bases:
OneshotResultEdgeFeature,Validator- async apprun(logger: Logger, args: Namespace, tm: float, pf: List[Dict[str, float]] = []) Tuple[int, Dict[str, Any], Any]
この機能の実行を行います
- Parameters:
logger (logging.Logger) -- ロガー
args (argparse.Namespace) -- 引数
tm (float) -- 実行開始時間
pf (List[Dict[str, float]]) -- 呼出元のパフォーマンス情報
- Returns:
終了コード, 結果, オブジェクト
- Return type:
Tuple[int, Dict[str, Any], Any]
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int[source]
この機能のサーバー側の実行を行います
- 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:
int
cmdbox.app.features.cli.cmdbox_skill_uninstall module
- class cmdbox.app.features.cli.cmdbox_skill_uninstall.SkillUninstall(appcls, ver, language: str = None)[source]
Bases:
OneshotResultEdgeFeature,Validator- async apprun(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]
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int[source]
この機能のサーバー側の実行を行います
- 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:
int
cmdbox.app.features.cli.cmdbox_test_gen_cli_docs module
- class cmdbox.app.features.cli.cmdbox_test_gen_cli_docs.TestGenCliDocs(appcls, ver, language: str = None)[source]
Bases:
OneshotResultEdgeFeature,Validator- apprun(logger: Logger, args: Namespace, tm: float, pf: List[Dict[str, float]] = []) Tuple[int, Dict[str, Any], Any][source]
詳細設計書の内容を元にコマンドリファレンスRSTファイルを生成します。
- Parameters:
logger (logging.Logger) -- ロガー
args (argparse.Namespace) -- 引数
tm (float) -- 実行開始時間
pf (List[Dict[str, float]]) -- 呼出元のパフォーマンス情報
- Returns:
終了コード, 結果, オブジェクト
- Return type:
Tuple[int, Dict[str, Any], Any]
cmdbox.app.features.cli.cmdbox_test_gen_cli_spec module
- class cmdbox.app.features.cli.cmdbox_test_gen_cli_spec.TestGenCliSpec(appcls, ver, language: str = None)[source]
Bases:
OneshotResultEdgeFeature,Validator- apprun(logger: Logger, args: Namespace, tm: float, pf: List[Dict[str, float]] = []) Tuple[int, Dict[str, Any], Any][source]
フィーチャーパッケージを解析してCLIコマンド詳細設計書を生成します。
- Parameters:
logger (logging.Logger) -- ロガー
args (argparse.Namespace) -- 引数
tm (float) -- 実行開始時間
pf (List[Dict[str, float]]) -- 呼出元のパフォーマンス情報
- Returns:
終了コード, 結果, オブジェクト
- Return type:
Tuple[int, Dict[str, Any], Any]
cmdbox.app.features.cli.cmdbox_test_gen_test_spec module
- class cmdbox.app.features.cli.cmdbox_test_gen_test_spec.TestGenTestSpec(appcls, ver, language: str = None)[source]
Bases:
OneshotResultEdgeFeature,Validator- apprun(logger: Logger, args: Namespace, tm: float, pf: List[Dict[str, float]] = []) Tuple[int, Dict[str, Any], Any][source]
CLIコマンド仕様JSONを読み込みユニットテスト仕様書を生成します。
- Parameters:
logger (logging.Logger) -- ロガー
args (argparse.Namespace) -- 引数
tm (float) -- 実行開始時間
pf (List[Dict[str, float]]) -- 呼出元のパフォーマンス情報
- Returns:
終了コード, 結果, オブジェクト
- Return type:
Tuple[int, Dict[str, Any], Any]
cmdbox.app.features.cli.cmdbox_test_run_spec module
- class cmdbox.app.features.cli.cmdbox_test_run_spec.TestRunSpec(appcls, ver, language: str = None)[source]
Bases:
OneshotResultEdgeFeature,Validator- apprun(logger: Logger, args: Namespace, tm: float, pf: List[Dict[str, float]] = []) Tuple[int, Dict[str, Any], Any][source]
テスト仕様JSONに基づいてテストを実行し、結果を報告します。
- Parameters:
logger (logging.Logger) -- ロガー
args (argparse.Namespace) -- 引数
tm (float) -- 実行開始時間
pf (List[Dict[str, float]]) -- 呼出元のパフォーマンス情報
- Returns:
終了コード, 結果, オブジェクト
- Return type:
Tuple[int, Dict[str, Any], Any]
- is_cluster_redirect() bool[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int[source]
この機能のサーバー側の実行を行います
- 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:
int
cmdbox.app.features.cli.cmdbox_tts_install module
- class cmdbox.app.features.cli.cmdbox_tts_install.TtsInstall(appcls, ver, language: str = None)[source]
Bases:
UnsupportEdgeFeature,Validator- async apprun(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]
- install(reskey: str, data_dir: Path, tts_engine: str, voicevox_ver: str, voicevox_whl: str, openjtalk_ver: str, openjtalk_dic: str, onnxruntime_ver: str, onnxruntime_lib: str, force_install: bool, logger: Logger) Dict[str, Any][source]
TTSエンジンをインストールします
- Parameters:
reskey (str) -- レスポンスキー
data_dir (Path) -- データディレクトリ
tts_engine (str) -- TTSエンジン
voicevox_ver (str) -- VoiceVoxバージョン
voicevox_whl (str) -- VoiceVox ホイールファイル
openjtalk_ver (str) -- Open JTalk バージョン
openjtalk_dic (str) -- Open JTalk 辞書
onnxruntime_ver (str) -- ONNX Runtime バージョン
onnxruntime_lib (str) -- ONNX Runtime ライブラリ
force_install (bool) -- 強制インストールフラグ
logger (logging.Logger) -- ロガー
- Returns:
結果
- Return type:
Dict[str, Any]
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int[source]
この機能のサーバー側の実行を行います
- 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:
int
cmdbox.app.features.cli.cmdbox_tts_list module
- class cmdbox.app.features.cli.cmdbox_tts_list.TtsList(appcls, ver, language: str = None)[source]
Bases:
UnsupportEdgeFeature,Validator- async apprun(logger: Logger, args: Namespace, tm: float, pf: List[Dict[str, float]] = []) Tuple[int, Dict[str, Any], Any]
この機能の実行を行います
- Parameters:
logger (logging.Logger) -- ロガー
args (argparse.Namespace) -- 引数
tm (float) -- 実行開始時間
pf (List[Dict[str, float]]) -- 呼出元のパフォーマンス情報
- Returns:
終了コード, 結果, オブジェクト
- Return type:
Tuple[int, Dict[str, Any], Any]
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int[source]
この機能のサーバー側の実行を行います
- 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:
int
cmdbox.app.features.cli.cmdbox_tts_say module
- class cmdbox.app.features.cli.cmdbox_tts_say.TtsSay(appcls, ver, language: str = None)[source]
Bases:
ResultEdgeFeature,Validator,LimitedFeature- VOICEVOX_STYLE = {'0.vvm_0': {'ch': '四国めたん', 'fn': '0.vvm', 'md': 'あまあま', 'model_key': 'voicevox_0.vvm_0', 'select': '四国めたんあまあま', 'st': 0}, '0.vvm_1': {'ch': 'ずんだもん', 'fn': '0.vvm', 'md': 'あまあま', 'model_key': 'voicevox_0.vvm_1', 'select': 'ずんだもんあまあま', 'st': 1}, '0.vvm_10': {'ch': '雨晴はう', 'fn': '0.vvm', 'md': 'ノーマル', 'model_key': 'voicevox_0.vvm_10', 'select': '雨晴はうノーマル', 'st': 10}, '0.vvm_2': {'ch': '四国めたん', 'fn': '0.vvm', 'md': 'ノーマル', 'model_key': 'voicevox_0.vvm_2', 'select': '四国めたんノーマル', 'st': 2}, '0.vvm_3': {'ch': 'ずんだもん', 'fn': '0.vvm', 'md': 'ノーマル', 'model_key': 'voicevox_0.vvm_3', 'select': 'ずんだもんノーマル', 'st': 3}, '0.vvm_4': {'ch': '四国めたん', 'fn': '0.vvm', 'md': 'セクシー', 'model_key': 'voicevox_0.vvm_4', 'select': '四国めたんセクシー', 'st': 4}, '0.vvm_5': {'ch': 'ずんだもん', 'fn': '0.vvm', 'md': 'セクシー', 'model_key': 'voicevox_0.vvm_5', 'select': 'ずんだもんセクシー', 'st': 5}, '0.vvm_6': {'ch': '四国めたん', 'fn': '0.vvm', 'md': 'ツンツン', 'model_key': 'voicevox_0.vvm_6', 'select': '四国めたんツンツン', 'st': 6}, '0.vvm_7': {'ch': 'ずんだもん', 'fn': '0.vvm', 'md': 'ツンツン', 'model_key': 'voicevox_0.vvm_7', 'select': 'ずんだもんツンツン', 'st': 7}, '0.vvm_8': {'ch': '春日部つむぎ', 'fn': '0.vvm', 'md': 'ノーマル', 'model_key': 'voicevox_0.vvm_8', 'select': '春日部つむぎノーマル', 'st': 8}, '1.vvm_14': {'ch': '冥鳴ひまり', 'fn': '1.vvm', 'md': 'ノーマル', 'model_key': 'voicevox_1.vvm_14', 'select': '冥鳴ひまりノーマル', 'st': 14}, '10.vvm_39': {'ch': '玄野武宏', 'fn': '10.vvm', 'md': '喜び', 'model_key': 'voicevox_10.vvm_39', 'select': '玄野武宏喜び', 'st': 39}, '10.vvm_40': {'ch': '玄野武宏', 'fn': '10.vvm', 'md': 'ツンギレ', 'model_key': 'voicevox_10.vvm_40', 'select': '玄野武宏ツンギレ', 'st': 40}, '10.vvm_41': {'ch': '玄野武宏', 'fn': '10.vvm', 'md': '悲しみ', 'model_key': 'voicevox_10.vvm_41', 'select': '玄野武宏悲しみ', 'st': 41}, '10.vvm_42': {'ch': 'ちび式じい', 'fn': '10.vvm', 'md': 'ノーマル', 'model_key': 'voicevox_10.vvm_42', 'select': 'ちび式じいノーマル', 'st': 42}, '11.vvm_43': {'ch': '櫻歌ミコ', 'fn': '11.vvm', 'md': 'ノーマル', 'model_key': 'voicevox_11.vvm_43', 'select': '櫻歌ミコノーマル', 'st': 43}, '11.vvm_44': {'ch': '櫻歌ミコ', 'fn': '11.vvm', 'md': '第二形態', 'model_key': 'voicevox_11.vvm_44', 'select': '櫻歌ミコ第二形態', 'st': 44}, '11.vvm_45': {'ch': '櫻歌ミコ', 'fn': '11.vvm', 'md': 'ロリ', 'model_key': 'voicevox_11.vvm_45', 'select': '櫻歌ミコロリ', 'st': 45}, '11.vvm_47': {'ch': 'ナースロボ_タイプT', 'fn': '11.vvm', 'md': 'ノーマル', 'model_key': 'voicevox_11.vvm_47', 'select': 'ナースロボ_タイプTノーマル', 'st': 47}, '11.vvm_48': {'ch': 'ナースロボ_タイプT', 'fn': '11.vvm', 'md': '楽々', 'model_key': 'voicevox_11.vvm_48', 'select': 'ナースロボ_タイプT楽々', 'st': 48}, '11.vvm_49': {'ch': 'ナースロボ_タイプT', 'fn': '11.vvm', 'md': '恐怖', 'model_key': 'voicevox_11.vvm_49', 'select': 'ナースロボ_タイプT恐怖', 'st': 49}, '11.vvm_50': {'ch': 'ナースロボ_タイプT', 'fn': '11.vvm', 'md': '内緒話', 'model_key': 'voicevox_11.vvm_50', 'select': 'ナースロボ_タイプT内緒話', 'st': 50}, '12.vvm_51': {'ch': '†聖騎士 紅桜†', 'fn': '12.vvm', 'md': 'ノーマル', 'model_key': 'voicevox_12.vvm_51', 'select': '†聖騎士 紅桜†ノーマル', 'st': 51}, '12.vvm_52': {'ch': '雀松朱司', 'fn': '12.vvm', 'md': 'ノーマル', 'model_key': 'voicevox_12.vvm_52', 'select': '雀松朱司ノーマル', 'st': 52}, '12.vvm_53': {'ch': '麒ヶ島宗麟', 'fn': '12.vvm', 'md': 'ノーマル', 'model_key': 'voicevox_12.vvm_53', 'select': '麒ヶ島宗麟ノーマル', 'st': 53}, '13.vvm_54': {'ch': '春歌ナナ', 'fn': '13.vvm', 'md': 'ノーマル', 'model_key': 'voicevox_13.vvm_54', 'select': '春歌ナナノーマル', 'st': 54}, '13.vvm_55': {'ch': '猫使アル', 'fn': '13.vvm', 'md': 'ノーマル', 'model_key': 'voicevox_13.vvm_55', 'select': '猫使アルノーマル', 'st': 55}, '13.vvm_56': {'ch': '猫使アル', 'fn': '13.vvm', 'md': 'おちつき', 'model_key': 'voicevox_13.vvm_56', 'select': '猫使アルおちつき', 'st': 56}, '13.vvm_57': {'ch': '猫使アル', 'fn': '13.vvm', 'md': 'うきうき', 'model_key': 'voicevox_13.vvm_57', 'select': '猫使アルうきうき', 'st': 57}, '13.vvm_58': {'ch': '猫使ビィ', 'fn': '13.vvm', 'md': 'ノーマル', 'model_key': 'voicevox_13.vvm_58', 'select': '猫使ビィノーマル', 'st': 58}, '13.vvm_59': {'ch': '猫使ビィ', 'fn': '13.vvm', 'md': 'おちつき', 'model_key': 'voicevox_13.vvm_59', 'select': '猫使ビィおちつき', 'st': 59}, '13.vvm_60': {'ch': '猫使ビィ', 'fn': '13.vvm', 'md': '人見知り', 'model_key': 'voicevox_13.vvm_60', 'select': '猫使ビィ人見知り', 'st': 60}, '14.vvm_67': {'ch': '栗田まろん', 'fn': '14.vvm', 'md': 'ノーマル', 'model_key': 'voicevox_14.vvm_67', 'select': '栗田まろんノーマル', 'st': 67}, '14.vvm_68': {'ch': 'あいえるたん', 'fn': '14.vvm', 'md': 'ノーマル', 'model_key': 'voicevox_14.vvm_68', 'select': 'あいえるたんノーマル', 'st': 68}, '14.vvm_69': {'ch': '満別花丸', 'fn': '14.vvm', 'md': 'ノーマル', 'model_key': 'voicevox_14.vvm_69', 'select': '満別花丸ノーマル', 'st': 69}, '14.vvm_70': {'ch': '満別花丸', 'fn': '14.vvm', 'md': '元気', 'model_key': 'voicevox_14.vvm_70', 'select': '満別花丸元気', 'st': 70}, '14.vvm_71': {'ch': '満別花丸', 'fn': '14.vvm', 'md': 'ささやき', 'model_key': 'voicevox_14.vvm_71', 'select': '満別花丸ささやき', 'st': 71}, '14.vvm_72': {'ch': '満別花丸', 'fn': '14.vvm', 'md': 'ぶりっ子', 'model_key': 'voicevox_14.vvm_72', 'select': '満別花丸ぶりっ子', 'st': 72}, '14.vvm_73': {'ch': '満別花丸', 'fn': '14.vvm', 'md': 'ボーイ', 'model_key': 'voicevox_14.vvm_73', 'select': '満別花丸ボーイ', 'st': 73}, '14.vvm_74': {'ch': '琴詠ニア', 'fn': '14.vvm', 'md': 'ノーマル', 'model_key': 'voicevox_14.vvm_74', 'select': '琴詠ニアノーマル', 'st': 74}, '15.vvm_13': {'ch': '青山龍星', 'fn': '15.vvm', 'md': 'ノーマル', 'model_key': 'voicevox_15.vvm_13', 'select': '青山龍星ノーマル', 'st': 13}, '15.vvm_20': {'ch': 'もち子さん', 'fn': '15.vvm', 'md': 'ノーマル', 'model_key': 'voicevox_15.vvm_20', 'select': 'もち子さんノーマル', 'st': 20}, '15.vvm_46': {'ch': '小夜/SAYO', 'fn': '15.vvm', 'md': 'ノーマル', 'model_key': 'voicevox_15.vvm_46', 'select': '小夜/SAYOノーマル', 'st': 46}, '15.vvm_66': {'ch': 'もち子さん', 'fn': '15.vvm', 'md': 'セクシー/あん子', 'model_key': 'voicevox_15.vvm_66', 'select': 'もち子さんセクシー/あん子', 'st': 66}, '15.vvm_75': {'ch': 'ずんだもん', 'fn': '15.vvm', 'md': 'ヘロヘロ', 'model_key': 'voicevox_15.vvm_75', 'select': 'ずんだもんヘロヘロ', 'st': 75}, '15.vvm_76': {'ch': 'ずんだもん', 'fn': '15.vvm', 'md': 'なみだめ', 'model_key': 'voicevox_15.vvm_76', 'select': 'ずんだもんなみだめ', 'st': 76}, '15.vvm_77': {'ch': 'もち子さん', 'fn': '15.vvm', 'md': '泣き', 'model_key': 'voicevox_15.vvm_77', 'select': 'もち子さん泣き', 'st': 77}, '15.vvm_78': {'ch': 'もち子さん', 'fn': '15.vvm', 'md': '怒り', 'model_key': 'voicevox_15.vvm_78', 'select': 'もち子さん怒り', 'st': 78}, '15.vvm_79': {'ch': 'もち子さん', 'fn': '15.vvm', 'md': '喜び', 'model_key': 'voicevox_15.vvm_79', 'select': 'もち子さん喜び', 'st': 79}, '15.vvm_80': {'ch': 'もち子さん', 'fn': '15.vvm', 'md': 'のんびり', 'model_key': 'voicevox_15.vvm_80', 'select': 'もち子さんのんびり', 'st': 80}, '15.vvm_81': {'ch': '青山龍星', 'fn': '15.vvm', 'md': '熱血', 'model_key': 'voicevox_15.vvm_81', 'select': '青山龍星熱血', 'st': 81}, '15.vvm_82': {'ch': '青山龍星', 'fn': '15.vvm', 'md': '不機嫌', 'model_key': 'voicevox_15.vvm_82', 'select': '青山龍星不機嫌', 'st': 82}, '15.vvm_83': {'ch': '青山龍星', 'fn': '15.vvm', 'md': '喜び', 'model_key': 'voicevox_15.vvm_83', 'select': '青山龍星喜び', 'st': 83}, '15.vvm_84': {'ch': '青山龍星', 'fn': '15.vvm', 'md': 'しっとり', 'model_key': 'voicevox_15.vvm_84', 'select': '青山龍星しっとり', 'st': 84}, '15.vvm_85': {'ch': '青山龍星', 'fn': '15.vvm', 'md': 'かなしみ', 'model_key': 'voicevox_15.vvm_85', 'select': '青山龍星かなしみ', 'st': 85}, '15.vvm_86': {'ch': '青山龍星', 'fn': '15.vvm', 'md': '囁き', 'model_key': 'voicevox_15.vvm_86', 'select': '青山龍星囁き', 'st': 86}, '16.vvm_87': {'ch': '後鬼', 'fn': '16.vvm', 'md': '人間(怒り)ver.', 'model_key': 'voicevox_16.vvm_87', 'select': '後鬼人間(怒り)ver.', 'st': 87}, '16.vvm_88': {'ch': '後鬼', 'fn': '16.vvm', 'md': '鬼ver.', 'model_key': 'voicevox_16.vvm_88', 'select': '後鬼鬼ver.', 'st': 88}, '17.vvm_89': {'ch': 'Voidoll', 'fn': '17.vvm', 'md': 'ノーマル', 'model_key': 'voicevox_17.vvm_89', 'select': 'Voidollノーマル', 'st': 89}, '18.vvm_90': {'ch': 'ぞん子', 'fn': '18.vvm', 'md': 'ノーマル', 'model_key': 'voicevox_18.vvm_90', 'select': 'ぞん子ノーマル', 'st': 90}, '18.vvm_91': {'ch': 'ぞん子', 'fn': '18.vvm', 'md': '低血圧', 'model_key': 'voicevox_18.vvm_91', 'select': 'ぞん子低血圧', 'st': 91}, '18.vvm_92': {'ch': 'ぞん子', 'fn': '18.vvm', 'md': '覚醒', 'model_key': 'voicevox_18.vvm_92', 'select': 'ぞん子覚醒', 'st': 92}, '18.vvm_93': {'ch': 'ぞん子', 'fn': '18.vvm', 'md': '実況風', 'model_key': 'voicevox_18.vvm_93', 'select': 'ぞん子実況風', 'st': 93}, '18.vvm_94': {'ch': '中部つるぎ', 'fn': '18.vvm', 'md': 'ノーマル', 'model_key': 'voicevox_18.vvm_94', 'select': '中部つるぎノーマル', 'st': 94}, '18.vvm_95': {'ch': '中部つるぎ', 'fn': '18.vvm', 'md': '怒り', 'model_key': 'voicevox_18.vvm_95', 'select': '中部つるぎ怒り', 'st': 95}, '18.vvm_96': {'ch': '中部つるぎ', 'fn': '18.vvm', 'md': 'ヒソヒソ', 'model_key': 'voicevox_18.vvm_96', 'select': '中部つるぎヒソヒソ', 'st': 96}, '18.vvm_97': {'ch': '中部つるぎ', 'fn': '18.vvm', 'md': 'おどおど', 'model_key': 'voicevox_18.vvm_97', 'select': '中部つるぎおどおど', 'st': 97}, '18.vvm_98': {'ch': '中部つるぎ', 'fn': '18.vvm', 'md': '絶望と敗北', 'model_key': 'voicevox_18.vvm_98', 'select': '中部つるぎ絶望と敗北', 'st': 98}, '19.vvm_100': {'ch': '黒沢冴白', 'fn': '19.vvm', 'md': 'ノーマル', 'model_key': 'voicevox_19.vvm_100', 'select': '黒沢冴白ノーマル', 'st': 100}, '19.vvm_101': {'ch': '離途', 'fn': '19.vvm', 'md': 'シリアス', 'model_key': 'voicevox_19.vvm_101', 'select': '離途シリアス', 'st': 101}, '19.vvm_99': {'ch': '離途', 'fn': '19.vvm', 'md': 'ノーマル', 'model_key': 'voicevox_19.vvm_99', 'select': '離途ノーマル', 'st': 99}, '2.vvm_15': {'ch': '九州そら', 'fn': '2.vvm', 'md': 'あまあま', 'model_key': 'voicevox_2.vvm_15', 'select': '九州そらあまあま', 'st': 15}, '2.vvm_16': {'ch': '九州そら', 'fn': '2.vvm', 'md': 'ノーマル', 'model_key': 'voicevox_2.vvm_16', 'select': '九州そらノーマル', 'st': 16}, '2.vvm_17': {'ch': '九州そら', 'fn': '2.vvm', 'md': 'セクシー', 'model_key': 'voicevox_2.vvm_17', 'select': '九州そらセクシー', 'st': 17}, '2.vvm_18': {'ch': '九州そら', 'fn': '2.vvm', 'md': 'ツンツン', 'model_key': 'voicevox_2.vvm_18', 'select': '九州そらツンツン', 'st': 18}, '20.vvm_102': {'ch': 'ユーレイちゃん', 'fn': '20.vvm', 'md': 'ノーマル', 'model_key': 'voicevox_20.vvm_102', 'select': 'ユーレイちゃんノーマル', 'st': 102}, '20.vvm_103': {'ch': 'ユーレイちゃん', 'fn': '20.vvm', 'md': '甘々', 'model_key': 'voicevox_20.vvm_103', 'select': 'ユーレイちゃん甘々', 'st': 103}, '20.vvm_104': {'ch': 'ユーレイちゃん', 'fn': '20.vvm', 'md': '哀しみ', 'model_key': 'voicevox_20.vvm_104', 'select': 'ユーレイちゃん哀しみ', 'st': 104}, '20.vvm_105': {'ch': 'ユーレイちゃん', 'fn': '20.vvm', 'md': 'ささやき', 'model_key': 'voicevox_20.vvm_105', 'select': 'ユーレイちゃんささやき', 'st': 105}, '20.vvm_106': {'ch': 'ユーレイちゃん', 'fn': '20.vvm', 'md': 'ツクモちゃん', 'model_key': 'voicevox_20.vvm_106', 'select': 'ユーレイちゃんツクモちゃん', 'st': 106}, '21.vvm_107': {'ch': '東北ずん子', 'fn': '21.vvm', 'md': 'ノーマル', 'model_key': 'voicevox_21.vvm_107', 'select': '東北ずん子ノーマル', 'st': 107}, '21.vvm_108': {'ch': '東北きりたん', 'fn': '21.vvm', 'md': 'ノーマル', 'model_key': 'voicevox_21.vvm_108', 'select': '東北きりたんノーマル', 'st': 108}, '21.vvm_109': {'ch': '東北イタコ', 'fn': '21.vvm', 'md': 'ノーマル', 'model_key': 'voicevox_21.vvm_109', 'select': '東北イタコノーマル', 'st': 109}, '21.vvm_110': {'ch': '猫使アル', 'fn': '21.vvm', 'md': 'つよつよ', 'model_key': 'voicevox_21.vvm_110', 'select': '猫使アルつよつよ', 'st': 110}, '21.vvm_111': {'ch': '猫使アル', 'fn': '21.vvm', 'md': 'へろへろ', 'model_key': 'voicevox_21.vvm_111', 'select': '猫使アルへろへろ', 'st': 111}, '21.vvm_112': {'ch': '猫使ビィ', 'fn': '21.vvm', 'md': 'つよつよ', 'model_key': 'voicevox_21.vvm_112', 'select': '猫使ビィつよつよ', 'st': 112}, '3.vvm_61': {'ch': '中国うさぎ', 'fn': '3.vvm', 'md': 'ノーマル', 'model_key': 'voicevox_3.vvm_61', 'select': '中国うさぎノーマル', 'st': 61}, '3.vvm_62': {'ch': '中国うさぎ', 'fn': '3.vvm', 'md': 'おどろき', 'model_key': 'voicevox_3.vvm_62', 'select': '中国うさぎおどろき', 'st': 62}, '3.vvm_63': {'ch': '中国うさぎ', 'fn': '3.vvm', 'md': 'こわがり', 'model_key': 'voicevox_3.vvm_63', 'select': '中国うさぎこわがり', 'st': 63}, '3.vvm_64': {'ch': '中国うさぎ', 'fn': '3.vvm', 'md': 'へろへろ', 'model_key': 'voicevox_3.vvm_64', 'select': '中国うさぎへろへろ', 'st': 64}, '3.vvm_65': {'ch': '波音リツ', 'fn': '3.vvm', 'md': 'クイーン', 'model_key': 'voicevox_3.vvm_65', 'select': '波音リツクイーン', 'st': 65}, '3.vvm_9': {'ch': '波音リツ', 'fn': '3.vvm', 'md': 'ノーマル', 'model_key': 'voicevox_3.vvm_9', 'select': '波音リツノーマル', 'st': 9}, '4.vvm_11': {'ch': '玄野武宏', 'fn': '4.vvm', 'md': 'ノーマル', 'model_key': 'voicevox_4.vvm_11', 'select': '玄野武宏ノーマル', 'st': 11}, '4.vvm_21': {'ch': '剣崎雌雄', 'fn': '4.vvm', 'md': 'ノーマル', 'model_key': 'voicevox_4.vvm_21', 'select': '剣崎雌雄ノーマル', 'st': 21}, '5.vvm_19': {'ch': '九州そら', 'fn': '5.vvm', 'md': 'ささやき', 'model_key': 'voicevox_5.vvm_19', 'select': '九州そらささやき', 'st': 19}, '5.vvm_22': {'ch': 'ずんだもん', 'fn': '5.vvm', 'md': 'ささやき', 'model_key': 'voicevox_5.vvm_22', 'select': 'ずんだもんささやき', 'st': 22}, '5.vvm_36': {'ch': '四国めたん', 'fn': '5.vvm', 'md': 'ささやき', 'model_key': 'voicevox_5.vvm_36', 'select': '四国めたんささやき', 'st': 36}, '5.vvm_37': {'ch': '四国めたん', 'fn': '5.vvm', 'md': 'ヒソヒソ', 'model_key': 'voicevox_5.vvm_37', 'select': '四国めたんヒソヒソ', 'st': 37}, '5.vvm_38': {'ch': 'ずんだもん', 'fn': '5.vvm', 'md': 'ヒソヒソ', 'model_key': 'voicevox_5.vvm_38', 'select': 'ずんだもんヒソヒソ', 'st': 38}, '6.vvm_29': {'ch': 'No.7', 'fn': '6.vvm', 'md': 'ノーマル', 'model_key': 'voicevox_6.vvm_29', 'select': 'No.7ノーマル', 'st': 29}, '6.vvm_30': {'ch': 'No.7', 'fn': '6.vvm', 'md': 'アナウンス', 'model_key': 'voicevox_6.vvm_30', 'select': 'No.7アナウンス', 'st': 30}, '6.vvm_31': {'ch': 'No.7', 'fn': '6.vvm', 'md': '読み聞かせ', 'model_key': 'voicevox_6.vvm_31', 'select': 'No.7読み聞かせ', 'st': 31}, '7.vvm_27': {'ch': '後鬼', 'fn': '7.vvm', 'md': '人間ver.', 'model_key': 'voicevox_7.vvm_27', 'select': '後鬼人間ver.', 'st': 27}, '7.vvm_28': {'ch': '後鬼', 'fn': '7.vvm', 'md': 'ぬいぐるみver.', 'model_key': 'voicevox_7.vvm_28', 'select': '後鬼ぬいぐるみver.', 'st': 28}, '8.vvm_23': {'ch': 'WhiteCUL', 'fn': '8.vvm', 'md': 'ノーマル', 'model_key': 'voicevox_8.vvm_23', 'select': 'WhiteCULノーマル', 'st': 23}, '8.vvm_24': {'ch': 'WhiteCUL', 'fn': '8.vvm', 'md': 'たのしい', 'model_key': 'voicevox_8.vvm_24', 'select': 'WhiteCULたのしい', 'st': 24}, '8.vvm_25': {'ch': 'WhiteCUL', 'fn': '8.vvm', 'md': 'かなしい', 'model_key': 'voicevox_8.vvm_25', 'select': 'WhiteCULかなしい', 'st': 25}, '8.vvm_26': {'ch': 'WhiteCUL', 'fn': '8.vvm', 'md': 'びえーん', 'model_key': 'voicevox_8.vvm_26', 'select': 'WhiteCULびえーん', 'st': 26}, '9.vvm_12': {'ch': '白上虎太郎', 'fn': '9.vvm', 'md': 'ふつう', 'model_key': 'voicevox_9.vvm_12', 'select': '白上虎太郎ふつう', 'st': 12}, '9.vvm_32': {'ch': '白上虎太郎', 'fn': '9.vvm', 'md': 'わーい', 'model_key': 'voicevox_9.vvm_32', 'select': '白上虎太郎わーい', 'st': 32}, '9.vvm_33': {'ch': '白上虎太郎', 'fn': '9.vvm', 'md': 'びくびく', 'model_key': 'voicevox_9.vvm_33', 'select': '白上虎太郎びくびく', 'st': 33}, '9.vvm_34': {'ch': '白上虎太郎', 'fn': '9.vvm', 'md': 'おこ', 'model_key': 'voicevox_9.vvm_34', 'select': '白上虎太郎おこ', 'st': 34}, '9.vvm_35': {'ch': '白上虎太郎', 'fn': '9.vvm', 'md': 'びえーん', 'model_key': 'voicevox_9.vvm_35', 'select': '白上虎太郎びえーん', 'st': 35}}
- async apprun(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]
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- k = '21.vvm_109'
- say(reskey: str, data_dir: Path, tts_engine: str, voicevox_model: str, tts_text: str, logger: Logger, redis_cli: RedisClient, sessions: Dict[str, Dict[str, Any]]) int[source]
TTSエンジンを使ってテキストを音声に変換します
- Parameters:
reskey (str) -- レスポンスキー
data_dir (Path) -- データディレクトリ
tts_engine (str) -- TTSエンジン
voicevox_model (str) -- VoiceVoxモデル
tts_text (str) -- TTSテキスト
logger (logging.Logger) -- ロガー
redis_cli (redis_client.RedisClient) -- Redisクライアント
sessions (Dict[str, Dict[str, Any]]) -- セッション情報
- Returns:
レスポンスコード
- Return type:
int
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int
この機能のサーバー側の実行を行います
- 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:
int
- svrun_credit(data_dir, logger, opt, msg)[source]
svrunの実行結果として使用クレジット数を取得します。 デフォルトの実装では、0 を返します。 このメソッドを拡張して、コマンドの引数やセッション情報などから使用クレジット数を算出する処理を実装できます。
- Parameters:
data_dir (Path) -- データディレクトリのパス
logger (logging.Logger) -- ロガー
opt (Dict[str, Any]) -- コマンドのオプション
msg (Union[Dict, str]) -- svrunの処理結果
- Returns:
使用クレジット数
- Return type:
int
- classmethod tts_say(tts_engine_obj: Dict, tts_text: str) str[source]
TTSエンジンを使ってテキストを音声に変換します
- Parameters:
tts_engine_obj (Dict) -- TTSエンジンオブジェクト
tts_text (str) -- TTSテキスト
- Returns:
変換後の音声データ(Base64エンコードされた文字列)
- Return type:
str
- classmethod tts_start(data_dir: Path, tts_engine: str, voicevox_model: str) Dict[source]
TTSエンジンのモデルを開始します :param data_dir: データディレクトリ :type data_dir: Path :param tts_engine: TTSエンジン :type tts_engine: str :param voicevox_model: VoiceVoxモデル :type voicevox_model: str
- Returns:
TTSエンジンオブジェクト
- Return type:
Dict
- classmethod tts_stop(tts_engine_obj: Dict) None[source]
TTSエンジンのモデルを停止します
- Parameters:
tts_engine_obj (Dict) -- TTSエンジンオブジェクト
- v = {'ch': '東北イタコ', 'fn': '21.vvm', 'md': 'ノーマル', 'model_key': 'voicevox_21.vvm_109', 'select': '東北イタコノーマル', 'st': 109}
cmdbox.app.features.cli.cmdbox_tts_uninstall module
- class cmdbox.app.features.cli.cmdbox_tts_uninstall.TtsUninstall(appcls, ver, language: str = None)[source]
Bases:
UnsupportEdgeFeature,Validator- async apprun(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]
- is_cluster_redirect()[source]
クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
- Returns:
メッセージを転送する場合はTrue
- Return type:
bool
- svrun(data_dir: Path, logger: Logger, redis_cli: RedisClient, msg: List[str], sessions: Dict[str, Dict[str, Any]]) int[source]
この機能のサーバー側の実行を行います
- 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:
int
cmdbox.app.features.cli.cmdbox_url_add module
- class cmdbox.app.features.cli.cmdbox_url_add.UrlAdd(appcls, ver, language=None)[source]
Bases:
OneshotResultEdgeFeature,Validator- apprun(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]
cmdbox.app.features.cli.cmdbox_url_del module
- class cmdbox.app.features.cli.cmdbox_url_del.UrlDel(appcls, ver, language=None)[source]
Bases:
OneshotResultEdgeFeature,Validator- apprun(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]
cmdbox.app.features.cli.cmdbox_url_list module
- class cmdbox.app.features.cli.cmdbox_url_list.UrlList(appcls, ver, language=None)[source]
Bases:
OneshotResultEdgeFeature,Validator- apprun(logger: Logger, args: Namespace, tm: float, pf: List[Dict[str, float]] = []) Tuple[int, Dict[str, Any], Any]
この機能の実行を行います
- Parameters:
logger (logging.Logger) -- ロガー
args (argparse.Namespace) -- 引数
tm (float) -- 実行開始時間
pf (List[Dict[str, float]]) -- 呼出元のパフォーマンス情報
- Returns:
終了コード, 結果, オブジェクト
- Return type:
Tuple[int, Dict[str, Any], Any]
cmdbox.app.features.cli.cmdbox_url_load module
- class cmdbox.app.features.cli.cmdbox_url_load.UrlLoad(appcls, ver, language=None)[source]
Bases:
OneshotResultEdgeFeature,Validator- apprun(logger: Logger, args: Namespace, tm: float, pf: List[Dict[str, float]] = []) Tuple[int, Dict[str, Any], Any]
この機能の実行を行います
- Parameters:
logger (logging.Logger) -- ロガー
args (argparse.Namespace) -- 引数
tm (float) -- 実行開始時間
pf (List[Dict[str, float]]) -- 呼出元のパフォーマンス情報
- Returns:
終了コード, 結果, オブジェクト
- Return type:
Tuple[int, Dict[str, Any], Any]
cmdbox.app.features.cli.cmdbox_web_apikey_add module
- class cmdbox.app.features.cli.cmdbox_web_apikey_add.WebApikeyAdd(appcls, ver, language: str = None)[source]
Bases:
UnsupportEdgeFeature,Validator- apprun(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]
cmdbox.app.features.cli.cmdbox_web_apikey_del module
- class cmdbox.app.features.cli.cmdbox_web_apikey_del.WebApikeyDel(appcls, ver, language: str = None)[source]
Bases:
UnsupportEdgeFeature,Validator- apprun(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]
cmdbox.app.features.cli.cmdbox_web_gencert module
- class cmdbox.app.features.cli.cmdbox_web_gencert.WebGencert(appcls, ver, language: str = None)[source]
Bases:
UnsupportEdgeFeature,Validator- apprun(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]
cmdbox.app.features.cli.cmdbox_web_genpass module
- class cmdbox.app.features.cli.cmdbox_web_genpass.WebGenpass(appcls, ver, language: str = None)[source]
Bases:
OneshotResultEdgeFeature,Validator- apprun(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]
cmdbox.app.features.cli.cmdbox_web_group_add module
- class cmdbox.app.features.cli.cmdbox_web_group_add.WebGroupAdd(appcls, ver, language: str = None)[source]
Bases:
UnsupportEdgeFeature,Validator,LimitedFeature- apprun(logger: Logger, args: Namespace, tm: float, pf: List[Dict[str, float]] = []) Tuple[int, Dict[str, Any], Any]
この機能の実行を行います
- Parameters:
logger (logging.Logger) -- ロガー
args (argparse.Namespace) -- 引数
tm (float) -- 実行開始時間
pf (List[Dict[str, float]]) -- 呼出元のパフォーマンス情報
- Returns:
終了コード, 結果, オブジェクト
- Return type:
Tuple[int, Dict[str, Any], Any]
- apprun_registrations(data_dir, logger, args, msg)[source]
apprunの実行結果として登録数(又は登録サイズ)を取得します。 デフォルトの実装では、0 を返します。 このメソッドを拡張して、コマンドの引数やセッション情報などから登録数を算出する処理を実装できます。
- Parameters:
data_dir (Path) -- データディレクトリのパス
logger (logging.Logger) -- ロガー
args (argparse.Namespace) -- コマンドの引数
msg (Dict[str, Any]) -- apprunの処理結果
- Returns:
登録数
- Return type:
int
- svrun_registrations(data_dir, logger, opt, msg)[source]
svrunの実行結果として登録数(又は登録サイズ)を取得します。 デフォルトの実装では、0 を返します。 このメソッドを拡張して、コマンドの引数やセッション情報などから登録数を算出する処理を実装できます。
- Parameters:
data_dir (Path) -- データディレクトリのパス
logger (logging.Logger) -- ロガー
opt (Dict[str, Any]) -- コマンドのオプション
msg (Union[Dict, str]) -- svrunの処理結果
- Returns:
登録数
- Return type:
int
cmdbox.app.features.cli.cmdbox_web_group_del module
- class cmdbox.app.features.cli.cmdbox_web_group_del.WebGroupDel(appcls, ver, language: str = None)[source]
Bases:
UnsupportEdgeFeature,Validator- apprun(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]
cmdbox.app.features.cli.cmdbox_web_group_edit module
- class cmdbox.app.features.cli.cmdbox_web_group_edit.WebGroupEdit(appcls, ver, language: str = None)[source]
Bases:
UnsupportEdgeFeature,Validator- apprun(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]
cmdbox.app.features.cli.cmdbox_web_group_list module
- class cmdbox.app.features.cli.cmdbox_web_group_list.WebGroupList(appcls, ver, language: str = None)[source]
Bases:
UnsupportEdgeFeature,Validator- apprun(logger: Logger, args: Namespace, tm: float, pf: List[Dict[str, float]] = []) Tuple[int, Dict[str, Any], Any]
この機能の実行を行います
- Parameters:
logger (logging.Logger) -- ロガー
args (argparse.Namespace) -- 引数
tm (float) -- 実行開始時間
pf (List[Dict[str, float]]) -- 呼出元のパフォーマンス情報
- Returns:
終了コード, 結果, オブジェクト
- Return type:
Tuple[int, Dict[str, Any], Any]
cmdbox.app.features.cli.cmdbox_web_session_list module
- class cmdbox.app.features.cli.cmdbox_web_session_list.WebSessionList(appcls, ver, language: str = None)[source]
Bases:
UnsupportEdgeFeature,Validator- apprun(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]
cmdbox.app.features.cli.cmdbox_web_start module
- class cmdbox.app.features.cli.cmdbox_web_start.WebStart(appcls, ver, language: str = None)[source]
Bases:
UnsupportEdgeFeature,Validator- apprun(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]
cmdbox.app.features.cli.cmdbox_web_stop module
- class cmdbox.app.features.cli.cmdbox_web_stop.WebStop(appcls, ver, language: str = None)[source]
Bases:
UnsupportEdgeFeature,Validator- apprun(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]
cmdbox.app.features.cli.cmdbox_web_user_add module
- class cmdbox.app.features.cli.cmdbox_web_user_add.WebUserAdd(appcls, ver, language: str = None)[source]
Bases:
UnsupportEdgeFeature,Validator,LimitedFeature- apprun(logger: Logger, args: Namespace, tm: float, pf: List[Dict[str, float]] = []) Tuple[int, Dict[str, Any], Any]
この機能の実行を行います
- Parameters:
logger (logging.Logger) -- ロガー
args (argparse.Namespace) -- 引数
tm (float) -- 実行開始時間
pf (List[Dict[str, float]]) -- 呼出元のパフォーマンス情報
- Returns:
終了コード, 結果, オブジェクト
- Return type:
Tuple[int, Dict[str, Any], Any]
- apprun_registrations(data_dir, logger, args, msg)[source]
apprunの実行結果として登録数(又は登録サイズ)を取得します。 デフォルトの実装では、0 を返します。 このメソッドを拡張して、コマンドの引数やセッション情報などから登録数を算出する処理を実装できます。
- Parameters:
data_dir (Path) -- データディレクトリのパス
logger (logging.Logger) -- ロガー
args (argparse.Namespace) -- コマンドの引数
msg (Dict[str, Any]) -- apprunの処理結果
- Returns:
登録数
- Return type:
int
- svrun_registrations(data_dir, logger, opt, msg)[source]
svrunの実行結果として登録数(又は登録サイズ)を取得します。 デフォルトの実装では、0 を返します。 このメソッドを拡張して、コマンドの引数やセッション情報などから登録数を算出する処理を実装できます。
- Parameters:
data_dir (Path) -- データディレクトリのパス
logger (logging.Logger) -- ロガー
opt (Dict[str, Any]) -- コマンドのオプション
msg (Union[Dict, str]) -- svrunの処理結果
- Returns:
登録数
- Return type:
int
cmdbox.app.features.cli.cmdbox_web_user_del module
- class cmdbox.app.features.cli.cmdbox_web_user_del.WebUserDel(appcls, ver, language: str = None)[source]
Bases:
UnsupportEdgeFeature,Validator- apprun(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]
cmdbox.app.features.cli.cmdbox_web_user_edit module
- class cmdbox.app.features.cli.cmdbox_web_user_edit.WebUserEdit(appcls, ver, language: str = None)[source]
Bases:
UnsupportEdgeFeature,Validator- apprun(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]
cmdbox.app.features.cli.cmdbox_web_user_list module
- class cmdbox.app.features.cli.cmdbox_web_user_list.WebUserList(appcls, ver, language: str = None)[source]
Bases:
UnsupportEdgeFeature,Validator- apprun(logger: Logger, args: Namespace, tm: float, pf: List[Dict[str, float]] = []) Tuple[int, Dict[str, Any], Any]
この機能の実行を行います
- Parameters:
logger (logging.Logger) -- ロガー
args (argparse.Namespace) -- 引数
tm (float) -- 実行開始時間
pf (List[Dict[str, float]]) -- 呼出元のパフォーマンス情報
- Returns:
終了コード, 結果, オブジェクト
- Return type:
Tuple[int, Dict[str, Any], Any]