cmdbox.app.features.web package
Submodules
cmdbox.app.features.web.cmdbox_web_agent module
- class cmdbox.app.features.web.cmdbox_web_agent.Agent(appcls, ver, language: str)[source]
Bases:
ExecCmd- get_startmsg(web: Web, user_name: str, groups: List[str], mcpserver_apikey: str | None, a2asv_apikey: str | None) str[source]
チャットの開始メッセージを返します
- Parameters:
web (Web) -- Webオブジェクト
user_name (str) -- ユーザー名
groups (List[str]) -- ユーザーが所属するグループ
mcpserver_apikey (Union[str, None]) -- MCPサーバーのAPIキー
a2asv_apikey (Union[str, None]) -- A2ASVのAPIキー
- Returns:
開始メッセージ
- Return type:
str
- get_user_info(web: Web, session: Dict[str, Any]) Tuple[str, List[str], str | None, str | None, str][source]
- route(web: Web, app: FastAPI) None[source]
webモードのルーティングを設定します
- Parameters:
web (Web) -- Webオブジェクト
app (FastAPI) -- FastAPIオブジェクト
ツールメニューの情報を返します
- Parameters:
web (Web) -- Webオブジェクト
- Returns:
ツールメニュー情報
- Return type:
Dict[str, Any]
Sample:
{ 'filer': { 'html': 'Filer', 'href': 'filer', 'target': '_blank', 'css_class': 'dropdown-item', 'onclick': 'alert("filer")' } }
cmdbox.app.features.web.cmdbox_web_assets module
- class cmdbox.app.features.web.cmdbox_web_assets.Assets(appcls=None, ver=<module 'cmdbox.version' from 'F:\\devenv\\cmdbox\\cmdbox\\version.py'>, language: str = None)[source]
Bases:
WebFeature- is_force_cache_path(web: Web, req: Request, path: str | Path) bool[source]
指定されたパスが強制キャッシュ対象かどうかを判定します。
- Parameters:
web (Web) -- Webオブジェクト
req (Request) -- クライアントからのリクエストオブジェクト
path (Union[str, Path]) -- 判定対象のパス
- Returns:
強制キャッシュ対象であればTrue、そうでなければFalse
- Return type:
bool
- regs_force_cache_path = [re.compile('assets/apexcharts'), re.compile('assets/bootstrap'), re.compile('assets/cmdbox/[A-z0-9\\.\\-_]*(png|ico|jpg|jpeg|gif|svg)'), re.compile('assets/dompurify'), re.compile('assets/encodingjs'), re.compile('assets/highlight'), re.compile('assets/jquery'), re.compile('assets/lightbox2'), re.compile('assets/marked'), re.compile('assets/split-pane'), re.compile('assets/tree-menu')]
cmdbox.app.features.web.cmdbox_web_audit module
- class cmdbox.app.features.web.cmdbox_web_audit.Audit(appcls=None, ver=<module 'cmdbox.version' from 'F:\\devenv\\cmdbox\\cmdbox\\version.py'>, language: str = None)[source]
Bases:
WebFeature- route(web: Web, app: FastAPI) None[source]
webモードのルーティングを設定します
- Parameters:
web (Web) -- Webオブジェクト
app (FastAPI) -- FastAPIオブジェクト
ツールメニューの情報を返します
- Parameters:
web (Web) -- Webオブジェクト
- Returns:
ツールメニュー情報
- Return type:
Dict[str, Any]
Sample:
{ 'filer': { 'html': 'Filer', 'href': 'filer', 'target': '_blank', 'css_class': 'dropdown-item', 'onclick': 'alert("filer")' } }
cmdbox.app.features.web.cmdbox_web_audit_metrics module
- class cmdbox.app.features.web.cmdbox_web_audit_metrics.AuditMetrics(appcls=None, ver=<module 'cmdbox.version' from 'F:\\devenv\\cmdbox\\cmdbox\\version.py'>, language: str = None)[source]
Bases:
WebFeature
cmdbox.app.features.web.cmdbox_web_bbforce_cmd module
- class cmdbox.app.features.web.cmdbox_web_bbforce_cmd.BbforceCmd(appcls=None, ver=<module 'cmdbox.version' from 'F:\\devenv\\cmdbox\\cmdbox\\version.py'>, language: str = None)[source]
Bases:
WebFeature
cmdbox.app.features.web.cmdbox_web_copyright module
- class cmdbox.app.features.web.cmdbox_web_copyright.Copyright(appcls=None, ver=<module 'cmdbox.version' from 'F:\\devenv\\cmdbox\\cmdbox\\version.py'>, language: str = None)[source]
Bases:
WebFeature
cmdbox.app.features.web.cmdbox_web_del_cmd module
- class cmdbox.app.features.web.cmdbox_web_del_cmd.DelCmd(appcls=None, ver=<module 'cmdbox.version' from 'F:\\devenv\\cmdbox\\cmdbox\\version.py'>, language: str = None)[source]
Bases:
WebFeature
cmdbox.app.features.web.cmdbox_web_del_pipe module
- class cmdbox.app.features.web.cmdbox_web_del_pipe.DelPipe(appcls=None, ver=<module 'cmdbox.version' from 'F:\\devenv\\cmdbox\\cmdbox\\version.py'>, language: str = None)[source]
Bases:
WebFeature
cmdbox.app.features.web.cmdbox_web_do_signin module
- class cmdbox.app.features.web.cmdbox_web_do_signin.DoSignin(appcls=None, ver=<module 'cmdbox.version' from 'F:\\devenv\\cmdbox\\cmdbox\\version.py'>, language: str = None)[source]
Bases:
Signin
cmdbox.app.features.web.cmdbox_web_do_signout module
- class cmdbox.app.features.web.cmdbox_web_do_signout.DoSignout(appcls=None, ver=<module 'cmdbox.version' from 'F:\\devenv\\cmdbox\\cmdbox\\version.py'>, language: str = None)[source]
Bases:
WebFeature
cmdbox.app.features.web.cmdbox_web_exec_cmd module
- class cmdbox.app.features.web.cmdbox_web_exec_cmd.ExecCmd(appcls, ver, language: str)[source]
Bases:
LoadCmd- chk_client_only(web: Web, opt)[source]
クライアントのみのサービスかどうかをチェックする
- Parameters:
web (Web) -- Webオブジェクト
opt (dict) -- オプション
- Returns:
(クライアントのみ場合はTrue, メッセージ)
- Return type:
tuple
- coercion_param(user_session: Dict[str, Any], opt: Dict[str, Any]) Dict[str, Any][source]
コマンドオプションを強制的に値を設定する拡張ポイントです。
- Parameters:
user_session (Dict[str, Any]) -- ユーザーセッション
opt (Dict[str, Any]) -- 実行時のコマンドオプション
- Returns:
強制的に値を設定したコマンドオプション
- Return type:
Dict[str, Any]
- async exec_cmd(req: Request, res: Response, web: Web, title: str, opt: Dict[str, Any], nothread: bool = False, appcls=None, resqueue: Queue = None) List[Dict[str, Any]][source]
コマンドを実行する
- Parameters:
req (Request) -- リクエスト
res (Response) -- レスポンス
web (Web) -- Webオブジェクト
title (str) -- タイトル
opt (dict) -- オプション
nothread (bool, optional) -- スレッドを使わないかどうか. Defaults to False.
resqueue (queue.Queue, optional) -- 結果を格納するキュー. Defaults to None.
- Returns:
コマンド実行結果
- Return type:
list
cmdbox.app.features.web.cmdbox_web_exec_pipe module
- class cmdbox.app.features.web.cmdbox_web_exec_pipe.ExecPipe(appcls, ver, language: str)[source]
-
- exec_pipe(req: Request, res: Response, web: Web, title: str, opt: Dict[str, Any], nothread: bool = False, capture_stdin: bool = False) List[Dict[str, Any]][source]
パイプラインを実行する
- Parameters:
req (Request) -- リクエスト
res (Response) -- レスポンス
web (Web) -- Webオブジェクト
title (str) -- タイトル
opt (dict) -- オプション
nothread (bool, optional) -- スレッドを使わないかどうか. Defaults to False.
capture_stdin (bool, optional) -- 標準入力をキャプチャするかどうか. Defaults to False.
- Returns:
パイプライン実行結果
- Return type:
list
cmdbox.app.features.web.cmdbox_web_filer module
- class cmdbox.app.features.web.cmdbox_web_filer.Filer(appcls=None, ver=<module 'cmdbox.version' from 'F:\\devenv\\cmdbox\\cmdbox\\version.py'>, language: str = None)[source]
Bases:
WebFeature- route(web: Web, app: FastAPI) None[source]
webモードのルーティングを設定します
- Parameters:
web (Web) -- Webオブジェクト
app (FastAPI) -- FastAPIオブジェクト
ツールメニューの情報を返します
- Parameters:
web (Web) -- Webオブジェクト
- Returns:
ツールメニュー情報
- Return type:
Dict[str, Any]
Sample:
{ 'filer': { 'html': 'Filer', 'href': 'filer', 'target': '_blank', 'css_class': 'dropdown-item', 'onclick': 'alert("filer")' } }
cmdbox.app.features.web.cmdbox_web_filer_download module
cmdbox.app.features.web.cmdbox_web_filer_upload module
- class cmdbox.app.features.web.cmdbox_web_filer_upload.FilerUpload(appcls, ver, language: str)[source]
Bases:
ExecCmd
cmdbox.app.features.web.cmdbox_web_get_cmd_choices module
- class cmdbox.app.features.web.cmdbox_web_get_cmd_choices.GetCmdChoices(appcls=None, ver=<module 'cmdbox.version' from 'F:\\devenv\\cmdbox\\cmdbox\\version.py'>, language: str = None)[source]
Bases:
WebFeature
cmdbox.app.features.web.cmdbox_web_get_cmds module
- class cmdbox.app.features.web.cmdbox_web_get_cmds.GetCmds(appcls=None, ver=<module 'cmdbox.version' from 'F:\\devenv\\cmdbox\\cmdbox\\version.py'>, language: str = None)[source]
Bases:
WebFeature
cmdbox.app.features.web.cmdbox_web_get_modes module
- class cmdbox.app.features.web.cmdbox_web_get_modes.GetModes(appcls=None, ver=<module 'cmdbox.version' from 'F:\\devenv\\cmdbox\\cmdbox\\version.py'>, language: str = None)[source]
Bases:
WebFeature
cmdbox.app.features.web.cmdbox_web_get_server_opt module
- class cmdbox.app.features.web.cmdbox_web_get_server_opt.GetServerOpt(appcls=None, ver=<module 'cmdbox.version' from 'F:\\devenv\\cmdbox\\cmdbox\\version.py'>, language: str = None)[source]
Bases:
WebFeature
cmdbox.app.features.web.cmdbox_web_gui module
- class cmdbox.app.features.web.cmdbox_web_gui.Gui(appcls, ver, language: str)[source]
Bases:
WebFeature- callback_console_modal_log_func(web: Web, output: Dict[str, Any])[source]
コンソールモーダルにログを出力する
- Parameters:
web (Web) -- Webオブジェクト
output (Dict[str, Any]) -- 出力
- callback_return_cmd_exec_func(web: Web, title: str, output: Dict[str, Any])[source]
コマンド実行結果を返す
- Parameters:
web (Web) -- Webオブジェクト
title (str) -- タイトル
output (Dict[str, Any]) -- 出力
- callback_return_pipe_exec_func(web: Web, title: str, output: Dict[str, Any])[source]
パイプライン実行結果を返す
- Parameters:
web (Web) -- Webオブジェクト
title (str) -- タイトル
output (Dict[str, Any]) -- 出力
- callback_return_stream_log_func(web: Web, output: Dict[str, Any])[source]
ストリームログを返す
- Parameters:
web (Web) -- Webオブジェクト
output (Dict[str, Any]) -- 出力
- mk_curl_fileup(web: Web, cmd_opt: Dict[str, Any]) str[source]
curlコマンド文字列を作成する
- Parameters:
web (Web) -- Webオブジェクト
cmd_opt (dict) -- コマンドのオプション
- Returns:
curlコマンド文字列
- Return type:
str
- route(web: Web, app: FastAPI) None[source]
webモードのルーティングを設定します
- Parameters:
web (Web) -- Webオブジェクト
app (FastAPI) -- FastAPIオブジェクト
ツールメニューの情報を返します
- Parameters:
web (Web) -- Webオブジェクト
- Returns:
ツールメニュー情報
- Return type:
Dict[str, Any]
Sample:
{ 'filer': { 'html': 'Filer', 'href': 'filer', 'target': '_blank', 'css_class': 'dropdown-item', 'onclick': 'alert("filer")' } }
cmdbox.app.features.web.cmdbox_web_gui_callback module
- class cmdbox.app.features.web.cmdbox_web_gui_callback.GuiCallback(appcls=None, ver=<module 'cmdbox.version' from 'F:\\devenv\\cmdbox\\cmdbox\\version.py'>, language: str = None)[source]
Bases:
WebFeature
cmdbox.app.features.web.cmdbox_web_limiter module
- class cmdbox.app.features.web.cmdbox_web_limiter.Limiter(appcls=None, ver=<module 'cmdbox.version' from 'F:\\devenv\\cmdbox\\cmdbox\\version.py'>, language: str = None)[source]
Bases:
WebFeature- route(web: Web, app: FastAPI) None[source]
webモードのルーティングを設定します
- Parameters:
web (Web) -- Webオブジェクト
app (FastAPI) -- FastAPIオブジェクト
ツールメニューの情報を返します
- Parameters:
web (Web) -- Webオブジェクト
- Returns:
ツールメニュー情報
- Return type:
Dict[str, Any]
Sample:
{ 'filer': { 'html': 'Filer', 'href': 'filer', 'target': '_blank', 'css_class': 'dropdown-item', 'onclick': 'alert("filer")' } }
cmdbox.app.features.web.cmdbox_web_list_cmd module
- class cmdbox.app.features.web.cmdbox_web_list_cmd.ListCmd(appcls=None, ver=<module 'cmdbox.version' from 'F:\\devenv\\cmdbox\\cmdbox\\version.py'>, language: str = None)[source]
Bases:
WebFeature
cmdbox.app.features.web.cmdbox_web_list_pipe module
- class cmdbox.app.features.web.cmdbox_web_list_pipe.ListPipe(appcls=None, ver=<module 'cmdbox.version' from 'F:\\devenv\\cmdbox\\cmdbox\\version.py'>, language: str = None)[source]
Bases:
WebFeature
cmdbox.app.features.web.cmdbox_web_load_cmd module
cmdbox.app.features.web.cmdbox_web_load_pipe module
- class cmdbox.app.features.web.cmdbox_web_load_pipe.LoadPipe(appcls=None, ver=<module 'cmdbox.version' from 'F:\\devenv\\cmdbox\\cmdbox\\version.py'>, language: str = None)[source]
Bases:
WebFeature
cmdbox.app.features.web.cmdbox_web_raw_cmd module
- class cmdbox.app.features.web.cmdbox_web_raw_cmd.RawCmd(appcls, ver, language: str)[source]
Bases:
Gui
cmdbox.app.features.web.cmdbox_web_raw_pipe module
- class cmdbox.app.features.web.cmdbox_web_raw_pipe.RawPipe(appcls, ver, language: str)[source]
-
- raw_pipe(web: Web, title: str, opt: Dict[str, Any], setredis: bool = False) List[Dict[str, Any]][source]
パイプラインのコマンドライン文字列、curlコマンド文字列を作成する
- Parameters:
web (Web) -- Webオブジェクト
title (str) -- タイトル
opt (dict) -- オプション
setredis (bool) -- Webインスタンスのredis接続情報をオプションにセットするかどうか
- Returns:
コマンドライン文字列、curlコマンド文字列
- Return type:
list[Dict[str, Any]]
cmdbox.app.features.web.cmdbox_web_result module
- class cmdbox.app.features.web.cmdbox_web_result.Result(appcls=None, ver=<module 'cmdbox.version' from 'F:\\devenv\\cmdbox\\cmdbox\\version.py'>, language: str = None)[source]
Bases:
WebFeature- route(web: Web, app: FastAPI) None[source]
webモードのルーティングを設定します
- Parameters:
web (Web) -- Webオブジェクト
app (FastAPI) -- FastAPIオブジェクト
ツールメニューの情報を返します
- Parameters:
web (Web) -- Webオブジェクト
- Returns:
ツールメニュー情報
- Return type:
Dict[str, Any]
Sample:
{ 'filer': { 'html': 'Filer', 'href': 'filer', 'target': '_blank', 'css_class': 'dropdown-item', 'onclick': 'alert("filer")' } }
cmdbox.app.features.web.cmdbox_web_save_cmd module
- class cmdbox.app.features.web.cmdbox_web_save_cmd.SaveCmd(appcls=None, ver=<module 'cmdbox.version' from 'F:\\devenv\\cmdbox\\cmdbox\\version.py'>, language: str = None)[source]
Bases:
WebFeature
cmdbox.app.features.web.cmdbox_web_save_pipe module
- class cmdbox.app.features.web.cmdbox_web_save_pipe.SavePipe(appcls=None, ver=<module 'cmdbox.version' from 'F:\\devenv\\cmdbox\\cmdbox\\version.py'>, language: str = None)[source]
Bases:
WebFeature
cmdbox.app.features.web.cmdbox_web_signin module
- class cmdbox.app.features.web.cmdbox_web_signin.Signin(appcls=None, ver=<module 'cmdbox.version' from 'F:\\devenv\\cmdbox\\cmdbox\\version.py'>, language: str = None)[source]
Bases:
WebFeature
cmdbox.app.features.web.cmdbox_web_status module
- class cmdbox.app.features.web.cmdbox_web_status.Status(appcls=None, ver=<module 'cmdbox.version' from 'F:\\devenv\\cmdbox\\cmdbox\\version.py'>, language: str = None)[source]
Bases:
WebFeature- route(web: Web, app: FastAPI) None[source]
webモードのルーティングを設定します
- Parameters:
web (Web) -- Webオブジェクト
app (FastAPI) -- FastAPIオブジェクト
ツールメニューの情報を返します
- Parameters:
web (Web) -- Webオブジェクト
- Returns:
ツールメニュー情報
- Return type:
Dict[str, Any]
cmdbox.app.features.web.cmdbox_web_url module
cmdbox.app.features.web.cmdbox_web_user_data module
- class cmdbox.app.features.web.cmdbox_web_user_data.UserData(appcls=None, ver=<module 'cmdbox.version' from 'F:\\devenv\\cmdbox\\cmdbox\\version.py'>, language: str = None)[source]
Bases:
WebFeature
cmdbox.app.features.web.cmdbox_web_users module
- class cmdbox.app.features.web.cmdbox_web_users.Users(appcls=None, ver=<module 'cmdbox.version' from 'F:\\devenv\\cmdbox\\cmdbox\\version.py'>, language: str = None)[source]
Bases:
WebFeature- route(web: Web, app: FastAPI) None[source]
webモードのルーティングを設定します
- Parameters:
web (Web) -- Webオブジェクト
app (FastAPI) -- FastAPIオブジェクト
ツールメニューの情報を返します
- Parameters:
web (Web) -- Webオブジェクト
- Returns:
ツールメニュー情報
- Return type:
Dict[str, Any]
Sample:
{ 'filer': { 'html': 'Filer', 'href': 'filer', 'target': '_blank', 'css_class': 'dropdown-item', 'onclick': 'alert("filer")' } }
cmdbox.app.features.web.cmdbox_web_usesignout module
- class cmdbox.app.features.web.cmdbox_web_usesignout.Usesignout(appcls=None, ver=<module 'cmdbox.version' from 'F:\\devenv\\cmdbox\\cmdbox\\version.py'>, language: str = None)[source]
Bases:
WebFeature
cmdbox.app.features.web.cmdbox_web_versions_cmdbox module
- class cmdbox.app.features.web.cmdbox_web_versions_cmdbox.VersionsCmdbox(appcls=None, ver=<module 'cmdbox.version' from 'F:\\devenv\\cmdbox\\cmdbox\\version.py'>, language: str = None)[source]
Bases:
WebFeature