bare-sidecar 0.1.0__py3-none-win_amd64.whl

bare_sidecar/__init__.py

@@ -0,0 +1,9 @@
+"""Start and manage Bare sidecar processes from Python."""
+
+from .sidecar import Sidecar, executable, spawn
+
+__all__ = [
+    "Sidecar",
+    "executable",
+    "spawn",
+]

bare_sidecar/_host.py

@@ -0,0 +1,19 @@
+import platform
+import sys
+
+SYSTEMS = {"darwin", "linux", "win32"}
+ARCHS = {"arm64": "arm64", "aarch64": "arm64", "x86_64": "x64", "amd64": "x64"}
+
+
+def host():
+    """The host triple of the running platform, named as by Bare."""
+    arch = ARCHS.get(platform.machine().lower())
+
+    if sys.platform not in SYSTEMS or arch is None:
+        raise OSError(f"Unsupported platform {sys.platform}-{platform.machine()}")
+
+    return f"{sys.platform}-{arch}"
+
+
+def executable_name(host):
+    return "bare.exe" if host.startswith("win32") else "bare"

bare_sidecar/_ipc.py

@@ -0,0 +1,91 @@
+import asyncio
+import os
+import secrets
+import socket
+import sys
+
+# Not exposed by `_winapi`.
+PIPE_REJECT_REMOTE_CLIENTS = 0x00000008
+
+BUFSIZE = 65536
+
+
+class Channel:
+    """An IPC connection between this process and a child yet to be spawned.
+
+    ``value`` names the child's end, as a descriptor or on Windows a handle, and
+    ``options`` are the subprocess options that pass it to the child.
+    ``release()`` closes this process' copy of it once the child is spawned.
+    """
+
+    def __init__(self, reader, writer, value, options, release):
+        self.reader = reader
+        self.writer = writer
+        self.value = value
+        self.options = options
+        self.release = release
+
+
+async def open_channel():
+    if sys.platform == "win32":
+        return await _open_pipe()
+
+    return await _open_socketpair()
+
+
+async def _open_socketpair():
+    parent, child = socket.socketpair()
+
+    try:
+        reader, writer = await asyncio.open_unix_connection(sock=parent)
+    except BaseException:
+        parent.close()
+        child.close()
+        raise
+
+    fd = child.fileno()
+
+    return Channel(reader, writer, str(fd), {"pass_fds": (fd,)}, child.close)
+
+
+async def _open_pipe():
+    import _winapi
+    import subprocess
+
+    name = rf"\\.\pipe\bare-sidecar-{os.getpid()}-{secrets.token_hex(8)}"
+
+    # A single instance that this process connects to before the child exists,
+    # so that no other process can connect in its place.
+    child = _winapi.CreateNamedPipe(
+        name,
+        _winapi.PIPE_ACCESS_DUPLEX
+        | _winapi.FILE_FLAG_OVERLAPPED
+        | _winapi.FILE_FLAG_FIRST_PIPE_INSTANCE,
+        _winapi.PIPE_WAIT | PIPE_REJECT_REMOTE_CLIENTS,
+        1,
+        BUFSIZE,
+        BUFSIZE,
+        _winapi.NMPWAIT_WAIT_FOREVER,
+        _winapi.NULL,
+    )
+
+    try:
+        loop = asyncio.get_running_loop()
+        reader = asyncio.StreamReader()
+        protocol = asyncio.StreamReaderProtocol(reader)
+        transport, _ = await loop.create_pipe_connection(lambda: protocol, name)
+        writer = asyncio.StreamWriter(transport, protocol, reader, loop)
+        os.set_handle_inheritable(child, True)
+    except BaseException:
+        _winapi.CloseHandle(child)
+        raise
+
+    startupinfo = subprocess.STARTUPINFO(lpAttributeList={"handle_list": [child]})
+
+    return Channel(
+        reader,
+        writer,
+        str(child),
+        {"startupinfo": startupinfo},
+        lambda: _winapi.CloseHandle(child),
+    )

bare_sidecar/prebuilds/win32-x64/bare.exe

@@ -0,0 +1,4 @@
+[diffend] Oversized file quarantined before diffing.
+name: bare_sidecar/prebuilds/win32-x64/bare.exe
+size: 43411456 bytes
+sha256: 04f1e4d9f2c7402a625aa877cd9368db171163b25aa58382962a7b4ca8980145

bare_sidecar/sidecar.py

