periplus-python-sdk 0.2.0__tar.gz → 0.4.0__tar.gz

periplus_python_sdk-0.4.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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.

periplus_python_sdk-0.4.0/NOTICE

@@ -0,0 +1,2 @@
+Periplus
+Copyright (c) 2026 Ekku Leivonen (elei.io)

{periplus_python_sdk-0.2.0 → periplus_python_sdk-0.4.0}/PKG-INFO

@@ -1,13 +1,17 @@
 Metadata-Version: 2.4
 Name: periplus-python-sdk
-Version: 0.2.0
+Version: 0.4.0
 Summary: Read-only Python client for the public Periplus query API
+License-Expression: Apache-2.0
 Project-URL: Repository, https://github.com/elei-io/periplus
 Project-URL: Issues, https://github.com/elei-io/periplus/issues
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
 Requires-Dist: httpx>=0.28
 Requires-Dist: pydantic<3,>=2.12
+Dynamic: license-file
 
 # Periplus Python SDK
 
@@ -20,7 +24,7 @@ from periplus_sdk import Client
 
 with Client("http://localhost:8080") as client:
     result = client.execute(
-        "SELECT observation_id FROM web.observation LIMIT ?", [10]
+        "SELECT capture_id FROM public_v1.capture LIMIT ?", [10]
     )
     print(result.columns, result.types)
     print(result.rows)
@@ -31,11 +35,26 @@ For a hosted deployment, replace the URL with its public HTTPS origin. Alternati
 `PERIPLUS_PUBLIC_URL` and use `Client()`. An optional URL path prefix is preserved.
 The client reuses HTTP connections; close it with a context manager or `close()`.
 
+## Stable and experimental APIs
+
+Both clients accept `mode="stable"` (the default) or `mode="experimental"` at initialization:
+
+```python
+with Client("https://periplus.dev", mode="experimental") as client:
+    result = client.execute("SELECT capture_id FROM public_v1.capture LIMIT 1")
+    print(result.query_mode, result.compiler_version, result.optimizations)
+```
+
+The selected mode applies to preparation, execution, and helper discovery. Experimental
+requests use the public application's `/api/query/experimental/` routes. There is no
+automatic fallback to stable if the experimental service is unavailable.
+`AsyncClient` accepts the same option. Invalid modes raise `ConfigurationError`.
+
 ## Preparation and helpers
 
 ```python
 with Client("http://localhost:8080") as client:
-    prepared = client.prepare("SELECT observation_id FROM web.observation LIMIT ?", [10])
+    prepared = client.prepare("SELECT capture_id FROM public_v1.capture LIMIT ?", [10])
     print(prepared.diagnostics, prepared.plan)
     result = client.execute(prepared.sql, prepared.parameters)
     helpers = client.helpers()
@@ -53,7 +72,7 @@ from periplus_sdk import AsyncClient
 
 async def observations():
     async with AsyncClient("http://localhost:8080") as client:
-        return await client.execute("SELECT observation_id FROM web.observation LIMIT 10")
+        return await client.execute("SELECT capture_id FROM public_v1.capture LIMIT 10")
 ```
 
 Use `aclose()` when managing an async client's lifetime explicitly.
@@ -78,13 +97,14 @@ Use `aclose()` when managing an async client's lifetime explicitly.
 
 ## Installation and verification
 
-Install from PyPI:
+Install the public-v1 client from PyPI:
 
 ```sh
-python -m pip install periplus-python-sdk==0.2.0
+python -m pip install "periplus-python-sdk>=0.4.0"
 ```
 
-For local development: `python -m pip install ./packages/periplus-python-sdk`.
+Version 0.4.0 supports the current public-v1 contract. For production, configure
+`PERIPLUS_PUBLIC_URL=https://periplus.dev`; no API token is required.
 Run the installed package against an available public app:
 
 ```sh
@@ -95,14 +115,24 @@ PERIPLUS_PUBLIC_URL=http://localhost:8080 python packages/periplus-python-sdk/ex
 
 Repository CI publishes immutable releases from tags named
 `periplus-python-sdk-v<version>`. The tag must exactly match the static version
-in `pyproject.toml`; for example, version `0.2.0` is released with:
+in `pyproject.toml`; for example, version `0.4.0` is released with:
 
 ```sh
