sqlquack 0.3.0__cp312-abi3-win_amd64.whl

sqlquack/__init__.py

@@ -0,0 +1,23 @@
+"""Check Snowflake SQL and convert it into DuckDB SQL, as the sqlquack command line does."""
+
+from __future__ import annotations
+
+from sqlquack._native import __version__
+from sqlquack.api.exceptions import SqlQuackError
+from sqlquack.api.main.check import check
+from sqlquack.api.main.convert import convert
+from sqlquack.api.main.udf import udf
+from sqlquack.api.models import CheckResult, Conversion, ConvertOptions, Diagnostic, Span
+
+__all__ = [
+    "CheckResult",
+    "Conversion",
+    "ConvertOptions",
+    "Diagnostic",
+    "Span",
+    "SqlQuackError",
+    "__version__",
+    "check",
+    "convert",
+    "udf",
+]

sqlquack/_native.pyd

@@ -0,0 +1,4 @@
+[diffend] Oversized file quarantined before diffing.
+name: sqlquack/_native.pyd
+size: 67441664 bytes
+sha256: 8fdd33a5d2d53696c904b05f822581575e672e6e5ea85cd48e32c3978691b74b

sqlquack/_native.pyi

@@ -0,0 +1,9 @@
+"""The native module the ``sqlquack`` package wraps; use the package's functions instead."""
+
+__version__: str
+
+def check_json(sql: str, path: str) -> str:
+    """``{"report": <check --json report>, "rendered": <text>}``; ``ValueError`` without SQL."""
+
+def convert_json(sql: str, request: str, path: str) -> str:
+    """``{"report": <convert --json report>, "rendered": <text>}``; ``ValueError`` on exit 2."""

sqlquack/api/__init__.py

@@ -0,0 +1 @@
+"""The sqlquack API: `check` and `convert`, mirroring the command line."""

sqlquack/api/_helpers/__init__.py

@@ -0,0 +1 @@
+"""api _helpers package."""

sqlquack/api/_helpers/reports.py

@@ -0,0 +1,41 @@
+"""The native module's JSON reports as typed results."""
+
+from __future__ import annotations
+
+import json
+import os
+from collections.abc import Callable, Mapping
+from typing import Any
+
+from sqlquack.api.exceptions import SqlQuackError
+from sqlquack.api.models import Diagnostic, Span
+
+
+def loaded(call: Callable[[], str]) -> dict[str, Any]:
+    """The native call's JSON, with its errors raised as `SqlQuackError`."""
+    try:
+        text: str = call()
+    except ValueError as error:
+        raise SqlQuackError(str(error)) from None
+    return json.loads(text)
+
+
+def path_argument(value: str | os.PathLike[str] | None) -> str | None:
+    """A path argument as the native module takes it."""
+    return None if value is None else os.fspath(value)
+
+
+def diagnostic(fields: Mapping[str, Any]) -> Diagnostic:
+    """A diagnostic from its JSON fields."""
+    span: Mapping[str, int] | None = fields["span"]
+    return Diagnostic(
+        code=fields["code"],
+        name=fields["name"],
+        alias=fields["alias"],
+        severity=fields["severity"],
+        message=fields["message"],
+        span=None if span is None else Span(**span),
+        label=fields["label"],
+        notes=tuple(fields["notes"]),
+        help=fields["help"],
+    )

sqlquack/api/constants.py

@@ -0,0 +1,5 @@
+"""Defaults of the sqlquack API."""
+
+from __future__ import annotations
+
+DEFAULT_PATH: str = "<string>"

sqlquack/api/exceptions.py

@@ -0,0 +1,7 @@
+"""Failures of the sqlquack API."""
+
+from __future__ import annotations
+
+
+class SqlQuackError(ValueError):
+    """The SQL could not be checked or converted at all, where the command line exits 2."""

sqlquack/api/main/__init__.py

@@ -0,0 +1 @@
+"""api main package."""

sqlquack/api/main/check.py

@@ -0,0 +1,21 @@
+"""`check`: what `sqlquack check` reports."""
+
+from __future__ import annotations
+
+from typing import Any
+
+from sqlquack._native import check_json
+from sqlquack.api._helpers.reports import diagnostic, loaded
+from sqlquack.api.constants import DEFAULT_PATH
+from sqlquack.api.models import CheckResult
+
+
+def check(*, sql: str, path: str = DEFAULT_PATH) -> CheckResult:
+    """Parse `sql` and find what Snowflake rejects, naming it `path`; no SQL raises."""
+    result: dict[str, Any] = loaded(lambda: check_json(sql, path))
+    report: dict[str, Any] = result["report"]
+    return CheckResult(
+        ok=report["ok"],
+        diagnostics=tuple(diagnostic(found) for found in report["diagnostics"]),
+        rendered=result["rendered"],
+    )

