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

cmdbox/extensions/features.yml

@@ -37,3 +37,23 @@ aliases:                                # Specify the alias for the specified co
                                         #   e.g. /{1}_exec
         move:                           # Specify whether to move the regular expression group of the source to the target.
                                         #   e.g. true
+audit:
+  enabled: true                         # Specify whether to enable the audit function.
+  feature:
+    mode: audit                         # Specify the mode of the feature to be audited.
+    cmd: write                          # Specify the command to be audited.
+  options:                              # Specify the options for the audit function.
+    host: localhost                     # Specify the service host of the audit Redis server.
+    port: 6379                          # Specify the service port of the audit Redis server.
+    password: password                  # Specify the access password of the audit Redis server.
+    svname: server                      # Specify the audit service name of the inference server.
+    retry_count: 3                      # Specifies the number of reconnections to the audit Redis server.If less than 0 is specified, reconnection is forever.
+    retry_interval: 1                   # Specifies the number of seconds before reconnecting to the audit Redis server.
+    timeout: 1                          # Specify the maximum waiting time until the server responds.
+    pg_enabled: False                   # Specify True if using the postgresql database server.
+    pg_host: localhost                  # Specify the postgresql host.
+    pg_port: 5432                       # Specify the postgresql port.
+    pg_user: postgres                   # Specify the postgresql user name.
+    pg_password: password               # Specify the postgresql password.
+    pg_dbname: audit                    # Specify the postgresql database name.
+    retention_period_days: 365          # Specify the number of days to retain audit logs.

cmdbox/extensions/sample_project/sample/app/features/cli/sample_client_time.py

@@ -1,82 +1,82 @@
-from cmdbox.app import common, feature
-from cmdbox.app.options import Options
-from typing import Dict, Any, Tuple, Union, List
-import argparse
-import datetime
-import logging
-
-
-class ClientTime(feature.Feature):
-    def get_mode(self) -> Union[str, List[str]]:
-        """
-        この機能のモードを返します
-
-        Returns:
-            Union[str, List[str]]: モード
-        """
-        return "client"
-
-    def get_cmd(self):
-        """
-        この機能のコマンドを返します
-
-        Returns:
-            str: コマンド
-        """
-        return 'time'
-
-    def get_option(self):
-        """
-        この機能のオプションを返します
-
-        Returns:
-            Dict[str, Any]: オプション
-        """
-        return dict(
-            type=Options.T_STR, default=None, required=False, multi=False, hide=False, use_redis=self.USE_REDIS_FALSE,
-            discription_ja="クライアント側の現在時刻を表示します。",
-            discription_en="Displays the current time at the client side.",
-            choice=[
-                dict(opt="timedelta", type=Options.T_INT, default=9, required=False, multi=False, hide=False, choice=None,
-                        discription_ja="時差の時間数を指定します。",
-                        discription_en="Specify the number of hours of time difference."),
-            ])
-
-    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]: 終了コード, 結果, オブジェクト
-        """
-        tz = datetime.timezone(datetime.timedelta(hours=args.timedelta))
-        dt = datetime.datetime.now(tz)
-        ret = dict(success=dict(data=dt.strftime('%Y-%m-%d %H:%M:%S')))
-        common.print_format(ret, args.format, tm, args.output_json, args.output_json_append, pf=pf)
-        if 'success' not in ret:
-            return 1, ret, None
-        return 0, ret, None
-
-    def edgerun(self, opt, tool, logger, timeout, prevres = None):
-        """
-        この機能のエッジ側の実行を行います
-
-        Args:
-            opt (Dict[str, Any]): オプション
-            tool (edge.Tool): 通知関数などedge側のUI操作を行うためのクラス
-            logger (logging.Logger): ロガー
-            timeout (int): タイムアウト時間
-            prevres (Any): 前コマンドの結果。pipeline実行の実行結果を参照する時に使用します。
-
-        Yields:
-            Tuple[int, Dict[str, Any]]: 終了コード, 結果
-        """
-        status, res = tool.exec_cmd(opt, logger, timeout, prevres)
-        tool.notify(res)
-        yield 1, res
+from cmdbox.app import common, feature
+from cmdbox.app.options import Options
+from typing import Dict, Any, Tuple, Union, List
+import argparse
+import datetime
+import logging
+
+
+class ClientTime(feature.Feature):
+    def get_mode(self) -> Union[str, List[str]]:
+        """
+        この機能のモードを返します
+
+        Returns:
+            Union[str, List[str]]: モード
+        """
+        return "client"
+
+    def get_cmd(self):
+        """
+        この機能のコマンドを返します
+
+        Returns:
+            str: コマンド
+        """
+        return 'time'
+
+    def get_option(self):
+        """
+        この機能のオプションを返します
+
+        Returns:
+            Dict[str, Any]: オプション
+        """
+        return dict(
+            type=Options.T_STR, default=None, required=False, multi=False, hide=False, use_redis=self.USE_REDIS_FALSE,
+            discription_ja="クライアント側の現在時刻を表示します。",
+            discription_en="Displays the current time at the client side.",
+            choice=[
+                dict(opt="timedelta", type=Options.T_INT, default=9, required=False, multi=False, hide=False, choice=None,
+                        discription_ja="時差の時間数を指定します。",
+                        discription_en="Specify the number of hours of time difference."),
+            ])
+
+    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]: 終了コード, 結果, オブジェクト
+        """
+        tz = datetime.timezone(datetime.timedelta(hours=args.timedelta))
+        dt = datetime.datetime.now(tz)
+        ret = dict(success=dict(data=dt.strftime('%Y-%m-%d %H:%M:%S')))
+        common.print_format(ret, args.format, tm, args.output_json, args.output_json_append, pf=pf)
+        if 'success' not in ret:
+            return 1, ret, None
+        return 0, ret, None
+
+    def edgerun(self, opt, tool, logger, timeout, prevres = None):
+        """
+        この機能のエッジ側の実行を行います
+
+        Args:
+            opt (Dict[str, Any]): オプション
+            tool (edge.Tool): 通知関数などedge側のUI操作を行うためのクラス
+            logger (logging.Logger): ロガー
+            timeout (int): タイムアウト時間
+            prevres (Any): 前コマンドの結果。pipeline実行の実行結果を参照する時に使用します。
+
+        Yields:
+            Tuple[int, Dict[str, Any]]: 終了コード, 結果
+        """
+        status, res = tool.exec_cmd(opt, logger, timeout, prevres)
+        tool.notify(res)
+        yield 1, res