-git tag periplus-python-sdk-v0.2.0
-git push origin periplus-python-sdk-v0.2.0
+git tag periplus-python-sdk-v0.4.0
+git push origin periplus-python-sdk-v0.4.0
 ```
 
 PyPI publishing uses Trusted Publishing rather than a stored API token. The
 PyPI publisher must be configured for GitHub owner `elei-io`, repository
 `periplus`, workflow `python-sdk-release.yml`, and environment `pypi`. Protect
 that GitHub environment with required reviewers before the first release.
+
+## Public v1
+
+Install the updated SDK from PyPI with `python -m pip install "periplus-python-sdk>=0.4.0"`. The previously published 0.2.0 release predates this contract. `prepare` and `execute` accept keyword-only `schema_version="public_v1"` (the default); responses preserve `schema_version` separately from `source_snapshot`. Unavailable versions are rejected by the server.
+
+## License
+
+Copyright (c) 2026 Ekku Leivonen (elei.io). Licensed under [Apache-2.0](LICENSE);
+see [NOTICE](NOTICE). The server and other repository packages have separate
+licensing described in the root LICENSING.md.

{periplus_python_sdk-0.2.0 → periplus_python_sdk-0.4.0}/README.md

@@ -9,7 +9,7 @@ from periplus_sdk import Client
 
 with Client("http://localhost:8080") as client:
     result = client.execute(
-        "SELECT observation_id FROM web.observation LIMIT ?", [10]
+        "SELECT capture_id FROM public_v1.capture LIMIT ?", [10]
     )
     print(result.columns, result.types)
     print(result.rows)
@@ -20,11 +20,26 @@ For a hosted deployment, replace the URL with its public HTTPS origin. Alternati
 `PERIPLUS_PUBLIC_URL` and use `Client()`. An optional URL path prefix is preserved.
 The client reuses HTTP connections; close it with a context manager or `close()`.
 
+## Stable and experimental APIs
+
+Both clients accept `mode="stable"` (the default) or `mode="experimental"` at initialization:
+
+```python
+with Client("https://periplus.dev", mode="experimental") as client:
+    result = client.execute("SELECT capture_id FROM public_v1.capture LIMIT 1")
+    print(result.query_mode, result.compiler_version, result.optimizations)
+```
+
+The selected mode applies to preparation, execution, and helper discovery. Experimental
+requests use the public application's `/api/query/experimental/` routes. There is no
+automatic fallback to stable if the experimental service is unavailable.
+`AsyncClient` accepts the same option. Invalid modes raise `ConfigurationError`.
+
 ## Preparation and helpers
 
 ```python
 with Client("http://localhost:8080") as client:
-    prepared = client.prepare("SELECT observation_id FROM web.observation LIMIT ?", [10])
+    prepared = client.prepare("SELECT capture_id FROM public_v1.capture LIMIT ?", [10])
     print(prepared.diagnostics, prepared.plan)
     result = client.execute(prepared.sql, prepared.parameters)
     helpers = client.helpers()
@@ -42,7 +57,7 @@ from periplus_sdk import AsyncClient
 
 async def observations():
     async with AsyncClient("http://localhost:8080") as client:
-        return await client.execute("SELECT observation_id FROM web.observation LIMIT 10")
+        return await client.execute("SELECT capture_id FROM public_v1.capture LIMIT 10")
 ```
 
 Use `aclose()` when managing an async client's lifetime explicitly.
@@ -67,13 +82,14 @@ Use `aclose()` when managing an async client's lifetime explicitly.
 
 ## Installation and verification
 
-Install from PyPI:
+Install the public-v1 client from PyPI:
 
 ```sh