@@ -0,0 +1,210 @@
+import asyncio
+import os
+import signal
+from contextlib import suppress
+from pathlib import Path
+
+from ._host import executable_name, host
+from ._ipc import open_channel
+
+# Read by the embedder shipped with this package, which opens `Bare.IPC` from
+# the descriptor, or on Windows the handle, it names.
+IPC_ENV = "BARE_SIDECAR_IPC"
+
+STDIO = {
+    "inherit": None,
+    "pipe": asyncio.subprocess.PIPE,
+    "ignore": asyncio.subprocess.DEVNULL,
+}
+
+
+def executable():
+    """The path of the Bare executable shipped for the running platform."""
+    current = host()
+    path = Path(__file__).parent / "prebuilds" / current / executable_name(current)
+
+    if not path.is_file():
+        raise FileNotFoundError(f"No Bare prebuild for {current}")
+
+    return path
+
+
+async def spawn(entry, *args, stdio="inherit", bare=None):
+    """Start ``entry`` in a Bare process with an IPC connection to it and
+    return its ``Sidecar``.
+
+    ``args`` are passed to the process as ``Bare.argv``. ``stdio`` is
+    ``"inherit"``, ``"pipe"``, or ``"ignore"``, either for all three standard
+    streams or as a sequence of one per stream. ``bare`` is the Bare executable
+    to use, defaulting to the one shipped with this package.
+    """
+    if isinstance(stdio, str):
+        stdio = (stdio,) * 3
+
+    stdin, stdout, stderr = (STDIO[mode] for mode in stdio)
+
+    channel = await open_channel()
+
+    try:
+        process = await asyncio.create_subprocess_exec(
+            os.fspath(bare or executable()),
+            os.fspath(entry),
+            *args,
+            stdin=stdin,
+            stdout=stdout,
+            stderr=stderr,
+            env={**os.environ, IPC_ENV: channel.value},
+            **channel.options,
+        )
+    except BaseException:
+        channel.writer.close()
+        raise
+    finally:
+        channel.release()
+
+    return Sidecar(process, channel.reader, channel.writer)
+
+
+class Sidecar:
+    """A Bare process connected to its ``Bare.IPC``.
+
+    Iterating it with ``async for`` yields the data the process writes to
+    ``Bare.IPC`` until the connection ends, and leaving ``async with`` closes
+    it. Use ``spawn()`` to start one.
+    """
+
+    def __init__(self, process, reader, writer):
+        self._process = process
+        self._reader = reader
+        self._writer = writer
+
+    @property
+    def pid(self):
+        """The process ID."""
+        return self._process.pid
+
+    @property
+    def returncode(self):
+        """The exit code of the process, negated if killed by a signal, or
+        ``None`` while it is running."""
+        return self._process.returncode
+
+    @property
+    def exit_code(self):
+        """The exit code of the process, or ``None`` while it is running or if
+        it was killed by a signal."""
+        code = self._process.returncode
+        return code if code is not None and code >= 0 else None
+
+    @property
+    def signal_code(self):
+        """The name of the signal that killed the process, or ``None``."""
+        code = self._process.returncode
+        return signal.Signals(-code).name if code is not None and code < 0 else None
+
+    @property
+    def stdin(self):
+        """The standard input of the process, if spawned with ``"pipe"``."""
+        return self._process.stdin
+
+    @property
+    def stdout(self):
+        """The standard output of the process, if spawned with ``"pipe"``."""
+        return self._process.stdout
+
+    @property
+    def stderr(self):
+        """The standard error of the process, if spawned with ``"pipe"``."""
+        return self._process.stderr
+
+    async def read(self, n=65536):
+        """Read up to ``n`` bytes from the process, or ``b""`` once it has
+        closed its end of the connection."""
+        try:
+            data = await self._reader.read(n)
+        except ConnectionResetError:
+            # On Linux, a process that exits with data still unread resets the
+            # connection rather than ending it.
+            return b""
+
+        if not data:
+            self._end()
+
+        return data
+
+    def _end(self):
+        """End this side of the connection, which the process waits for before
+        it exits once it has ended its own."""
+        if self._writer.is_closing():
+            return
+
+        # A process that has already exited has no end left to end, and pipes on
+        # Windows can't be half closed.
+        with suppress(OSError):
+            if self._writer.can_write_eof():
+                self._writer.write_eof()
+            else:
+                self._writer.close()
+
+    def __aiter__(self):
+        return self._chunks()
+
+    async def _chunks(self):
+        while chunk := await self.read():
+            yield chunk
+
+    async def write(self, data):
+        """Write ``data`` to the process and wait for it to drain.
+
+        Data written once the process has closed its end of the connection,
+        such as while exiting, is dropped, as its exit already accounts for it.
+        """
+        if self._writer.is_closing():
+            return
+
+        try:
+            self._writer.write(data)
+            await self._writer.drain()
+        except (BrokenPipeError, ConnectionResetError):
+            pass
+
+    def send_signal(self, sig):
+        """Send ``sig`` to the process unless it has already exited."""
+        with suppress(ProcessLookupError):
+            self._process.send_signal(sig)
+
+    def terminate(self):
+        """Ask the process to exit, with ``SIGTERM`` or on Windows by
+        terminating it, unless it has already exited."""
+        with suppress(ProcessLookupError):
+            self._process.terminate()
+
+    def kill(self):
+        """Kill the process, with ``SIGKILL`` or on Windows by terminating it,
+        unless it has already exited."""
+        with suppress(ProcessLookupError):
+            self._process.kill()
+
+    async def wait(self):
+        """Wait for the process to exit and return its exit code, negated if it
+        was killed by a signal."""
+        return await self._process.wait()
+
+    async def close(self):
+        """Close the connection, terminating the process if it is still
+        running, and wait for it to exit."""
+        self._writer.close()
+
+        if self._process.returncode is None:
+            self.terminate()
+
+        await self.wait()
+
+        with suppress(OSError):
+            await self._writer.wait_closed()
+
+    async def __aenter__(self):
+        return self
+
+    async def __aexit__(self, *exc):
+        await self.close()

