ob-driver-core 0.1.0__py3-none-any.whl

ob_driver_core/__init__.py

@@ -0,0 +1,5 @@
+"""OrionBelt DB-API 2.0 driver core — shared PEP 249 types, OBML detection, compilation bridge."""
+
+from __future__ import annotations
+
+__version__ = "0.1.0"

ob_driver_core/compiler.py

@@ -0,0 +1,52 @@
+"""OrionBelt compilation bridge for DB-API 2.0 drivers.
+
+Compiles OBML query dicts to SQL by calling the OrionBelt REST API.
+Assumes the API is running in single-model mode (MODEL_FILE set).
+Uses the ``/v1/query/sql`` shortcut endpoint — no session or model ID required.
+"""
+
+from __future__ import annotations
+
+import logging
+from typing import Any
+
+from ob_driver_core.exceptions import OperationalError, ProgrammingError
+
+logger = logging.getLogger(__name__)
+
+
+def compile_obml(
+    obml: dict[str, Any],
+    *,
+    dialect: str,
+    ob_api_url: str = "http://localhost:8000",
+    ob_timeout: int = 30,
+) -> str:
+    """Compile an OBML query dict to SQL via the OrionBelt REST API.
+
+    Calls ``POST /v1/query/sql?dialect=...`` which auto-resolves the
+    single session and model in single-model mode.
+    """
+    import httpx
+
+    url = f"{ob_api_url.rstrip('/')}/v1/query/sql"
+    try:
+        response = httpx.post(
+            url,
+            params={"dialect": dialect},
+            json=obml,
+            timeout=ob_timeout,
+        )
+    except httpx.ConnectError as exc:
+        raise OperationalError(f"OB API unavailable at {ob_api_url}: {exc}") from exc
+
+    if not response.is_success:
+        try:
+            detail = response.json().get("detail", response.text)
+        except Exception:
+            detail = response.text
+        if response.status_code < 500:
+            raise ProgrammingError(f"OB compile error: {detail}")
+        raise OperationalError(f"OB API error: {detail}")
+
+    return response.json()["sql"]  # type: ignore[no-any-return]

ob_driver_core/detection.py

@@ -0,0 +1,36 @@
+"""OBML YAML query detection.
+
+Determines whether a query string is an OBML semantic query or plain SQL.
+"""
+
+from __future__ import annotations
+
+from typing import Any
+
+import yaml
+
+
+def is_obml(query: str) -> bool:
+    """Return True if *query* is an OBML YAML query (starts with ``select:`` and
+    contains ``dimensions`` or ``measures``).
+    """
+    stripped = query.strip()
+    if not stripped.lower().startswith("select:"):
+        return False
+    try:
+        parsed = yaml.safe_load(stripped)
+    except yaml.YAMLError:
+        return False
+    if not isinstance(parsed, dict):
+        return False
+    # YAML preserves key case — normalise to lowercase for lookup
+    lower_keys = {k.lower() if isinstance(k, str) else k: v for k, v in parsed.items()}
+    select = lower_keys.get("select", {})
+    if not isinstance(select, dict):
+        return False
+    return "dimensions" in select or "measures" in select
+
+
+def parse_obml(query: str) -> dict[str, Any]:
+    """Parse an OBML YAML string into a dict. Call only after :func:`is_obml`."""
+    return yaml.safe_load(query.strip())  # type: ignore[return-value]

ob_driver_core/exceptions.py

