cloe-logging 0.3.7__py3-none-any.whl → 0.3.9__py3-none-any.whl

cloe_logging/decorators/devops_decorator.py

@@ -2,8 +2,8 @@ import functools
 import logging
 import sys
 import time
-from typing import Any
 from collections.abc import Callable
+from typing import Any
 
 from cloe_logging.formatters import DevOpsFormatter
 
@@ -52,7 +52,7 @@ def build_logger():
                 start = time.time()
                 value = func(*args, **kwargs)
                 end = time.time()
-                logger.info(f"\n##### END {func.__name__} DURATION [ '{round(end-start)}'s ] #####")
+                logger.info(f"\n##### END {func.__name__} DURATION [ '{round(end - start)}'s ] #####")
             except:
                 logger.error(f"ERROR: {str(sys.exc_info()[1])}")
                 raise

cloe_logging/formatters/__init__.py

@@ -1,4 +1,4 @@
-from .dict_formatter import DictFormatter
 from .devops_formatter import DevOpsFormatter
+from .dict_formatter import DictFormatter
 
 __all__ = ["DictFormatter", "DevOpsFormatter"]

cloe_logging/formatters/devops_formatter.py

@@ -61,7 +61,7 @@ class DevOpsFormatter(logging.Formatter):
         if record.levelno == logging.INFO:
             record_message = record.msg  # f"{record.name} -- {record.msg}"
 
-            return f"{self.parse_progress(record.msg)}{self.parse_group_start(record.msg)}{record_message}{self.parse_group_end(record.msg)}"
+            return f"{self.parse_progress(record.msg)}{self.parse_group_start(record.msg)}{record_message}{self.parse_group_end(record.msg)}"  # noqa: E501
 
         # Replace the original format with one customized by logging level
         if record.levelno == logging.DEBUG:

cloe_logging/formatters/dict_formatter.py

@@ -1,5 +1,5 @@
-import logging
 import json
+import logging
 
 
 class DictFormatter(logging.Formatter):

cloe_logging/handlers/__init__.py

@@ -1,5 +1,5 @@
-from .unity_catalog_handler import UnityCatalogHandler
 from .log_analytics_handler import LogAnalyticsHandler
 from .snowflake_handler import SnowflakeHandler
+from .unity_catalog_handler import UnityCatalogHandler
 
 __all__ = ["UnityCatalogHandler", "LogAnalyticsHandler", "SnowflakeHandler"]

cloe_logging/handlers/log_analytics_handler.py

@@ -3,7 +3,7 @@ import hashlib
 import hmac
 import logging
 import os
-from datetime import datetime
+from datetime import UTC, datetime
 
 try:
     import requests
@@ -37,7 +37,7 @@ class LogAnalyticsHandler(logging.Handler):
         test_connectivity: bool = True,
         column_split_char: str = "|",
         key_value_split_char: str = ":",
-        **kwargs,  # required to work with the Factory
+        **kwargs,  # noqa: ARG002 required to work with the Factory
     ):
         """Initializes a new instance of the LogAnalyticsHandler class.
 
@@ -99,7 +99,7 @@ class LogAnalyticsHandler(logging.Handler):
                 )
                 self.levelname = "INFO"
 
-            def getMessage(self):
+            def getMessage(self):  # noqa: N802 mimics logging.LogRecord.getMessage
                 return self.msg
 
         try:
@@ -154,8 +154,7 @@ class LogAnalyticsHandler(logging.Handler):
         encoded_hash = base64.b64encode(
             hmac.new(decoded_key, bytes_to_hash, digestmod=hashlib.sha256).digest(),
         ).decode()
-        authorization = f"SharedKey {self.workspace_id}:{encoded_hash}"
-        return authorization
+        return f"SharedKey {self.workspace_id}:{encoded_hash}"
 
     def _make_message_compliant(self, input_string):
         """Encodes the input string as UTF-8 to make it compliant.
@@ -174,8 +173,7 @@ class LogAnalyticsHandler(logging.Handler):
         Returns:
             str: The URL of the Azure Log Analytics workspace.
         """
-        uri = f"https://{self.workspace_id}.ods.opinsights.azure.com{self.RESOURCE}?api-version=2016-04-01"
-        return uri
+        return f"https://{self.workspace_id}.ods.opinsights.azure.com{self.RESOURCE}?api-version=2016-04-01"
 
     def emit(self, record: logging.LogRecord):
         """Sends the log message to Azure Log Analytics.
