dsw-config 4.13.0__tar.gz → 4.14.0__tar.gz

{dsw_config-4.13.0 → dsw_config-4.14.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dsw-config
-Version: 4.13.0
+Version: 4.14.0
 Summary: Library for DSW config manipulation
 Author-email: Marek Suchánek <marek.suchanek@ds-wizard.org>
 License: Apache License 2.0
@@ -11,11 +11,11 @@ Keywords: dsw,config,yaml,parser
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Text Processing
 Classifier: Topic :: Utilities
-Requires-Python: <4,>=3.10
+Requires-Python: <4,>=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: PyYAML

{dsw_config-4.13.0 → dsw_config-4.14.0}/dsw/config/build_info.py

@@ -9,9 +9,9 @@ BuildInfo = namedtuple(
 )
 
 BUILD_INFO = BuildInfo(
-    version='v4.13.0~c8e1cb3',
-    built_at='2024-12-05 08:07:29Z',
-    sha='c8e1cb3b7e0cc93bdf509eef715cd0a926d907c3',
+    version='v4.14.0~213910f',
+    built_at='2025-01-07 08:17:37Z',
+    sha='213910ffb32a7cea98942ccd0f6c52cb6cf79128',
     branch='HEAD',
-    tag='v4.13.0',
+    tag='v4.14.0',
 )

{dsw_config-4.13.0 → dsw_config-4.14.0}/dsw/config/keys.py

@@ -1,60 +1,61 @@
+# pylint: disable=too-few-public-methods
 import collections
+import typing
 
-from typing import Any, Optional, Generic, TypeVar, Callable
 
+T = typing.TypeVar('T')
 
-T = TypeVar('T')
 
-
-def cast_bool(value: Any) -> bool:
+def cast_bool(value: typing.Any) -> bool:
     return bool(value)
 
 
-def cast_optional_bool(value: Any) -> Optional[bool]:
+def cast_optional_bool(value: typing.Any) -> bool | None:
     if value is None:
         return None
     return bool(value)
 
 
-def cast_int(value: Any) -> int:
+def cast_int(value: typing.Any) -> int:
     return int(value)
 
 
-def cast_optional_int(value: Any) -> Optional[int]:
+def cast_optional_int(value: typing.Any) -> int | None:
     if value is None:
         return None
     return int(value)
 
 
-def cast_float(value: Any) -> float:
+def cast_float(value: typing.Any) -> float:
     return float(value)
 
 
-def cast_optional_float(value: Any) -> Optional[float]:
+def cast_optional_float(value: typing.Any) -> float | None:
     if value is None:
         return None
     return float(value)
 
 
-def cast_str(value: Any) -> str:
+def cast_str(value: typing.Any) -> str:
     return str(value)
 
 
-def cast_optional_str(value: Any) -> Optional[str]:
+def cast_optional_str(value: typing.Any) -> str | None:
     if value is None:
         return None
     return str(value)
 
 
-def cast_optional_dict(value: Any) -> Optional[dict]:
+def cast_optional_dict(value: typing.Any) -> dict | None:
     if not isinstance(value, dict):
         return None
     return value
 
 
-class ConfigKey(Generic[T]):
+class ConfigKey(typing.Generic[T]):
 
-    def __init__(self, yaml_path: list[str], cast: Callable[[Any], T],
+    def __init__(self, *, yaml_path: list[str],
+                 cast: typing.Callable[[typing.Any], T],
                  var_names=None, default=None, required=False):
         self.yaml_path = yaml_path
         self.var_names = var_names or []  # type: list[str]
@@ -63,12 +64,13 @@ class ConfigKey(Generic[T]):
         self.cast = cast
 
     def __str__(self):
-        return 'ConfigKey: ' + '.'.join(self.yaml_path)
+        return f'ConfigKey: {".".join(self.yaml_path)}'
 
 
 class ConfigKeysMeta(type):
 
     @classmethod
+    # pylint: disable-next=unused-argument
     def __prepare__(mcs, name, bases, **kwargs):
         return collections.OrderedDict()
 
@@ -176,6 +178,12 @@ class _SentryKeys(ConfigKeysContainer):
         default='',
         cast=cast_str,
     )
+    environment = ConfigKey(
+        yaml_path=['sentry', 'environment'],
+        var_names=['SENTRY_ENVIRONMENT'],
+        default='production',
+        cast=cast_str,
+    )
 
 
 class _DatabaseKeys(ConfigKeysContainer):

{dsw_config-4.13.0 → dsw_config-4.14.0}/dsw/config/logging.py

@@ -28,6 +28,8 @@ class DSWLogger(logging.Logger):
 
 
 def prepare_logging(logging_cfg):
+    # pylint: disable-next=no-member
+    logger_dict = logging.root.manager.loggerDict
     if logging_cfg.dict_config is not None:
         logging.config.dictConfig(logging_cfg.dict_config)
     else:
@@ -36,15 +38,13 @@ def prepare_logging(logging_cfg):
             level=logging_cfg.global_level,
             format=logging_cfg.message_format
         )