@@ -0,0 +1,57 @@
+"""PEP 249 DB-API 2.0 exception hierarchy.
+
+Hierarchy (per PEP 249):
+    StandardError (builtin Exception)
+    ├── Warning
+    └── Error
+        ├── InterfaceError
+        └── DatabaseError
+            ├── DataError
+            ├── OperationalError
+            ├── IntegrityError
+            ├── InternalError
+            ├── ProgrammingError
+            └── NotSupportedError
+"""
+
+from __future__ import annotations
+
+
+class Warning(Exception):  # noqa: A001
+    """Exception raised for important warnings (e.g. data truncation)."""
+
+
+class Error(Exception):
+    """Base class for all DB-API errors."""
+
+
+class InterfaceError(Error):
+    """Exception for errors related to the database interface, not the database itself."""
+
+
+class DatabaseError(Error):
+    """Exception for errors related to the database."""
+
+
+class DataError(DatabaseError):
+    """Exception for errors due to problems with processed data."""
+
+
+class OperationalError(DatabaseError):
+    """Exception for errors related to the database's operation."""
+
+
+class IntegrityError(DatabaseError):
+    """Exception for errors related to database integrity."""
+
+
+class InternalError(DatabaseError):
+    """Exception for internal database errors."""
+
+
+class ProgrammingError(DatabaseError):
+    """Exception for programming errors (e.g. bad SQL, table not found)."""
+
+
+class NotSupportedError(DatabaseError):
+    """Exception for optional features not supported by the database."""

ob_driver_core/type_codes.py

@@ -0,0 +1,41 @@
+"""PEP 249 DB-API 2.0 type objects.
+
+Type objects compare equal to any value in their set, enabling:
+    if cursor.description[i][1] == NUMBER:
+        ...
+"""
+
+from __future__ import annotations
+
+
+class DBAPITypeObject:
+    """PEP 249 type object that compares equal to any value in its set."""
+
+    def __init__(self, *values: str) -> None:
+        self._values = frozenset(values)
+
+    def __eq__(self, other: object) -> bool:
+        if isinstance(other, str):
+            return other in self._values
+        if isinstance(other, DBAPITypeObject):
+            return self._values == other._values
+        return NotImplemented
+
+    def __hash__(self) -> int:
+        return hash(self._values)
+
+    def __repr__(self) -> str:
+        return f"DBAPITypeObject({', '.join(sorted(self._values))})"
+
+
+STRING = DBAPITypeObject("STRING", "VARCHAR", "TEXT", "CHAR", "NVARCHAR", "NCHAR")
+BINARY = DBAPITypeObject("BINARY", "BLOB", "VARBINARY", "BYTEA", "BYTES")
+NUMBER = DBAPITypeObject(
+    "NUMBER", "INT", "INTEGER", "BIGINT", "SMALLINT", "TINYINT",
+    "FLOAT", "DOUBLE", "DECIMAL", "NUMERIC", "REAL", "HUGEINT",
+)
+DATETIME = DBAPITypeObject(
+    "DATETIME", "DATE", "TIME", "TIMESTAMP", "TIMESTAMPTZ",
+    "TIMESTAMP_NTZ", "TIMESTAMP_LTZ", "TIMESTAMP_TZ",
+)
+ROWID = DBAPITypeObject("ROWID")

ob_driver_core-0.1.0.dist-info/METADATA

