xenoslib 0.2.0__py3-none-any.whl → 0.3.0__py3-none-any.whl

xenoslib/about.py

@@ -4,4 +4,4 @@ __url__ = "https://github.com/XenosLu/xenoslib.git"
 __author__ = "Xenocider"
 __author_email__ = "xenos.lu@gmail.com"
 __license__ = "MIT License"
-__version__ = "0.2.0"
+__version__ = "0.3.0"

xenoslib/base.py

@@ -4,6 +4,68 @@ import argparse
 import sys
 import time
 import inspect
+import logging
+import os
+
+from logging.handlers import TimedRotatingFileHandler
+
+
+def init_logger(
+    use_file: bool = True,
+    level: int = logging.INFO,
+    backup_count: int = 0,  # New parameter: number of log files to retain (0 means keep all)
+) -> logging.Logger:
+    """
+    Automatically names logger after caller's filename, rotates by time, and retains specified number of log files
+
+    Args:
+        use_file: Whether to enable file logging
+        level: Logging level (DEBUG/INFO/WARN/ERROR)
+        backup_count: Number of historical log files to retain (default 0=keep all)
+    """
+    # 1. Dynamically get caller's filename
+    caller_frame = inspect.stack()[1]
+    caller_path = caller_frame.filename
+    caller_name = os.path.splitext(os.path.basename(caller_path))[0]
+
+    # 2. Configure log directory and filename
+    log_dir = "logs"
+    os.makedirs(log_dir, exist_ok=True)
+    log_filename = f"{caller_name}.log"
+    full_path = os.path.join(log_dir, log_filename)
+
+    # 3. Avoid duplicate initialization
+    logger = logging.getLogger(caller_name)
+    if logger.hasHandlers():
+        return logger
+
+    logger.setLevel(level)
+    formatter = logging.Formatter(
+        "%(asctime)s [%(levelname)s] %(filename)s:%(lineno)d - %(message)s",
+        datefmt="%Y-%m-%d %H:%M:%S",
+    )
+
+    # 4. Console handler (required)
+    console_handler = logging.StreamHandler()
+    console_handler.setFormatter(formatter)
+    handlers = [console_handler]
+
+    # 5. File handler (daily rotation + file retention policy)
+    if use_file:
+        file_handler = TimedRotatingFileHandler(
+            full_path,
+            when="midnight",  # Rotate daily
+            interval=1,
+            backupCount=backup_count,  # Key parameter: controls number of retained files
+            encoding="utf-8",
+        )
+        file_handler.setFormatter(formatter)
+        handlers.append(file_handler)
+
+    for handler in handlers:
+        logger.addHandler(handler)
+
+    return logger
 
 
 def sleep(seconds, mute=False):

xenoslib/tools/config_loader.py

@@ -28,17 +28,17 @@ class ConfigLoader(SingletonWithArgs):
 
         # With Vault (hvac imported on demand)
         >>> config = ConfigLoader("config.yml", vault_secret_id="my-secret-id")
-        
+
         # Write to Vault using attribute style
         >>> config.test_section.test_key = "new_value"