-        dsw_loggers = (logging.getLogger(name)
-                       for name in logging.root.manager.loggerDict.keys()
+        dsw_loggers = (logging.getLogger(name) for name in logger_dict
                        if name.lower().startswith('dsw'))
         for logger in dsw_loggers:
             logger.setLevel(logging_cfg.level)
     # Set for all existing loggers
     logging.getLogger().addFilter(filter=LOG_FILTER)
-    loggers = (logging.getLogger(name)
-               for name in logging.root.manager.loggerDict.keys())
+    loggers = (logging.getLogger(name) for name in logger_dict)
     for logger in loggers:
         logger.addFilter(filter=LOG_FILTER)
     # Set for any future loggers

dsw_config-4.14.0/dsw/config/model.py

@@ -0,0 +1,82 @@
+import dataclasses
+
+from .logging import prepare_logging, LOG_FILTER
+
+
+def _config_to_string(config: object):
+    lines = [f'{type(config).__name__}']
+    fields = (f for f in config.__dict__.keys() if not f.startswith('_'))
+    for field in fields:
+        v = str(getattr(config, field))
+        t = type(getattr(config, field)).__name__
+        lines.append(f'- {field} = {v} [{t}]')
+    return '\n'.join(lines)
+
+
+class ConfigModel:
+
+    def __str__(self):
+        return _config_to_string(self)
+
+
+@dataclasses.dataclass
+class GeneralConfig(ConfigModel):
+    environment: str
+    client_url: str
+    secret: str
+
+
+@dataclasses.dataclass
+class SentryConfig(ConfigModel):
+    enabled: bool
+    workers_dsn: str | None
+    traces_sample_rate: float | None
+    max_breadcrumbs: int | None
+    environment: str
+
+
+@dataclasses.dataclass
+class DatabaseConfig(ConfigModel):
+    connection_string: str
+    connection_timeout: int
+    queue_timeout: int
+
+
+@dataclasses.dataclass
+class S3Config(ConfigModel):
+    url: str
+    username: str
+    password: str
+    bucket: str
+    region: str
+
+
+@dataclasses.dataclass
+class LoggingConfig(ConfigModel):
+    level: str
+    global_level: str
+    message_format: str
+    dict_config: dict | None = None
+
+    def apply(self):
+        prepare_logging(self)
+
+    @staticmethod
+    def set_logging_extra(key: str, value: str):
+        LOG_FILTER.set_extra(key, value)
+
+
+@dataclasses.dataclass
+class AWSConfig(ConfigModel):
+    access_key_id: str | None
+    secret_access_key: str | None
+    region: str | None
+
+    @property
+    def has_credentials(self) -> bool:
+        return self.access_key_id is not None and self.secret_access_key is not None
+
+
+@dataclasses.dataclass
+class CloudConfig(ConfigModel):
+    multi_tenant: bool

{dsw_config-4.13.0 → dsw_config-4.14.0}/dsw/config/parser.py

@@ -1,7 +1,7 @@
 import os
-import yaml
+import typing
 
-from typing import List, Any, IO
+import yaml
 
 from .keys import ConfigKey, ConfigKeys
 from .model import GeneralConfig, SentryConfig, S3Config, \
@@ -10,14 +10,14 @@ from .model import GeneralConfig, SentryConfig, S3Config, \
 
 class MissingConfigurationError(Exception):
 
-    def __init__(self, missing: List[str]):
+    def __init__(self, missing: list[str]):
         self.missing = missing
 
 
 class DSWConfigParser:
 
     def __init__(self, keys=ConfigKeys):
-        self.cfg = dict()
+        self.cfg = {}
         self.keys = keys
 
     @staticmethod
@@ -28,7 +28,7 @@ class DSWConfigParser:
         except Exception:
             return False
 
-    def read_file(self, fp: IO):
+    def read_file(self, fp: typing.IO):
         self.cfg = yaml.load(fp, Loader=yaml.FullLoader) or self.cfg
 
     def read_string(self, content: str):
@@ -50,12 +50,12 @@ class DSWConfigParser:
         if self.has_value_for_path(key.yaml_path):
             return True
         for var_name in key.var_names:
-            if var_name in os.environ.keys() or \
-                    self._prefix_var(var_name) in os.environ.keys():
+            if var_name in os.environ or self._prefix_var(var_name) in os.environ:
                 return True
+        return False
 
     def get_or_default(self, key: ConfigKey):
-        x = self.cfg  # type: Any
+        x: typing.Any = self.cfg
         for p in key.yaml_path:
             if not hasattr(x, 'keys') or p not in x.keys():
                 return key.default
@@ -64,9 +64,9 @@ class DSWConfigParser:
 
     def get(self, key: ConfigKey):
         for var_name in key.var_names:
-            if var_name in os.environ.keys():
+            if var_name in os.environ:
                 return key.cast(os.environ[var_name])
-            if self._prefix_var(var_name) in os.environ.keys():
+            if self._prefix_var(var_name) in os.environ:
                 return key.cast(os.environ[self._prefix_var(var_name)])
         return key.cast(self.get_or_default(key))
 
@@ -118,6 +118,7 @@ class DSWConfigParser:
             workers_dsn=self.get(self.keys.sentry.worker_dsn),
             traces_sample_rate=self.get(self.keys.sentry.traces_sample_rate),
             max_breadcrumbs=self.get(self.keys.sentry.max_breadcrumbs),
+            environment=self.get(self.keys.sentry.environment),
         )
 
     @property

