crosswind-sandboxes 0.1.0__py3-none-any.whl

crosswind_sandboxes-0.1.0.dist-info/METADATA

@@ -0,0 +1,63 @@
+Metadata-Version: 2.4
+Name: crosswind-sandboxes
+Version: 0.1.0
+Summary: Cloudflare Sandbox SDK for Python Workers
+Author: Viswa Marepalli
+Author-email: Viswa Marepalli <reachvishm@gmail.com>
+License-Expression: Apache-2.0
+License-File: LICENSE-APACHE
+Requires-Python: >=3.12
+Project-URL: Source, https://github.com/justanotherbyte/crosswind/tree/main/sandboxes
+Project-URL: Documentation, https://crosswind.viswa.space
+Description-Content-Type: text/markdown
+
+# crosswind-sandboxes
+
+A Python port of [`@cloudflare/sandbox`](https://developers.cloudflare.com/sandbox/reference/) 1.0.3 for Python Workers. It has file operations, S3 mounts and directory backups for a running container. It installs as `crosswind-sandboxes` and imports as `sandboxes`.
+
+The package has no Python dependencies. It calls `ctx.container` through the Pyodide FFI and runs the official `sandbox-shim` binary inside the container, speaking shim protocol version 1.
+
+## Requirements
+
+- The container image must contain `/usr/local/bin/sandbox-shim`, copied from `cloudflare/sandbox:<VERSION>`.
+- The container must be running. No class starts, stops, or monitors it.
+- `nodejs_compat` is not needed. Errno names come from a fixed table of Linux values.
+
+## Example
+
+```python
+from sandboxes import DirectoryBackup, Files
+from workers import DurableObject
+
+# Export the gateways so ctx.exports can reach them.
+from sandboxes import DirectoryBackupGateway, S3Gateway  # noqa: F401
+
+
+class Workspace(DurableObject):
+    async def snapshot(self) -> dict:
+        container = self.ctx.container
+        if not container.running:
+            container.start()
+
+        files = Files(container)
+        await files.write_file("/workspace/notes.txt", "hello")
+        entries = await files.read_directory("/workspace")
+
+        backups = DirectoryBackup(
+            container, self.ctx.exports.DirectoryBackupGateway, binding="BACKUPS"
+        )
+        record = await backups.backup("/workspace")
+        return {"entries": [entry.name for entry in entries], "record": record}
+```
+
+## Differences from the TypeScript SDK
+
+- Names use `snake_case`, and option objects become keyword-only arguments.
+- `AbortSignal` becomes an `asyncio.Event` passed as `abort=`. Setting it raises `SandboxAbortError`. An event can't cross RPC, so cancellation works only inside the Durable Object.
+- Invalid values raise `ValueError`, and values of the wrong type raise `TypeError`.
+- Errors are exception classes under `SandboxError`, checked with `isinstance`. There is no `is()` helper.
+- `stat()` returns a `SandboxFileStat` dataclass with an `int` size and UTC `datetime` times. File types use `snake_case`: `block_device` and `character_device`.
+- `read_file()` returns a JS `Response`. A failure after the file opens errors the body with a JS `Error` whose `name` is the Python exception's class name.
+- `DirectoryBackupRecord` is a `TypedDict` compatible with the JS SDK's records.
+
+See [`sandbox-sdk-api.md`](sandbox-sdk-api.md) for the full API map.

crosswind_sandboxes-0.1.0.dist-info/RECORD

@@ -0,0 +1,16 @@
+sandboxes/__init__.py,sha256=Er1vgNzqfllhrLY-3srIEIT1MHaqp14jaQIAdk-aLXM,1328
+sandboxes/_ffi.py,sha256=1T9N5Ia04SE9qUCm3Eg95LGEhhAcGk3JM_-rVajT4Xo,4059
+sandboxes/_shim.py,sha256=p-umjz198z_qT0gGLpU_PKZNM40KcTHx_jqkkXIaGgo,10259
+sandboxes/_sigv4.py,sha256=5ep5h5DQ4YKjo380T4bV9zQhGI6mtND60WVrVngqzDc,3670
+sandboxes/_streams.py,sha256=VazkZm5-CP0SULszNeGqYeUvrXjenq9yM19omrJY48k,12188
+sandboxes/_utils.py,sha256=yMre9LxNDhW85JmKB-cEBXw1O9qTK6ZFbbmAsZlnriY,872
+sandboxes/directory_backup.py,sha256=NRNitTVPbe_57O969od7-snF_2ZTKssKo3ph0LKxCzk,25039
+sandboxes/errors.py,sha256=4FBD_Pi7IEBwa470oUCNoErfS2ieiCsqh_nF4H1u_wQ,5762
+sandboxes/files.py,sha256=_CIWg3M0q05HXRKlkt1ha-DaHyBRnHbCcQyg_ti2Z8M,19658
+sandboxes/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+sandboxes/s3_gateway.py,sha256=shMK6JN6JLpWlwvj2M-yWb5koaQxtnl0kAOHrX7yWLs,19029
+sandboxes/s3_mount.py,sha256=KoODHHnsCq_oFLKqqYrWhaFza-rDNd5pAAaL7ZINEeU,27724
+crosswind_sandboxes-0.1.0.dist-info/licenses/LICENSE-APACHE,sha256=_18arsrGE1ssQH7MeECC2gyZ2uEUXNFU4wUep-jm8q0,11337
+crosswind_sandboxes-0.1.0.dist-info/WHEEL,sha256=3NO1oYsF7mANFUWVdyEQLM-zmecczWWEmmF5rEbXrWk,80
+crosswind_sandboxes-0.1.0.dist-info/METADATA,sha256=l--B94PxChs_3a8KdNbV9ZR-OpENwg4xQivnP3vL97s,3010
+crosswind_sandboxes-0.1.0.dist-info/RECORD,,

crosswind_sandboxes-0.1.0.dist-info/WHEEL

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

crosswind_sandboxes-0.1.0.dist-info/licenses/LICENSE-APACHE

@@ -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 2026 Viswa M
+
+   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.

sandboxes/__init__.py

@@ -0,0 +1,64 @@
+"""Cloudflare Sandbox SDK for Python Workers."""
+
+from .directory_backup import (
+    DirectoryBackup,
+    DirectoryBackupGateway,
+    DirectoryBackupRecord,
+)
+from .errors import (
+    SandboxAbortError,
+    SandboxBackupError,
+    SandboxError,
+    SandboxFileError,
+    SandboxProtocolError,
+    SandboxS3MountError,
+)
+from .files import (
+    FileContent,
+    Files,
+    SandboxDirectoryEntry,
+    SandboxFileStat,
+    SandboxFileType,
+)
+from .s3_gateway import S3Gateway
+from .s3_mount import (
+    ProviderCredentials,
+    S3Credentials,
+    S3Mount,
+    S3MountAccess,
+    S3MountConfiguration,
+    S3MountInspection,
+    S3Source,
+    StaticCredentials,
+)
+
+__all__ = (
+    "DirectoryBackup",
+    "DirectoryBackupGateway",
+    "DirectoryBackupRecord",
+    "FileContent",
+    "Files",
+    "ProviderCredentials",
+    "S3Credentials",
+    "S3Gateway",
+    "S3Mount",
+    "S3MountAccess",
+    "S3MountConfiguration",
+    "S3MountInspection",
+    "S3Source",
+    "SandboxAbortError",
+    "SandboxBackupError",
+    "SandboxDirectoryEntry",
+    "SandboxError",
+    "SandboxFileError",
+    "SandboxFileStat",
+    "SandboxFileType",
+    "SandboxProtocolError",
+    "SandboxS3MountError",
+    "StaticCredentials",
+)
+
+__title__ = "sandboxes"
+__version__ = "0.1.0"
+__license__ = "Apache-2.0"
+__copyright__ = "Copyright 2026 Viswa M"

sandboxes/_ffi.py

@@ -0,0 +1,141 @@
+"""
+Helpers for crossing the Python/JavaScript boundary inside Pyodide.
+
+This is the only module in the package that imports ``js`` or ``pyodide``.
+"""
+
+from collections.abc import Awaitable, Callable
+from typing import Any
+
+import js
+from pyodide.ffi import create_once_callable, create_proxy, to_js
+
+try:
+    from pyodide.ffi import jsnull
+except ImportError:
+    jsnull = None
+
+__all__ = (
+    "abort_controller",
+    "fixed_length_stream",
+    "header_items",
+    "is_absent",
+    "is_bytes_chunk",
+    "is_readable_stream",
+    "js_fetch",
+    "json_response",
+    "readable_stream",
+    "response",
+    "to_bytes",
+    "to_js_error",
+    "to_js_object",
+    "to_py",
+    "to_uint8array",
+    "unwrap",
+)
+
+
+def to_js_object(value: Any) -> Any:
+    """Convert dicts and lists into plain JavaScript objects and arrays."""
+    return to_js(value, dict_converter=js.Object.fromEntries)
+
+
+def to_py(value: Any) -> Any:
+    """Convert a JavaScript value into Python dicts, lists and scalars."""
+    return value.to_py() if hasattr(value, "to_py") else value
+
+
+def unwrap(value: Any) -> Any:
+    """The JavaScript object behind a Python ``workers`` wrapper, if any."""
+    # Runtime quirk: binding wrappers keep the JS object in ``_binding`` and
+    # forward unknown names to JS, so ``js_object`` would return a JS function.
+    binding = getattr(value, "_binding", None)
+    return binding if binding is not None else getattr(value, "js_object", value)
+
+
+def is_absent(value: Any) -> bool:
+    return value is None or value is jsnull
+
+
+def to_bytes(chunk: Any) -> bytes:
+    """Convert a ``Uint8Array`` read from a stream into ``bytes``."""
+    return bytes(chunk) if isinstance(chunk, bytes | bytearray) else chunk.to_bytes()
+
+
+def to_uint8array(data: bytes) -> Any:
+    return to_js(data)
+
+
+def is_bytes_chunk(chunk: Any) -> bool:
+    if isinstance(chunk, bytes | bytearray):
+        return True
+    return getattr(getattr(chunk, "constructor", None), "name", None) == "Uint8Array"
+
+
+def is_readable_stream(value: Any) -> bool:
+    return callable(getattr(value, "getReader", None))
+
+
+def header_items(headers: Any) -> list[tuple[str, str]]:
+    """The name and value pairs of a JavaScript ``Headers``, names lowercase."""
+    return [(str(name).lower(), str(value)) for name, value in headers]
+
+
+def abort_controller() -> Any:
+    return js.AbortController.new()
+
+
+def to_js_error(error: BaseException) -> Any:
+    """A JavaScript ``Error`` with the exception's class name and message."""
+    js_error = js.Error.new(str(error))
+    js_error.name = type(error).__name__
+    return js_error
+
+
+def readable_stream(
+    pull: Callable[[Any], Awaitable[bool]], cancel: Callable[[Any], None]
+) -> Any:
+    """
+    A ``ReadableStream`` that calls ``pull`` for each chunk it needs.
+
+    ``pull`` returns ``True`` once it has closed or errored the stream. The
+    proxies are destroyed then, or after ``cancel``.
+    """
+    proxies: list[Any] = []
+
+    def destroy() -> None:
+        for proxy in proxies:
+            proxy.destroy()
+
+    async def pull_once(controller: Any) -> None:
+        if await pull(controller):
+            js.queueMicrotask(create_once_callable(destroy))
+
+    def cancel_once(reason: Any) -> None:
+        try:
+            cancel(reason)
+        finally:
+            js.queueMicrotask(create_once_callable(destroy))
+
+    proxies.extend((create_proxy(pull_once), create_proxy(cancel_once)))
+    source = to_js_object({"pull": proxies[0], "cancel": proxies[1]})
+    return js.ReadableStream.new(source)
+
+
+def response(body: Any = None, *, status: int = 200, headers: Any = None) -> Any:
+    init: dict[str, Any] = {"status": status}
+    if headers is not None:
+        init["headers"] = headers
+    return js.Response.new(body, to_js_object(init))
+
+
+def json_response(value: Any) -> Any:
+    return js.Response.json(to_js_object(value))
+
+
+def js_fetch(url: str, init: dict[str, Any]) -> Awaitable[Any]:
+    return js.fetch(url, to_js_object(init))
+
+
+def fixed_length_stream(length: int) -> Any:
+    return js.FixedLengthStream.new(length)