zygo-sdk 0.1.2__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,42 @@
1
+ /target
2
+ **/*.rs.bk
3
+ .DS_Store
4
+ __pycache__/
5
+ *.pyc
6
+ /dist
7
+
8
+ # `zygo.lock` is meant to be committed — the docs say so, and a project that
9
+ # does not commit it gets no benefit from it. Ignored only under `examples/`,
10
+ # where a pinned digest would refuse to come up for every reader whose image
11
+ # is newer than the one the lock was written against.
12
+ /examples/**/zygo.lock
13
+
14
+ # Build outputs the Linux suites run, not source: the static binary
15
+ # (`make tests/linux/bin/zygo-linux-musl`), the vm-capable one
16
+ # (`make vm-build`), the guest kernel and the V1 probe's log (`make vm-kernel`,
17
+ # `make vm-probe`, 24 MB of artefact that a checkout should rebuild). All in
18
+ # one folder, so a clean checkout has nothing to rebuild by hand.
19
+ #
20
+ # A bare `zygo-linux` there is a leftover from an earlier workflow that no
21
+ # `make` target built; every suite defaults to `zygo-linux-musl` now, and
22
+ # every target that runs one rebuilds it first.
23
+ /tests/linux/bin/
24
+ # The Phase 0 proof-of-concept binary, cross-compiled.
25
+ /tests/poc/poc3-linux
26
+
27
+ # Built by `make examples-go-linux`
28
+ /examples/warm-exec/go/bin/
29
+
30
+ # The binary `make oci-image` copies into the image's build context. The
31
+ # Dockerfile takes it from there rather than compiling a second time, so that
32
+ # the image holds the binary the size and static-linking checks were run
33
+ # against — but it is still a build artefact.
34
+ /packaging/oci/zygo
35
+
36
+ # Development material: planning notes, design notes and review reports
37
+ # and the test plans. Useful to whoever is building Zygo and noise to whoever
38
+ # is using it, so it lives here rather than in `docs/`, which is for readers.
39
+ /mhmt/
40
+
41
+ # The workflow-engine example writes its queue beside itself.
42
+ examples/workflow-engine/jobs.db
zygo_sdk-0.1.2/LICENSE ADDED
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
zygo_sdk-0.1.2/NOTICE ADDED
@@ -0,0 +1,11 @@
1
+ Zygo
2
+ Copyright 2026 Mehmet Sekercioglu and the Zygo contributors
3
+
4
+ This product is licensed under the Apache License, Version 2.0 (the
5
+ "License"); see the LICENSE file. Unless required by applicable law or agreed
6
+ to in writing, software distributed under the License is distributed on an
7
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND.
8
+
9
+ Binaries built with the `vm` feature link libkrun
10
+ (https://github.com/containers/libkrun), which is licensed under the Apache
11
+ License, Version 2.0 by its own authors.
@@ -0,0 +1,82 @@
1
+ Metadata-Version: 2.5
2
+ Name: zygo-sdk
3
+ Version: 0.1.2
4
+ Summary: Python client for Zygo — warm, isolated sandboxes for function-shaped code
5
+ Project-URL: Homepage, https://github.com/mhmtskrc2/zygo
6
+ Project-URL: Source, https://github.com/mhmtskrc2/zygo/tree/main/sdk/python
7
+ Author: Zygo contributors
8
+ License-Expression: Apache-2.0
9
+ License-File: LICENSE
10
+ License-File: NOTICE
11
+ Keywords: agent,container,isolation,sandbox,serverless
12
+ Classifier: Development Status :: 3 - Alpha
13
+ Classifier: Intended Audience :: Developers
14
+ Classifier: Programming Language :: Python :: 3
15
+ Classifier: Topic :: Software Development :: Interpreters
16
+ Classifier: Topic :: System :: Systems Administration
17
+ Requires-Python: >=3.9
18
+ Description-Content-Type: text/markdown
19
+
20
+ # zygo — Python client
21
+
22
+ Warm, isolated sandboxes for function-shaped code. A warm function costs about
23
+ a millisecond and gets a clean process per request.
24
+
25
+ ```bash
26
+ pip install zygo-sdk # then `import zygo_sdk`
27
+ ```
28
+
29
+ ```python
30
+ import zygo_sdk as zygo
31
+
32
+ client = zygo.connect() # `zygo api`, on loopback or a unix socket
33
+ resize = client.fn("resize") # a function declared in sandbox.toml
34
+
35
+ out = resize({"url": "https://example.com/a.png"})
36
+ print(out.result, out.metrics.wall_ms)
37
+ ```
38
+
39
+ Asynchronous, which is what an agent framework needs — the same methods,
40
+ every one a coroutine:
41
+
42
+ ```python
43
+ import asyncio
44
+ import zygo_sdk as zygo
45
+
46
+ async def main(events):
47
+ async with zygo.aio.connect() as client:
48
+ return await asyncio.gather(*(client.call("resize", e) for e in events))
49
+
50
+ asyncio.run(main([{"url": "https://example.com/a.png"}]))
51
+ ```
52
+
53
+ A refused request can be retried for you. `Busy` (the pool was full) and
54
+ `Unavailable` (the host is still building or warming something) both mean the
55
+ request never ran, so sending it again is safe; nothing else is retried:
56
+
57
+ ```python
58
+ client = zygo.connect(retries=3) # waits the server's Retry-After, then again
59
+ ```
60
+
61
+ A one-shot sandbox, needing nothing declared in advance:
62
+
63
+ ```python
64
+ r = client.run("python:3.12-slim", ["python3", "-c", "print(6 * 7)"], mem="128M")
65
+ print(r.stdout)
66
+ ```
67
+
68
+ **No dependencies.** The standard library has an HTTP client, and a unix socket
69
+ is thirty lines on top of it.
70
+
71
+ Full documentation: [docs/book/17-api-sdk-mcp.md](../../docs/book/17-api-sdk-mcp.md). The project:
72
+ [zygo](../../README.md).
73
+
74
+ ## Tests
75
+
76
+ ```bash
77
+ python -m unittest discover -s tests
78
+ ```
79
+
80
+ They run against a stand-in API and need no Linux, no kernel and no sandbox:
81
+ what is under test is the client. A test that needs a real sandbox belongs in
82
+ the Rust suites, against a real kernel.
@@ -0,0 +1,63 @@
1
+ # zygo — Python client
2
+
3
+ Warm, isolated sandboxes for function-shaped code. A warm function costs about
4
+ a millisecond and gets a clean process per request.
5
+
6
+ ```bash
7
+ pip install zygo-sdk # then `import zygo_sdk`
8
+ ```
9
+
10
+ ```python
11
+ import zygo_sdk as zygo
12
+
13
+ client = zygo.connect() # `zygo api`, on loopback or a unix socket
14
+ resize = client.fn("resize") # a function declared in sandbox.toml
15
+
16
+ out = resize({"url": "https://example.com/a.png"})
17
+ print(out.result, out.metrics.wall_ms)
18
+ ```
19
+
20
+ Asynchronous, which is what an agent framework needs — the same methods,
21
+ every one a coroutine:
22
+
23
+ ```python
24
+ import asyncio
25
+ import zygo_sdk as zygo
26
+
27
+ async def main(events):
28
+ async with zygo.aio.connect() as client:
29
+ return await asyncio.gather(*(client.call("resize", e) for e in events))
30
+
31
+ asyncio.run(main([{"url": "https://example.com/a.png"}]))
32
+ ```
33
+
34
+ A refused request can be retried for you. `Busy` (the pool was full) and
35
+ `Unavailable` (the host is still building or warming something) both mean the
36
+ request never ran, so sending it again is safe; nothing else is retried:
37
+
38
+ ```python
39
+ client = zygo.connect(retries=3) # waits the server's Retry-After, then again
40
+ ```
41
+
42
+ A one-shot sandbox, needing nothing declared in advance:
43
+
44
+ ```python
45
+ r = client.run("python:3.12-slim", ["python3", "-c", "print(6 * 7)"], mem="128M")
46
+ print(r.stdout)
47
+ ```
48
+
49
+ **No dependencies.** The standard library has an HTTP client, and a unix socket
50
+ is thirty lines on top of it.
51
+
52
+ Full documentation: [docs/book/17-api-sdk-mcp.md](../../docs/book/17-api-sdk-mcp.md). The project:
53
+ [zygo](../../README.md).
54
+
55
+ ## Tests
56
+
57
+ ```bash
58
+ python -m unittest discover -s tests
59
+ ```
60
+
61
+ They run against a stand-in API and need no Linux, no kernel and no sandbox:
62
+ what is under test is the client. A test that needs a real sandbox belongs in
63
+ the Rust suites, against a real kernel.
@@ -0,0 +1,32 @@
1
+ [build-system]
2
+ requires = ["hatchling"]
3
+ build-backend = "hatchling.build"
4
+
5
+ [project]
6
+ name = "zygo-sdk"
7
+ version = "0.1.2"
8
+ description = "Python client for Zygo — warm, isolated sandboxes for function-shaped code"
9
+ readme = "README.md"
10
+ requires-python = ">=3.9"
11
+ license = "Apache-2.0"
12
+ license-files = ["LICENSE", "NOTICE"]
13
+ authors = [{ name = "Zygo contributors" }]
14
+ keywords = ["sandbox", "isolation", "agent", "serverless", "container"]
15
+ classifiers = [
16
+ "Development Status :: 3 - Alpha",
17
+ "Intended Audience :: Developers",
18
+ "Programming Language :: Python :: 3",
19
+ "Topic :: Software Development :: Interpreters",
20
+ "Topic :: System :: Systems Administration",
21
+ ]
22
+ # Deliberately empty. An SDK for a runtime whose argument is a small, auditable
23
+ # boundary should not arrive with a dependency tree of its own; the standard
24
+ # library has an HTTP client, and a unix socket is thirty lines on top of it.
25
+ dependencies = []
26
+
27
+ [project.urls]
28
+ Homepage = "https://github.com/mhmtskrc2/zygo"
29
+ Source = "https://github.com/mhmtskrc2/zygo/tree/main/sdk/python"
30
+
31
+ [tool.hatch.build.targets.wheel]
32
+ packages = ["src/zygo_sdk"]
@@ -0,0 +1,119 @@
1
+ # SPDX-License-Identifier: Apache-2.0
2
+ """Zygo — warm sandboxes for function-shaped code, from Python.
3
+
4
+ import zygo_sdk as zygo
5
+
6
+ client = zygo.connect() # `zygo api` on loopback
7
+ resize = client.fn("resize") # a function from sandbox.toml
8
+ out = resize({"url": "..."}) # ~2 ms, a fresh process
9
+ print(out.result)
10
+
11
+ A warm function costs about a millisecond and gets a clean process per request.
12
+ A one-shot sandbox costs tens of milliseconds and needs nothing declared in
13
+ advance:
14
+
15
+ r = client.run("python:3.12-slim", ["python3", "-c", "print(6*7)"])
16
+ print(r.stdout)
17
+
18
+ For an event loop, ``zygo.aio`` is the same API with every call a coroutine:
19
+
20
+ async with zygo.aio.connect() as client:
21
+ out = await client.call("resize", {"url": "..."})
22
+
23
+ A refused request — :class:`Busy`, or :class:`Unavailable` while the host is
24
+ still building something — can be retried for you: ``zygo.connect(retries=3)``
25
+ waits the server's ``Retry-After`` and sends it again. Off by default.
26
+
27
+ This package talks to ``zygo api`` over HTTP — on a unix socket when the API is
28
+ on this machine, which is the usual case and needs no token. It has no
29
+ dependencies.
30
+
31
+ What it is *not* is a second implementation of Zygo. Every boundary a sandbox
32
+ has is built by the Zygo binary and enforced by the kernel; nothing here can
33
+ widen one, and an API started without ``--allow-deploy`` will not let this
34
+ package create a sandbox at all.
35
+ """
36
+
37
+ from ._endpoint import DEFAULT_URL, Endpoint
38
+ from ._errors import (
39
+ AuthError,
40
+ Busy,
41
+ Cancelled,
42
+ HandlerError,
43
+ NotFound,
44
+ SpecError,
45
+ Stuck,
46
+ Timeout,
47
+ TransportError,
48
+ Unavailable,
49
+ ZygoError,
50
+ )
51
+ from ._models import (
52
+ Deps,
53
+ Event,
54
+ Function,
55
+ LogEntry,
56
+ LogPage,
57
+ Metrics,
58
+ Minted,
59
+ Result,
60
+ Run,
61
+ Runtime,
62
+ Script,
63
+ Served,
64
+ Tenant,
65
+ Token,
66
+ )
67
+ from ._sync import Client, FunctionHandle, connect
68
+
69
+ __version__ = "0.1.2"
70
+
71
+ __all__ = [
72
+ "aio",
73
+ "Client",
74
+ "FunctionHandle",
75
+ "connect",
76
+ "DEFAULT_URL",
77
+ "Endpoint",
78
+ # results
79
+ "Deps",
80
+ "Event",
81
+ "Function",
82
+ "LogEntry",
83
+ "LogPage",
84
+ "Metrics",
85
+ "Minted",
86
+ "Result",
87
+ "Run",
88
+ "Runtime",
89
+ "Script",
90
+ "Served",
91
+ "Tenant",
92
+ "Token",
93
+ # failures
94
+ "AuthError",
95
+ "Busy",
96
+ "Cancelled",
97
+ "HandlerError",
98
+ "NotFound",
99
+ "SpecError",
100
+ "Stuck",
101
+ "Timeout",
102
+ "TransportError",
103
+ "Unavailable",
104
+ "ZygoError",
105
+ ]
106
+
107
+
108
+ def __getattr__(name: str): # noqa: ANN202 - PEP 562, a module attribute
109
+ """``zygo_sdk.aio`` without a second import line.
110
+
111
+ Loaded on first use rather than here, so that ``import zygo_sdk`` does not
112
+ pull in :mod:`asyncio` for a script that never opens an event loop. Both
113
+ ``import zygo_sdk.aio`` and ``zygo_sdk.aio`` reach the same module.
114
+ """
115
+ if name == "aio":
116
+ from importlib import import_module
117
+
118
+ return import_module(".aio", __name__)
119
+ raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
@@ -0,0 +1,79 @@
1
+ # SPDX-License-Identifier: Apache-2.0
2
+ """Where the API is, and how it was decided.
3
+
4
+ One function, because the rule has to be the same for the synchronous and the
5
+ asynchronous client. Two discovery orders that drift is a support question
6
+ nobody can answer from the traceback.
7
+ """
8
+
9
+ from __future__ import annotations
10
+
11
+ import os
12
+ from dataclasses import dataclass
13
+ from typing import Optional
14
+
15
+ #: What ``zygo api`` listens on when nothing says otherwise.
16
+ DEFAULT_URL = "http://127.0.0.1:7700"
17
+
18
+
19
+ @dataclass(frozen=True)
20
+ class Endpoint:
21
+ """A parsed address: either a unix socket path or a host and port."""
22
+
23
+ url: str
24
+ socket_path: Optional[str] = None
25
+ host: str = "127.0.0.1"
26
+ port: int = 7700
27
+ tls: bool = False
28
+
29
+ @property
30
+ def is_unix(self) -> bool:
31
+ return self.socket_path is not None
32
+
33
+ def __str__(self) -> str:
34
+ return self.url
35
+
36
+
37
+ def resolve(url: Optional[str] = None) -> Endpoint:
38
+ """Work out which API to talk to.
39
+
40
+ In order: the argument, then ``ZYGO_API_URL``, then loopback on the port
41
+ ``zygo api`` uses by default. Accepts ``unix:///path/to.sock``,
42
+ ``http://host:port``, ``https://host:port`` and a bare ``host:port``.
43
+ """
44
+ text = url or os.environ.get("ZYGO_API_URL") or DEFAULT_URL
45
+ return parse(text)
46
+
47
+
48
+ def parse(text: str) -> Endpoint:
49
+ text = text.strip()
50
+ if text.startswith("unix://"):
51
+ path = text[len("unix://") :]
52
+ if not path:
53
+ raise ValueError("unix:// needs a path, e.g. unix:///run/user/1000/zygo/api.sock")
54
+ return Endpoint(url=text, socket_path=path)
55
+
56
+ tls = False
57
+ rest = text
58
+ if text.startswith("https://"):
59
+ tls, rest = True, text[len("https://") :]
60
+ elif text.startswith("http://"):
61
+ rest = text[len("http://") :]
62
+ elif "://" in text:
63
+ scheme = text.split("://", 1)[0]
64
+ raise ValueError(f"`{scheme}://` is not an address Zygo serves; use http://, https:// or unix://")
65
+
66
+ # A trailing path is dropped rather than honoured: every route this client
67
+ # calls is rooted, and silently prefixing them would turn a typo in the
68
+ # address into a 404 on every call.
69
+ rest = rest.split("/", 1)[0]
70
+ host, _, port_text = rest.rpartition(":")
71
+ if not host:
72
+ host, port_text = rest, "443" if tls else "7700"
73
+ try:
74
+ port = int(port_text)
75
+ except ValueError as e:
76
+ raise ValueError(f"`{port_text}` is not a port number, in `{text}`") from e
77
+
78
+ scheme = "https" if tls else "http"
79
+ return Endpoint(url=f"{scheme}://{host}:{port}", host=host, port=port, tls=tls)