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

cmdbox/app/client.py

@@ -28,7 +28,7 @@ class Client(object):
     def __exit__(self, a, b, c):
         pass
 
-    def stop_server(self, retry_count:int=3, retry_interval:int=5, timeout:int = 60):
+    def stop_server(self, retry_count:int=3, retry_interval:int=5, timeout:int=60):
         """
         Redisサーバーを停止する
 
@@ -44,7 +44,7 @@ class Client(object):
         return res_json
     
     def file_list(self, svpath:str, recursive:bool, scope:str="client", client_data:Path = None,
-                  retry_count:int=3, retry_interval:int=5, timeout:int = 60):
+                  retry_count:int=3, retry_interval:int=5, timeout:int=60):
         """
         サーバー上のファイルリストを取得する
 
@@ -81,7 +81,7 @@ class Client(object):
             return dict(warn=f"scope is invalid. {scope}")
 
     def file_mkdir(self, svpath:str, scope:str="client", client_data:Path = None,
-                   retry_count:int=3, retry_interval:int=5, timeout:int = 60):
+                   retry_count:int=3, retry_interval:int=5, timeout:int=60):
         """
         サーバー上にディレクトリを作成する
 
@@ -117,7 +117,7 @@ class Client(object):
             return dict(warn=f"scope is invalid. {scope}")
     
     def file_rmdir(self, svpath:str, scope:str="client", client_data:Path = None,
-                   retry_count:int=3, retry_interval:int=5, timeout:int = 60):
+                   retry_count:int=3, retry_interval:int=5, timeout:int=60):
         """
         サーバー上のディレクトリを削除する
 
@@ -153,7 +153,7 @@ class Client(object):
             return dict(warn=f"scope is invalid. {scope}")
     
     def file_download(self, svpath:str, download_file:Path, scope:str="client", client_data:Path = None, rpath:str="", img_thumbnail:float=0.0,
-                      retry_count:int=3, retry_interval:int=5, timeout:int = 60):
+                      retry_count:int=3, retry_interval:int=5, timeout:int=60):
         """
         サーバー上のファイルをダウンロードする
 
@@ -203,7 +203,7 @@ class Client(object):
         return res_json
     
     def file_upload(self, svpath:str, upload_file:Path, scope:str="client", client_data:Path=None, mkdir:bool=False, orverwrite:bool=False,
-                    retry_count:int=3, retry_interval:int=5, timeout:int = 60):
+                    retry_count:int=3, retry_interval:int=5, timeout:int=60):
         """
         サーバー上にファイルをアップロードする
 
@@ -257,7 +257,7 @@ class Client(object):
                 return dict(warn=f"scope is invalid. {scope}")
 
     def file_remove(self, svpath:str, scope:str="client", client_data:Path = None,
-                    retry_count:int=3, retry_interval:int=5, timeout:int = 60):
+                    retry_count:int=3, retry_interval:int=5, timeout:int=60):
         """
         サーバー上のファイルを削除する
 
@@ -293,7 +293,7 @@ class Client(object):
             return dict(warn=f"scope is invalid. {scope}")
 
     def file_copy(self, from_path:str, to_path:str, orverwrite:bool=False, scope:str="client", client_data:Path = None,
-                    retry_count:int=3, retry_interval:int=5, timeout:int = 60):
+                    retry_count:int=3, retry_interval:int=5, timeout:int=60):
         """
         サーバー上のファイルをコピーする
 
@@ -331,7 +331,7 @@ class Client(object):
             return dict(warn=f"scope is invalid. {scope}")
 
     def file_move(self, from_path:str, to_path:str, scope:str="client", client_data:Path = None,
-                    retry_count:int=3, retry_interval:int=5, timeout:int = 60):
+                    retry_count:int=3, retry_interval:int=5, timeout:int=60):
         """
         サーバー上のファイルを移動する
 
@@ -367,7 +367,7 @@ class Client(object):
             self.logger.warning(f"scope is invalid. {scope}")
             return dict(warn=f"scope is invalid. {scope}")
 
-    def server_info(self, retry_count:int=3, retry_interval:int=5, timeout:int = 60):
+    def server_info(self, retry_count:int=3, retry_interval:int=5, timeout:int=60):
         """
         サーバーの情報を取得する
 

