xenoslib 0.1.29.15__py3-none-any.whl → 0.1.29.17__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.1.29.15"
+__version__ = "0.1.29.17"

xenoslib/extend.py

@@ -7,6 +7,8 @@ import logging
 import yaml
 import requests
 
+from xenoslib.base import SingletonWithArgs
+
 
 logger = logging.getLogger(__name__)
 
@@ -192,5 +194,177 @@ class DingTalkLogHandler(logging.Handler):
             print(exc)
 
 
+class ConfigLoader(SingletonWithArgs):
+    """Centralized configuration management with optional Vault integration.
+
+    Args:
+        config_file_path (str): Path to the YAML configuration file. Defaults to "config.yml".
+        vault_secret_id (str, optional): Secret ID for Vault authentication.
+            If provided, enables Vault functionality and imports hvac module.
+
+    Attributes:
+        cache (dict): Cache storage for frequently accessed configuration values.
+
+    Example:
+        # Without Vault (hvac not imported)
+        >>> config = ConfigLoader("config.yml")
+
+        # With Vault (hvac imported on demand)
+        >>> config = ConfigLoader("config.yml", vault_secret_id="my-secret-id")
+    """
+
+    def __init__(self, config_file_path="config.yml", vault_secret_id=None):
+        """Initialize the ConfigLoader with a configuration file and optional Vault secret."""
+        with open(config_file_path, "r") as f:
+            self._raw_config = yaml.safe_load(f) or {}
+
+        self.cache = {}
+        self.vault_client = None
+
+        if vault_secret_id is not None:
+            self._init_vault_client(vault_secret_id)
+
+    def _init_vault_client(self, vault_secret_id):
+        """Initialize and authenticate the Vault client (imports hvac on demand).
+
+        Args:
+            vault_secret_id (str): Secret ID for Vault authentication.
+
+        Raises:
+            ImportError: If hvac package is not installed.
+            KeyError: If required Vault configuration is missing.
+            Exception: If Vault authentication fails.
+        """
+        try:
+            import hvac  # Lazy import
+        except ImportError as e:
+            raise ImportError(
+                "hvac package is required for Vault integration. " "Install with: pip install hvac"
+            ) from e
+
+        try:
+            vault_config = self._raw_config.get("vault", {})
+            vault_url = vault_config.get("url")
+            vault_space = vault_config.get("space")
+            vault_role_id = vault_config.get("role_id")
+
+            if not all([vault_url, vault_space, vault_role_id]):
+                raise KeyError("Missing required Vault configuration in config.yml")
+
+            self.vault_client = hvac.Client(url=vault_url, namespace=vault_space)
+            self.vault_client.auth.approle.login(role_id=vault_role_id, secret_id=vault_secret_id)
+        except Exception as e:
+            self.vault_client = None
+            raise Exception(f"Failed to initialize Vault client: {str(e)}")
+
+    def get(self, section, key_name, use_cache=True):
+        """Retrieve a configuration value.
+
+        Args:
+            section (str): The configuration section name.
+            key_name (str): The key name within the section.
+            use_cache (bool): Whether to use cached values. Defaults to True.
+
+        Returns:
+            The configuration value, which may come from:
+            - Direct configuration value
+            - Vault secret (if Vault is initialized)
+            - Cache (if enabled)
+
+        Raises:
+            KeyError: If the section or key is not found.
+            Exception: If Vault access is required but not available.
+        """
+        if section not in self._raw_config:
+            raise KeyError(f"Section '{section}' not found")
+
+        # Check for direct value first
+        if key_name in self._raw_config[section]:
+            return self._raw_config[section][key_name]
+
+        # Handle Vault reference if Vault is enabled
+        vault_key = f"{key_name}@vault"
+        if vault_key in self._raw_config[section]:
+            if self.vault_client is None:
+                raise Exception(
+                    f"Vault access required for {key_name} but Vault is not initialized"
+                )
+
+            cache_key = f"{section}_{key_name}"
+            if use_cache and cache_key in self.cache:
+                return self.cache[cache_key]
+
+            value = self._get_value_from_vault(section, key_name)
+            self.cache[cache_key] = value
+            return value
+
+        raise KeyError(f"Key '{key_name}' or '{vault_key}' not found in section '{section}'")
+
+    def _get_value_from_vault(self, section, key_name):
+        """Retrieve a secret value from Vault.
+
+        Args:
+            section (str): The configuration section name.
+            key_name (str): The key name within the section.
+
+        Returns:
+            The secret value from Vault.
+
+        Raises:
+            Exception: If Vault access fails.
+        """
+        try:
+            vault_path = self._raw_config[section]["vault_path"]
+            vault_key = self._raw_config[section][f"{key_name}@vault"]
+            data = self.vault_client.secrets.kv.read_secret_version(
+                path=vault_path, mount_point="kv", raise_on_deleted_version=True
+            )
+            return data["data"]["data"][vault_key]
+        except Exception as e:
+            raise Exception(f"Failed to fetch {key_name} from Vault: {str(e)}")
+
+    def __getitem__(self, section):
+        """Dictionary-style access to configuration sections."""
+        if section not in self._raw_config:
+            raise KeyError(f"Section '{section}' not found")
+        return SectionProxy(self, section)
+
+    def __getattr__(self, section):
+        """Attribute-style access to configuration sections."""
+        try:
+            return self[section]
+        except KeyError as e:
+            raise AttributeError(str(e))
+
+
+class SectionProxy:
+    """Proxy class for configuration section access."""
+
+    def __init__(self, config_loader, section):
+        self._loader = config_loader
+        self._section = section
+
+    def __getitem__(self, key):
+        """Dictionary-style access to configuration values."""
+        return self._loader.get(self._section, key)
+
+    def __getattr__(self, key):
+        """Attribute-style access to configuration values."""
+        try:
+            return self[key]
+        except KeyError as e:
+            raise AttributeError(str(e))
+
+    def __repr__(self):
+        """String representation of the section's configuration."""
+        return yaml.dump(self._loader._raw_config[self._section])
+
+
 if __name__ == "__main__":