bare_sidecar-0.1.0.dist-info/METADATA

@@ -0,0 +1,52 @@
+Metadata-Version: 2.5
+Name: bare-sidecar
+Version: 0.1.0
+Summary: Start and manage Bare sidecar processes from Python
+Author: Holepunch
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Requires-Python: >=3.10
+Provides-Extra: dev
+Requires-Dist: pytest>=8; extra == 'dev'
+Requires-Dist: ruff>=0.6; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# bare-sidecar-python
+
+Start and manage Bare sidecar processes from Python. The Python counterpart of [bare-sidecar](https://github.com/holepunchto/bare-sidecar): it runs a Bare entry point in a child process with an IPC connection to it, exposed as `Bare.IPC` inside the process. The Bare executable is shipped in platform wheels.
+
+```
+pip install bare-sidecar
+```
+
+Platform wheels are published for macOS 13 and later, Linux with glibc 2.34 and later, and Windows, each on arm64 and x64.
+
+## Usage
+
+```python
+import asyncio
+
+from bare_sidecar import spawn
+
+
+async def main():
+    async with await spawn("app.js") as sidecar:
+        await sidecar.write(b"Hello world")
+
+        async for data in sidecar:
+            print(data)
+
+
+asyncio.run(main())
+```
+
+Where `app.js` is a Bare entry point using `Bare.IPC`:
+
+```js
+Bare.IPC.on('data', (data) => Bare.IPC.write(data))
+```
+
+## License
+
+Apache-2.0

bare_sidecar-0.1.0.dist-info/RECORD

@@ -0,0 +1,11 @@
+bare_sidecar/__init__.py,sha256=IGrEdDxNTwugH4077OgCEGv7lMSWiIVFONjEuh-Fdhw,169
+bare_sidecar/_host.py,sha256=msf3SckEfXKpnjUgqBPuVgEzhPeroXVrcdMLzFGdCSk,543
+bare_sidecar/_ipc.py,sha256=T6c0b2adRMH517w_Gg7jva69XdWok7arLGDcoNNjbQw,2459
+bare_sidecar/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+bare_sidecar/sidecar.py,sha256=Mfax8ismpUKkqRiTWoSpjuWOjf506RJ1sep4GoNIA20,6447
+bare_sidecar/prebuilds/win32-x64/bare.exe,sha256=BPHk2fLHQCpiWqh3zZNo2xcRY7JapYOClip7TKiYAUU,43411456
+bare_sidecar-0.1.0.dist-info/METADATA,sha256=Qq_AelFDWDEfq-MNdySusVQkGY8OnmtTec-rMNtyB3o,1276
+bare_sidecar-0.1.0.dist-info/WHEEL,sha256=lpoBGaIUIidvvdZ4qRAP61bBKYJdt4FI3WXFL50Gzyo,94
+bare_sidecar-0.1.0.dist-info/licenses/LICENSE,sha256=R6LPz3pytRiGjm1UcrDBpNo9Lde4z9-HnfLdr4CJUQo,11284
+bare_sidecar-0.1.0.dist-info/licenses/NOTICE,sha256=hdAkJJsXX3Bg31bhcXn-xt_HHvZOAp-Yb3rwwHPxWzU,554
+bare_sidecar-0.1.0.dist-info/RECORD,,

bare_sidecar-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.33.0
+Root-Is-Purelib: false
+Tag: py3-none-win_amd64

bare_sidecar-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,200 @@
+                                 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 (an "as is" basis
+      without warranties 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.

bare_sidecar-0.1.0.dist-info/licenses/NOTICE

@@ -0,0 +1,13 @@
+Copyright 2026 Holepunch Inc
+
+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.