cmdbox/app/common.py

@@ -36,7 +36,7 @@ def copy_sample(data:Path, ver=version):
         data (Path): データディレクトリ
         ver (version, optional): バージョン. Defaults to version
     """
-    dst = Path(data) / '.samples' if data is not None else HOME_DIR / '.samples'
+    dst_sample = Path(data) / '.samples' if data is not None else HOME_DIR / '.samples'
     #if dst.exists():
     #    return
     src = Path(ver.__file__).parent / 'extensions'
@@ -44,7 +44,13 @@ def copy_sample(data:Path, ver=version):
         p = Path(dst)
         if not p.exists():
             shutil.copy2(src, dst)
-    shutil.copytree(src, dst, dirs_exist_ok=True, copy_function=copy)
+    shutil.copytree(src, dst_sample, dirs_exist_ok=True, copy_function=copy)
+    dst_config = Path(data) / f'.{ver.__appid__}' if data is not None else HOME_DIR / f'.{ver.__appid__}'
+    dst_config.mkdir(parents=True, exist_ok=True)
+    if not (dst_config / 'features.yml').exists():
+        shutil.copy2(src / 'features.yml', dst_config / 'features.yml')
+    if not (dst_config / 'user_list.yml').exists():
+        shutil.copy2(src / 'user_list.yml', dst_config / 'user_list.yml')
 
 def mklogdir(data:Path) -> Path:
     """
@@ -200,7 +206,9 @@ def default_json_enc(o) -> Any:
     if isinstance(o, tempfile._TemporaryFileWrapper):
         return str(o)
     if isinstance(o, datetime.datetime):
-        return o.strftime('%Y-%m-%dT%H:%M:%S')
+        if o.tzinfo is datetime.timezone.utc:
+            return o.strftime('%Y-%m-%dT%H:%M:%S')
+        return o.strftime('%Y-%m-%dT%H:%M:%S%z')
     if isinstance(o, feature.Feature):
         return 'object'
     raise TypeError(f"Type {type(o)} not serializable")