-python -m pip install periplus-python-sdk==0.2.0
+python -m pip install "periplus-python-sdk>=0.4.0"
 ```
 
-For local development: `python -m pip install ./packages/periplus-python-sdk`.
+Version 0.4.0 supports the current public-v1 contract. For production, configure
+`PERIPLUS_PUBLIC_URL=https://periplus.dev`; no API token is required.
 Run the installed package against an available public app:
 
 ```sh
@@ -84,14 +100,24 @@ PERIPLUS_PUBLIC_URL=http://localhost:8080 python packages/periplus-python-sdk/ex
 
 Repository CI publishes immutable releases from tags named
 `periplus-python-sdk-v<version>`. The tag must exactly match the static version
-in `pyproject.toml`; for example, version `0.2.0` is released with:
+in `pyproject.toml`; for example, version `0.4.0` is released with:
 
 ```sh
-git tag periplus-python-sdk-v0.2.0
-git push origin periplus-python-sdk-v0.2.0
+git tag periplus-python-sdk-v0.4.0
+git push origin periplus-python-sdk-v0.4.0
 ```
 
 PyPI publishing uses Trusted Publishing rather than a stored API token. The
 PyPI publisher must be configured for GitHub owner `elei-io`, repository
 `periplus`, workflow `python-sdk-release.yml`, and environment `pypi`. Protect
 that GitHub environment with required reviewers before the first release.
+
+## Public v1
+
+Install the updated SDK from PyPI with `python -m pip install "periplus-python-sdk>=0.4.0"`. The previously published 0.2.0 release predates this contract. `prepare` and `execute` accept keyword-only `schema_version="public_v1"` (the default); responses preserve `schema_version` separately from `source_snapshot`. Unavailable versions are rejected by the server.
+
+## License
+
+Copyright (c) 2026 Ekku Leivonen (elei.io). Licensed under [Apache-2.0](LICENSE);
+see [NOTICE](NOTICE). The server and other repository packages have separate
+licensing described in the root LICENSING.md.

{periplus_python_sdk-0.2.0 → periplus_python_sdk-0.4.0}/pyproject.toml

@@ -1,6 +1,8 @@
 [project]
+license = "Apache-2.0"
+license-files = ["LICENSE", "NOTICE"]
 name = "periplus-python-sdk"
-version = "0.2.0"
+version = "0.4.0"
 description = "Read-only Python client for the public Periplus query API"
 readme = "README.md"
 requires-python = ">=3.11"

{periplus_python_sdk-0.2.0 → periplus_python_sdk-0.4.0}/src/periplus_python_sdk.egg-info/PKG-INFO

@@ -1,13 +1,17 @@
 Metadata-Version: 2.4
 Name: periplus-python-sdk
-Version: 0.2.0
+Version: 0.4.0
 Summary: Read-only Python client for the public Periplus query API
+License-Expression: Apache-2.0
 Project-URL: Repository, https://github.com/elei-io/periplus
 Project-URL: Issues, https://github.com/elei-io/periplus/issues
 Requires-Python: >=3.11
 Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
 Requires-Dist: httpx>=0.28
 Requires-Dist: pydantic<3,>=2.12
+Dynamic: license-file
 
 # Periplus Python SDK
 
@@ -20,7 +24,7 @@ from periplus_sdk import Client
 
 with Client("http://localhost:8080") as client:
     result = client.execute(
-        "SELECT observation_id FROM web.observation LIMIT ?", [10]
+        "SELECT capture_id FROM public_v1.capture LIMIT ?", [10]
     )
     print(result.columns, result.types)
     print(result.rows)
@@ -31,11 +35,26 @@ For a hosted deployment, replace the URL with its public HTTPS origin. Alternati
 `PERIPLUS_PUBLIC_URL` and use `Client()`. An optional URL path prefix is preserved.
 The client reuses HTTP connections; close it with a context manager or `close()`.
 
+## Stable and experimental APIs
+
+Both clients accept `mode="stable"` (the default) or `mode="experimental"` at initialization:
+
+```python
+with Client("https://periplus.dev", mode="experimental") as client:
+    result = client.execute("SELECT capture_id FROM public_v1.capture LIMIT 1")
+    print(result.query_mode, result.compiler_version, result.optimizations)
+```
+
+The selected mode applies to preparation, execution, and helper discovery. Experimental
+requests use the public application's `/api/query/experimental/` routes. There is no
+automatic fallback to stable if the experimental service is unavailable.
+`AsyncClient` accepts the same option. Invalid modes raise `ConfigurationError`.
+
 ## Preparation and helpers
 
 ```python
 with Client("http://localhost:8080") as client:
