Source code for cmdbox.app.features.cli.cmdbox_web_group_del

from cmdbox.app import common, feature, web
from cmdbox.app.commons import resdata, validator
from cmdbox.app.options import Options
from typing import Dict, Any, Tuple, List, Union
import argparse
import logging
import pydantic


[docs] class WebGroupDel(feature.UnsupportEdgeFeature, validator.Validator):
[docs] def get_mode(self) -> Union[str, List[str]]: """ この機能のモードを返します Returns: Union[str, List[str]]: モード """ return 'web'
[docs] def get_cmd(self): """ この機能のコマンドを返します Returns: str: コマンド """ return 'group_del'
[docs] def get_option(self): """ この機能のオプションを返します Returns: Dict[str, Any]: オプション """ return dict( use_redis=self.USE_REDIS_MEIGHT, nouse_webmode=False, use_agent=False, description_ja="Webモードのグループを削除します。", description_en="Del a group in Web mode.", choice=[ dict(opt="host", type=Options.T_STR, default=self.default_host, required=True, multi=False, hide=True, choice=None, web="mask", description_ja="Redisサーバーのサービスホストを指定します。", description_en="Specify the service host of the Redis server."), dict(opt="port", type=Options.T_INT, default=self.default_port, required=True, multi=False, hide=True, choice=None, web="mask", description_ja="Redisサーバーのサービスポートを指定します。", description_en="Specify the service port of the Redis server."), dict(opt="password", type=Options.T_PASSWD, default=self.default_pass, required=True, multi=False, hide=True, choice=None, web="mask", description_ja="Redisサーバーのアクセスパスワード(任意)を指定します。省略時は `password` を使用します。", description_en="Specify the access password of the Redis server (optional). If omitted, `password` is used."), dict(opt="svname", type=Options.T_STR, default=self.default_svname, required=True, multi=False, hide=True, choice=None, web="readonly", description_ja="サーバーのサービス名を指定します。省略時は `server` を使用します。", description_en="Specify the service name of the inference server. If omitted, `server` is used."), dict(opt="data", type=Options.T_DIR, default=self.default_data, required=False, multi=False, hide=False, choice=None, web="mask", description_ja=f"省略した時は `$HOME/.{self.ver.__appid__}` を使用します。", description_en=f"When omitted, `$HOME/.{self.ver.__appid__}` is used."), dict(opt="retry_count", type=Options.T_INT, default=3, required=False, multi=False, hide=True, choice=None, description_ja="Redisサーバーへの再接続回数を指定します。0以下を指定すると永遠に再接続を行います。", description_en="Specifies the number of reconnections to the Redis server.If less than 0 is specified, reconnection is forever."), dict(opt="retry_interval", type=Options.T_INT, default=5, required=False, multi=False, hide=True, choice=None, description_ja="Redisサーバーに再接続までの秒数を指定します。", description_en="Specifies the number of seconds before reconnecting to the Redis server."), dict(opt="timeout", type=Options.T_INT, default="60", required=False, multi=False, hide=True, choice=None, description_ja="サーバーの応答が返ってくるまでの最大待ち時間を指定します。", description_en="Specify the maximum waiting time until the server responds."), dict(opt="group_id", type=Options.T_STR, default=None, required=True, multi=False, hide=False, choice=None, description_ja="グループIDを指定します。", description_en="Specify the group ID. Do not duplicate other groups."), dict(opt="signin_file", type=Options.T_FILE, default=f'.{self.ver.__appid__}/user_list.yml', required=True, multi=False, hide=False, choice=None, fileio="in", web="mask", description_ja=f"サインイン可能なユーザーとパスワードを記載したファイルを指定します。通常 '.{self.ver.__appid__}/user_list.yml' を指定します。", description_en=f"Specify a file containing users and passwords with which they can signin.Typically, specify '.{self.ver.__appid__}/user_list.yml'."), ] )
[docs] @validator.apprun_check def apprun(self, logger:logging.Logger, args:argparse.Namespace, tm:float, pf:List[Dict[str, float]]=[]) -> Tuple[int, Dict[str, Any], Any]: """ この機能の実行を行います Args: logger (logging.Logger): ロガー args (argparse.Namespace): 引数 tm (float): 実行開始時間 pf (List[Dict[str, float]]): 呼出元のパフォーマンス情報 Returns: Tuple[int, Dict[str, Any], Any]: 終了コード, 結果, オブジェクト """ w = None try: w = web.Web.getInstance(logger, self.data, appcls=self.appcls, ver=self.ver, redis_host=args.host, redis_port=args.port, redis_password=args.password, svname=args.svname, retry_count=args.retry_count, retry_interval=args.retry_interval, timeout=args.timeout, signin_file=args.signin_file) w.group_del(args.group_id) msg = dict(success=f"group ID {args.group_id} has been deleted.") common.print_format(msg, args.format, tm, pf=pf) return self.RESP_SUCCESS, msg, w except Exception as e: msg = dict(warn=f"{e}") common.print_format(msg, args.format, tm, pf=pf) return self.RESP_WARN, msg, w
[docs] def output_schema(self) -> type: class Data(resdata.Data): data: Union[str, None] = pydantic.Field(default=None, description="処理結果のデータ") class Result(resdata.Result): success: Union[Data, None] = pydantic.Field(default=None, description="成功した場合の結果") return Result