bitspark-bitwire 0.1.0__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,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.
@@ -0,0 +1,3 @@
1
+ include check.py
2
+ include requirements-dev.txt
3
+ recursive-include tests *.py
@@ -0,0 +1,10 @@
1
+ Bitwire
2
+ Copyright 2026 Bitspark and the Bitwire contributors
3
+
4
+ This product includes software developed at Bitspark (https://github.com/Bitspark).
5
+
6
+ The Python Wire declarations are adapted from Nightseam, licensed under the
7
+ Apache License, Version 2.0:
8
+ Copyright 2026 Bitspark and the Nightseam contributors.
9
+ Source revision: 1c63f1c4d7e4b5987d4bd32e294177645c92ed8f.
10
+ Source path: duplex/py/nightseam/duplex/wire.py.
@@ -0,0 +1,112 @@
1
+ Metadata-Version: 2.4
2
+ Name: bitspark-bitwire
3
+ Version: 0.1.0
4
+ Summary: The shared relative-path Wire contract for Python
5
+ Author: Bitspark
6
+ License-Expression: Apache-2.0
7
+ Project-URL: Homepage, https://github.com/Bitspark/bitwire
8
+ Project-URL: Documentation, https://github.com/Bitspark/bitwire/tree/main/docs
9
+ Project-URL: Repository, https://github.com/Bitspark/bitwire
10
+ Project-URL: Issues, https://github.com/Bitspark/bitwire/issues
11
+ Classifier: Development Status :: 3 - Alpha
12
+ Classifier: Programming Language :: Python :: 3
13
+ Classifier: Programming Language :: Python :: 3 :: Only
14
+ Classifier: Typing :: Typed
15
+ Requires-Python: >=3.11
16
+ Description-Content-Type: text/markdown
17
+ License-File: LICENSE
18
+ License-File: NOTICE
19
+ Dynamic: license-file
20
+
21
+ # Bitwire for Python
22
+
23
+ `bitspark-bitwire` provides the shared relative-path Wire contract as the Python
24
+ module `bitwire`. It requires Python 3.11 or newer and has no runtime dependencies.
25
+ The package contains typed declarations and supporting values; endpoint runtimes,
26
+ carriers, codecs and routing helpers belong to implementations.
27
+
28
+ ```python
29
+ from bitwire import Message, Receiver, ReturnAddress, Wire
30
+
31
+
32
+ def call(endpoint: Wire, replies: Wire) -> None:
33
+ endpoint.send(
34
+ ["cells", "get"],
35
+ Message(
36
+ {"version": 1, "kind": "request", "id": "request-1", "params": {}},
37
+ return_address=ReturnAddress(replies),
38
+ ),
39
+ )
40
+
41
+
42
+ def listen(endpoint: Wire):
43
+ def receive(path, message):
44
+ print(path, message.frame)
45
+
46
+ return endpoint.receive([], Receiver(namespace=True, message=receive))
47
+ ```
48
+
49
+ `Wire` is a structural `Protocol`; implementations do not need to inherit from
50
+ it. `send` accepts or refuses synchronously; the implementation schedules delivery.
51
+ Receivers may return an awaitable. `receive` returns an idempotent detach function.
52
+ Paths are sequences of opaque Unicode-scalar strings and retain empty segments.
53
+ Receiver paths are relative to the Wire on which they registered.
54
+
55
+ `ReturnAddress` uses object identity, including when its Wire cannot be compared
56
+ or hashed. Preserve this object during routing. The return address is local
57
+ capability data and must never be serialized into the profile envelope. Profile
58
+ payloads must follow the JSON profile despite their Python `object` annotation.
59
+ Runtime-owned received context associated with the return identity must survive
60
+ routing. Application-supplied context or metadata does not establish verified
61
+ invocation context; that verification remains the runtime's responsibility.
62
+
63
+ The [Wire contract](https://github.com/Bitspark/bitwire/blob/main/docs/wire/contract.md)
64
+ and [profile boundary](https://github.com/Bitspark/bitwire/blob/main/docs/wire/profile.md)
65
+ define the behavior. Runtime protocol checks verify only the presence of methods;
66
+ they cannot establish conformance.
67
+
68
+ ## Packaging and checks
69
+
70
+ From this directory:
71
+
72
+ ```sh
73
+ python -m pip install -r requirements-dev.txt
74
+ python check.py
75
+ ```
76
+
77
+ This builds a source distribution and a wheel from it, verifies the distribution
78
+ contents, installs the wheel into a temporary virtual environment, and runs both
79
+ consumer tests and static typing checks against that installed package. The test
80
+ endpoint is a recording fixture, not a Bitwire runtime or conformance driver.
81
+
82
+ For release artifacts at a chosen location:
83
+
84
+ ```sh
85
+ python -m build --outdir dist
86
+ ```
87
+
88
+ ## Optional PyPI publication
89
+
90
+ The manual `publish-python.yml` workflow publishes an existing immutable public
91
+ release tag. It is separate from the Go/TypeScript release and does not gate that
92
+ handover. Its default authentication is a PyPI trusted publisher. Configure these
93
+ fields under the PyPI account's **Publishing** page for a pending project:
94
+
95
+ | Field | Value |
96
+ | --- | --- |
97
+ | PyPI project name | `bitspark-bitwire` |
98
+ | Owner | `Bitspark` |
99
+ | Repository name | `bitwire` |
100
+ | Workflow name | `publish-python.yml` |
101
+ | Environment name | `pypi` |
102
+
103
+ For an existing project, add the same publisher under the project's publishing
104
+ settings. As a bootstrap fallback, store an API token in the repository or `pypi`
105
+ environment secret named `PYPI_API_TOKEN`, then select `api-token` when dispatching
106
+ the workflow from `main`. Tokens are passed only to publication steps. Revoke the
107
+ bootstrap token after trusted publishing is configured. The workflow verifies the
108
+ packaged artifact before upload and installs the published PyPI package afterward.
109
+
110
+ The binding is adapted from Nightseam's Python Wire declarations at commit
111
+ [`1c63f1c4`](https://github.com/Bitspark/nightseam/blob/1c63f1c4d7e4b5987d4bd32e294177645c92ed8f/duplex/py/nightseam/duplex/wire.py)
112
+ under Apache-2.0. See the included `LICENSE` and `NOTICE` files.
@@ -0,0 +1,92 @@
1
+ # Bitwire for Python
2
+
3
+ `bitspark-bitwire` provides the shared relative-path Wire contract as the Python
4
+ module `bitwire`. It requires Python 3.11 or newer and has no runtime dependencies.
5
+ The package contains typed declarations and supporting values; endpoint runtimes,
6
+ carriers, codecs and routing helpers belong to implementations.
7
+
8
+ ```python
9
+ from bitwire import Message, Receiver, ReturnAddress, Wire
10
+
11
+
12
+ def call(endpoint: Wire, replies: Wire) -> None:
13
+ endpoint.send(
14
+ ["cells", "get"],
15
+ Message(
16
+ {"version": 1, "kind": "request", "id": "request-1", "params": {}},
17
+ return_address=ReturnAddress(replies),
18
+ ),
19
+ )
20
+
21
+
22
+ def listen(endpoint: Wire):
23
+ def receive(path, message):
24
+ print(path, message.frame)
25
+
26
+ return endpoint.receive([], Receiver(namespace=True, message=receive))
27
+ ```
28
+
29
+ `Wire` is a structural `Protocol`; implementations do not need to inherit from
30
+ it. `send` accepts or refuses synchronously; the implementation schedules delivery.
31
+ Receivers may return an awaitable. `receive` returns an idempotent detach function.
32
+ Paths are sequences of opaque Unicode-scalar strings and retain empty segments.
33
+ Receiver paths are relative to the Wire on which they registered.
34
+
35
+ `ReturnAddress` uses object identity, including when its Wire cannot be compared
36
+ or hashed. Preserve this object during routing. The return address is local
37
+ capability data and must never be serialized into the profile envelope. Profile
38
+ payloads must follow the JSON profile despite their Python `object` annotation.
39
+ Runtime-owned received context associated with the return identity must survive
40
+ routing. Application-supplied context or metadata does not establish verified
41
+ invocation context; that verification remains the runtime's responsibility.
42
+
43
+ The [Wire contract](https://github.com/Bitspark/bitwire/blob/main/docs/wire/contract.md)
44
+ and [profile boundary](https://github.com/Bitspark/bitwire/blob/main/docs/wire/profile.md)
45
+ define the behavior. Runtime protocol checks verify only the presence of methods;
46
+ they cannot establish conformance.
47
+
48
+ ## Packaging and checks
49
+
50
+ From this directory:
51
+
52
+ ```sh
53
+ python -m pip install -r requirements-dev.txt
54
+ python check.py
55
+ ```
56
+
57
+ This builds a source distribution and a wheel from it, verifies the distribution
58
+ contents, installs the wheel into a temporary virtual environment, and runs both
59
+ consumer tests and static typing checks against that installed package. The test
60
+ endpoint is a recording fixture, not a Bitwire runtime or conformance driver.
61
+
62
+ For release artifacts at a chosen location:
63
+
64
+ ```sh
65
+ python -m build --outdir dist
66
+ ```
67
+
68
+ ## Optional PyPI publication
69
+
70
+ The manual `publish-python.yml` workflow publishes an existing immutable public
71
+ release tag. It is separate from the Go/TypeScript release and does not gate that
72
+ handover. Its default authentication is a PyPI trusted publisher. Configure these
73
+ fields under the PyPI account's **Publishing** page for a pending project:
74
+
75
+ | Field | Value |
76
+ | --- | --- |
77
+ | PyPI project name | `bitspark-bitwire` |
78
+ | Owner | `Bitspark` |
79
+ | Repository name | `bitwire` |
80
+ | Workflow name | `publish-python.yml` |
81
+ | Environment name | `pypi` |
82
+
83
+ For an existing project, add the same publisher under the project's publishing
84
+ settings. As a bootstrap fallback, store an API token in the repository or `pypi`
85
+ environment secret named `PYPI_API_TOKEN`, then select `api-token` when dispatching
86
+ the workflow from `main`. Tokens are passed only to publication steps. Revoke the
87
+ bootstrap token after trusted publishing is configured. The workflow verifies the
88
+ packaged artifact before upload and installs the published PyPI package afterward.
89
+
90
+ The binding is adapted from Nightseam's Python Wire declarations at commit
91
+ [`1c63f1c4`](https://github.com/Bitspark/nightseam/blob/1c63f1c4d7e4b5987d4bd32e294177645c92ed8f/duplex/py/nightseam/duplex/wire.py)
92
+ under Apache-2.0. See the included `LICENSE` and `NOTICE` files.
@@ -0,0 +1,55 @@
1
+ """Build an sdist and wheel, then check the wheel as an isolated typed consumer."""
2
+
3
+ from __future__ import annotations
4
+
5
+ import os
6
+ from pathlib import Path
7
+ import subprocess
8
+ import sys
9
+ import tarfile
10
+ from tempfile import TemporaryDirectory
11
+ import venv
12
+ from zipfile import ZipFile
13
+
14
+
15
+ def run(*args: str, cwd: Path, env: dict[str, str]) -> None:
16
+ subprocess.run(args, cwd=cwd, env=env, check=True)
17
+
18
+
19
+ def main() -> None:
20
+ package = Path(__file__).resolve().parent
21
+ env = dict(os.environ)
22
+ env.pop("PYTHONPATH", None)
23
+ with TemporaryDirectory(prefix="bitwire-python-") as directory:
24
+ temporary = Path(directory)
25
+ artifacts = temporary / "dist"
26
+ run(sys.executable, "-m", "build", str(package), "--outdir", str(artifacts), cwd=temporary, env=env)
27
+ wheel, = artifacts.glob("*.whl")
28
+ sdist, = artifacts.glob("*.tar.gz")
29
+ with ZipFile(wheel) as archive:
30
+ names = archive.namelist()
31
+ assert "bitwire/__init__.py" in names
32
+ assert "bitwire/py.typed" in names
33
+ assert any(name.endswith("/licenses/LICENSE") for name in names)
34
+ assert any(name.endswith("/licenses/NOTICE") for name in names)
35
+ metadata, = (name for name in names if name.endswith(".dist-info/METADATA"))
36
+ assert b"Requires-Dist:" not in archive.read(metadata)
37
+ with tarfile.open(sdist) as archive:
38
+ names = archive.getnames()
39
+ assert any(name.endswith("/src/bitwire/py.typed") for name in names)
40
+ assert any(name.endswith("/NOTICE") for name in names)
41
+ assert any(name.endswith("/check.py") for name in names)
42
+ assert any(name.endswith("/tests/typecheck.py") for name in names)
43
+
44
+ consumer = temporary / "consumer"
45
+ venv.create(consumer, with_pip=True)
46
+ executable = consumer / ("Scripts/python.exe" if os.name == "nt" else "bin/python")
47
+ run(str(executable), "-m", "pip", "install", "--no-index", "--no-deps", str(wheel), cwd=temporary, env=env)
48
+ run(str(executable), "-c", "import bitwire, sys; from pathlib import Path; assert Path(bitwire.__file__).resolve().is_relative_to(Path(sys.prefix).resolve())", cwd=temporary, env=env)
49
+ run(str(executable), "-m", "unittest", "discover", "-s", str(package / "tests"), "-p", "test_*.py", "-v", cwd=temporary, env=env)
50
+ run(sys.executable, "-m", "mypy", "--strict", "--python-version", "3.11", "--python-executable", str(executable), str(package / "tests"), cwd=temporary, env=env)
51
+ print("Python sdist, wheel, installed consumer and PEP 561 typing checks passed.")
52
+
53
+
54
+ if __name__ == "__main__":
55
+ main()
@@ -0,0 +1,36 @@
1
+ [build-system]
2
+ requires = ["setuptools>=77.0.3"]
3
+ build-backend = "setuptools.build_meta"
4
+
5
+ [project]
6
+ name = "bitspark-bitwire"
7
+ version = "0.1.0"
8
+ description = "The shared relative-path Wire contract for Python"
9
+ readme = "README.md"
10
+ requires-python = ">=3.11"
11
+ license = "Apache-2.0"
12
+ license-files = ["LICENSE", "NOTICE"]
13
+ authors = [{name = "Bitspark"}]
14
+ dependencies = []
15
+ classifiers = [
16
+ "Development Status :: 3 - Alpha",
17
+ "Programming Language :: Python :: 3",
18
+ "Programming Language :: Python :: 3 :: Only",
19
+ "Typing :: Typed",
20
+ ]
21
+
22
+ [project.urls]
23
+ Homepage = "https://github.com/Bitspark/bitwire"
24
+ Documentation = "https://github.com/Bitspark/bitwire/tree/main/docs"
25
+ Repository = "https://github.com/Bitspark/bitwire"
26
+ Issues = "https://github.com/Bitspark/bitwire/issues"
27
+
28
+ [tool.setuptools.packages.find]
29
+ where = ["src"]
30
+
31
+ [tool.setuptools.package-data]
32
+ bitwire = ["py.typed"]
33
+
34
+ [tool.mypy]
35
+ strict = true
36
+ python_version = "3.11"
@@ -0,0 +1,2 @@
1
+ build==1.5.0
2
+ mypy==1.18.2
@@ -0,0 +1,4 @@
1
+ [egg_info]
2
+ tag_build =
3
+ tag_date = 0
4
+
@@ -0,0 +1,112 @@
1
+ Metadata-Version: 2.4
2
+ Name: bitspark-bitwire
3
+ Version: 0.1.0
4
+ Summary: The shared relative-path Wire contract for Python
5
+ Author: Bitspark
6
+ License-Expression: Apache-2.0
7
+ Project-URL: Homepage, https://github.com/Bitspark/bitwire
8
+ Project-URL: Documentation, https://github.com/Bitspark/bitwire/tree/main/docs
9
+ Project-URL: Repository, https://github.com/Bitspark/bitwire
10
+ Project-URL: Issues, https://github.com/Bitspark/bitwire/issues
11
+ Classifier: Development Status :: 3 - Alpha
12
+ Classifier: Programming Language :: Python :: 3
13
+ Classifier: Programming Language :: Python :: 3 :: Only
14
+ Classifier: Typing :: Typed
15
+ Requires-Python: >=3.11
16
+ Description-Content-Type: text/markdown
17
+ License-File: LICENSE
18
+ License-File: NOTICE
19
+ Dynamic: license-file
20
+
21
+ # Bitwire for Python
22
+
23
+ `bitspark-bitwire` provides the shared relative-path Wire contract as the Python
24
+ module `bitwire`. It requires Python 3.11 or newer and has no runtime dependencies.
25
+ The package contains typed declarations and supporting values; endpoint runtimes,
26
+ carriers, codecs and routing helpers belong to implementations.
27
+
28
+ ```python
29
+ from bitwire import Message, Receiver, ReturnAddress, Wire
30
+
31
+
32
+ def call(endpoint: Wire, replies: Wire) -> None:
33
+ endpoint.send(
34
+ ["cells", "get"],
35
+ Message(
36
+ {"version": 1, "kind": "request", "id": "request-1", "params": {}},
37
+ return_address=ReturnAddress(replies),
38
+ ),
39
+ )
40
+
41
+
42
+ def listen(endpoint: Wire):
43
+ def receive(path, message):
44
+ print(path, message.frame)
45
+
46
+ return endpoint.receive([], Receiver(namespace=True, message=receive))
47
+ ```
48
+
49
+ `Wire` is a structural `Protocol`; implementations do not need to inherit from
50
+ it. `send` accepts or refuses synchronously; the implementation schedules delivery.
51
+ Receivers may return an awaitable. `receive` returns an idempotent detach function.
52
+ Paths are sequences of opaque Unicode-scalar strings and retain empty segments.
53
+ Receiver paths are relative to the Wire on which they registered.
54
+
55
+ `ReturnAddress` uses object identity, including when its Wire cannot be compared
56
+ or hashed. Preserve this object during routing. The return address is local
57
+ capability data and must never be serialized into the profile envelope. Profile
58
+ payloads must follow the JSON profile despite their Python `object` annotation.
59
+ Runtime-owned received context associated with the return identity must survive
60
+ routing. Application-supplied context or metadata does not establish verified
61
+ invocation context; that verification remains the runtime's responsibility.
62
+
63
+ The [Wire contract](https://github.com/Bitspark/bitwire/blob/main/docs/wire/contract.md)
64
+ and [profile boundary](https://github.com/Bitspark/bitwire/blob/main/docs/wire/profile.md)
65
+ define the behavior. Runtime protocol checks verify only the presence of methods;
66
+ they cannot establish conformance.
67
+
68
+ ## Packaging and checks
69
+
70
+ From this directory:
71
+
72
+ ```sh
73
+ python -m pip install -r requirements-dev.txt
74
+ python check.py
75
+ ```
76
+
77
+ This builds a source distribution and a wheel from it, verifies the distribution
78
+ contents, installs the wheel into a temporary virtual environment, and runs both
79
+ consumer tests and static typing checks against that installed package. The test
80
+ endpoint is a recording fixture, not a Bitwire runtime or conformance driver.
81
+
82
+ For release artifacts at a chosen location:
83
+
84
+ ```sh
85
+ python -m build --outdir dist
86
+ ```
87
+
88
+ ## Optional PyPI publication
89
+
90
+ The manual `publish-python.yml` workflow publishes an existing immutable public
91
+ release tag. It is separate from the Go/TypeScript release and does not gate that
92
+ handover. Its default authentication is a PyPI trusted publisher. Configure these
93
+ fields under the PyPI account's **Publishing** page for a pending project:
94
+
95
+ | Field | Value |
96
+ | --- | --- |
97
+ | PyPI project name | `bitspark-bitwire` |
98
+ | Owner | `Bitspark` |
99
+ | Repository name | `bitwire` |
100
+ | Workflow name | `publish-python.yml` |
101
+ | Environment name | `pypi` |
102
+
103
+ For an existing project, add the same publisher under the project's publishing
104
+ settings. As a bootstrap fallback, store an API token in the repository or `pypi`
105
+ environment secret named `PYPI_API_TOKEN`, then select `api-token` when dispatching
106
+ the workflow from `main`. Tokens are passed only to publication steps. Revoke the
107
+ bootstrap token after trusted publishing is configured. The workflow verifies the
108
+ packaged artifact before upload and installs the published PyPI package afterward.
109
+
110
+ The binding is adapted from Nightseam's Python Wire declarations at commit
111
+ [`1c63f1c4`](https://github.com/Bitspark/nightseam/blob/1c63f1c4d7e4b5987d4bd32e294177645c92ed8f/duplex/py/nightseam/duplex/wire.py)
112
+ under Apache-2.0. See the included `LICENSE` and `NOTICE` files.
@@ -0,0 +1,15 @@
1
+ LICENSE
2
+ MANIFEST.in
3
+ NOTICE
4
+ README.md
5
+ check.py
6
+ pyproject.toml
7
+ requirements-dev.txt
8
+ src/bitspark_bitwire.egg-info/PKG-INFO
9
+ src/bitspark_bitwire.egg-info/SOURCES.txt
10
+ src/bitspark_bitwire.egg-info/dependency_links.txt
11
+ src/bitspark_bitwire.egg-info/top_level.txt
12
+ src/bitwire/__init__.py
13
+ src/bitwire/py.typed
14
+ tests/test_consumer.py
15
+ tests/typecheck.py
@@ -0,0 +1,140 @@
1
+ """The shared relative-path Wire contract, without a runtime dependency.
2
+
3
+ Adapted from Nightseam's duplex/py/nightseam/duplex/wire.py at
4
+ 1c63f1c4d7e4b5987d4bd32e294177645c92ed8f under Apache-2.0.
5
+ Dispatch, path encoding, carriers and composition helpers belong to implementations.
6
+ """
7
+
8
+ from __future__ import annotations
9
+
10
+ from collections.abc import Awaitable, Callable, Mapping, Sequence
11
+ from dataclasses import dataclass
12
+ from typing import Literal, NotRequired, Protocol, TypedDict, runtime_checkable
13
+
14
+ __all__ = [
15
+ "Path",
16
+ "ProfileKind",
17
+ "ProfileError",
18
+ "RequestFrame",
19
+ "ResultFrame",
20
+ "ErrorFrame",
21
+ "EventFrame",
22
+ "CancelFrame",
23
+ "ProfileFrame",
24
+ "ReturnAddress",
25
+ "Message",
26
+ "Receiver",
27
+ "Wire",
28
+ ]
29
+
30
+ # Opaque Unicode-scalar segments: [] != [""] != ["a/b"] != ["a", "b"].
31
+ Path = Sequence[str]
32
+ ProfileKind = Literal["request", "response", "event", "cancel"]
33
+
34
+
35
+ class ProfileError(TypedDict):
36
+ """Public error data, independent of any runtime exception class."""
37
+
38
+ code: str
39
+ message: str
40
+ data: NotRequired[object]
41
+
42
+
43
+ class _TracedFrame(TypedDict):
44
+ version: Literal[1]
45
+ traceparent: NotRequired[str]
46
+ tracestate: NotRequired[str]
47
+
48
+
49
+ class RequestFrame(_TracedFrame):
50
+ """The send path supplies the method name; params follow the JSON profile."""
51
+
52
+ kind: Literal["request"]
53
+ id: str
54
+ params: object
55
+ meta: NotRequired[Mapping[str, str]]
56
+
57
+
58
+ class ResultFrame(_TracedFrame):
59
+ kind: Literal["response"]
60
+ id: str
61
+ result: object
62
+
63
+
64
+ class ErrorFrame(_TracedFrame):
65
+ kind: Literal["response"]
66
+ id: str
67
+ error: ProfileError
68
+
69
+
70
+ class EventFrame(_TracedFrame):
71
+ """The send path supplies the event name; data follow the JSON profile."""
72
+
73
+ kind: Literal["event"]
74
+ data: object
75
+ meta: NotRequired[Mapping[str, str]]
76
+
77
+
78
+ class CancelFrame(_TracedFrame):
79
+ kind: Literal["cancel"]
80
+ id: str
81
+
82
+
83
+ ProfileFrame = RequestFrame | ResultFrame | ErrorFrame | EventFrame | CancelFrame
84
+
85
+
86
+ @dataclass(frozen=True, eq=False)
87
+ class ReturnAddress:
88
+ """Local capability with identity equality, never a network-envelope member.
89
+
90
+ Different addresses stay distinct even when they hold the same Wire. The
91
+ wrapped implementation need not support equality or hashing. Routing must
92
+ preserve this address object, rather than construct an equivalent wrapper.
93
+ Runtime-owned received context associated with this identity must survive
94
+ routing; application payloads are not evidence of verified context.
95
+ """
96
+
97
+ wire: Wire
98
+
99
+
100
+ @dataclass(frozen=True)
101
+ class Message:
102
+ """A profile frame plus optional local return access.
103
+
104
+ Only frame data belongs to the serialized profile. Payloads typed as object
105
+ must still satisfy the JSON profile; arbitrary Python objects are not implied.
106
+ """
107
+
108
+ frame: ProfileFrame
109
+ return_address: ReturnAddress | None = None
110
+
111
+
112
+ @dataclass(frozen=True)
113
+ class Receiver:
114
+ """Callbacks receive paths relative to the Wire on which they registered.
115
+
116
+ Exact routes win, then the longest namespace segment prefix wins. A receiver
117
+ may be synchronous or awaitable; endpoint implementations own dispatch.
118
+ """
119
+
120
+ namespace: bool = False
121
+ message: Callable[[Path, Message], None | Awaitable[None]] | None = None
122
+ closed: Callable[[int, str], None] | None = None
123
+
124
+
125
+ @runtime_checkable
126
+ class Wire(Protocol):
127
+ """Access to an origin with synchronous admission and asynchronous dispatch.
128
+
129
+ send returns on acceptance or raises on refusal, without running destination
130
+ application code on the sender's stack. receive refuses duplicate paths and
131
+ returns an idempotent detach. A root owns dispatch, bounds and closure; a
132
+ selected view shares that closure, while a mount owns only its registrations
133
+ and routing. Structural protocol matching alone does not prove these laws.
134
+ """
135
+
136
+ def send(self, path: Path, message: Message) -> None: ...
137
+
138
+ def receive(self, path: Path, receiver: Receiver) -> Callable[[], None]: ...
139
+
140
+ def close(self, code: int = 1000, reason: str = "") -> None: ...
File without changes
@@ -0,0 +1,105 @@
1
+ """Consumer observations against declarations, not a runtime conformance suite."""
2
+
3
+ from __future__ import annotations
4
+
5
+ import asyncio
6
+ import inspect
7
+ import unittest
8
+ from collections.abc import Callable
9
+
10
+ from bitwire import Message, Path, Receiver, ReturnAddress, Wire
11
+
12
+
13
+ class RecordingEndpoint:
14
+ """Independent structural consumer fixture; no inheritance or routing runtime."""
15
+
16
+ def __init__(self) -> None:
17
+ self.sent: list[tuple[tuple[str, ...], Message]] = []
18
+ self.receivers: dict[tuple[str, ...], Receiver] = {}
19
+ self.ending: tuple[int, str] | None = None
20
+
21
+ def __eq__(self, other: object) -> bool:
22
+ raise AssertionError("ReturnAddress must not compare the wrapped Wire")
23
+
24
+ def send(self, path: Path, message: Message) -> None:
25
+ self.sent.append((tuple(path), message))
26
+
27
+ def receive(self, path: Path, receiver: Receiver) -> Callable[[], None]:
28
+ key = tuple(path)
29
+ self.receivers[key] = receiver
30
+
31
+ def detach() -> None:
32
+ self.receivers.pop(key, None)
33
+
34
+ return detach
35
+
36
+ def close(self, code: int = 1000, reason: str = "") -> None:
37
+ self.ending = (code, reason)
38
+
39
+
40
+ class ConsumerTests(unittest.TestCase):
41
+ def test_structural_consumer_keeps_path_frame_and_return_object(self) -> None:
42
+ endpoint = RecordingEndpoint()
43
+ wire: Wire = endpoint
44
+ replies = ReturnAddress(RecordingEndpoint())
45
+ request = Message(
46
+ {"version": 1, "kind": "request", "id": "r1", "params": {"count": 2**80}},
47
+ replies,
48
+ )
49
+ self.assertIsInstance(endpoint, Wire)
50
+ for path in ([], [""], ["a/b"], ["a", "b"], ["\u03bb", "\U0001f30d"]):
51
+ wire.send(path, request)
52
+
53
+ self.assertEqual(len({path for path, _ in endpoint.sent}), 5)
54
+ for _, delivered in endpoint.sent:
55
+ self.assertIs(delivered, request)
56
+ self.assertIs(delivered.frame, request.frame)
57
+ self.assertIs(delivered.return_address, replies)
58
+
59
+ def test_return_identity_is_independent_of_wire_equality_and_hashing(self) -> None:
60
+ endpoint = RecordingEndpoint()
61
+ first, second = ReturnAddress(endpoint), ReturnAddress(endpoint)
62
+ self.assertNotEqual(first, second)
63
+ self.assertEqual(first, first)
64
+ self.assertEqual(len({first, second}), 2)
65
+ self.assertIs(first.wire, endpoint)
66
+
67
+ def test_async_receiver_and_detach_are_usable_by_a_consumer(self) -> None:
68
+ endpoint = RecordingEndpoint()
69
+ observed: list[tuple[tuple[str, ...], Message]] = []
70
+
71
+ async def delivered(path: Path, message: Message) -> None:
72
+ await asyncio.sleep(0)
73
+ observed.append((tuple(path), message))
74
+
75
+ receiver = Receiver(namespace=True, message=delivered)
76
+ detach = endpoint.receive(["reply"], receiver)
77
+ request = Message({"version": 1, "kind": "event", "data": None})
78
+
79
+ async def dispatch() -> None:
80
+ registered = endpoint.receivers[("reply",)]
81
+ self.assertTrue(registered.namespace)
82
+ assert registered.message is not None
83
+ result = registered.message(["reply", ""], request)
84
+ if inspect.isawaitable(result):
85
+ await result
86
+
87
+ asyncio.run(dispatch())
88
+ self.assertEqual(observed, [(("reply", ""), request)])
89
+ detach()
90
+ detach()
91
+ self.assertEqual(endpoint.receivers, {})
92
+ self.assertIsNone(endpoint.ending)
93
+
94
+ def test_closed_callback_is_independent_from_message_callback(self) -> None:
95
+ endings: list[tuple[int, str]] = []
96
+ receiver = Receiver(closed=lambda code, reason: endings.append((code, reason)))
97
+ assert receiver.closed is not None
98
+ receiver.closed(1000, "complete")
99
+ self.assertEqual(endings, [(1000, "complete")])
100
+ self.assertIsNone(receiver.message)
101
+ self.assertFalse(receiver.namespace)
102
+
103
+
104
+ if __name__ == "__main__":
105
+ unittest.main()
@@ -0,0 +1,43 @@
1
+ """Compile-only consumers, including rejections guarded by unused-ignore checks."""
2
+
3
+ from typing import assert_type
4
+
5
+ from bitwire import (
6
+ CancelFrame,
7
+ ErrorFrame,
8
+ EventFrame,
9
+ Message,
10
+ Path,
11
+ ProfileFrame,
12
+ ProfileKind,
13
+ Receiver,
14
+ RequestFrame,
15
+ ResultFrame,
16
+ ReturnAddress,
17
+ Wire,
18
+ )
19
+
20
+
21
+ def consume(wire: Wire, frame: ProfileFrame) -> None:
22
+ address = ReturnAddress(wire)
23
+ wire.send(["scope", ""], Message(frame, address))
24
+ assert_type(address.wire, Wire)
25
+ kind: ProfileKind = frame["kind"]
26
+ assert_type(kind, ProfileKind)
27
+ if frame["kind"] == "request":
28
+ assert_type(frame["id"], str)
29
+
30
+ async def delivered(path: Path, message: Message) -> None:
31
+ assert_type(message.return_address, ReturnAddress | None)
32
+
33
+ wire.receive([], Receiver(namespace=True, message=delivered))()
34
+ wire.send([42], Message(frame)) # type: ignore[list-item]
35
+
36
+
37
+ request: RequestFrame = {"version": 1, "kind": "request", "id": "1", "params": {}}
38
+ result: ResultFrame = {"version": 1, "kind": "response", "id": "1", "result": None}
39
+ error: ErrorFrame = {"version": 1, "kind": "response", "id": "1", "error": {"code": "no", "message": "No"}}
40
+ event: EventFrame = {"version": 1, "kind": "event", "data": None}
41
+ cancel: CancelFrame = {"version": 1, "kind": "cancel", "id": "1"}
42
+ invalid_version: RequestFrame = {"version": 2, "kind": "request", "id": "1", "params": {}} # type: ignore[typeddict-item]
43
+ contradictory: ResultFrame = {"version": 1, "kind": "response", "id": "1", "result": None, "error": {"code": "x", "message": "x"}} # type: ignore[typeddict-unknown-key]