-    prepared = client.prepare("SELECT observation_id FROM web.observation LIMIT ?", [10])
+    prepared = client.prepare("SELECT capture_id FROM public_v1.capture LIMIT ?", [10])
     print(prepared.diagnostics, prepared.plan)
     result = client.execute(prepared.sql, prepared.parameters)
     helpers = client.helpers()
@@ -53,7 +72,7 @@ from periplus_sdk import AsyncClient
 
 async def observations():
     async with AsyncClient("http://localhost:8080") as client:
-        return await client.execute("SELECT observation_id FROM web.observation LIMIT 10")
+        return await client.execute("SELECT capture_id FROM public_v1.capture LIMIT 10")
 ```
 
 Use `aclose()` when managing an async client's lifetime explicitly.
@@ -78,13 +97,14 @@ Use `aclose()` when managing an async client's lifetime explicitly.
 
 ## Installation and verification
 
-Install from PyPI:
+Install the public-v1 client from PyPI:
 
 ```sh
-python -m pip install periplus-python-sdk==0.2.0
+python -m pip install "periplus-python-sdk>=0.4.0"
 ```
 
-For local development: `python -m pip install ./packages/periplus-python-sdk`.
+Version 0.4.0 supports the current public-v1 contract. For production, configure
+`PERIPLUS_PUBLIC_URL=https://periplus.dev`; no API token is required.
 Run the installed package against an available public app:
 
 ```sh
@@ -95,14 +115,24 @@ PERIPLUS_PUBLIC_URL=http://localhost:8080 python packages/periplus-python-sdk/ex
 
 Repository CI publishes immutable releases from tags named
 `periplus-python-sdk-v<version>`. The tag must exactly match the static version
-in `pyproject.toml`; for example, version `0.2.0` is released with:
+in `pyproject.toml`; for example, version `0.4.0` is released with:
 
 ```sh