@@ -389,11 +397,11 @@ def print_format(data:dict, format:bool, tm:float, output_json:str=None, output_
     Returns:
         str: 生成された文字列
     """
-    if type(data) is dict and "success" in data and "performance" in data["success"] and type(data["success"]["performance"]) is list and pf is not None:
+    if type(data) is dict and "success" in data and type(data["success"]) is dict and "performance" in data["success"] and type(data["success"]["performance"]) is list and pf is not None:
         data["success"]["performance"] += pf
     txt = ''
     if format:
-        if 'success' in data:
+        if 'success' in data and type(data["success"]) is dict:
             data = data['success']['data'] if 'data' in data['success'] else data['success']
             if type(data) == list:
                 txt = tabulate(data, headers='keys', tablefmt=tablefmt)
@@ -412,7 +420,7 @@ def print_format(data:dict, format:bool, tm:float, output_json:str=None, output_
             except BrokenPipeError:
                 pass
     else:
-        if 'success' in data and type(data['success']) == dict:
+        if 'success' in data and type(data['success']) is dict:
             if "performance" not in data["success"]:
                 data["success"]["performance"] = []
             performance = data["success"]["performance"]
@@ -559,6 +567,23 @@ def decrypt(enc_message:str, password:str) -> str:
     except:
         return None
 
+def chopdq(target:str):
+    """"
+    "で囲まれた文字列を取り除きます。
+    targetにNoneが指定された場合はNoneを返します。
+
+    Args:
+        target (str): 対象文字列
+    
+    Returns:
+        str: 取り除かれた文字列
+    """
+    if target is None:
+        return None
+    if not isinstance(target, str):
+        return target
+    return target[1:-1] if target.startswith('"') and target.endswith('"') else target
+
 def is_event_loop_running() -> bool:
     """
     イベントループが実行中かどうかを取得します。
@@ -594,3 +619,22 @@ def exec_sync(func, *args, **kwargs) -> Any:
             return ret
         return asyncio.run(func(*args, **kwargs))
     return func(*args, **kwargs)
+
+def get_tzoffset_str() -> str:
+    """
+    タイムゾーンのオフセットを取得します
+
+    Returns:
+        str: タイムゾーンのオフセット
+    """
+    # 現在のタイムゾーンのオフセットを取得
+    now_utc = datetime.datetime.now(datetime.timezone.utc)
+    now_local = now_utc.astimezone()
+    offset = now_local.utcoffset()
+    # timedelta オブジェクトから '+/-HH:MM' 形式の文字列を生成
+    total_seconds = int(offset.total_seconds())
+    hours = abs(total_seconds) // 3600
+    minutes = (abs(total_seconds) % 3600) // 60
+    sign = "+" if total_seconds >= 0 else "-"
+
+    return f"{sign}{hours:02}:{minutes:02}"

cmdbox/app/commons/convert.py

@@ -227,6 +227,7 @@ def img2byte(image:Image.Image, format:str='jpeg') -> bytes:
 def str2b64str(s:str) -> str:
     """
     文字列をBase64エンコードします。
+    sにNoneを指定した場合はNoneを返します。
 
     Args:
         s (str): 文字列
@@ -234,11 +235,15 @@ def str2b64str(s:str) -> str:
     Returns:
         str: Base64エンコードされた文字列
     """
+    if s is None:
+        return None
     return base64.b64encode(s.encode()).decode('utf-8')
 
 def b64str2str(b64str:str) -> str:
     """
     Base64エンコードされた文字列をデコードします。
+    b64strにNoneを指定した場合はNoneを返します。
+    b64strに'None'を指定した場合はNoneを返します。
 
     Args:
         b64str (str): Base64エンコードされた文字列
@@ -246,4 +251,8 @@ def b64str2str(b64str:str) -> str:
     Returns:
         str: デコードされた文字列
     """
+    if b64str is None:
+        return None
+    if b64str == 'None':
+        return None
     return base64.b64decode(b64str).decode('utf-8')

cmdbox/app/commons/module.py

@@ -1,114 +1,114 @@
-from cmdbox.app import feature
-from typing import List, Dict, Any
-import importlib.util
-import inspect
-import logging
-import pkgutil
-
-
-def get_module_list(package_name) -> List[str]:
-    """
-    パッケージ内のモジュール名のリストを取得します。
-
-    Args:
-        package_name (str): パッケージ名
-
-    Returns:
-        List[str]: モジュール名のリスト
-    """
-    package = __import__(package_name, fromlist=[''])
-    return [name for _, name, _ in pkgutil.iter_modules(package.__path__)]
-
-def load_features(package_name:str, prefix:str="cmdbox_", excludes:list=[], appcls=None, ver=None) -> Dict[str, Any]:
-    """
-    フィーチャーを読み込みます。
-
-    Args:
-        package_name (str): パッケージ名
-        prefix (str, optional): プレフィックス. Defaults to "cmdbox_".
-        excludes (list, optional): 除外するモジュール名のリスト. Defaults to [].
-        appcls ([type], optional): アプリケーションクラス. Defaults to None.
-        ver ([type], optional): バージョンモジュール. Defaults to None.
-    Returns:
-        Dict[str, Any]: フィーチャーのリスト
-    """
-    features = dict()
-    package = __import__(package_name, fromlist=[''])
-    for finder, name, ispkg in pkgutil.iter_modules(package.__path__):
-        if name.startswith(prefix):
-            if name in excludes:
-                continue
-            mod = importlib.import_module(f"{package_name}.{name}")
-            members = inspect.getmembers(mod, inspect.isclass)
-            for name, cls in members:
-                if cls is feature.Feature or not issubclass(cls, feature.Feature):
-                    continue
-                fobj = cls(appcls, ver)
-                mode = fobj.get_mode()
-                if type(mode) is str:
-                    cmd = fobj.get_cmd()
-                    if mode not in features:
-                        features[mode] = dict()
-                    features[mode][cmd] = fobj.get_option()
-                    if features[mode][cmd] is None:
-                        raise ValueError(f'load_features: Cannot get options from {fobj}. The get_option() method returns None.')
-                    features[mode][cmd]['feature'] = fobj
-                elif type(mode) is list:
-                    for m in mode:
-                        cmd = fobj.get_cmd()
-                        if m not in features:
-                            features[m] = dict()
-                        features[m][cmd] = fobj.get_option()
-                        if features[m][cmd] is None:
-                            raise ValueError(f'load_features: Cannot get options from {fobj}. The get_option() method returns None.')
-                        features[m][cmd]['feature'] = fobj
-    return features
-
-def load_webfeatures(package_name:str, prefix:str="cmdbox_web_", excludes:list=[], appcls=None, ver=None, logger:logging.Logger=None) -> List[Any]:
-    """
-    Webフィーチャーを読み込みます。
-
-    Args:
-        package_name (str): パッケージ名
-        prefix (str, optional): プレフィックス. Defaults to "cmdbox_web_".
-        excludes (list, optional): 除外するモジュール名のリスト. Defaults to [].
-        appcls ([type], optional): アプリケーションクラス. Defaults to None.
-        ver ([type], optional): バージョンモジュール. Defaults to None.
-        logger ([type], optional): ロガー. Defaults to None.
-    Returns:
-        Dict[feature.WebFeature]: Webフィーチャーのリスト
-    """
-    webfeatures = list()
-    package = __import__(package_name, fromlist=[''])
-    for finder, name, ispkg in pkgutil.iter_modules(package.__path__):
-        if name.startswith(prefix):
-            if name in excludes:
-                if logger.level == logging.DEBUG:
-                    logger.warning(f'load_webfeatures: {name} is excludes feature.')
-                continue
-            mod = importlib.import_module(f"{package_name}.{name}")
-            members = inspect.getmembers(mod, inspect.isclass)
-            for name, cls in members:
-                if cls is feature.WebFeature or not issubclass(cls, feature.WebFeature):
-                    continue
-                fobj = cls(appcls, ver)
-                if logger is not None and logger.level == logging.DEBUG:
-                    logger.debug(f'load_webfeatures: {fobj}')
-                webfeatures.append(fobj)
-    return webfeatures
-
-def class_for_name(class_full_name:str):
-    """
-    クラス名からクラスを取得します。
-
-    Args:
-        class_full_name (str): クラスフルパス名
-
-    Returns:
-        [type]: クラス
-    """
-    package_name = '.'.join(class_full_name.split('.')[:-1])
-    class_name = class_full_name.split('.')[-1]
-    m = importlib.import_module(package_name)
-    c = getattr(m, class_name)
+from cmdbox.app import feature
+from typing import List, Dict, Any
+import importlib.util
+import inspect
+import logging
+import pkgutil
+
+
+def get_module_list(package_name) -> List[str]:
+    """
+    パッケージ内のモジュール名のリストを取得します。
+
+    Args:
+        package_name (str): パッケージ名
+
+    Returns:
+        List[str]: モジュール名のリスト
+    """
+    package = __import__(package_name, fromlist=[''])
+    return [name for _, name, _ in pkgutil.iter_modules(package.__path__)]
+
+def load_features(package_name:str, prefix:str="cmdbox_", excludes:list=[], appcls=None, ver=None) -> Dict[str, Any]:
+    """
+    フィーチャーを読み込みます。
+
+    Args:
+        package_name (str): パッケージ名
+        prefix (str, optional): プレフィックス. Defaults to "cmdbox_".
+        excludes (list, optional): 除外するモジュール名のリスト. Defaults to [].
+        appcls ([type], optional): アプリケーションクラス. Defaults to None.
+        ver ([type], optional): バージョンモジュール. Defaults to None.
+    Returns:
+        Dict[str, Any]: フィーチャーのリスト
+    """
+    features = dict()
+    package = __import__(package_name, fromlist=[''])
+    for finder, name, ispkg in pkgutil.iter_modules(package.__path__):
+        if name.startswith(prefix):
+            if name in excludes:
+                continue
+            mod = importlib.import_module(f"{package_name}.{name}")
+            members = inspect.getmembers(mod, inspect.isclass)
+            for name, cls in members:
+                if cls is feature.Feature or not issubclass(cls, feature.Feature):
+                    continue
+                fobj = cls(appcls, ver)
+                mode = fobj.get_mode()
+                if type(mode) is str:
+                    cmd = fobj.get_cmd()
+                    if mode not in features:
+                        features[mode] = dict()
+                    features[mode][cmd] = fobj.get_option()
+                    if features[mode][cmd] is None:
+                        raise ValueError(f'load_features: Cannot get options from {fobj}. The get_option() method returns None.')
+                    features[mode][cmd]['feature'] = fobj
+                elif type(mode) is list:
+                    for m in mode:
+                        cmd = fobj.get_cmd()
+                        if m not in features:
+                            features[m] = dict()
+                        features[m][cmd] = fobj.get_option()
+                        if features[m][cmd] is None:
+                            raise ValueError(f'load_features: Cannot get options from {fobj}. The get_option() method returns None.')
+                        features[m][cmd]['feature'] = fobj
+    return features
+
+def load_webfeatures(package_name:str, prefix:str="cmdbox_web_", excludes:list=[], appcls=None, ver=None, logger:logging.Logger=None) -> List[Any]:
+    """
+    Webフィーチャーを読み込みます。
+
+    Args:
+        package_name (str): パッケージ名
+        prefix (str, optional): プレフィックス. Defaults to "cmdbox_web_".
+        excludes (list, optional): 除外するモジュール名のリスト. Defaults to [].
+        appcls ([type], optional): アプリケーションクラス. Defaults to None.
+        ver ([type], optional): バージョンモジュール. Defaults to None.
+        logger ([type], optional): ロガー. Defaults to None.
+    Returns:
+        Dict[feature.WebFeature]: Webフィーチャーのリスト
+    """
+    webfeatures = list()
+    package = __import__(package_name, fromlist=[''])
+    for finder, name, ispkg in pkgutil.iter_modules(package.__path__):
+        if name.startswith(prefix):
+            if name in excludes:
+                if logger.level == logging.DEBUG:
+                    logger.warning(f'load_webfeatures: {name} is excludes feature.')
+                continue
+            mod = importlib.import_module(f"{package_name}.{name}")
+            members = inspect.getmembers(mod, inspect.isclass)
+            for name, cls in members:
+                if cls is feature.WebFeature or not issubclass(cls, feature.WebFeature):
+                    continue
+                fobj = cls(appcls, ver)
+                if logger is not None and logger.level == logging.DEBUG:
+                    logger.debug(f'load_webfeatures: {fobj}')
+                webfeatures.append(fobj)
+    return webfeatures
+
+def class_for_name(class_full_name:str):
+    """
+    クラス名からクラスを取得します。
+
+    Args:
+        class_full_name (str): クラスフルパス名
+
+    Returns:
+        [type]: クラス
+    """
+    package_name = '.'.join(class_full_name.split('.')[:-1])
+    class_name = class_full_name.split('.')[-1]
+    m = importlib.import_module(package_name)
+    c = getattr(m, class_name)
     return c

cmdbox/app/commons/redis_client.py

@@ -7,6 +7,7 @@ import logging
 import json
 import redis
 import time
+import threading
 
 
 class RedisClient(object):
@@ -111,9 +112,11 @@ class RedisClient(object):
             except KeyboardInterrupt as e:
                 return False
 
-    def send_cmd(self, cmd:str, params:List[str], retry_count:int=20, retry_interval:int=5, outstatus:bool=False, timeout:int = 60):
+    def send_cmd(self, cmd:str, params:List[str], retry_count:int=20, retry_interval:int=5, outstatus:bool=False, timeout:int=60, nowait:bool=False):
         """
-        コマンドをRedisサーバーに送信し、応答を取得する
+        コマンドをRedisサーバーに送信し、応答を取得します。
+        nowait=Trueの場合は、応答を待たずにスレッドで実行します。
+        その場合、応答は受信できません。
 
         Args:
             cmd (str): コマンド
@@ -122,37 +125,45 @@ class RedisClient(object):
             retry_interval (int, optional): リトライ間隔. Defaults to 5.
             outstatus (bool, optional): ステータスを出力する. Defaults to False.
             timeout (int, optional): タイムアウト時間. Defaults to 60.
+            nowait (bool, optional): 応答を待たない. Defaults to False.
 
         Returns:
             dict: Redisサーバーからの応答
         """
-        try:
-            if timeout <= 0:
-                raise ValueError(f"timeout must be greater than 0. timeout={timeout}")
-            sreqtime = time.perf_counter()
-            if not self.check_server(find_svname=True, retry_count=retry_count, retry_interval=retry_interval, outstatus=outstatus):
-                return dict(error=f"Connected server failed or server not found. svname={self.svname.split('-')[1]}")
-            reskey = common.random_string()
-            reskey = f"cl-{reskey}-{int(time.time())}"
-            self.redis_cli.rpush(self.svname, f"{cmd} {reskey} {' '.join([str(p) for p in params])}")
-            self.is_running = True
-            stime = time.time()
-            while self.is_running:
-                ctime = time.time()
-                if ctime - stime > timeout:
-                    raise Exception(f"Response timed out.")
-                res = self.redis_cli.lpop(reskey)
-                if res is None or len(res) <= 0:
-                    time.sleep(0.001)
-                    continue
-                return self._res_cmd(reskey, res, sreqtime)
-            raise KeyboardInterrupt(f"Stop command.")
-        except KeyboardInterrupt as e:
-            self.logger.warning(f"Stop command. cmd={cmd}", exc_info=True)
-            return dict(error=f"Stop command. cmd={cmd}")
-        except Exception as e:
-            self.logger.warning(f"fail to execute command. cmd={cmd}, msg={e}", exc_info=True)
-            return dict(error=f"fail to execute command. cmd={cmd}, msg={e}")
+        def send(nowait:bool=False):
+            try:
+                if timeout <= 0:
+                    raise ValueError(f"timeout must be greater than 0. timeout={timeout}")
+                sreqtime = time.perf_counter()
+                if not self.check_server(find_svname=True, retry_count=retry_count, retry_interval=retry_interval, outstatus=outstatus):
+                    return dict(error=f"Connected server failed or server not found. svname={self.svname.split('-')[1]}")
+                reskey = common.random_string()
+                reskey = f"cl-{reskey}-{int(time.time())}"
+                self.redis_cli.rpush(self.svname, f"{cmd} {reskey} {' '.join([str(p) for p in params])}")
+                if nowait: return
+                self.is_running = True
+                stime = time.time()
+                while self.is_running:
+                    ctime = time.time()
+                    if ctime - stime > timeout:
+                        raise Exception(f"Response timed out.")
+                    res = self.redis_cli.lpop(reskey)
+                    if res is None or len(res) <= 0:
+                        time.sleep(0.001)
+                        continue
+                    return self._res_cmd(reskey, res, sreqtime)
+                raise KeyboardInterrupt(f"Stop command.")
+            except KeyboardInterrupt as e:
+                self.logger.warning(f"Stop command. cmd={cmd}", exc_info=True)
+                return dict(error=f"Stop command. cmd={cmd}")
+            except Exception as e:
+                self.logger.warning(f"fail to execute command. cmd={cmd}, msg={e}", exc_info=True)
+                return dict(error=f"fail to execute command. cmd={cmd}, msg={e}")
+        if not nowait:
+            return send(nowait)
+        else:
+            thread = threading.Thread(target=send, args=(nowait,))
+            thread.start()
 
     def _res_cmd(self, reskey:str, res_msg:bytes, sreqtime:float):
         """

cmdbox/app/edge.py

@@ -183,10 +183,10 @@ class Edge(object):
             self.svcert_no_verify = opt['svcert_no_verify']
             if self.svcert_no_verify:
                 urllib3.disable_warnings(urllib3.exceptions.InsecureRequestWarning)
-            status, msg = self.signin(opt['auth_type'], opt['user'], opt['password'], opt['apikey'],
-                                      opt['oauth2'], int(opt['oauth2_port']),
-                                      opt['oauth2_tenant_id'], opt['oauth2_client_id'], opt['oauth2_client_secret'],
-                                      int(opt['oauth2_timeout']))
+            status, msg = self.signin(opt.get('auth_type'), opt.get('user'), opt.get('password'), opt.get('apikey'),
+                                      opt.get('oauth2'), int(opt.get('oauth2_port')),
+                                      opt.get('oauth2_tenant_id'), opt.get('oauth2_client_id'), opt.get('oauth2_client_secret'),
+                                      int(opt.get('oauth2_timeout')))
             if status != 0:
                 return msg