cmdbox/extensions/sample_project/sample/app/features/cli/sample_server_time.py

@@ -1,145 +1,145 @@
-from cmdbox.app import common, client, feature
-from cmdbox.app.commons import redis_client
-from cmdbox.app.options import Options
-from pathlib import Path
-from typing import Dict, Any, Tuple, Union, List
-import argparse
-import datetime
-import logging
-
-
-class ServerTime(feature.Feature):
-    def get_mode(self) -> Union[str, List[str]]:
-        """
-        この機能のモードを返します
-
-        Returns:
-            Union[str, List[str]]: モード
-        """
-        return "server"
-
-    def get_cmd(self):
-        """
-        この機能のコマンドを返します
-
-        Returns:
-            str: コマンド
-        """
-        return 'time'
-
-    def get_option(self):
-        """
-        この機能のオプションを返します
-
-        Returns:
-            Dict[str, Any]: オプション
-        """
-        return dict(
-            type=Options.T_STR, default=None, required=False, multi=False, hide=False, use_redis=self.USE_REDIS_FALSE,
-            discription_ja="サーバー側の現在時刻を表示します。",
-            discription_en="Displays the current time at the server side.",
-            choice=[
-                dict(opt="host", type=Options.T_STR, default=self.default_host, required=True, multi=False, hide=True, choice=None,
-                        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,
-                        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,
-                        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,
-                        discription_ja="サーバーのサービス名を指定します。省略時は `server` を使用します。",
-                        discription_en="Specify the service name of the inference server. If omitted, `server` is used."),
-                dict(opt="timedelta", type=Options.T_INT, default=9, required=False, multi=False, hide=False, choice=None,
-                        discription_ja="時差の時間数を指定します。",
-                        discription_en="Specify the number of hours of time difference."),
-                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."),
-            ])
-
-    def get_svcmd(self):
-        """
-        この機能のサーバー側のコマンドを返します
-
-        Returns:
-            str: サーバー側のコマンド
-        """
-        return 'server_time'
-
-    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]: 終了コード, 結果, オブジェクト
-        """
-        cl = client.Client(logger, redis_host=args.host, redis_port=args.port, redis_password=args.password, svname=args.svname)
-        ret = cl.redis_cli.send_cmd(self.get_svcmd(), [str(args.timedelta)],
-                                    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, None
-        return 0, ret, None
-
-    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: 終了コード
-        """
-        td = 9 if msg[2] == None else int(msg[2])
-        tz = datetime.timezone(datetime.timedelta(hours=td))
-        dt = datetime.datetime.now(tz)
-        ret = dict(success=dict(data=dt.strftime('%Y-%m-%d %H:%M:%S')))
-        redis_cli.rpush(msg[1], ret)
-        return self.RESP_SCCESS
-
-    def edgerun(self, opt, tool, logger, timeout, prevres = None):
-        """
-        この機能のエッジ側の実行を行います
-
-        Args:
-            opt (Dict[str, Any]): オプション
-            tool (edge.Tool): 通知関数などedge側のUI操作を行うためのクラス
-            logger (logging.Logger): ロガー
-            timeout (int): タイムアウト時間
-            prevres (Any): 前コマンドの結果。pipeline実行の実行結果を参照する時に使用します。
-
-        Yields:
-            Tuple[int, Dict[str, Any]]: 終了コード, 結果
-        """
-        status, res = tool.exec_cmd(opt, logger, timeout, prevres)
-        tool.notify(res)
-        yield 1, res
+from cmdbox.app import common, client, feature
+from cmdbox.app.commons import redis_client
+from cmdbox.app.options import Options
+from pathlib import Path
+from typing import Dict, Any, Tuple, Union, List
+import argparse
+import datetime
+import logging
+
+
+class ServerTime(feature.Feature):
+    def get_mode(self) -> Union[str, List[str]]:
+        """
+        この機能のモードを返します
+
+        Returns:
+            Union[str, List[str]]: モード
+        """
+        return "server"
+
+    def get_cmd(self):
+        """
+        この機能のコマンドを返します
+
+        Returns:
+            str: コマンド
+        """
+        return 'time'
+
+    def get_option(self):
+        """
+        この機能のオプションを返します
+
+        Returns:
+            Dict[str, Any]: オプション
+        """
+        return dict(
+            type=Options.T_STR, default=None, required=False, multi=False, hide=False, use_redis=self.USE_REDIS_FALSE,
+            discription_ja="サーバー側の現在時刻を表示します。",
+            discription_en="Displays the current time at the server side.",
+            choice=[
+                dict(opt="host", type=Options.T_STR, default=self.default_host, required=True, multi=False, hide=True, choice=None,
+                        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,
+                        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,
+                        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,
+                        discription_ja="サーバーのサービス名を指定します。省略時は `server` を使用します。",
+                        discription_en="Specify the service name of the inference server. If omitted, `server` is used."),
+                dict(opt="timedelta", type=Options.T_INT, default=9, required=False, multi=False, hide=False, choice=None,
+                        discription_ja="時差の時間数を指定します。",
+                        discription_en="Specify the number of hours of time difference."),
+                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."),
+            ])
+
+    def get_svcmd(self):
+        """
+        この機能のサーバー側のコマンドを返します
+
+        Returns:
+            str: サーバー側のコマンド
+        """
+        return 'server_time'
+
+    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]: 終了コード, 結果, オブジェクト
+        """
+        cl = client.Client(logger, redis_host=args.host, redis_port=args.port, redis_password=args.password, svname=args.svname)
+        ret = cl.redis_cli.send_cmd(self.get_svcmd(), [str(args.timedelta)],
+                                    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, None
+        return 0, ret, None
+
+    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: 終了コード
+        """
+        td = 9 if msg[2] == None else int(msg[2])
+        tz = datetime.timezone(datetime.timedelta(hours=td))
+        dt = datetime.datetime.now(tz)
+        ret = dict(success=dict(data=dt.strftime('%Y-%m-%d %H:%M:%S')))
+        redis_cli.rpush(msg[1], ret)
+        return self.RESP_SCCESS
+
+    def edgerun(self, opt, tool, logger, timeout, prevres = None):
+        """
+        この機能のエッジ側の実行を行います
+
+        Args:
+            opt (Dict[str, Any]): オプション
+            tool (edge.Tool): 通知関数などedge側のUI操作を行うためのクラス
+            logger (logging.Logger): ロガー
+            timeout (int): タイムアウト時間
+            prevres (Any): 前コマンドの結果。pipeline実行の実行結果を参照する時に使用します。
+
+        Yields:
+            Tuple[int, Dict[str, Any]]: 終了コード, 結果
+        """
+        status, res = tool.exec_cmd(opt, logger, timeout, prevres)
+        tool.notify(res)
+        yield 1, res

