tketool.core 1.3.4__tar.gz

tketool_core-1.3.4/PKG-INFO

@@ -0,0 +1,62 @@
+Metadata-Version: 2.4
+Name: tketool.core
+Version: 1.3.4
+Summary: Core configuration, file, buffer, and utility APIs for tketool
+Author-email: Ke <jiangke1207@icloud.com>
+License-Expression: MIT
+Project-URL: Homepage, https://pypi.org/project/tketool.core/
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: paramiko<6,>=4
+Provides-Extra: storage
+Requires-Dist: minio<8,>=7.2.20; extra == "storage"
+Requires-Dist: redis<9,>=6; extra == "storage"
+Provides-Extra: documents
+Requires-Dist: pandas<4,>=2.2; extra == "documents"
+Requires-Dist: openpyxl<4,>=3.1.5; extra == "documents"
+Requires-Dist: python-docx<2,>=1.2; extra == "documents"
+Provides-Extra: console
+Requires-Dist: blessed<2,>=1.20; extra == "console"
+Requires-Dist: prettytable<4,>=3.12; extra == "console"
+Requires-Dist: wcwidth<1,>=0.2.13; extra == "console"
+Provides-Extra: docker
+Requires-Dist: docker<8,>=7; extra == "docker"
+Provides-Extra: test
+Requires-Dist: pytest<9,>=8; extra == "test"
+Provides-Extra: all
+Requires-Dist: minio<8,>=7.2.20; extra == "all"
+Requires-Dist: redis<9,>=6; extra == "all"
+Requires-Dist: pandas<4,>=2.2; extra == "all"
+Requires-Dist: openpyxl<4,>=3.1.5; extra == "all"
+Requires-Dist: python-docx<2,>=1.2; extra == "all"
+Requires-Dist: blessed<2,>=1.20; extra == "all"
+Requires-Dist: prettytable<4,>=3.12; extra == "all"
+Requires-Dist: wcwidth<1,>=0.2.13; extra == "all"
+Requires-Dist: docker<8,>=7; extra == "all"
+
+# tketool.core
+
+`tketool.core` contains the shared configuration, file, buffer, command, and
+utility APIs used by the other tketool distributions.
+
+```bash
+pip install tketool.core
+```
+
+```python
+from tketool import ConfigManager, read_file, write_file
+from tketool.buffer.local_onesqlite import init_db
+```
+
+Optional dependencies are grouped by feature:
+
+```bash
+pip install "tketool.core[storage]"
+pip install "tketool.core[documents]"
+pip install "tketool.core[console]"
+```

tketool_core-1.3.4/README.md

@@ -0,0 +1,21 @@
+# tketool.core
+
+`tketool.core` contains the shared configuration, file, buffer, command, and
+utility APIs used by the other tketool distributions.
+
+```bash
+pip install tketool.core
+```
+
+```python
+from tketool import ConfigManager, read_file, write_file
+from tketool.buffer.local_onesqlite import init_db
+```
+
+Optional dependencies are grouped by feature:
+
+```bash
+pip install "tketool.core[storage]"
+pip install "tketool.core[documents]"
+pip install "tketool.core[console]"
+```

tketool_core-1.3.4/pyproject.toml