sqlquack/api/main/convert.py

@@ -0,0 +1,48 @@
+"""`convert`: what `sqlquack convert` reports, with one option per command-line flag."""
+
+from __future__ import annotations
+
+import json
+from typing import Any
+
+from sqlquack._native import convert_json
+from sqlquack.api._helpers.reports import diagnostic, loaded, path_argument
+from sqlquack.api.constants import DEFAULT_PATH
+from sqlquack.api.models import Conversion, ConvertOptions
+
+
+def convert(
+    *, sql: str, options: ConvertOptions | None = None, path: str = DEFAULT_PATH
+) -> Conversion:
+    """Convert `sql` or refuse it as `sqlquack convert` does; exit-2 failures raise."""
+    chosen: ConvertOptions = options or ConvertOptions()
+    request: dict[str, Any] = {
+        "project": path_argument(chosen.project),
+        "schema": None if chosen.schema is None else dict(chosen.schema),
+        "policy": path_argument(chosen.policy),
+        "builtin_policy": chosen.builtin_policy,
+        "session": dict(chosen.session),
+        "strict": chosen.strict,
+        "utc_session": chosen.utc_session,
+        "confirm_declared_offsets": chosen.confirm_declared_offsets,
+        "python_runtime": chosen.python_runtime,
+        "loud_divergences_only": chosen.loud_divergences_only,
+        "overrides": path_argument(chosen.overrides),
+        "verified_overrides": dict(chosen.verified_overrides),
+        "compact": chosen.compact,
+    }
+    result: dict[str, Any] = loaded(lambda: convert_json(sql, json.dumps(request), path))
+    report: dict[str, Any] = result["report"]
+    return Conversion(
+        converted=report["converted"],
+        sql=report["sql"],
+        macros=tuple(report["macros"]),
+        profile=report["profile"],
+        diagnostics=tuple(diagnostic(refusal) for refusal in report["refusals"]),
+        divergences={name: tuple(uses) for name, uses in report["divergences"].items()},
+        assumptions=tuple(report["assumptions"]),
+        divergence_failures=dict(report["divergence_failures"]),
+        notes=tuple(report["notes"]),
+        rendered=result["rendered"],
+        report=report,
+    )

sqlquack/api/main/udf.py

@@ -0,0 +1,16 @@
+"""`udf`: marks a project's Python function, as SQLBuild's `sqlbuild.functions.udf` does."""
+
+from __future__ import annotations
+
+from collections.abc import Callable
+from typing import Any
+
+
+def udf(**kwargs: object) -> Callable[[Callable[..., Any]], Callable[..., Any]]:
+    """Mark a Python function as a project function; its keywords are read statically."""
+    del kwargs
+
+    def _decorate(function: Callable[..., Any]) -> Callable[..., Any]:
+        return function
+
+    return _decorate

sqlquack/api/models.py

@@ -0,0 +1,80 @@
+"""Diagnostics and results, as the command line reports them."""
+
+from __future__ import annotations
+
+import os
+from collections.abc import Mapping
+from dataclasses import dataclass, field
+from typing import Any
+
+
+@dataclass(frozen=True)
+class Span:
+    """Where a diagnostic points: character offsets, then one-based line and column positions."""
+
+    start: int
+    end: int
+    line: int
+    column: int
+    end_line: int
+    end_column: int
+
+
+@dataclass(frozen=True)
+class Diagnostic:
+    """One coded problem; `span` is absent only for problems outside the SQL, like sessions."""
+
+    code: str
+    name: str
+    alias: str | None
+    severity: str
+    message: str
+    span: Span | None
+    label: str
+    notes: tuple[str, ...]
+    help: str | None
+
+
+@dataclass(frozen=True)
+class CheckResult:
+    """What `check` found, with `rendered` as the command line prints it."""
+
+    ok: bool
+    diagnostics: tuple[Diagnostic, ...]
+    rendered: str
+
+
+@dataclass(frozen=True)
+class Conversion:
+    """DuckDB SQL or the refusing diagnostics; `report` is exactly `convert --json`'s."""
+
+    converted: bool
+    sql: str
+    macros: tuple[str, ...]
+    profile: str
+    diagnostics: tuple[Diagnostic, ...]
+    divergences: Mapping[str, tuple[str, ...]]
+    assumptions: tuple[str, ...]
+    divergence_failures: Mapping[str, str]
+    notes: tuple[str, ...]
+    rendered: str
+    report: Mapping[str, Any]
+
+
+@dataclass(frozen=True)
+class ConvertOptions:
+    """The `sqlquack convert` flags, one field each, and `schema`, declarations held in memory."""
+
+    project: str | os.PathLike[str] | None = None
+    schema: Mapping[str, Any] | None = None
+    policy: str | os.PathLike[str] | None = None
+    builtin_policy: bool = False
+    session: Mapping[str, str] = field(default_factory=dict)
+    strict: bool = False
+    utc_session: bool = False
+    confirm_declared_offsets: bool = False
+    python_runtime: bool = False
+    loud_divergences_only: bool = False
+    overrides: str | os.PathLike[str] | None = None
+    verified_overrides: Mapping[str, str] = field(default_factory=dict)
+    compact: bool = False