cmdbox/licenses/{LICENSE.Sphinx.8.1.3(BSD License).txt → LICENSE.Sphinx.8.2.3(UNKNOWN).txt}

@@ -4,7 +4,7 @@ License for Sphinx
 Unless otherwise indicated, all code in the Sphinx project is licenced under the
 two clause BSD licence below.
 
-Copyright (c) 2007-2024 by the Sphinx team (see AUTHORS file).
+Copyright (c) 2007-2025 by the Sphinx team (see AUTHORS file).
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

cmdbox/licenses/{LICENSE.babel.2.16.0(BSD License).txt → LICENSE.babel.2.17.0(BSD License).txt }

@@ -1,4 +1,4 @@
-Copyright (c) 2013-2024 by the Babel Team, see AUTHORS for more information.
+Copyright (c) 2013-2025 by the Babel Team, see AUTHORS for more information.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions

cmdbox/licenses/{LICENSE.pkginfo.1.10.0(MIT License).txt → LICENSE.charset-normalizer.3.4.1(MIT License).txt }

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2009 Agendaless Consulting, Inc.
+Copyright (c) 2025 TAHRI Ahmed R.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

cmdbox/licenses/LICENSE.gunicorn.23.0.0(MIT License).txt

@@ -0,0 +1,23 @@
+2009-2024 (c) Benoît Chesneau <benoitc@gunicorn.org>
+2009-2015 (c) Paul J. Davis <paul.joseph.davis@gmail.com>
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.