-        
+
         # Write to Vault using dictionary style
         >>> config["test_section"]["test_key"] = "new_value"
     """
 
     VAULT_SUFFIX = "@vault"
     KV_MOUNT_POINT = "kv"
-    
+
     cache = {}
     vault_client = None
 
@@ -47,7 +47,7 @@ class ConfigLoader(SingletonWithArgs):
         with open(config_file_path, "r") as f:
             config_data = yaml.safe_load(f)
             self._raw_config = config_data if isinstance(config_data, dict) else {}
-        
+
         if vault_secret_id is not None:
             self.vault_secret_id = vault_secret_id
             self._check_and_renew_vault_client()
@@ -115,17 +115,15 @@ class ConfigLoader(SingletonWithArgs):
         section_config = self._raw_config.get(section)
         if section_config is None:
             raise KeyError(f"Section '{section}' not found")
-            
+
         if not self._is_vault_reference(section_config, key_name):
             raise KeyError(f"Key '{key_name}' is not a Vault reference in section '{section}'")
-            
+
         if self.vault_client is None:
-            raise Exception(
-                f"Vault access required for {key_name} but Vault is not initialized"
-            )
-            
+            raise Exception(f"Vault access required for {key_name} but Vault is not initialized")
+
         self._set_value_to_vault(section, key_name, value)
-        
+
         cache_key = f"{section}:{key_name}"
         if use_cache:
             self.cache[cache_key] = value
@@ -140,10 +138,10 @@ class ConfigLoader(SingletonWithArgs):
 
             vault_key_ref = f"{key_name}{self.VAULT_SUFFIX}"
             vault_key = section_config[vault_key_ref]
-            
+
             namespace = section_config.get("vault_namespace") or self._raw_config["vault"]["space"]
             self.vault_client.adapter.namespace = namespace
-            
+
             data = self.vault_client.secrets.kv.read_secret_version(
                 path=vault_path, mount_point=self.KV_MOUNT_POINT, raise_on_deleted_version=True
             )
@@ -155,18 +153,18 @@ class ConfigLoader(SingletonWithArgs):
         """Set a secret value to Vault."""
         try:
             self._check_and_renew_vault_client()
-            
+
             section_config = self._raw_config[section]
             vault_path = section_config.get("vault_path")
             if not vault_path:
                 raise KeyError(f"Missing vault_path in section '{section}'")
-                
+
             vault_key_ref = f"{key_name}{self.VAULT_SUFFIX}"
             vault_key = section_config[vault_key_ref]
-            
+
             namespace = section_config.get("vault_namespace") or self._raw_config["vault"]["space"]
             self.vault_client.adapter.namespace = namespace
-            
+
             try:
                 data = self.vault_client.secrets.kv.read_secret_version(
                     path=vault_path, mount_point=self.KV_MOUNT_POINT, raise_on_deleted_version=True
@@ -175,15 +173,13 @@ class ConfigLoader(SingletonWithArgs):
             except Exception:
                 logger.warning(f"Secret not found, creating new secret at {vault_path}")
                 secret_data = {}
-                
+
             secret_data[vault_key] = value
-            
+
             self.vault_client.secrets.kv.create_or_update_secret(
-                path=vault_path,
-                secret=secret_data,
-                mount_point=self.KV_MOUNT_POINT
+                path=vault_path, secret=secret_data, mount_point=self.KV_MOUNT_POINT
             )
-            
+
             logger.info(f"Updated Vault secret: {vault_path}/{vault_key}")
         except Exception as e:
             raise Exception(f"Failed to set {key_name} to Vault: {str(e)}") from e
@@ -216,7 +212,7 @@ class SectionProxy:
     def __getitem__(self, key):
         """Dictionary-style access to configuration values."""
         return self._loader.get(self._section, key)
-        
+
     def __setitem__(self, key, value):
         """Dictionary-style setting of configuration values to Vault."""
         self.set(key, value)
@@ -227,7 +223,7 @@ class SectionProxy:
             return self._loader.get(self._section, key)
         except KeyError:
             return default
-            
+
     def set(self, key, value):
         """Set a configuration value to Vault."""
         self._loader.set(self._section, key, value)
@@ -238,10 +234,10 @@ class SectionProxy:
             return self[key]
         except KeyError as e:
             raise AttributeError(str(e))
-            
+
     def __setattr__(self, name, value):
         """Attribute-style setting of configuration values to Vault."""
-        if name.startswith('_'):
+        if name.startswith("_"):
             super().__setattr__(name, value)
         else:
             self.set(name, value)
@@ -259,13 +255,13 @@ if __name__ == "__main__":
 
     # 属性方式读取
     print("With Vault (attr):", config_with_vault.test.test)
-    
+
     # 字典方式读取
     print("With Vault (dict):", config_with_vault["cis"]["cis_client_id"])
-    
+
     # 测试不存在的值
     print("Try val not exists: ", config_with_vault.test.get("not_exists"))
-    
+
     # 写入示例 - 属性方式
     try:
         print("Current test value (attr read):", config_with_vault.test.test)
@@ -273,18 +269,18 @@ if __name__ == "__main__":
         print("After write (attr read):", config_with_vault.test.test)
     except Exception as e:
         print("Attribute write failed:", str(e))
-    
+
     # 写入示例 - 字典方式
     try:
         print("Current test value (dict read):", config_with_vault["test"]["test"])
         config_with_vault["test"]["test"] = "new_value_456"
         print("After write (dict read):", config_with_vault["test"]["test"])
-        
+
         # 混合方式验证
         print("After write (attr read):", config_with_vault.test.test)
     except Exception as e:
         print("Dictionary write failed:", str(e))
-    
+
     # 写入新键示例
     try:
         print("Setting new key...")

{xenoslib-0.2.0.dist-info → xenoslib-0.3.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: xenoslib
-Version: 0.2.0
+Version: 0.3.0
 Summary: Xenos' common lib
 Home-page: https://github.com/XenosLu/xenoslib.git
 Author: Xenocider

{xenoslib-0.2.0.dist-info → xenoslib-0.3.0.dist-info}/RECORD

@@ -1,7 +1,7 @@
 xenoslib/__init__.py,sha256=vlMWwdD2gTb9ztpm_orYAm_Y0Be0Es64ifvMQwrE1jU,310
 xenoslib/__main__.py,sha256=UpD3pl4l5ZUFxK6FzNMWRb1AZpEnwerulSFoPb_Pdgw,307
-xenoslib/about.py,sha256=uFeXGwBMEZ9Wsa7XjcqkicPpYbNWez7gMZ6AunNMQe4,228
-xenoslib/base.py,sha256=rAXk71AsnWvQ7MaSad5Xxd9Lwucp-cZc15yyqoV5Dk4,12440
+xenoslib/about.py,sha256=JOPWsSbcxv9ls6wxojlF88auWvYf0Ok4vc4yFIolu-Y,228
+xenoslib/base.py,sha256=2qHsptnf_EAaoezr5aQwM6gdPEGnAPn8ommRYtOhD1c,14428
 xenoslib/dev.py,sha256=R6iwKuu-xvaYiBOUyP2gpePyvXss17TOZaCmQEihPCw,1236
 xenoslib/extend.py,sha256=Vl5d8carSGy6ERE2EjTmB9lOo2uIBWs1iz-fKm_TX-M,5947
 xenoslib/linux.py,sha256=EFCQBq_JsmNJc3wGlJlzH9W0tjOA7sSwx0u62R5Ut2k,1318
@@ -11,9 +11,9 @@ xenoslib/onedrive.py,sha256=-bJJ8Cd_RjJSlDynYqKoZlFKE1HHM34l6NXOQrWOwtg,7783
 xenoslib/win_trayicon.py,sha256=7GJwX3c2CS1XWQjsyDK5EfM-MmEHdzPJCTX2sGpWmuU,13115
 xenoslib/windows.py,sha256=lUTD7TowaPqYHgIL6b-GM9PLd-VyJNNGzkzC3K9vOxo,4080
 xenoslib/tools/__init__.py,sha256=D1qP5tD2ZukXHgjKUh0fFl8jUipM3KaPBZBi0vGPypQ,48
-xenoslib/tools/config_loader.py,sha256=Iuw7DiAb4z2mR3hFsZBQw9YGgGHUJvcNeT_Dj53NahM,11257
-xenoslib-0.2.0.dist-info/licenses/LICENSE,sha256=lF6hjufhiR-xAje_Wo7ogxV5phz2d5TgkfL5SGshujg,1066
-xenoslib-0.2.0.dist-info/METADATA,sha256=QtFP5XxADSObEVeou3ket3GfwWj6374GJqqBHJLPiMc,910
-xenoslib-0.2.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-xenoslib-0.2.0.dist-info/top_level.txt,sha256=Rfm4GdW0NyA2AHDNUF2wFQOfAo53mAPibddSHGd3X60,9
-xenoslib-0.2.0.dist-info/RECORD,,
+xenoslib/tools/config_loader.py,sha256=dHGqeRX-RvtBCdERsOYTYRIBD8nfYx04XRpps25ob_c,10947
+xenoslib-0.3.0.dist-info/licenses/LICENSE,sha256=lF6hjufhiR-xAje_Wo7ogxV5phz2d5TgkfL5SGshujg,1066
+xenoslib-0.3.0.dist-info/METADATA,sha256=YjQwsxquDj_F_rfl9-GiRVsWRHxmtDE7yh7Q73dKj6g,910
+xenoslib-0.3.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+xenoslib-0.3.0.dist-info/top_level.txt,sha256=Rfm4GdW0NyA2AHDNUF2wFQOfAo53mAPibddSHGd3X60,9
+xenoslib-0.3.0.dist-info/RECORD,,