@@ -198,7 +196,7 @@ class LogAnalyticsHandler(logging.Handler):
             log_message_dict = self.serializer.serialize(log_message)
             compliant_log_message = self._make_message_compliant(str(log_message_dict))
             content_length = len(compliant_log_message)
-            rfc1123date = datetime.utcnow().strftime("%a, %d %b %Y %H:%M:%S GMT")
+            rfc1123date = datetime.now(UTC).strftime("%a, %d %b %Y %H:%M:%S GMT")
             signature = self._build_signature(rfc1123date, content_length)
 
             headers = {

cloe_logging/handlers/snowflake_handler.py

@@ -2,8 +2,10 @@ import logging
 import os
 
 try:
-    from cloe_util_snowflake_connector.connection_parameters import ConnectionParameters
-    from cloe_util_snowflake_connector.snowflake_interface import SnowflakeInterface
+    from cloe_util_snowflake_connector.connection_parameters import (  # type: ignore[import-not-found]
+        ConnectionParameters,
+    )
+    from cloe_util_snowflake_connector.snowflake_interface import SnowflakeInterface  # type: ignore[import-not-found]
 except ImportError:
     ConnectionParameters = None  # type: ignore
     SnowflakeInterface = None  # type: ignore
@@ -24,7 +26,7 @@ class SnowflakeHandler(logging.Handler):
         target_table: str = "",
         column_split_char: str = "|",
         key_value_split_char: str = ":",
-        **kwargs,  # required to work with the Factory
+        **kwargs,  # noqa: ARG002 required to work with the Factory
     ):
         """Initializes a new instance of the SnowflakeHandler class.
 
@@ -79,8 +81,7 @@ class SnowflakeHandler(logging.Handler):
 
     def _get_snowflake_connection(self) -> SnowflakeInterface:
         conn_params = ConnectionParameters.init_from_env_variables()
-        snowflake_conn = SnowflakeInterface(conn_params)
-        return snowflake_conn
+        return SnowflakeInterface(conn_params)
 
     def _parse_dict_to_sql_insert(self, input_dict: dict) -> str:
         """
@@ -95,11 +96,7 @@ class SnowflakeHandler(logging.Handler):
         """
         columns = ", ".join(input_dict.keys())
         values = ", ".join(f"'{str(v)}'" for v in input_dict.values())
-        sql_statement = (
-            f"INSERT INTO {self.target_db}.{self.target_schema}.{self.target_table} ({columns}) VALUES ({values})"
-        )
-
-        return sql_statement
+        return f"INSERT INTO {self.target_db}.{self.target_schema}.{self.target_table} ({columns}) VALUES ({values})"
 
     def emit(self, record: logging.LogRecord):
         """Sends the log message to Snowflake.

cloe_logging/handlers/unity_catalog_handler.py

@@ -3,8 +3,8 @@ import logging
 from typing import cast
 
 try:
-    from databricks.sdk import WorkspaceClient
-    from databricks.sdk.service.sql import ExecuteStatementRequestOnWaitTimeout
+    from databricks.sdk import WorkspaceClient  # type: ignore[import-not-found]
+    from databricks.sdk.service.sql import ExecuteStatementRequestOnWaitTimeout  # type: ignore[import-not-found]
 except ImportError:
     WorkspaceClient = None  # type: ignore
     ExecuteStatementRequestOnWaitTimeout = None  # type: ignore
@@ -60,7 +60,8 @@ class UnityCatalogHandler(logging.Handler):
         self.warehouse_id = cast(str, warehouse_id)
         if not all([self.catalog, self.schema, self.table, self.warehouse_id, self.workspace_url]):
             raise ValueError(
-                "You must provide a workspace_url, warehouse_id, catalog, schema, and table to create a DatabricksHandler."
+                "You must provide a workspace_url, warehouse_id, catalog,"
+                " schema, and table to create a DatabricksHandler."
             )
         self.table_identifier = f"{self.catalog}.{self.schema}.{self.table}"
         self.workspace_client = workspace_client or WorkspaceClient(host=self.workspace_url)
