pydiverse-common 0.3.2__py2.py3-none-any.whl

pydiverse/common/util/structlog.py

@@ -0,0 +1,115 @@
+# Copyright (c) QuantCo and pydiverse contributors 2025-2025
+# SPDX-License-Identifier: BSD-3-Clause
+import logging
+import sys
+import textwrap
+import types
+from io import StringIO
+
+try:
+    import structlog
+    from structlog.typing import EventDict, WrappedLogger
+
+    structlog_installed = True
+except ImportError:
+    structlog = types.ModuleType("structlog")
+
+    class dev:
+        class ConsoleRenderer:
+            pass
+
+    structlog.dev = dev
+    structlog_installed = False
+    EventDict, WrappedLogger = None, None
+
+
+class StructlogHandler(logging.Handler):
+    """
+    Stdlib logging handler that feeds all events back into structlog
+
+    Can't be used with a structlog logger_factory that uses the logging library,
+    otherwise logging would result in an infinite loop.
+    """
+
+    def __init__(self, *args, **kw):
+        super().__init__(*args, **kw)
+        self._log = structlog.get_logger()
+
+    def emit(self, record):
+        msg = self.format(record)
+        self._log.log(record.levelno, msg, logger=record.name)
+
+
+class PydiverseConsoleRenderer(structlog.dev.ConsoleRenderer):
+    """
+    Custom subclass of the structlog ConsoleRenderer that allows rendering
+    specific values in the event dict on separate lines.
+    """
+
+    def __init__(self, *args, **kwargs):
+        self._render_keys = kwargs.pop("render_keys", [])
+        super().__init__(*args, **kwargs)
+
+    def __call__(self, logger: WrappedLogger, name: str, event_dict: EventDict):
+        render_objects = {}
+        for key in self._render_keys:
+            obj = event_dict.pop(key, None)
+            if obj is not None:
+                render_objects[key] = obj
+
+        result = super().__call__(logger, name, event_dict)
+        sio = StringIO()
+        sio.write(result)
+
+        for key, obj in render_objects.items():
+            string_rep = str(obj)
+            sio.write(
+                "\n"
+                + "    ["
+                + self._styles.kv_key
+                + key
+                + self._styles.reset
+                + "]"
+                + "\n"
+                + textwrap.indent(string_rep, prefix="    " + self._styles.kv_value)
+                + self._styles.reset
+            )
+
+        return sio.getvalue()
+
+
+def setup_logging(
+    log_level=logging.INFO,
+    log_stream=sys.stderr,
+    timestamp_format="%Y-%m-%d %H:%M:%S.%f",
+):
+    """Configures structlog and logging with sane defaults."""
+
+    if structlog_installed:
+        # Redirect all logs submitted to logging to structlog
+        logging.basicConfig(
+            format="%(message)s",
+            level=log_level,
+            handlers=[StructlogHandler()],
+        )
+        # Configure structlog
+        structlog.configure(
+            processors=[
+                structlog.contextvars.merge_contextvars,
+                structlog.processors.StackInfoRenderer(),
+                structlog.dev.set_exc_info,
+                structlog.processors.add_log_level,
+                structlog.processors.TimeStamper(timestamp_format),
+                PydiverseConsoleRenderer(
+                    render_keys=["query", "table_obj", "task", "table", "detail"]
+                ),
+            ],
+            wrapper_class=structlog.make_filtering_bound_logger(log_level),
+            logger_factory=structlog.PrintLoggerFactory(log_stream),
+            cache_logger_on_first_use=True,
+        )
+    else:
+        logging.basicConfig(
+            format="%(message)s",
+            level=log_level,
+        )

pydiverse/common/version.py

@@ -0,0 +1,10 @@
+# Copyright (c) QuantCo and pydiverse contributors 2025-2025
+# SPDX-License-Identifier: BSD-3-Clause
+
+from importlib.metadata import PackageNotFoundError, version
+
+try:
+    __version__ = version(__package__ or __name__)
+except PackageNotFoundError:
+    # Running from a Git checkout or an editable install
+    __version__ = "0.0.0+dev"

pydiverse_common-0.3.2.dist-info/METADATA