dsw_config-4.14.0/dsw/config/sentry.py

@@ -0,0 +1,60 @@
+import logging
+import typing
+
+import sentry_sdk
+from sentry_sdk.types import Event, Hint
+from sentry_sdk.integrations.logging import LoggingIntegration
+
+from .model import SentryConfig
+
+
+EventProcessor = typing.Callable[[Event, Hint], typing.Optional[Event]]
+
+
+class SentryReporter:
+    report = False
+    filters = []  # type: list[EventProcessor]
+
+    @classmethod
+    def initialize(cls, *, config: SentryConfig, prog_name: str, release: str,
+                   breadcrumb_level: int | None = logging.INFO,
+                   event_level: int | None = logging.ERROR):
+        cls.report = config.enabled and config.workers_dsn is not None
+        if cls.report:
+            def before_send(event, hint):
+                for f in cls.filters:
+                    if not f(event, hint):
+                        return None
+                return event
+
+            sentry_sdk.init(
+                dsn=config.workers_dsn,
+                traces_sample_rate=config.traces_sample_rate or 1.0,
+                max_breadcrumbs=config.max_breadcrumbs or sentry_sdk.consts.DEFAULT_MAX_BREADCRUMBS,
+                release=release,
+                environment=config.environment,
+                before_send=before_send,
+                default_integrations=False,
+                integrations=[
+                    LoggingIntegration(
+                        level=breadcrumb_level,
+                        event_level=event_level,
+                    ),
+                ],
+            )
+            sentry_sdk.set_tag('component', prog_name)
+
+    @classmethod
+    def capture_exception(cls, *args, **kwargs):
+        if cls.report:
+            sentry_sdk.capture_exception(*args, **kwargs)
+
+    @classmethod
+    def capture_message(cls, *args, **kwargs):
+        if cls.report:
+            sentry_sdk.capture_message(*args, **kwargs)
+
+    @classmethod
+    def set_tags(cls, **tags):
+        if cls.report:
+            sentry_sdk.set_tags(tags)

{dsw_config-4.13.0 → dsw_config-4.14.0}/dsw_config.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dsw-config
-Version: 4.13.0
+Version: 4.14.0
 Summary: Library for DSW config manipulation
 Author-email: Marek Suchánek <marek.suchanek@ds-wizard.org>
 License: Apache License 2.0
@@ -11,11 +11,11 @@ Keywords: dsw,config,yaml,parser
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Text Processing
 Classifier: Topic :: Utilities
-Requires-Python: <4,>=3.10
+Requires-Python: <4,>=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: PyYAML