sqlquack-0.3.0.dist-info/METADATA

@@ -0,0 +1,9 @@
+Metadata-Version: 2.4
+Name: sqlquack
+Version: 0.3.0
+Requires-Dist: sqlquack-cli==0.3.0
+License-File: LICENSE
+License-File: THIRD_PARTY_NOTICES
+Summary: Check Snowflake SQL and convert it into DuckDB SQL, or refuse it with coded diagnostics.
+License-Expression: Apache-2.0 AND MIT
+Requires-Python: >=3.12

sqlquack-0.3.0.dist-info/RECORD

@@ -0,0 +1,20 @@
+sqlquack/__init__.py,sha256=8suGQHnRi7odGAKCF1kb2Mi-hh92R4IzImSIlGoDNec,643
+sqlquack/_native.pyd,sha256=j90zpdLVNpbJBLBfgiWBV15nLm5eqFzUjjLDl4aRt0s,67441664
+sqlquack/_native.pyi,sha256=L6_qh8XLQTuTikI8HMo3RZBAQn3ujRP-kxS4IY9vwxg,420
+sqlquack/api/__init__.py,sha256=7JytRgm1iutdMCgdz7dX3uznwmzJEN5Pe9UeV97hy7E,76
+sqlquack/api/_helpers/__init__.py,sha256=uShqKKzf9Q-mlGQSDzq-sACrkd58wMS7RlukCHRhUnI,29
+sqlquack/api/_helpers/reports.py,sha256=0NAFTAOHTvhK1tbkcDQgmkKo7KAYZXegUn0lctPXFXU,1288
+sqlquack/api/constants.py,sha256=t6NEUY8Ro3ig6rfv22SgTAWFO74l4ceOhzcwhYvXxeM,109
+sqlquack/api/exceptions.py,sha256=tTFdS3rmEpX1FgabG7rOzbuKNC5dQh-_ZYND_6DUXbg,206
+sqlquack/api/main/__init__.py,sha256=Ra5ZTysl9K1B5sxiJ0UquadaD8EY70ltKhYSyWp7loA,25
+sqlquack/api/main/check.py,sha256=oTFcAPW77EgCOPedktBhl6CSjR8E2LJmIfVLvdy4u58,762
+sqlquack/api/main/convert.py,sha256=McGxCQPzayEzLq5eB5Y7tRZc5eTdpi-U6pPIzJORjmc,2092
+sqlquack/api/main/udf.py,sha256=b_6jg63sXMuSQ4q9WE0JB9zorVAsy1vZ1mbsdhlJF88,512
+sqlquack/api/models.py,sha256=06fY06aZVai_lrrXfVLTkGnAe9Blhp3tRDr9uoaeKEM,2187
+sqlquack/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+sqlquack-0.3.0.dist-info/METADATA,sha256=AvTpu-ymTAPNYoBPeeFzdIfv0DmuXcY72ndhMXhtLU0,304
+sqlquack-0.3.0.dist-info/WHEEL,sha256=frxxrLnlIAj9_4xWoM1LytQSnn-rPtE_w9IecHETOYQ,96
+sqlquack-0.3.0.dist-info/licenses/LICENSE,sha256=HrhfyXIkWY2tGFK11kg7vPCqhgh5DcxleloqdhrpyMY,11558
+sqlquack-0.3.0.dist-info/licenses/THIRD_PARTY_NOTICES,sha256=Zoz6ipNhJYVDhgYRTOq3JSHSV17k7b_lJ_15CTAzu2I,9508
+sqlquack-0.3.0.dist-info/sboms/sqlquack-python.cyclonedx.json,sha256=-ojL2jw3yLgrIl9xfYhMmG-g6iXKnauTJc7vbavrxns,216645
+sqlquack-0.3.0.dist-info/RECORD,,

sqlquack-0.3.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: maturin (1.16.0)
+Root-Is-Purelib: false
+Tag: cp312-abi3-win_amd64

sqlquack-0.3.0.dist-info/licenses/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.