@@ -0,0 +1,64 @@
+Metadata-Version: 2.4
+Name: pydiverse-common
+Version: 0.3.2
+Summary: Common functionality shared between pydiverse libraries
+Author: QuantCo, Inc.
+Author-email: Martin Trautmann <windiana@users.sf.net>, Finn Rudolph <finn.rudolph@t-online.de>
+License: BSD 3-Clause License
+        
+        Copyright (c) 2022, pydiverse
+        All rights reserved.
+        
+        Redistribution and use in source and binary forms, with or without
+        modification, are permitted provided that the following conditions are met:
+        
+        1. Redistributions of source code must retain the above copyright notice, this
+           list of conditions and the following disclaimer.
+        
+        2. Redistributions in binary form must reproduce the above copyright notice,
+           this list of conditions and the following disclaimer in the documentation
+           and/or other materials provided with the distribution.
+        
+        3. Neither the name of the copyright holder nor the names of its
+           contributors may be used to endorse or promote products derived from
+           this software without specific prior written permission.
+        
+        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: BSD License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: SQL
+Classifier: Topic :: Database
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Software Development
+Description-Content-Type: text/markdown
+
+# pydiverse.common
+
+[![CI](https://github.com/pydiverse/pydiverse.common/actions/workflows/tests.yml/badge.svg)](https://github.com/pydiverse/pydiverse.common/actions/workflows/tests.yml)
+
+A base package for different libraries in the pydiverse library collection.
+This includes functionality like a type-system for tabular data (SQL and DataFrame).
+This type-system is used for ensuring reliable operation of the pydiverse library
+with various execution backends like Pandas, Polars, and various SQL dialects.
+
+## Usage
+
+pydiverse.common can either be installed via pypi with `pip install pydiverse-common` or via
+conda-forge with `conda install pydiverse-common -c conda-forge`.

pydiverse_common-0.3.2.dist-info/RECORD

@@ -0,0 +1,16 @@
+pydiverse/common/__init__.py,sha256=eK3Wji6868cvXeq6e9YPRxi20vU6i9Lql4IzG6iB4B4,784
+pydiverse/common/dtypes.py,sha256=OtxOLnA5HIX9OandrrSgKS8bzERnntLRvQF-hSzvlbU,12509
+pydiverse/common/version.py,sha256=1IU_m4r76_Qq0u-Tyo2_bERZFOkh0ZFueVzDqcCfLO0,336
+pydiverse/common/errors/__init__.py,sha256=FNeEfVbUa23b9sHkFsmxHYhY6sRgjaZysPQmlovpJrI,262
+pydiverse/common/util/__init__.py,sha256=fGdKZtLaTVBW7NfCpX7rZhKHwUzmBnsuY2akDOnAnjc,315
+pydiverse/common/util/computation_tracing.py,sha256=HeXRHRUI8vxpzQ27Xcpa0StndSTP63EMT9vj4trPJUY,9697
+pydiverse/common/util/deep_map.py,sha256=JtY5ViWMMelOiLzPF7ZjzruCfB-bETISGxCk37qETxg,2540
+pydiverse/common/util/deep_merge.py,sha256=bV5p5_lsC-9nFah28EiEyG2h6U3Z5AuTqSooxOgCHN0,1929
+pydiverse/common/util/disposable.py,sha256=4XoGz70YRWA9TAqnUBvRCTAdsOGBviFN0gzxU7veY9o,993
+pydiverse/common/util/hashing.py,sha256=6x77BKg-w61u59fuTe9di0BtU-kEKH6UTRcKsRoYJ84,1196
+pydiverse/common/util/import_.py,sha256=K7dSgz4YyrqEvqhoOzbwgD7D8HScMoO5XoSWtjbaoUs,4056
+pydiverse/common/util/structlog.py,sha256=g0d8yaXBzAxmGNGZYMnMP9dsSQ__jN44GAY8Mb0ABeI,3487
+pydiverse_common-0.3.2.dist-info/METADATA,sha256=fwld0ZxdHloPOoeRj-X9WLZPwrNpQ4QuYeD1BZJ7qPo,3333
+pydiverse_common-0.3.2.dist-info/WHEEL,sha256=tkmg4JIqwd9H8mL30xA7crRmoStyCtGp0VWshokd1Jc,105
+pydiverse_common-0.3.2.dist-info/licenses/LICENSE,sha256=AcE6SDVuAq6v9ZLE_8eOCe_NvSE0rAPR3NR7lSowYh4,1517
+pydiverse_common-0.3.2.dist-info/RECORD,,

pydiverse_common-0.3.2.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py2-none-any
+Tag: py3-none-any

pydiverse_common-0.3.2.dist-info/licenses/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2022, pydiverse
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.