@@ -136,8 +137,7 @@ class UnityCatalogHandler(logging.Handler):
         timestamp = split_values[0]
         casted_timestamp = f"to_timestamp({timestamp}, 'yyyy-MM-dd HH:mm:ss,SSS')"
         joined_values = ", ".join([casted_timestamp] + split_values[1:])
-        sql_statement = f"INSERT INTO {self.table_identifier} ({columns}) VALUES ({joined_values})"
-        return sql_statement
+        return f"INSERT INTO {self.table_identifier} ({columns}) VALUES ({joined_values})"
 
     def emit(self, record: logging.LogRecord) -> None:
         """Put a log record into the Queue.

cloe_logging/logger_factory.py

@@ -1,7 +1,8 @@
 import logging
 from collections.abc import Callable
+from typing import cast
 
-from cloe_logging.handlers import UnityCatalogHandler, SnowflakeHandler, LogAnalyticsHandler
+from cloe_logging.handlers import LogAnalyticsHandler, SnowflakeHandler, UnityCatalogHandler
 
 
 class LoggerFactory:
@@ -47,18 +48,18 @@ class LoggerFactory:
         log_format: str = "%(asctime)s - %(name)s - %(levelname)s - %(message)s",
         **kwargs,
     ) -> logging.Handler:
-        HANDLER_FUNCTIONS: dict[str, Callable] = {
+        handler_functions: dict[str, Callable] = {
             "console": LoggerFactory.get_console_handler,
             "file": LoggerFactory.get_file_handler,
             "unity_catalog": LoggerFactory.get_unity_catalog_handler,
             "snowflake": LoggerFactory.get_snowflake_handler,
             "log_analytics": LoggerFactory.get_log_analytics_handler,
         }
-        handler = HANDLER_FUNCTIONS[handler_type](**kwargs, log_format=log_format)
-        return handler
+        handler = handler_functions[handler_type](**kwargs, log_format=log_format)
+        return cast(logging.Handler, handler)
 
     @staticmethod
-    def get_console_handler(log_format: str, **kwargs) -> logging.Handler:
+    def get_console_handler(log_format: str, **kwargs) -> logging.Handler:  # noqa: ARG004
         handler = logging.StreamHandler()
         handler.setFormatter(logging.Formatter(log_format))
         return handler
@@ -70,7 +71,7 @@ class LoggerFactory:
         mode: str = "a",
         encoding: str | None = None,
         delay: bool = False,
-        **kwargs,
+        **kwargs,  # noqa: ARG004
     ) -> logging.Handler:
         if filename is None:
             raise ValueError("filename is required for file logger")
@@ -89,7 +90,7 @@ class LoggerFactory:
         warehouse_id: str,
         column_split_char: str = DEFAULT_COLUMN_SPLIT_CHAR,
         key_value_split_char: str = DEFAULT_KEY_VALUE_SPLIT_CHAR,
-        **kwargs,
+        **kwargs,  # noqa: ARG003
     ) -> logging.Handler:
         return UnityCatalogHandler(
             catalog=uc_catalog_name,
@@ -110,7 +111,7 @@ class LoggerFactory:
         target_table: str,
         column_split_char: str = DEFAULT_COLUMN_SPLIT_CHAR,
         key_value_split_char: str = DEFAULT_KEY_VALUE_SPLIT_CHAR,
-        **kwargs,
+        **kwargs,  # noqa: ARG003
     ) -> logging.Handler:
         return SnowflakeHandler(
             target_db=target_db,
@@ -129,7 +130,7 @@ class LoggerFactory:
         test_connectivity: bool,
         column_split_char: str = DEFAULT_COLUMN_SPLIT_CHAR,
         key_value_split_char: str = DEFAULT_KEY_VALUE_SPLIT_CHAR,
-        **kwargs,
+        **kwargs,  # noqa: ARG003
     ) -> logging.Handler:
         return LogAnalyticsHandler(
             workspace_id=workspace_id,
@@ -152,7 +153,7 @@ class LoggerFactory:
             The logger with the handler added.
         """
         if len(logger.handlers) > 0:
-            if not any([isinstance(h, handler.__class__) for h in logger.handlers]):
+            if not any(isinstance(h, handler.__class__) for h in logger.handlers):
                 logger.addHandler(handler)
         else:
             logger.addHandler(handler)

