cmdbox 0.5.1.1__py3-none-any.whl → 0.5.2__py3-none-any.whl

cmdbox/app/features/cli/cmdbox_client_file_list.py

@@ -1,193 +1,193 @@
-from cmdbox.app import common, client, feature, filer
-from cmdbox.app.commons import convert, redis_client
-from cmdbox.app.options import Options
-from pathlib import Path
-from typing import Dict, Any, Tuple, List, Union
-import argparse
-import logging
-
-
-class ClientFileList(feature.OneshotResultEdgeFeature):
-    def get_mode(self) -> Union[str, List[str]]:
-        """
-        この機能のモードを返します
-
-        Returns:
-            Union[str, List[str]]: モード
-        """
-        return 'client'
-
-    def get_cmd(self):
-        """
-        この機能のコマンドを返します
-
-        Returns:
-            str: コマンド
-        """
-        return 'file_list'
-    
-    def get_option(self):
-        """
-        この機能のオプションを返します
-
-        Returns:
-            Dict[str, Any]: オプション
-        """
-        return dict(
-            use_redis=self.USE_REDIS_MEIGHT, nouse_webmode=False,
-            discription_ja="データフォルダ配下のファイルリストを取得します。",
-            discription_en="Get a list of files under the data folder.",
-            choice=[
-                dict(opt="host", type=Options.T_STR, default=self.default_host, required=True, multi=False, hide=True, choice=None, web="mask",
-                     discription_ja="Redisサーバーのサービスホストを指定します。",
-                     discription_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",
-                     discription_ja="Redisサーバーのサービスポートを指定します。",
-                     discription_en="Specify the service port of the Redis server."),
-                dict(opt="password", type=Options.T_STR, default=self.default_pass, required=True, multi=False, hide=True, choice=None, web="mask",
-                     discription_ja="Redisサーバーのアクセスパスワード(任意)を指定します。省略時は `password` を使用します。",
-                     discription_en="Specify the access password of the Redis server (optional). If omitted, `password` is used."),
-                dict(opt="svname", type=Options.T_STR, default="server", required=True, multi=False, hide=True, choice=None, web="readonly",
-                     discription_ja="サーバーのサービス名を指定します。省略時は `server` を使用します。",
-                     discription_en="Specify the service name of the inference server. If omitted, `server` is used."),
-                dict(opt="svpath", type=Options.T_STR, default="/", required=True, multi=False, hide=False, choice=None,
-                     discription_ja="サーバーのデータフォルダ以下のパスを指定します。省略時は `/` を使用します。",
-                     discription_en="Specify the directory path to get the list of files.",
-                     test_true={"server":"/"}),
-                dict(opt="recursive", type=Options.T_BOOL, default=False, required=False, multi=False, hide=True, choice=[True, False],
-                     discription_ja="指定したパスに含まれるフォルダについて、再帰的にファイルリストを取得します。",
-                     discription_en="Get a list of files recursively for a folder contained in the specified path.",
-                     test_true={"server":True, "client":False}),
-                dict(opt="scope", type=Options.T_STR, default="client", required=True, multi=False, hide=False, choice=["client", "current", "server"],
-                     discription_ja="参照先スコープを指定します。指定可能な画像タイプは `client` , `current` , `server` です。",
-                     discription_en="Specifies the scope to be referenced. When omitted, 'client' is used.",
-                     choice_show=dict(client=["client_data"]),
-                     test_true={"server":"server",
-                                "client":"client",
-                                "current":"current"}),
-                dict(opt="client_data", type=Options.T_STR, default=None, required=False, multi=False, hide=False, choice=None,
-                     discription_ja="ローカルを参照させる場合のデータフォルダのパスを指定します。",
-                     discription_en="Specify the path of the data folder when local is referenced.",
-                     test_true={"server":None,
-                                "client":common.HOME_DIR / f".{self.ver.__appid__}",
-                                "current":None}),
-                dict(opt="retry_count", type=Options.T_INT, default=3, required=False, multi=False, hide=True, choice=None,
-                     discription_ja="Redisサーバーへの再接続回数を指定します。0以下を指定すると永遠に再接続を行います。",
-                     discription_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,
-                     discription_ja="Redisサーバーに再接続までの秒数を指定します。",
-                     discription_en="Specifies the number of seconds before reconnecting to the Redis server."),
-                dict(opt="timeout", type=Options.T_INT, default="15", required=False, multi=False, hide=True, choice=None,
-                     discription_ja="サーバーの応答が返ってくるまでの最大待ち時間を指定。",
-                     discription_en="Specify the maximum waiting time until the server responds."),
-                dict(opt="output_json", short="o", type=Options.T_FILE, default=None, required=False, multi=False, hide=True, choice=None, fileio="out",
-                     discription_ja="処理結果jsonの保存先ファイルを指定。",
-                     discription_en="Specify the destination file for saving the processing result json."),
-                dict(opt="output_json_append", short="a", type=Options.T_BOOL, default=False, required=False, multi=False, hide=True, choice=[True, False],
-                     discription_ja="処理結果jsonファイルを追記保存します。",
-                     discription_en="Save the processing result json file by appending."),
-                dict(opt="stdout_log", type=Options.T_BOOL, default=True, required=False, multi=False, hide=True, choice=[True, False],
-                     discription_ja="GUIモードでのみ使用可能です。コマンド実行時の標準出力をConsole logに出力します。",
-                     discription_en="Available only in GUI mode. Outputs standard output during command execution to Console log."),
-                dict(opt="capture_stdout", type=Options.T_BOOL, default=True, required=False, multi=False, hide=True, choice=[True, False],
-                     discription_ja="GUIモードでのみ使用可能です。コマンド実行時の標準出力をキャプチャーし、実行結果画面に表示します。",
-                     discription_en="Available only in GUI mode. Captures standard output during command execution and displays it on the execution result screen."),
-                dict(opt="capture_maxsize", type=Options.T_INT, default=self.DEFAULT_CAPTURE_MAXSIZE, required=False, multi=False, hide=True, choice=None,
-                     discription_ja="GUIモードでのみ使用可能です。コマンド実行時の標準出力の最大キャプチャーサイズを指定します。",
-                     discription_en="Available only in GUI mode. Specifies the maximum capture size of standard output when executing commands."),
-            ]
-        )
-    
-    def get_svcmd(self):
-        """
-        この機能のサーバー側のコマンドを返します
-
-        Returns:
-            str: サーバー側のコマンド
-        """
-        return 'file_list'
-
-    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]: 終了コード, 結果, オブジェクト
-        """
-        if args.svname is None:
-            msg = dict(warn=f"Please specify the --svname option.")
-            common.print_format(msg, args.format, tm, args.output_json, args.output_json_append, pf=pf)
-            return 1, msg, None
-        cl = client.Client(logger, redis_host=args.host, redis_port=args.port, redis_password=args.password, svname=args.svname)
-
-        client_data = Path(args.client_data.replace('"','')) if args.client_data is not None else None
-        ret = cl.file_list(args.svpath.replace('"',''), recursive=args.recursive, scope=args.scope, client_data=client_data,
-                            retry_count=args.retry_count, retry_interval=args.retry_interval, timeout=args.timeout)
-        common.print_format(ret, args.format, tm, args.output_json, args.output_json_append, pf=pf)
-
-        if 'success' not in ret:
-            return 1, ret, cl
-
-        return 0, ret, cl
-
-    def is_cluster_redirect(self):
-        """
-        クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
-
-        Returns:
-            bool: メッセージを転送する場合はTrue
-        """
-        return False
-
-    def svrun(self, data_dir:Path, logger:logging.Logger, redis_cli:redis_client.RedisClient, msg:List[str],
-              sessions:Dict[str, Dict[str, Any]]) -> int:
-        """
-        この機能のサーバー側の実行を行います
-
-        Args:
-            data_dir (Path): データディレクトリ
-            logger (logging.Logger): ロガー
-            redis_cli (redis_client.RedisClient): Redisクライアント
-            msg (List[str]): 受信メッセージ
-            sessions (Dict[str, Dict[str, Any]]): セッション情報
-        
-        Returns:
-            int: 終了コード
-        """
-        svpath = convert.b64str2str(msg[2])
-        recursive = True if msg[3] == 'True' else False
-        st = self.file_list(msg[1], svpath, recursive, data_dir, logger, redis_cli, sessions)
-        return st
-
-    def file_list(self, reskey:str, current_path:str, recursive:bool,
-                  data_dir:Path, logger:logging.Logger, redis_cli:redis_client.RedisClient, sessions:Dict[str, Dict[str, Any]]) -> int:
-        """
-        ファイルリストを取得する
-
-        Args:
-            reskey (str): レスポンスキー
-            path (str): ファイルパス
-            recursive (bool): 再帰的に取得するかどうか
-            data_dir (Path): データディレクトリ
-            logger (logging.Logger): ロガー
-            redis_cli (redis_client.RedisClient): Redisクライアント
-            sessions (Dict[str, Dict[str, Any]]): セッション情報
-
-        Returns:
-            int: レスポンスコード
-        """
-        try:
-            f = filer.Filer(data_dir, logger)
-            rescode, msg = f.file_list(current_path, recursive)
-            redis_cli.rpush(reskey, msg)
-            return rescode
-        except Exception as e:
-            logger.warning(f"Failed to get file list: {e}", exc_info=True)
-            redis_cli.rpush(reskey, dict(warn=f"Failed to get file list: {e}"))
-            return self.RESP_WARN
+from cmdbox.app import common, client, feature, filer
+from cmdbox.app.commons import convert, redis_client
+from cmdbox.app.options import Options
+from pathlib import Path
+from typing import Dict, Any, Tuple, List, Union
+import argparse
+import logging
+
+
+class ClientFileList(feature.OneshotResultEdgeFeature):
+    def get_mode(self) -> Union[str, List[str]]:
+        """
+        この機能のモードを返します
+
+        Returns:
+            Union[str, List[str]]: モード
+        """
+        return 'client'
+
+    def get_cmd(self):
+        """
+        この機能のコマンドを返します
+
+        Returns:
+            str: コマンド
+        """
+        return 'file_list'
+    
+    def get_option(self):
+        """
+        この機能のオプションを返します
+
+        Returns:
+            Dict[str, Any]: オプション
+        """
+        return dict(
+            use_redis=self.USE_REDIS_MEIGHT, nouse_webmode=False,
+            discription_ja="データフォルダ配下のファイルリストを取得します。",
+            discription_en="Get a list of files under the data folder.",
+            choice=[
+                dict(opt="host", type=Options.T_STR, default=self.default_host, required=True, multi=False, hide=True, choice=None, web="mask",
+                     discription_ja="Redisサーバーのサービスホストを指定します。",
+                     discription_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",
+                     discription_ja="Redisサーバーのサービスポートを指定します。",
+                     discription_en="Specify the service port of the Redis server."),
+                dict(opt="password", type=Options.T_STR, default=self.default_pass, required=True, multi=False, hide=True, choice=None, web="mask",
+                     discription_ja="Redisサーバーのアクセスパスワード(任意)を指定します。省略時は `password` を使用します。",
+                     discription_en="Specify the access password of the Redis server (optional). If omitted, `password` is used."),
+                dict(opt="svname", type=Options.T_STR, default="server", required=True, multi=False, hide=True, choice=None, web="readonly",
+                     discription_ja="サーバーのサービス名を指定します。省略時は `server` を使用します。",
+                     discription_en="Specify the service name of the inference server. If omitted, `server` is used."),
+                dict(opt="svpath", type=Options.T_STR, default="/", required=True, multi=False, hide=False, choice=None,
+                     discription_ja="サーバーのデータフォルダ以下のパスを指定します。省略時は `/` を使用します。",
+                     discription_en="Specify the directory path to get the list of files.",
+                     test_true={"server":"/"}),
+                dict(opt="recursive", type=Options.T_BOOL, default=False, required=False, multi=False, hide=True, choice=[True, False],
+                     discription_ja="指定したパスに含まれるフォルダについて、再帰的にファイルリストを取得します。",
+                     discription_en="Get a list of files recursively for a folder contained in the specified path.",
+                     test_true={"server":True, "client":False}),
+                dict(opt="scope", type=Options.T_STR, default="client", required=True, multi=False, hide=False, choice=["client", "current", "server"],
+                     discription_ja="参照先スコープを指定します。指定可能な画像タイプは `client` , `current` , `server` です。",
+                     discription_en="Specifies the scope to be referenced. When omitted, 'client' is used.",
+                     choice_show=dict(client=["client_data"]),
+                     test_true={"server":"server",
+                                "client":"client",
+                                "current":"current"}),
+                dict(opt="client_data", type=Options.T_STR, default=None, required=False, multi=False, hide=False, choice=None,
+                     discription_ja="ローカルを参照させる場合のデータフォルダのパスを指定します。",
+                     discription_en="Specify the path of the data folder when local is referenced.",
+                     test_true={"server":None,
+                                "client":common.HOME_DIR / f".{self.ver.__appid__}",
+                                "current":None}),
+                dict(opt="retry_count", type=Options.T_INT, default=3, required=False, multi=False, hide=True, choice=None,
+                     discription_ja="Redisサーバーへの再接続回数を指定します。0以下を指定すると永遠に再接続を行います。",
+                     discription_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,
+                     discription_ja="Redisサーバーに再接続までの秒数を指定します。",
+                     discription_en="Specifies the number of seconds before reconnecting to the Redis server."),
+                dict(opt="timeout", type=Options.T_INT, default="15", required=False, multi=False, hide=True, choice=None,
+                     discription_ja="サーバーの応答が返ってくるまでの最大待ち時間を指定。",
+                     discription_en="Specify the maximum waiting time until the server responds."),
+                dict(opt="output_json", short="o", type=Options.T_FILE, default=None, required=False, multi=False, hide=True, choice=None, fileio="out",
+                     discription_ja="処理結果jsonの保存先ファイルを指定。",
+                     discription_en="Specify the destination file for saving the processing result json."),
+                dict(opt="output_json_append", short="a", type=Options.T_BOOL, default=False, required=False, multi=False, hide=True, choice=[True, False],
+                     discription_ja="処理結果jsonファイルを追記保存します。",
+                     discription_en="Save the processing result json file by appending."),
+                dict(opt="stdout_log", type=Options.T_BOOL, default=True, required=False, multi=False, hide=True, choice=[True, False],
+                     discription_ja="GUIモードでのみ使用可能です。コマンド実行時の標準出力をConsole logに出力します。",
+                     discription_en="Available only in GUI mode. Outputs standard output during command execution to Console log."),
+                dict(opt="capture_stdout", type=Options.T_BOOL, default=True, required=False, multi=False, hide=True, choice=[True, False],
+                     discription_ja="GUIモードでのみ使用可能です。コマンド実行時の標準出力をキャプチャーし、実行結果画面に表示します。",
+                     discription_en="Available only in GUI mode. Captures standard output during command execution and displays it on the execution result screen."),
+                dict(opt="capture_maxsize", type=Options.T_INT, default=self.DEFAULT_CAPTURE_MAXSIZE, required=False, multi=False, hide=True, choice=None,
+                     discription_ja="GUIモードでのみ使用可能です。コマンド実行時の標準出力の最大キャプチャーサイズを指定します。",
+                     discription_en="Available only in GUI mode. Specifies the maximum capture size of standard output when executing commands."),
+            ]
+        )
+    
+    def get_svcmd(self):
+        """
+        この機能のサーバー側のコマンドを返します
+
+        Returns:
+            str: サーバー側のコマンド
+        """
+        return 'file_list'
+
+    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]: 終了コード, 結果, オブジェクト
+        """
+        if args.svname is None:
+            msg = dict(warn=f"Please specify the --svname option.")
+            common.print_format(msg, args.format, tm, args.output_json, args.output_json_append, pf=pf)
+            return 1, msg, None
+        cl = client.Client(logger, redis_host=args.host, redis_port=args.port, redis_password=args.password, svname=args.svname)
+
+        client_data = Path(args.client_data.replace('"','')) if args.client_data is not None else None
+        ret = cl.file_list(args.svpath.replace('"',''), recursive=args.recursive, scope=args.scope, client_data=client_data,
+                            retry_count=args.retry_count, retry_interval=args.retry_interval, timeout=args.timeout)
+        common.print_format(ret, args.format, tm, args.output_json, args.output_json_append, pf=pf)
+
+        if 'success' not in ret:
+            return 1, ret, cl
+
+        return 0, ret, cl
+
+    def is_cluster_redirect(self):
+        """
+        クラスター宛のメッセージの場合、メッセージを転送するかどうかを返します
+
+        Returns:
+            bool: メッセージを転送する場合はTrue
+        """
+        return False
+
+    def svrun(self, data_dir:Path, logger:logging.Logger, redis_cli:redis_client.RedisClient, msg:List[str],
+              sessions:Dict[str, Dict[str, Any]]) -> int:
+        """
+        この機能のサーバー側の実行を行います
+
+        Args:
+            data_dir (Path): データディレクトリ
+            logger (logging.Logger): ロガー
+            redis_cli (redis_client.RedisClient): Redisクライアント
+            msg (List[str]): 受信メッセージ
+            sessions (Dict[str, Dict[str, Any]]): セッション情報
+        
+        Returns:
+            int: 終了コード
+        """
+        svpath = convert.b64str2str(msg[2])
+        recursive = True if msg[3] == 'True' else False
+        st = self.file_list(msg[1], svpath, recursive, data_dir, logger, redis_cli, sessions)
+        return st
+
+    def file_list(self, reskey:str, current_path:str, recursive:bool,
+                  data_dir:Path, logger:logging.Logger, redis_cli:redis_client.RedisClient, sessions:Dict[str, Dict[str, Any]]) -> int:
+        """
+        ファイルリストを取得する
+
+        Args:
+            reskey (str): レスポンスキー
+            path (str): ファイルパス
+            recursive (bool): 再帰的に取得するかどうか
+            data_dir (Path): データディレクトリ
+            logger (logging.Logger): ロガー
+            redis_cli (redis_client.RedisClient): Redisクライアント
+            sessions (Dict[str, Dict[str, Any]]): セッション情報
+
+        Returns:
+            int: レスポンスコード
+        """
+        try:
+            f = filer.Filer(data_dir, logger)
+            rescode, msg = f.file_list(current_path, recursive)
+            redis_cli.rpush(reskey, msg)
+            return rescode
+        except Exception as e:
+            logger.warning(f"Failed to get file list: {e}", exc_info=True)
+            redis_cli.rpush(reskey, dict(warn=f"Failed to get file list: {e}"))
+            return self.RESP_WARN