@@ -0,0 +1,46 @@
+[build-system]
+requires = ["setuptools>=77", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "tketool.core"
+version = "1.3.4"
+description = "Core configuration, file, buffer, and utility APIs for tketool"
+readme = "README.md"
+requires-python = ">=3.10"
+license = "MIT"
+authors = [{ name = "Ke", email = "jiangke1207@icloud.com" }]
+dependencies = ["paramiko>=4,<6"]
+classifiers = [
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Operating System :: OS Independent",
+]
+
+[project.optional-dependencies]
+storage = ["minio>=7.2.20,<8", "redis>=6,<9"]
+documents = ["pandas>=2.2,<4", "openpyxl>=3.1.5,<4", "python-docx>=1.2,<2"]
+console = ["blessed>=1.20,<2", "prettytable>=3.12,<4", "wcwidth>=0.2.13,<1"]
+docker = ["docker>=7,<8"]
+test = ["pytest>=8,<9"]
+all = [
+  "minio>=7.2.20,<8",
+  "redis>=6,<9",
+  "pandas>=2.2,<4",
+  "openpyxl>=3.1.5,<4",
+  "python-docx>=1.2,<2",
+  "blessed>=1.20,<2",
+  "prettytable>=3.12,<4",
+  "wcwidth>=0.2.13,<1",
+  "docker>=7,<8",
+]
+
+[project.urls]
+Homepage = "https://pypi.org/project/tketool.core/"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+include = ["tketool*"]
+namespaces = true

tketool_core-1.3.4/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

tketool_core-1.3.4/src/tketool/JConfig.py

@@ -0,0 +1,498 @@
+# pass_generate
+import os
+from typing import Optional, Dict, Any, Union
+
+
+
+class ConfigManager:
+    """
+    配置管理器类（单例模式），用于处理配置文件的读取、写入和管理。
+
+    支持以下特性：
+    - 单例模式，确保全局只有一个配置管理器实例
+    - 从配置文件读取键值对配置
+    - 环境变量优先级支持（文件 -> 环境变量 -> 默认值）
+    - 自动创建不存在的配置文件
+    - 动态添加配置项
+    - 配置项的保存、删除和重载
+    - 动态切换配置文件路径
+
+    配置文件格式：
+    ```
+    # 这是注释
+    database_host=localhost
+    database_port=5432
+    api_key="your_api_key_here"
+    ```
+
+    使用示例：
+    ```python
+    # 获取单例配置管理器
+    config = ConfigManager()
+    # 或者
+    config = get_config_instance()
+
+    # 切换配置文件
+    config.set_config_filepath("/path/to/new/config.jconfig")
+
+    # 获取配置，优先级：文件 -> 环境变量 -> 默认值
+    db_host = config.get_config("database_host", "localhost")
+
+    # 检查配置是否存在
+    if config.has_config("api_key"):
+        api_key = config.get_config("api_key")
+
+    # 设置配置
+    config.set_config("new_setting", "value")
+
+    # 删除配置
+    config.delete_config("old_setting")
+
+    # 重新加载配置文件
+    config.reload()
+    ```
+    """
+
+    _instance = None
+    _initialized = False
+
+    def __new__(cls, config_file_path: str = None):
+        """
+        实现单例模式。
+        
+        参数:
+            config_file_path (str, optional): 配置文件路径，仅在首次创建实例时有效
+        
+        返回:
+            ConfigManager: 单例实例
+        """
+        if cls._instance is None:
+            cls._instance = super(ConfigManager, cls).__new__(cls)
+        return cls._instance
+
+    def __init__(self, config_file_path: str = None) -> None:
+        """
+        初始化配置管理器（单例模式）。
+
+        参数:
+            config_file_path (str, optional): 配置文件的路径，可以是相对路径或绝对路径。
+                                             如果为None，使用默认的 config.jconfig
+                                             如果文件不存在，将自动创建一个空的配置文件。
+
+        示例:
+            ```python
+            config = ConfigManager("./config/app.jconfig")
+            config = ConfigManager("/etc/myapp/config.jconfig")
+            # 使用默认配置文件
+            config = ConfigManager()
+            ```
+
+        注意:
+            - 由于是单例模式，config_file_path 参数仅在首次创建实例时有效
+            - 如需切换配置文件，请使用 set_config_filepath() 方法
+            - 配置文件使用UTF-8编码
+            - 支持以#开头的注释行
+            - 键值对格式：key=value
+            - 值可以用双引号或单引号包围
+        """
+        # 避免重复初始化
+        if self._initialized:
+            return
+            
+        self._config_map: Dict[str, str] = {}
+        
+        # 设置默认配置文件路径
+        if config_file_path is None:
+            config_file_path = os.path.join(os.getcwd(), "config.jconfig")
+            
+        self._config_file_path: str = config_file_path
+        self._load_configs()
+        self._initialized = True
+
+    def set_config_filepath(self, config_file_path: str) -> None:
+        """
+        设置新的配置文件路径并重新加载配置。
+        
+        参数:
+            config_file_path (str): 新的配置文件路径
+            
+        示例:
+            ```python
+            config = get_config_instance()
+            config.set_config_filepath("/path/to/new/config.jconfig")
+            ```
+            
+        注意:
+            - 会立即重新加载新的配置文件
+            - 原有的内存配置将被清空
+            - 如果新文件不存在，会自动创建
+        """
+        print(f"切换配置文件路径: {self._config_file_path} -> {config_file_path}")
+        self._config_file_path = config_file_path
+        self._load_configs()
+
+    def _load_configs(self) -> None:
+        """
+        加载配置文件中的配置项。
+
+        如果配置文件存在，读取文件中的每一行，解析键值对并存储到内存字典中。
+        支持注释行（以#开头）和空行的过滤。
+
+        如果配置文件不存在，创建一个新的空配置文件。
+
+        文件格式说明:
+        - 每行一个键值对，格式为：key=value
+        - 支持注释行，以#开头
+        - 键和值的前后空格会被自动去除
+        - 值可以用单引号或双引号包围
+        """
+        self._config_map.clear()
+
+        if os.path.exists(self._config_file_path):
+            try:
+                with open(self._config_file_path, "r", encoding="utf-8") as f:
+                    lines = f.readlines()
+                    for line_num, line in enumerate(lines, 1):
+                        line = line.strip()
+                        # 跳过空行和注释行
+                        if not line or line.startswith("#"):
+                            continue
+
+                        key, sep, value = line.partition("=")
+                        if sep:  # 确保包含等号
+                            key = self._sanitize_string(key.strip())
+                            value = self._sanitize_string(value.strip())
+                            if key:  # 确保键不为空
+                                self._config_map[key] = value
+                        else:
+                            print(f"警告: 配置文件第{line_num}行格式错误: {line}")
+            except Exception as e:
+                print(f"加载配置文件失败: {e}")
+                raise
+        else:
+            # 创建空的配置文件
+            try:
+                os.makedirs(os.path.dirname(self._config_file_path), exist_ok=True)
+                with open(self._config_file_path, "w", encoding="utf-8") as f:
+                    f.write("# 配置文件\n")
+            except Exception as e:
+                print(f"创建配置文件失败: {e}")
+                raise
+
+    @staticmethod
+    def _sanitize_string(s: str) -> str:
+        """
+        清理字符串，去除前后的引号和空格。
+
+        参数:
+            s (str): 待处理的字符串
+
+        返回:
+            str: 处理后的字符串
+
+        示例:
+            ```python
+            result = ConfigManager._sanitize_string(' "hello world" ')
+            # result = "hello world"
+
+            result = ConfigManager._sanitize_string("'test'")
+            # result = "test"
+            ```
+        """
+        if not s:
+            return s
+
+        s = s.strip()
+        # 去除前后的引号
+        if len(s) >= 2:
+            if (s.startswith('"') and s.endswith('"')) or (
+                s.startswith("'") and s.endswith("'")
+            ):
+                s = s[1:-1]
+
+        return s
+
+    def has_config(self, key: str, use_env: bool = True) -> bool:
+        """
+        检查指定的配置键是否存在。
+
+        参数:
+            key (str): 配置键名
+
+        返回:
+            bool: 如果配置键存在返回True，否则返回False
+
+        示例:
+            ```python
+            if config.has_config("database_host"):
+                host = config.get_config("database_host")
+            ```
+        """
+        if use_env:
+            env_value = os.environ.get(key)
+            if env_value is not None:
+                return True
+
+        return key in self._config_map
+
+    def get_config(
+        self,
+        key: str,
+        default_value: str = "",
+        use_env: bool = True,
+        raise_if_missing: bool = False,
+    ) -> str:
+        """
+        获取指定键的配置值，支持多级优先级查找。
+
+        查找优先级：
+        1. 配置文件中的值
+        2. 环境变量中的值（如果use_env为True）
+        3. 默认值
+
+        参数:
+            key (str): 配置键名
+            default_value (str): 默认值，当配置项不存在时使用
+            use_env (bool): 是否检查环境变量，默认为True
+            raise_if_missing (bool): 当配置项不存在且无默认值时是否抛出异常
+
+        返回:
+            str: 配置值
+
+        异常:
+            KeyError: 当raise_if_missing为True且配置项不存在时抛出
+
+        示例:
+            ```python
+            # 基本用法
+            host = config.get_config("database_host", "localhost")
+
+            # 不使用环境变量
+            port = config.get_config("database_port", "5432", use_env=False)
+
+            # 必须存在的配置
+            api_key = config.get_config("api_key", raise_if_missing=True)
+            ```
+        """
+        # 1. 首先检查配置文件
+        if key in self._config_map:
+            return self._config_map[key]
+
+        # 2. 检查环境变量
+        if use_env:
+            env_value = os.environ.get(key)
+            if env_value is not None:
+                print(f"使用环境变量 {key}={env_value}")
+                return env_value
+
+        # 3. 检查是否必须存在
+        if raise_if_missing and not default_value:
+            raise KeyError(f"配置项 '{key}' 不存在且未提供默认值")
+
+        # 4. 使用默认值并添加到配置文件
+        if default_value or not raise_if_missing:
+            print(f"配置项 '{key}' 不存在，使用默认值: {default_value}")
+            self.set_config(key, default_value)
+            return default_value
+
+        return default_value
+
+    def set_config(self, key: str, value: str) -> None:
+        """
+        设置配置项的值，同时更新内存和文件。
+
+        参数:
+            key (str): 配置键名
+            value (str): 配置值
+
+        示例:
+            ```python
+            config.set_config("database_host", "192.168.1.100")
+            config.set_config("debug_mode", "true")
+            ```
+
+        注意:
+            - 会立即写入配置文件
+            - 如果键已存在，会覆盖原有值
+        """
+        # 更新内存中的配置
+        self._config_map[key] = value
+
+        # 保存到文件
+        self._save_to_file()
+
+    def delete_config(self, key: str) -> bool:
+        """
+        删除指定的配置项。
+
+        参数:
+            key (str): 要删除的配置键名
+
+        返回:
+            bool: 如果成功删除返回True，如果键不存在返回False
+
+        示例:
+            ```python
+            if config.delete_config("old_setting"):
+                print("配置项已删除")
+            else:
+                print("配置项不存在")
+            ```
+        """
+        if key in self._config_map:
+            del self._config_map[key]
+            self._save_to_file()
+            print(f"已删除配置项: {key}")
+            return True
+        return False
+
+    def reload(self) -> None:
+        """
+        重新加载配置文件，丢弃内存中的修改。
+
+        示例:
+            ```python
+            # 重新从文件加载配置
+            config.reload()
+            ```
+
+        注意:
+            这会丢弃所有未保存的内存中的配置修改。
+        """
+        print("重新加载配置文件")
+        self._load_configs()
+
+    def get_all_configs(self) -> Dict[str, str]:
+        """
+        获取所有配置项的副本。
+
+        返回:
+            Dict[str, str]: 包含所有配置项的字典
+
+        示例:
+            ```python
+            all_configs = config.get_all_configs()
+            for key, value in all_configs.items():
+                print(f"{key} = {value}")
+            ```
+        """
+        return self._config_map.copy()
+
+    def get_current_filepath(self) -> str:
+        """
+        获取当前使用的配置文件路径。
+        
+        返回:
+            str: 当前配置文件的路径
+            
+        示例:
+            ```python
+            current_path = config.get_current_filepath()
+            print(f"当前配置文件: {current_path}")
+            ```
+        """
+        return self._config_file_path
+
+    def _save_to_file(self) -> None:
+        """
+        将当前内存中的配置保存到文件。
+
+        内部方法，在设置或删除配置时自动调用。
+        """
+        try:
+            with open(self._config_file_path, "w", encoding="utf-8") as f:
+                f.write("# 配置文件\n")
+                f.write("# 格式：key=value\n")
+                f.write("# 支持注释行（以#开头）\n\n")
+
+                for key, value in sorted(self._config_map.items()):
+                    # 如果值包含特殊字符，用引号包围
+                    if " " in value or "=" in value or value.startswith("#"):
+                        f.write(f'{key}="{value}"\n')
+                    else:
+                        f.write(f"{key}={value}\n")
+        except Exception as e:
+            print(f"保存配置文件失败: {e}")
+            raise
+
+
+def get_config_instance() -> ConfigManager:
+    """
+    获取配置管理器的单例实例。
+
+    返回:
+        ConfigManager: 配置管理器单例实例
+
+    示例:
+        ```python
+        # 获取单例配置管理器
+        config = get_config_instance()
+        
+        # 所有调用都返回同一个实例
+        config1 = get_config_instance()
+        config2 = get_config_instance()
+        assert config1 is config2  # True
+        ```
+
+    注意:
+        - 使用单例模式确保全局只有一个配置管理器实例
+        - 首次调用时会使用默认的配置文件路径（当前目录下的 config.jconfig）
+        - 如需使用不同的配置文件，请使用 set_config_filepath() 方法
+    """
+    return ConfigManager()
+
+
+def clear_config_cache() -> None:
+    """
+    清除配置实例缓存，主要用于测试。
+    
+    注意: 由于改为单例模式，此方法会重置单例实例。
+
+    示例:
+        ```python
+        # 重置单例实例，下次获取时会重新创建
+        clear_config_cache()
+        ```
+    """
+    ConfigManager._instance = None
+    ConfigManager._initialized = False
+    print("已重置配置管理器单例实例")
+
+
+# 改进建议和未来功能扩展：
+#
+# 1. 数据类型支持：
+#    - 添加 get_int(), get_float(), get_bool() 等类型转换方法
+#    - 支持列表和字典类型的配置项
+#    - 添加配置项的类型验证
+#
+# 2. 配置文件格式扩展：
+#    - 支持 JSON, YAML, TOML 等格式
+#    - 支持配置分组/节（[section]）
+#    - 支持配置项的继承和覆盖
+#
+# 3. 高级功能：
+#    - 配置文件的版本控制和迁移
+#    - 配置项的加密支持
+#    - 配置变更的监听和回调
+#    - 配置项的验证规则（正则表达式、范围检查等）
+#
+# 4. 性能优化：
+#    - 文件变更监控，自动重载
+#    - 惰性加载大型配置文件
+#    - 配置项的缓存策略
+#
+# 5. 安全性增强：
+#    - 敏感配置项的掩码显示
+#    - 配置文件的权限检查
+#    - 配置项的访问日志
+#
+# 6. 开发工具：
+#    - 配置项的自动补全
+#    - 配置文件的语法检查
+#    - 配置项的使用统计和分析
+#
+# 7. 集成功能：
+#    - 与命令行参数的集成
+#    - 与远程配置中心的集成
+#    - 与容器环境的集成（Docker secrets, Kubernetes ConfigMap）

tketool_core-1.3.4/src/tketool/__init__.py

@@ -0,0 +1,8 @@
+from pkgutil import extend_path
+
+__path__ = extend_path(__path__, __name__)
+__version__ = "1.3.4"
+
+from tketool.JConfig import *
+# from tketool.logs import *  # 移除日志模块依赖
+from tketool.files import *