-    pass
+    config_without_vault = ConfigLoader("config.yml")
+    print("Without Vault:", config_without_vault.get("jira", "url"))
+
+    # This will only work if you provide a valid Vault secret ID
+    # and hvac package is installed
+    config_with_vault = ConfigLoader("config.yml", vault_secret_id="your-secret-id")
+    print("With Vault:", config_with_vault.get("cis", "cis_client_id"))

xenoslib/mail.py

@@ -40,14 +40,22 @@ class MailFetcher:
     """
 
     def __new__(
-        cls, imap_server, mail_addr, mail_pwd, interval=30, days=1, timeout=30, skip_current=True, endless=True
+        cls,
+        imap_server,
+        mail_addr,
+        mail_pwd,
+        interval=30,
+        days=1,
+        timeout=30,
+        skip_current=True,
+        endless=True,
     ):
         self = super().__new__(cls)
         self.imap_server = imap_server
         self.mail_addr = mail_addr
         self.mail_pwd = mail_pwd
         self.days = days
-        self.timeout=timeout
+        self.timeout = timeout
 
         self.msg_ids = deque(maxlen=999)
         if not endless:
@@ -105,7 +113,9 @@ class MailFetcher:
             except Exception as exc:
                 logger.warning(exc)
                 sleep(30)
-        raise Exception("Reached maximum retry attempts when connect IMAP server. Giving up connection.")
+        raise Exception(
+            "Reached maximum retry attempts when connect IMAP server. Giving up connection."
+        )
 
 
 class SMTPMail:

xenoslib-0.1.29.17.dist-info/METADATA

@@ -0,0 +1,30 @@
+Metadata-Version: 2.4
+Name: xenoslib
+Version: 0.1.29.17
+Summary: Xenos' common lib
+Home-page: https://github.com/XenosLu/xenoslib.git
+Author: Xenocider
+Author-email: xenos.lu@gmail.com
+License: MIT License
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: PyYAML>=5.4
+Requires-Dist: IMAPClient>=2.3.1
+Requires-Dist: pywin32>=225; sys_platform == "win32"
+Requires-Dist: requests>=2.19; python_version >= "3.10"
+Requires-Dist: requests>=2.0.0; python_version <= "3.9"
+Provides-Extra: colorful
+Requires-Dist: colorama>=0.4.4; sys_platform == "win32" and extra == "colorful"
+Provides-Extra: mock
+Requires-Dist: requests_mock>=1.9.3; extra == "mock"
+Dynamic: author
+Dynamic: author-email
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: license-file
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary

{xenoslib-0.1.29.15.dist-info → xenoslib-0.1.29.17.dist-info}/RECORD

@@ -1,17 +1,17 @@
 xenoslib/__init__.py,sha256=vlMWwdD2gTb9ztpm_orYAm_Y0Be0Es64ifvMQwrE1jU,310
 xenoslib/__main__.py,sha256=UpD3pl4l5ZUFxK6FzNMWRb1AZpEnwerulSFoPb_Pdgw,307
-xenoslib/about.py,sha256=QdU3Wbq1HwaSgxPN7c14DtEgkaDgxCLBAToKX-hkQqE,232
+xenoslib/about.py,sha256=bCHEaNZtyjL7Bkwok4krX155G-dVugCI2mNLMzY4djA,232
 xenoslib/base.py,sha256=yylMYrF5F-bY4ncdo5bCyImjy7OkBAz5YWMGdZNV3rY,12377
 xenoslib/dev.py,sha256=R6iwKuu-xvaYiBOUyP2gpePyvXss17TOZaCmQEihPCw,1236
-xenoslib/extend.py,sha256=LSzcBafyyLn1H_rwyLqGtTPqL18EDHC01_YxCsyCPLY,5887
+xenoslib/extend.py,sha256=z6wZu70w4yv8d7q7tWdc08GdGr8jJwc8gH9FR_Nmi7c,12477
 xenoslib/linux.py,sha256=EFCQBq_JsmNJc3wGlJlzH9W0tjOA7sSwx0u62R5Ut2k,1318
-xenoslib/mail.py,sha256=olgvOxpZGxVYXK313A3GixkbvJ2ldyWw--PdLt32luc,7197
+xenoslib/mail.py,sha256=pkC4gpMSxKbuvNR-0CdwbJQEJNbBCp5oEYAJS-uxq9s,7286
 xenoslib/mock.py,sha256=iNIplO7clejqLWfpY4r0WQH5BULy9dCoolDenZEci0c,3572
 xenoslib/onedrive.py,sha256=-bJJ8Cd_RjJSlDynYqKoZlFKE1HHM34l6NXOQrWOwtg,7783
 xenoslib/win_trayicon.py,sha256=7GJwX3c2CS1XWQjsyDK5EfM-MmEHdzPJCTX2sGpWmuU,13115
 xenoslib/windows.py,sha256=lUTD7TowaPqYHgIL6b-GM9PLd-VyJNNGzkzC3K9vOxo,4080
-xenoslib-0.1.29.15.dist-info/LICENSE,sha256=lF6hjufhiR-xAje_Wo7ogxV5phz2d5TgkfL5SGshujg,1066
-xenoslib-0.1.29.15.dist-info/METADATA,sha256=v-mplstVhD1G9vDgsd7L4STgEJ98_HZQCPUWsI76OaE,710
-xenoslib-0.1.29.15.dist-info/WHEEL,sha256=R06PA3UVYHThwHvxuRWMqaGcr-PuniXahwjmQRFMEkY,91
-xenoslib-0.1.29.15.dist-info/top_level.txt,sha256=Rfm4GdW0NyA2AHDNUF2wFQOfAo53mAPibddSHGd3X60,9
-xenoslib-0.1.29.15.dist-info/RECORD,,
+xenoslib-0.1.29.17.dist-info/licenses/LICENSE,sha256=lF6hjufhiR-xAje_Wo7ogxV5phz2d5TgkfL5SGshujg,1066
+xenoslib-0.1.29.17.dist-info/METADATA,sha256=Wbk4ENgu87_xfcFOwZThy3p_iJhybUxexanO5d2KbNI,914
+xenoslib-0.1.29.17.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+xenoslib-0.1.29.17.dist-info/top_level.txt,sha256=Rfm4GdW0NyA2AHDNUF2wFQOfAo53mAPibddSHGd3X60,9
+xenoslib-0.1.29.17.dist-info/RECORD,,

{xenoslib-0.1.29.15.dist-info → xenoslib-0.1.29.17.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (75.5.0)
+Generator: setuptools (80.9.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

xenoslib-0.1.29.15.dist-info/METADATA

@@ -1,21 +0,0 @@
-Metadata-Version: 2.1
-Name: xenoslib
-Version: 0.1.29.15
-Summary: Xenos' common lib
-Home-page: https://github.com/XenosLu/xenoslib.git
-Author: Xenocider
-Author-email: xenos.lu@gmail.com
-License: MIT License
-Requires-Python: >=3.7
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: PyYAML >=5.4
-Requires-Dist: IMAPClient >=2.3.1
-Requires-Dist: requests >=2.0.0 ; python_version <= "3.9"
-Requires-Dist: requests >=2.19 ; python_version >= "3.10"
-Requires-Dist: pywin32 >=225 ; sys_platform == "win32"
-Provides-Extra: colorful
-Requires-Dist: colorama >=0.4.4 ; (sys_platform == "win32") and extra == 'colorful'
-Provides-Extra: mock
-Requires-Dist: requests-mock >=1.9.3 ; extra == 'mock'
-