{dsw_config-4.13.0 → dsw_config-4.14.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = 'setuptools.build_meta'
 
 [project]
 name = 'dsw-config'
-version = "4.13.0"
+version = "4.14.0"
 description = 'Library for DSW config manipulation'
 readme = 'README.md'
 keywords = ['dsw', 'config', 'yaml', 'parser']
@@ -16,12 +16,12 @@ classifiers = [
     'Development Status :: 5 - Production/Stable',
     'License :: OSI Approved :: Apache Software License',
     'Programming Language :: Python',
-    'Programming Language :: Python :: 3.10',
     'Programming Language :: Python :: 3.11',
+    'Programming Language :: Python :: 3.12',
     'Topic :: Text Processing',
     'Topic :: Utilities',
 ]
-requires-python = '>=3.10, <4'
+requires-python = '>=3.11, <4'
 dependencies = [
     'PyYAML',
     'sentry-sdk',

dsw_config-4.13.0/dsw/config/model.py

@@ -1,93 +0,0 @@
-from typing import Optional
-
-from .logging import prepare_logging, LOG_FILTER
-
-
-def _config_to_string(config: object):
-    lines = [f'{type(config).__name__}']
-    fields = (f for f in config.__dict__.keys() if not f.startswith('_'))
-    for field in fields:
-        v = str(getattr(config, field))
-        t = type(getattr(config, field)).__name__
-        lines.append(f'- {field} = {v} [{t}]')
-    return '\n'.join(lines)
-
-
-class ConfigModel:
-
-    def __str__(self):
-        return _config_to_string(self)
-
-
-class GeneralConfig(ConfigModel):
-
-    def __init__(self, environment: str, client_url: str, secret: str):
-        self.environment = environment
-        self.client_url = client_url
-        self.secret = secret
-
-
-class SentryConfig(ConfigModel):
-
-    def __init__(self, enabled: bool, workers_dsn: Optional[str],
-                 traces_sample_rate: Optional[float], max_breadcrumbs: Optional[int]):
-        self.enabled = enabled
-        self.workers_dsn = workers_dsn
-        self.traces_sample_rate = traces_sample_rate
-        self.max_breadcrumbs = max_breadcrumbs
-
-
-class DatabaseConfig(ConfigModel):
-
-    def __init__(self, connection_string: str, connection_timeout: int,
-                 queue_timeout: int):
-        self.connection_string = connection_string
-        self.connection_timeout = connection_timeout
-        self.queue_timeout = queue_timeout
-
-
-class S3Config(ConfigModel):
-
-    def __init__(self, url: str, username: str, password: str,
-                 bucket: str, region: str):
-        self.url = url
-        self.username = username
-        self.password = password
-        self.bucket = bucket
-        self.region = region
-
-
-class LoggingConfig(ConfigModel):
-
-    def __init__(self, level: str, global_level: str, message_format: str,
-                 dict_config: Optional[dict] = None):
-        self.level = level
-        self.global_level = global_level
-        self.message_format = message_format
-        self.dict_config = dict_config
-
-    def apply(self):
-        prepare_logging(self)
-
-    @staticmethod
-    def set_logging_extra(key: str, value: str):
-        LOG_FILTER.set_extra(key, value)
-
-
-class AWSConfig(ConfigModel):
-
-    def __init__(self, access_key_id: Optional[str], secret_access_key: Optional[str],
-                 region: Optional[str]):
-        self.access_key_id = access_key_id
-        self.secret_access_key = secret_access_key
-        self.region = region
-
-    @property
-    def has_credentials(self) -> bool:
-        return self.access_key_id is not None and self.secret_access_key is not None
-
-
-class CloudConfig(ConfigModel):
-
-    def __init__(self, multi_tenant: bool):
-        self.multi_tenant = multi_tenant

dsw_config-4.13.0/dsw/config/sentry.py

@@ -1,37 +0,0 @@
-import sentry_sdk
-
-from .model import SentryConfig
-
-
-class SentryReporter:
-    report = False
-
-    @classmethod
-    def initialize(cls, dsn: str, server_name: str, environment: str,
-                   prog_name: str, release: str, config: SentryConfig):
-        cls.report = config.enabled and config.workers_dsn is not None
-        if cls.report:
-            sentry_sdk.init(
-                dsn=dsn,
-                traces_sample_rate=config.traces_sample_rate or 1.0,
-                max_breadcrumbs=config.max_breadcrumbs or sentry_sdk.consts.DEFAULT_MAX_BREADCRUMBS,
-                release=release,
-                server_name=server_name,
-                environment=environment,
-            )
-            sentry_sdk.set_tag('component', prog_name)
-
-    @classmethod
-    def capture_exception(cls, *args, **kwargs):
-        if cls.report:
-            sentry_sdk.capture_exception(*args, **kwargs)
-
-    @classmethod
-    def capture_message(cls, *args, **kwargs):
-        if cls.report:
-            sentry_sdk.capture_message(*args, **kwargs)
-
-    @classmethod
-    def set_context(cls, name: str, value):
-        if cls.report:
-            sentry_sdk.set_context(name, value)