cloe_logging/utility/serializer.py

@@ -49,7 +49,8 @@ class DictSerializer(LogSerializer):
             dict: The converted dictionary.
 
         Raises:
-            ValueError: If the log_record is not a string, or if any part of the log_record does not contain the key_value_split_char.
+            ValueError: If the log_record is not a string, or if any part of the
+                log_record does not contain the key_value_split_char.
         """
         if not isinstance(log_record, str):
             raise ValueError("record must be a string.")

cloe_logging-0.3.9.dist-info/METADATA

@@ -0,0 +1,45 @@
+Metadata-Version: 2.4
+Name: cloe-logging
+Version: 0.3.9
+Summary: A Standardized Solution for logging to various targets.
+Author-email: David Achilles <david.achilles@accenture.com>, Ole Steinbrueck <ole.steinbrueck@accenture.com>
+License: Proprietary
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: Other/Proprietary License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Database
+Requires-Python: <3.13,>=3.11
+Requires-Dist: pydantic<3.0.0,>=2.7.0
+Requires-Dist: typing-extensions<5.0.0,>=4.12.2
+Provides-Extra: databricks
+Requires-Dist: databricks-sdk>=0.39.0; extra == 'databricks'
+Provides-Extra: log-analytics
+Requires-Dist: requests<3.0.0,>=2.31.0; extra == 'log-analytics'
+Provides-Extra: snowflake
+Requires-Dist: cloe-util-snowflake-connector<2.0.0,>=1.0.2; extra == 'snowflake'
+Description-Content-Type: text/markdown
+
+# cloe-logging
+
+[![Copier](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/copier-org/copier/master/img/badge/badge-grayscale-inverted-border-orange.json)](https://github.com/copier-org/copier)
+[![python](https://img.shields.io/badge/Python-3.12-3776AB.svg?style=flat&logo=python&logoColor=white)](https://www.python.org)
+[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v0.json)](https://github.com/charliermarsh/ruff)
+[![Checked with mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](https://mypy-lang.org/)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
+
+Owner: David Achilles
+
+A Standardized Solution for logging to various targets.
+
+The logging module provides a simple interface to log messages
+to various targets. All components
+of the Framework use this module to log messages. It could also be
+used by application or notebook code to log messages.
+
+Please find the docs [here](https://white-rock-0cabbc003.1.azurestaticapps.net/tool_docs/cloe-logging)!

cloe_logging-0.3.9.dist-info/RECORD

@@ -0,0 +1,17 @@
+cloe_logging/__init__.py,sha256=3rsW-XtJbAaENMtN9ah2qRZyQnZOtqTnkCE_OqXBLNw,74
+cloe_logging/logger_factory.py,sha256=3H_5_Ry-l2ap2-aGe-bkh9lmDcHr0a81qLN8X7mkXaA,5666
+cloe_logging/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+cloe_logging/decorators/__init__.py,sha256=ZFfADCScnpZ3ofxNgle1UybF322cdH9vuIGCx3S9wUU,71
+cloe_logging/decorators/devops_decorator.py,sha256=npuOLa2HLxPlhTN9HMa_EBqyVWQxv8HvlTtaICyfVRw,1961
+cloe_logging/formatters/__init__.py,sha256=1hhmT6qeIGuom63oHrg_2SHQZpLWG2GclMSTmF-fR_g,136
+cloe_logging/formatters/devops_formatter.py,sha256=EeTgN932jGisW1Q_z9RXdd0yvXuOgbN-CuFaSQ3usss,3315
+cloe_logging/formatters/dict_formatter.py,sha256=QGUcCx3KrCAXFGkYD3SY4s13k0OIgSBn6fhijgJ4m0Y,1553
+cloe_logging/handlers/__init__.py,sha256=5RTIz8UooLgVc9h5GnXvI2yF-FkOKiJBfHbSKHKitRE,236
+cloe_logging/handlers/log_analytics_handler.py,sha256=x5gX98srlvBsEFmIWTISzO0v1Fx-O6CfsBDvyigA4YI,9048
+cloe_logging/handlers/snowflake_handler.py,sha256=TWctiCR10UacVrkDCIF6Z1GvuhfhC7iIpNefzdTgd0Q,5049
+cloe_logging/handlers/unity_catalog_handler.py,sha256=DabwGA-2_F1BGGUZnEA9YMSIPmeaUkhkKjo3Fm-rXps,6928
+cloe_logging/utility/__init__.py,sha256=wp758l5P1M20bNUbbGojSkBUscFUgRd_TLLdnHgQ_l8,70
+cloe_logging/utility/serializer.py,sha256=a_XNHC3DTPongLXcEBp7UCvVdmdjT-qAQ9ZHubCV0oI,2656
+cloe_logging-0.3.9.dist-info/METADATA,sha256=QsOVBzsajELGWn-VhU9_uLYuVAEfAuYA7q5fcv7-GpQ,2487
+cloe_logging-0.3.9.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+cloe_logging-0.3.9.dist-info/RECORD,,

cloe_logging-0.3.7.dist-info/METADATA

@@ -1,14 +0,0 @@
-Metadata-Version: 2.4
-Name: cloe-logging
-Version: 0.3.7
-Summary: A Standardized Solution for logging to various targets.
-Home-page: https://initions.com/
-Author: initions
-Author-email: ICSMC_EXT_PYPIORG@accenture.com
-License: MIT
-Requires-Python: <3.12,>=3.11
-Requires-Dist: pydantic<3.0.0,>=2.7.0
-Requires-Dist: typing-extensions<5.0.0,>=4.12.2
-Requires-Dist: databricks-sdk>=0.39.0; extra == 'databricks'
-Requires-Dist: requests<3.0.0,>=2.31.0; extra == 'log-analytics'
-Requires-Dist: cloe-util-snowflake-connector<2.0.0,>=1.0.2; extra == 'snowflake'

cloe_logging-0.3.7.dist-info/RECORD

@@ -1,17 +0,0 @@
-cloe_logging/__init__.py,sha256=3rsW-XtJbAaENMtN9ah2qRZyQnZOtqTnkCE_OqXBLNw,74
-cloe_logging/logger_factory.py,sha256=az_XcRSrUCge4yG3HXNqFPSPRJ0V8EMKmjPPl54UIms,5541
-cloe_logging/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-cloe_logging/decorators/__init__.py,sha256=ZFfADCScnpZ3ofxNgle1UybF322cdH9vuIGCx3S9wUU,71
-cloe_logging/decorators/devops_decorator.py,sha256=1jCfNa22lU87u-QPNUt6fVLJOCINhZncYz76UjUh2XE,1959
-cloe_logging/formatters/__init__.py,sha256=0FbiRRJbo4zYgNb2QSxY5aGthu8evt9Gex5c_-jxCIs,136
-cloe_logging/formatters/devops_formatter.py,sha256=KwarCm_EPpRV-cZk6nGM3GZVNKN39FNOofXfC0KfkQg,3301
-cloe_logging/formatters/dict_formatter.py,sha256=PsbNXxdCZxtEC9g-nIukhdQwCcsCfz42EumHPHFt9-4,1553
-cloe_logging/handlers/__init__.py,sha256=xgYTK6qXJEgNFPZE6yHXwS1o9bmGuQQZ7so_7BncW7A,236
-cloe_logging/handlers/log_analytics_handler.py,sha256=2Z-Hg2mWgvqAbO3nvego9AjDy3PGgzPQOxVWL7x5GAY,9038
-cloe_logging/handlers/snowflake_handler.py,sha256=bZR5UIJIlivAJT3IeniVoFXlsQhq5-YDuSUH4qrXeL0,5054
-cloe_logging/handlers/unity_catalog_handler.py,sha256=aXIiwDq9tHHheAFMusHhEI9uvYpI39KCscuVntFvNLA,6879
-cloe_logging/utility/__init__.py,sha256=wp758l5P1M20bNUbbGojSkBUscFUgRd_TLLdnHgQ_l8,70
-cloe_logging/utility/serializer.py,sha256=uPdmpawqM3WXZQVxz63deCalvKJYxRNecxjBQeDzTIY,2639
-cloe_logging-0.3.7.dist-info/METADATA,sha256=TCZNiRj3PJJpq8PcKGqkiYRpYWnesboKsv5TDGKdAM8,1033
-cloe_logging-0.3.7.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-cloe_logging-0.3.7.dist-info/RECORD,,