@@ -0,0 +1,33 @@
+Metadata-Version: 2.4
+Name: ob-driver-core
+Version: 0.1.0
+Summary: Shared foundation for OrionBelt DB-API 2.0 drivers (PEP 249 types, OBML detection, compilation bridge)
+Author-email: Ralf Becher <info@orionbelt.ai>
+License: BSL-1.1
+License-File: LICENSE
+Keywords: db-api,obml,orionbelt,pep249,semantic-layer
+Requires-Python: >=3.12
+Requires-Dist: httpx>=0.27
+Requires-Dist: pyyaml>=6.0
+Provides-Extra: dev
+Requires-Dist: mypy>=1.10; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: respx>=0.21; extra == 'dev'
+Requires-Dist: ruff>=0.4; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# ob-driver-core
+
+Shared foundation for OrionBelt DB-API 2.0 drivers (PEP 249 types, OBML detection, compilation bridge)
+
+Part of the [OrionBelt Semantic Layer](https://github.com/ralfbecher/orionbelt-semantic-layer) project.
+
+## Installation
+
+```bash
+pip install ob-driver-core
+```
+
+## License
+
+BSL-1.1 — see [LICENSE](LICENSE) for details.

ob_driver_core-0.1.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+ob_driver_core/__init__.py,sha256=5ML4GMa91DEBu4dg4cPlgGGgQjfiVqVA5lwD47SEMG4,160
+ob_driver_core/compiler.py,sha256=Hwysknr0xVsX77LQJwsWcJWvuw76BqPCt1G8ltMqdFw,1574
+ob_driver_core/detection.py,sha256=VIZ19epE0JPJmWgAYsBCNP6MoN-jGFR_wGBNiUAW-Fc,1125
+ob_driver_core/exceptions.py,sha256=IQmMSKyxvi1hqUvHxC0BnOmh-Xwxqd-WhZcKB6p7u1M,1503
+ob_driver_core/type_codes.py,sha256=XUlfsDOzW8HzNSTIbJejJm2MERC7ALp1ukkkYe0VazM,1292
+ob_driver_core-0.1.0.dist-info/METADATA,sha256=6A7SV6VjYUZ3iTlzk0o93zinGedRzcmIWNAMeeYtB4U,961
+ob_driver_core-0.1.0.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
+ob_driver_core-0.1.0.dist-info/licenses/LICENSE,sha256=t-vr73N5s2w6yxpCnwo5r_QuB5_u6FuEovAYMjlfe7E,3378
+ob_driver_core-0.1.0.dist-info/RECORD,,

ob_driver_core-0.1.0.dist-info/WHEEL

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

ob_driver_core-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,70 @@
+Business Source License 1.1
+
+Parameters
+
+Licensor:             RALFORION d.o.o.
+Licensed Work:        OrionBelt Semantic Layer 1.0
+                      The Licensed Work is (c) 2025 RALFORION d.o.o.
+Additional Use Grant: You may use the Licensed Work for any purpose,
+                      including production use, PROVIDED THAT you may
+                      not embed OrionBelt in a commercial product or
+                      provide it as part of a commercial service
+                      without purchasing a commercial license from
+                      the Licensor. Contact licensing@ralforion.com
+                      for commercial licensing inquiries.
+Change Date:          2030-03-16
+Change License:       Apache License, Version 2.0
+
+-----------------------------------------------------------------------------
+
+Business Source License 1.1
+
+License text copyright (c) 2017 MariaDB Corporation Ab, All Rights Reserved.
+"Business Source License" is a trademark of MariaDB Corporation Ab.
+
+Terms
+
+The Licensor hereby grants you the right to copy, modify, create derivative
+works, redistribute, and make non-production use of the Licensed Work. The
+Licensor may make an Additional Use Grant, above, permitting limited
+production use.
+
+Effective on the Change Date, or the fourth anniversary of the first publicly
+available distribution of a specific version of the Licensed Work under this
+License, whichever comes first, the Licensor hereby grants you rights under
+the terms of the Change License, and the rights granted in the paragraph
+above terminate.
+
+If your use of the Licensed Work does not comply with the requirements
+currently in effect as described in this License, you must purchase a
+commercial license from the Licensor, its affiliated entities, or authorized
+resellers, or you must refrain from using the Licensed Work.
+
+All copies of the original and modified Licensed Work, and derivative works
+of the Licensed Work, are subject to this License. This License applies
+separately for each version of the Licensed Work and the Change Date may vary
+for each version of the Licensed Work released by Licensor.
+
+You must conspicuously display this License on each original or modified copy
+of the Licensed Work. If you receive the Licensed Work in original or
+modified form from a third party, the terms and conditions set forth in this
+License apply to your use of that work.
+
+Any use of the Licensed Work in violation of this License will automatically
+terminate your rights under this License for the current and all other
+versions of the Licensed Work.
+
+This License does not grant you any right in any trademark or logo of
+Licensor or its affiliates (provided that you may use a trademark or logo of
+Licensor as expressly required by this License).
+
+TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE LICENSED WORK IS PROVIDED ON
+AN "AS IS" BASIS. LICENSOR HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
+EXPRESS OR IMPLIED, INCLUDING (WITHOUT LIMITATION) WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND
+TITLE.
+
+MariaDB hereby grants you permission to use this License's text to license
+your works, and to refer to it using the trademark "Business Source License",
+as long as you comply with the Covenants of Licensor of MariaDB's Business Source
+License Trademark Policy available at https://mariadb.com/bsl11/.