-git tag periplus-python-sdk-v0.2.0
-git push origin periplus-python-sdk-v0.2.0
+git tag periplus-python-sdk-v0.4.0
+git push origin periplus-python-sdk-v0.4.0
 ```
 
 PyPI publishing uses Trusted Publishing rather than a stored API token. The
 PyPI publisher must be configured for GitHub owner `elei-io`, repository
 `periplus`, workflow `python-sdk-release.yml`, and environment `pypi`. Protect
 that GitHub environment with required reviewers before the first release.
+
+## Public v1
+
+Install the updated SDK from PyPI with `python -m pip install "periplus-python-sdk>=0.4.0"`. The previously published 0.2.0 release predates this contract. `prepare` and `execute` accept keyword-only `schema_version="public_v1"` (the default); responses preserve `schema_version` separately from `source_snapshot`. Unavailable versions are rejected by the server.
+
+## License
+
+Copyright (c) 2026 Ekku Leivonen (elei.io). Licensed under [Apache-2.0](LICENSE);
+see [NOTICE](NOTICE). The server and other repository packages have separate
+licensing described in the root LICENSING.md.

{periplus_python_sdk-0.2.0 → periplus_python_sdk-0.4.0}/src/periplus_python_sdk.egg-info/SOURCES.txt

@@ -1,3 +1,5 @@
+LICENSE
+NOTICE
 README.md
 pyproject.toml
 src/periplus_python_sdk.egg-info/PKG-INFO

{periplus_python_sdk-0.2.0 → periplus_python_sdk-0.4.0}/src/periplus_sdk/client.py

@@ -6,7 +6,7 @@ from datetime import UTC, datetime
 from email.utils import parsedate_to_datetime
 import math
 import os
-from typing import TypeVar
+from typing import Literal, TypeVar
 
 import httpx
 from pydantic import BaseModel, JsonValue, ValidationError
@@ -71,15 +71,18 @@ def _decode(response: httpx.Response, model: type[Model]) -> Model:
         raise ResponseError("Public query response did not match the expected contract.") from None
 
 
-def _payload(sql: str, parameters: Sequence[JsonValue] | None) -> dict:
+def _payload(sql: str, parameters: Sequence[JsonValue] | None, schema_version: str) -> dict:
     # Server owns SQL validation, linting, preparation and optimization.
-    return {"sql": sql, "parameters": list(parameters) if parameters is not None else []}
+    return {"schema_version": schema_version, "sql": sql, "parameters": list(parameters) if parameters is not None else []}
 
 
 class Client:
     """Reusable synchronous public query client. Close it or use a with block."""
 
-    def __init__(self, base_url: str | None = None, *, timeout: float = 140):
+    def __init__(self, base_url: str | None = None, *, timeout: float = 140, mode: Literal["stable", "experimental"] = "stable"):
+        if mode not in {"stable", "experimental"}:
+            raise ConfigurationError("mode must be stable or experimental.")
+        self._query_path = "api/query/experimental/" if mode == "experimental" else "api/query/"
         self._http = httpx.Client(**_options(base_url, timeout))
 
     def __enter__(self) -> Client:
@@ -93,16 +96,16 @@ class Client:
 
     def _request(self, method: str, path: str, model: type[Model], **kwargs) -> Model:
         try:
-            response = self._http.request(method, "api/query/" + path, **kwargs)
+            response = self._http.request(method, self._query_path + path, **kwargs)
         except httpx.RequestError:
             raise TransportError("Could not complete the public query request.") from None
         return _decode(response, model)
 
-    def prepare(self, sql: str, parameters: Sequence[JsonValue] | None = None) -> PreparedQuery:
-        return self._request("POST", "prep", PreparedQuery, json=_payload(sql, parameters))
+    def prepare(self, sql: str, parameters: Sequence[JsonValue] | None = None, *, schema_version: str = "public_v1") -> PreparedQuery:
+        return self._request("POST", "prep", PreparedQuery, json=_payload(sql, parameters, schema_version))
 
-    def execute(self, sql: str, parameters: Sequence[JsonValue] | None = None) -> QueryResult:
-        return self._request("POST", "exec", QueryResult, json=_payload(sql, parameters))
+    def execute(self, sql: str, parameters: Sequence[JsonValue] | None = None, *, schema_version: str = "public_v1") -> QueryResult:
+        return self._request("POST", "exec", QueryResult, json=_payload(sql, parameters, schema_version))
 
     def helpers(self) -> QueryHelpers:
         return self._request("GET", "helpers", QueryHelpers)
@@ -111,7 +114,10 @@ class Client:
 class AsyncClient:
     """Reusable asynchronous public query client. Use an async with block."""
 
-    def __init__(self, base_url: str | None = None, *, timeout: float = 140):
+    def __init__(self, base_url: str | None = None, *, timeout: float = 140, mode: Literal["stable", "experimental"] = "stable"):
+        if mode not in {"stable", "experimental"}:
+            raise ConfigurationError("mode must be stable or experimental.")
+        self._query_path = "api/query/experimental/" if mode == "experimental" else "api/query/"
         self._http = httpx.AsyncClient(**_options(base_url, timeout))
 
     async def __aenter__(self) -> AsyncClient:
@@ -125,16 +131,16 @@ class AsyncClient:
 
     async def _request(self, method: str, path: str, model: type[Model], **kwargs) -> Model:
         try:
-            response = await self._http.request(method, "api/query/" + path, **kwargs)
+            response = await self._http.request(method, self._query_path + path, **kwargs)
         except httpx.RequestError:
             raise TransportError("Could not complete the public query request.") from None
         return _decode(response, model)
 
-    async def prepare(self, sql: str, parameters: Sequence[JsonValue] | None = None) -> PreparedQuery:
-        return await self._request("POST", "prep", PreparedQuery, json=_payload(sql, parameters))
+    async def prepare(self, sql: str, parameters: Sequence[JsonValue] | None = None, *, schema_version: str = "public_v1") -> PreparedQuery:
+        return await self._request("POST", "prep", PreparedQuery, json=_payload(sql, parameters, schema_version))
 
-    async def execute(self, sql: str, parameters: Sequence[JsonValue] | None = None) -> QueryResult:
-        return await self._request("POST", "exec", QueryResult, json=_payload(sql, parameters))
+    async def execute(self, sql: str, parameters: Sequence[JsonValue] | None = None, *, schema_version: str = "public_v1") -> QueryResult:
+        return await self._request("POST", "exec", QueryResult, json=_payload(sql, parameters, schema_version))
 
     async def helpers(self) -> QueryHelpers:
         return await self._request("GET", "helpers", QueryHelpers)

{periplus_python_sdk-0.2.0 → periplus_python_sdk-0.4.0}/src/periplus_sdk/types.py

@@ -1,4 +1,6 @@
 """Public query wire types; SQL types and JSON values are preserved."""
+from typing import Literal
+
 from pydantic import BaseModel, Field, JsonValue
 
 
@@ -9,6 +11,10 @@ class Diagnostic(BaseModel):
 
 
 class PreparedQuery(BaseModel):
+    query_mode: Literal["stable", "experimental"]
+    compiler_version: str
+    optimizations: list[str]
+    schema_version: str
     query_id: str
     sql: str
     parameters: list[JsonValue]

{periplus_python_sdk-0.2.0 → periplus_python_sdk-0.4.0}/tests/test_client.py

@@ -7,17 +7,17 @@ import httpx
 
 from periplus_sdk import AsyncClient, Client, ApiError, ConfigurationError, ResponseError, TransportError
 
-PREP = dict(query_id='q', sql='SELECT ? AS n', parameters=[1], diagnostics=[], plan='plan')
+PREP = dict(query_mode='stable', compiler_version='public-query-v8:stable', optimizations=[], schema_version='public_v1', query_id='q', sql='SELECT ? AS n', parameters=[1], diagnostics=[], plan='plan')
 RESULT = dict(**PREP, columns=['n', 'n'], types=['BIGINT', 'DECIMAL(20,2)'],
               rows=[['9007199254740993', '123.45']], truncated=True, elapsed_ms=1.2, source_snapshot=4)
 
 
 class ClientTests(unittest.TestCase):
-    def client(self, handler):
+    def client(self, handler, **options):
         factory = httpx.Client
         with patch('periplus_sdk.client.httpx.Client', side_effect=lambda **kw:
                    factory(**kw, transport=httpx.MockTransport(handler))):
-            client = Client('https://public.example/prefix/')
+            client = Client('https://public.example/prefix/', **options)
         self.addCleanup(client.close)
         return client
 
@@ -28,8 +28,8 @@ class ClientTests(unittest.TestCase):
             self.assertNotIn('authorization', request.headers)
             self.assertEqual(request.headers['x-periplus-query-source'], 'sdk')
             if request.url.path.endswith('helpers'):
-                return httpx.Response(200, json={'catalogue_version': '3.0.0', 'helpers': []})
-            self.assertEqual(json.loads(request.content), {'sql': PREP['sql'], 'parameters': [1]})
+                return httpx.Response(200, json={'catalogue_version': '1.0.0', 'helpers': []})
+            self.assertEqual(json.loads(request.content), {'sql': PREP['sql'], 'parameters': [1], 'schema_version': 'public_v1'})
             return httpx.Response(200, json=RESULT if request.url.path.endswith('exec') else PREP)
         with patch.dict(os.environ, {'PERIPLUS_QUERY_API_TOKEN': 'secret', 'PERIPLUS_API_TOKEN': 'admin'}):
             client = self.client(handler)
@@ -39,9 +39,32 @@ class ClientTests(unittest.TestCase):
             self.assertEqual(result.columns, ['n', 'n'])
             self.assertTrue(result.truncated)
             self.assertEqual(result.source_snapshot, 4)
-            self.assertEqual(client.helpers().catalogue_version, '3.0.0')
+            self.assertEqual(client.helpers().catalogue_version, '1.0.0')
         self.assertEqual([r.url.path for r in requests], ['/prefix/api/query/prep', '/prefix/api/query/exec', '/prefix/api/query/helpers'])
 
+    def test_experimental_routes_and_metadata(self):
+        paths = []
+        def handler(request):
+            paths.append(request.url.path)
+            if request.url.path.endswith('helpers'):
+                return httpx.Response(200, json={'catalogue_version': '1.0.0', 'helpers': []})
+            payload = dict(RESULT if request.url.path.endswith('exec') else PREP,
+                           query_mode='experimental', compiler_version='public-query-v8:experimental',
+                           optimizations=['content_scope'])
+            return httpx.Response(200, json=payload)
+        with self.client(handler, mode='experimental') as client:
+            prepared = client.prepare('SELECT 1')
+            self.assertEqual(prepared.query_mode, 'experimental')
+            self.assertEqual(prepared.compiler_version, 'public-query-v8:experimental')
+            self.assertEqual(client.execute('SELECT 1').optimizations, ['content_scope'])
+            client.helpers()
+        self.assertEqual(paths, ['/prefix/api/query/experimental/' + p for p in ['prep', 'exec', 'helpers']])
+
+    def test_invalid_mode(self):
+        for factory in (Client, AsyncClient):
+            with self.assertRaises(ConfigurationError):
+                factory('https://public.example', mode='unknown')
+
     def test_errors_preserve_categories_and_never_retry(self):
         for status, body, code in [(429, {'code': 'service_busy', 'detail': 'Busy'}, 'service_busy'),
                                    (403, {'code': 'feature_disabled', 'detail': 'Disabled'}, 'feature_disabled'),
@@ -97,14 +120,15 @@ class AsyncClientTests(unittest.IsolatedAsyncioTestCase):
         def handler(request):
             calls.append(request)
             if request.url.path.endswith('helpers'):
-                return httpx.Response(200, json={'catalogue_version': '3.0.0', 'helpers': []})
+                return httpx.Response(200, json={'catalogue_version': '1.0.0', 'helpers': []})
             return httpx.Response(200, json=RESULT if request.url.path.endswith('exec') else PREP)
         with patch('periplus_sdk.client.httpx.AsyncClient', side_effect=lambda **kw:
                    factory(**kw, transport=httpx.MockTransport(handler))):
-            async with AsyncClient('https://public.example') as client:
+            async with AsyncClient('https://public.example/prefix/', mode='experimental') as client:
                 self.assertEqual((await client.prepare('SELECT ?', [1])).parameters, [1])
                 self.assertEqual((await client.execute('SELECT ?', [1])).rows, RESULT['rows'])
-                self.assertEqual((await client.helpers()).catalogue_version, '3.0.0')
+                self.assertEqual((await client.helpers()).catalogue_version, '1.0.0')
         self.assertTrue(client._http.is_closed)
         self.assertEqual(len(calls), 3)
+        self.assertEqual([r.url.path for r in calls], ['/prefix/api/query/experimental/' + p for p in ['prep', 'exec', 'helpers']])
         self.assertTrue(all(r.headers['x-periplus-query-source'] == 'sdk' for r in calls))