wirestead 0.9.2__cp313-cp313-win_amd64.whl
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.
- wirestead/__init__.py +66 -0
- wirestead/_core.cp313-win_amd64.pyd +0 -0
- wirestead/_version.py +1 -0
- wirestead/asyncio.py +263 -0
- wirestead/py.typed +1 -0
- wirestead-0.9.2.dist-info/METADATA +186 -0
- wirestead-0.9.2.dist-info/RECORD +10 -0
- wirestead-0.9.2.dist-info/WHEEL +5 -0
- wirestead-0.9.2.dist-info/licenses/LICENSE +201 -0
- wirestead-0.9.2.dist-info/licenses/NOTICE +3 -0
wirestead/__init__.py
ADDED
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
import os
|
|
2
|
+
from pathlib import Path
|
|
3
|
+
import sys
|
|
4
|
+
|
|
5
|
+
from ._version import __version__
|
|
6
|
+
|
|
7
|
+
_dll_dir_handles = []
|
|
8
|
+
_registered_dll_dirs = set()
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
def _register_windows_dll_directory(directory: Path) -> None:
|
|
12
|
+
if os.name != "nt" or not hasattr(os, "add_dll_directory"):
|
|
13
|
+
return
|
|
14
|
+
|
|
15
|
+
try:
|
|
16
|
+
resolved_dir = str(directory.resolve())
|
|
17
|
+
if not os.path.isdir(resolved_dir) or resolved_dir in _registered_dll_dirs:
|
|
18
|
+
return
|
|
19
|
+
|
|
20
|
+
handle = os.add_dll_directory(resolved_dir)
|
|
21
|
+
_dll_dir_handles.append(handle)
|
|
22
|
+
_registered_dll_dirs.add(resolved_dir)
|
|
23
|
+
except Exception:
|
|
24
|
+
pass
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
def _add_windows_dll_directories(package_dir: Path) -> None:
|
|
28
|
+
if os.name != "nt" or not hasattr(os, "add_dll_directory"):
|
|
29
|
+
return
|
|
30
|
+
|
|
31
|
+
_register_windows_dll_directory(package_dir)
|
|
32
|
+
|
|
33
|
+
for path_str in os.environ.get("WIRESTEAD_WINDOWS_DLL_DIRS", "").split(
|
|
34
|
+
os.pathsep
|
|
35
|
+
):
|
|
36
|
+
if path_str:
|
|
37
|
+
_register_windows_dll_directory(Path(path_str))
|
|
38
|
+
|
|
39
|
+
for path_str in os.environ.get("PATH", "").split(os.pathsep):
|
|
40
|
+
if not path_str:
|
|
41
|
+
continue
|
|
42
|
+
path_lower = path_str.lower()
|
|
43
|
+
if (
|
|
44
|
+
"vcpkg" in path_lower
|
|
45
|
+
or "wirestead" in path_lower
|
|
46
|
+
or "unilink" in path_lower
|
|
47
|
+
):
|
|
48
|
+
_register_windows_dll_directory(Path(path_str))
|
|
49
|
+
|
|
50
|
+
|
|
51
|
+
try:
|
|
52
|
+
_add_windows_dll_directories(Path(__file__).resolve().parent)
|
|
53
|
+
from ._core import *
|
|
54
|
+
except ImportError as exc:
|
|
55
|
+
raise ImportError(
|
|
56
|
+
"Failed to import the Wirestead Python extension. "
|
|
57
|
+
"Make sure the package was built with a compatible Wirestead C++ core."
|
|
58
|
+
) from exc
|
|
59
|
+
|
|
60
|
+
__all__ = [
|
|
61
|
+
name
|
|
62
|
+
for name in globals()
|
|
63
|
+
if not name.startswith("_") and name not in {"os", "Path", "sys"}
|
|
64
|
+
]
|
|
65
|
+
|
|
66
|
+
del os, Path, sys
|
|
Binary file
|
wirestead/_version.py
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
__version__ = "0.9.2"
|
wirestead/asyncio.py
ADDED
|
@@ -0,0 +1,263 @@
|
|
|
1
|
+
import asyncio
|
|
2
|
+
from typing import List, Union
|
|
3
|
+
|
|
4
|
+
from . import _core
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
def _get_loop():
|
|
8
|
+
try:
|
|
9
|
+
return asyncio.get_running_loop()
|
|
10
|
+
except RuntimeError:
|
|
11
|
+
return asyncio.get_event_loop()
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
class AsyncChannelBase:
|
|
15
|
+
"""Base class for all asynchronous client transports."""
|
|
16
|
+
|
|
17
|
+
def __init__(self, client_instance):
|
|
18
|
+
self._raw_client = client_instance
|
|
19
|
+
self._loop = None
|
|
20
|
+
self._data_queue = asyncio.Queue()
|
|
21
|
+
self._message_queue = asyncio.Queue()
|
|
22
|
+
|
|
23
|
+
try:
|
|
24
|
+
self._loop = _get_loop()
|
|
25
|
+
except RuntimeError:
|
|
26
|
+
self._loop = None
|
|
27
|
+
|
|
28
|
+
# Setup internal handlers
|
|
29
|
+
self._raw_client.on_data(self._on_data_bridge)
|
|
30
|
+
self._raw_client.on_message(self._on_message_bridge)
|
|
31
|
+
|
|
32
|
+
def _ensure_loop(self):
|
|
33
|
+
if self._loop is None or self._loop.is_closed():
|
|
34
|
+
self._loop = _get_loop()
|
|
35
|
+
return self._loop
|
|
36
|
+
|
|
37
|
+
def _schedule_on_loop(self, callback, *args):
|
|
38
|
+
loop = self._loop
|
|
39
|
+
if loop is None or loop.is_closed():
|
|
40
|
+
return False
|
|
41
|
+
loop.call_soon_threadsafe(callback, *args)
|
|
42
|
+
return True
|
|
43
|
+
|
|
44
|
+
def _on_data_bridge(self, ctx):
|
|
45
|
+
self._schedule_on_loop(self._data_queue.put_nowait, ctx)
|
|
46
|
+
|
|
47
|
+
def _on_message_bridge(self, ctx):
|
|
48
|
+
self._schedule_on_loop(self._message_queue.put_nowait, ctx)
|
|
49
|
+
|
|
50
|
+
async def start(self) -> bool:
|
|
51
|
+
"""Starts the channel and waits for the connection attempt to complete."""
|
|
52
|
+
loop = self._ensure_loop()
|
|
53
|
+
return await loop.run_in_executor(None, self._raw_client.start)
|
|
54
|
+
|
|
55
|
+
def stop(self):
|
|
56
|
+
"""Stops the channel operations."""
|
|
57
|
+
self._raw_client.stop()
|
|
58
|
+
|
|
59
|
+
def connected(self) -> bool:
|
|
60
|
+
"""Returns whether the underlying channel is currently connected."""
|
|
61
|
+
return self._raw_client.connected()
|
|
62
|
+
|
|
63
|
+
def send(self, data: Union[str, bytes]) -> bool:
|
|
64
|
+
"""Sends data through the channel and returns whether it was accepted."""
|
|
65
|
+
return self._raw_client.send(data)
|
|
66
|
+
|
|
67
|
+
async def read(self) -> _core.MessageContext:
|
|
68
|
+
"""Waits for next raw data packet."""
|
|
69
|
+
return await self._data_queue.get()
|
|
70
|
+
|
|
71
|
+
async def read_message(self) -> _core.MessageContext:
|
|
72
|
+
"""Waits for next framed message context."""
|
|
73
|
+
return await self._message_queue.get()
|
|
74
|
+
|
|
75
|
+
def use_line_framer(
|
|
76
|
+
self, delimiter: str = "\n", include_delimiter: bool = False, max_length: int = 65536
|
|
77
|
+
):
|
|
78
|
+
self._raw_client.use_line_framer(delimiter, include_delimiter, max_length)
|
|
79
|
+
return self
|
|
80
|
+
|
|
81
|
+
def use_packet_framer(
|
|
82
|
+
self, start_pattern: List[int], end_pattern: List[int], max_length: int
|
|
83
|
+
):
|
|
84
|
+
self._raw_client.use_packet_framer(start_pattern, end_pattern, max_length)
|
|
85
|
+
return self
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
class AsyncTcpClient(AsyncChannelBase):
|
|
89
|
+
def __init__(self, host: str, port: int):
|
|
90
|
+
super().__init__(_core.TcpClient(host, port))
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
class AsyncUdsClient(AsyncChannelBase):
|
|
94
|
+
def __init__(self, socket_path: str):
|
|
95
|
+
super().__init__(_core.UdsClient(socket_path))
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
class AsyncSerial(AsyncChannelBase):
|
|
99
|
+
def __init__(self, device: str, baud_rate: int):
|
|
100
|
+
super().__init__(_core.Serial(device, baud_rate))
|
|
101
|
+
|
|
102
|
+
def baud_rate(self, baud: int):
|
|
103
|
+
self._raw_client.baud_rate(baud)
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
class AsyncUdp(AsyncChannelBase):
|
|
107
|
+
def __init__(self, config: _core.UdpConfig):
|
|
108
|
+
super().__init__(_core.Udp(config))
|
|
109
|
+
|
|
110
|
+
|
|
111
|
+
class AsyncServerSession:
|
|
112
|
+
"""Represents a client session on an asynchronous server."""
|
|
113
|
+
|
|
114
|
+
def __init__(self, server, client_id: int, info: str, loop):
|
|
115
|
+
self._server = server
|
|
116
|
+
self.id = client_id
|
|
117
|
+
self.info = info
|
|
118
|
+
self._loop = loop
|
|
119
|
+
self._data_queue = asyncio.Queue()
|
|
120
|
+
self._message_queue = asyncio.Queue()
|
|
121
|
+
self._closed = asyncio.Event()
|
|
122
|
+
|
|
123
|
+
def _push_data(self, data):
|
|
124
|
+
self._loop.call_soon_threadsafe(self._data_queue.put_nowait, data)
|
|
125
|
+
|
|
126
|
+
def _push_message(self, data):
|
|
127
|
+
self._loop.call_soon_threadsafe(self._message_queue.put_nowait, data)
|
|
128
|
+
|
|
129
|
+
def _notify_disconnect(self):
|
|
130
|
+
self._loop.call_soon_threadsafe(self._closed.set)
|
|
131
|
+
|
|
132
|
+
async def send(self, data: Union[str, bytes]) -> bool:
|
|
133
|
+
return self._server.send_to(self.id, data)
|
|
134
|
+
|
|
135
|
+
async def read(self) -> _core.MessageContext:
|
|
136
|
+
return await self._data_queue.get()
|
|
137
|
+
|
|
138
|
+
async def read_message(self) -> _core.MessageContext:
|
|
139
|
+
return await self._message_queue.get()
|
|
140
|
+
|
|
141
|
+
def __aiter__(self):
|
|
142
|
+
return self
|
|
143
|
+
|
|
144
|
+
async def __anext__(self):
|
|
145
|
+
if self._closed.is_set() and self._message_queue.empty():
|
|
146
|
+
raise StopAsyncIteration
|
|
147
|
+
return await self.read_message()
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
class AsyncServerBase:
|
|
151
|
+
"""Base class for all asynchronous servers."""
|
|
152
|
+
|
|
153
|
+
def __init__(self, server_instance):
|
|
154
|
+
self._raw_server = server_instance
|
|
155
|
+
self._loop = None
|
|
156
|
+
self._sessions = {}
|
|
157
|
+
self._session_queue = asyncio.Queue()
|
|
158
|
+
|
|
159
|
+
try:
|
|
160
|
+
self._loop = _get_loop()
|
|
161
|
+
except RuntimeError:
|
|
162
|
+
self._loop = None
|
|
163
|
+
|
|
164
|
+
# Setup bridges
|
|
165
|
+
self._raw_server.on_connect(self._on_connect_bridge)
|
|
166
|
+
self._raw_server.on_disconnect(self._on_disconnect_bridge)
|
|
167
|
+
self._raw_server.on_data(self._on_data_bridge)
|
|
168
|
+
self._raw_server.on_message(self._on_message_bridge)
|
|
169
|
+
|
|
170
|
+
def _ensure_loop(self):
|
|
171
|
+
if self._loop is None or self._loop.is_closed():
|
|
172
|
+
self._loop = _get_loop()
|
|
173
|
+
return self._loop
|
|
174
|
+
|
|
175
|
+
def _schedule_on_loop(self, callback, *args):
|
|
176
|
+
loop = self._loop
|
|
177
|
+
if loop is None or loop.is_closed():
|
|
178
|
+
return False
|
|
179
|
+
loop.call_soon_threadsafe(callback, *args)
|
|
180
|
+
return True
|
|
181
|
+
|
|
182
|
+
def _on_connect_bridge(self, ctx):
|
|
183
|
+
def attach_session():
|
|
184
|
+
session = AsyncServerSession(
|
|
185
|
+
self._raw_server, ctx.client_id, ctx.client_info, self._loop
|
|
186
|
+
)
|
|
187
|
+
self._sessions[ctx.client_id] = session
|
|
188
|
+
self._session_queue.put_nowait(session)
|
|
189
|
+
|
|
190
|
+
self._schedule_on_loop(attach_session)
|
|
191
|
+
|
|
192
|
+
def _on_disconnect_bridge(self, ctx):
|
|
193
|
+
def detach_session():
|
|
194
|
+
session = self._sessions.pop(ctx.client_id, None)
|
|
195
|
+
if session:
|
|
196
|
+
session._closed.set()
|
|
197
|
+
|
|
198
|
+
self._schedule_on_loop(detach_session)
|
|
199
|
+
|
|
200
|
+
def _on_data_bridge(self, ctx):
|
|
201
|
+
def push_data():
|
|
202
|
+
session = self._sessions.get(ctx.client_id)
|
|
203
|
+
if session:
|
|
204
|
+
session._data_queue.put_nowait(ctx)
|
|
205
|
+
|
|
206
|
+
self._schedule_on_loop(push_data)
|
|
207
|
+
|
|
208
|
+
def _on_message_bridge(self, ctx):
|
|
209
|
+
def push_message():
|
|
210
|
+
session = self._sessions.get(ctx.client_id)
|
|
211
|
+
if session:
|
|
212
|
+
session._message_queue.put_nowait(ctx)
|
|
213
|
+
|
|
214
|
+
self._schedule_on_loop(push_message)
|
|
215
|
+
|
|
216
|
+
async def start(self) -> bool:
|
|
217
|
+
loop = self._ensure_loop()
|
|
218
|
+
return await loop.run_in_executor(None, self._raw_server.start)
|
|
219
|
+
|
|
220
|
+
def stop(self):
|
|
221
|
+
self._raw_server.stop()
|
|
222
|
+
|
|
223
|
+
def listening(self) -> bool:
|
|
224
|
+
return self._raw_server.listening()
|
|
225
|
+
|
|
226
|
+
def broadcast(self, data: Union[str, bytes]) -> bool:
|
|
227
|
+
return self._raw_server.broadcast(data)
|
|
228
|
+
|
|
229
|
+
def use_line_framer(
|
|
230
|
+
self, delimiter: str = "\n", include_delimiter: bool = False, max_length: int = 65536
|
|
231
|
+
):
|
|
232
|
+
self._raw_server.use_line_framer(delimiter, include_delimiter, max_length)
|
|
233
|
+
return self
|
|
234
|
+
|
|
235
|
+
def use_packet_framer(
|
|
236
|
+
self, start_pattern: List[int], end_pattern: List[int], max_length: int
|
|
237
|
+
):
|
|
238
|
+
self._raw_server.use_packet_framer(start_pattern, end_pattern, max_length)
|
|
239
|
+
return self
|
|
240
|
+
|
|
241
|
+
def __aiter__(self):
|
|
242
|
+
return self
|
|
243
|
+
|
|
244
|
+
async def __anext__(self) -> AsyncServerSession:
|
|
245
|
+
return await self._session_queue.get()
|
|
246
|
+
|
|
247
|
+
|
|
248
|
+
class AsyncTcpServer(AsyncServerBase):
|
|
249
|
+
def __init__(self, port: int):
|
|
250
|
+
super().__init__(_core.TcpServer(port))
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
class AsyncUdsServer(AsyncServerBase):
|
|
254
|
+
def __init__(self, socket_path: str):
|
|
255
|
+
super().__init__(_core.UdsServer(socket_path))
|
|
256
|
+
|
|
257
|
+
|
|
258
|
+
class AsyncUdpServer(AsyncServerBase):
|
|
259
|
+
def __init__(self, port_or_config: Union[int, _core.UdpConfig]):
|
|
260
|
+
if isinstance(port_or_config, int):
|
|
261
|
+
super().__init__(_core.UdpServer(port_or_config))
|
|
262
|
+
else:
|
|
263
|
+
super().__init__(_core.UdpServer(port_or_config))
|
wirestead/py.typed
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
|
|
@@ -0,0 +1,186 @@
|
|
|
1
|
+
Metadata-Version: 2.1
|
|
2
|
+
Name: wirestead
|
|
3
|
+
Version: 0.9.2
|
|
4
|
+
Summary: Cross-platform Python bindings for the Wirestead async C++ communication library
|
|
5
|
+
Author: Jinwoo Sung
|
|
6
|
+
License: Apache-2.0
|
|
7
|
+
Classifier: Development Status :: 3 - Alpha
|
|
8
|
+
Classifier: Programming Language :: Python :: 3
|
|
9
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
|
10
|
+
Classifier: Programming Language :: Python :: 3.10
|
|
11
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
12
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
13
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
14
|
+
Classifier: Programming Language :: C++
|
|
15
|
+
Classifier: License :: OSI Approved :: Apache Software License
|
|
16
|
+
Classifier: Operating System :: POSIX :: Linux
|
|
17
|
+
Classifier: Operating System :: MacOS
|
|
18
|
+
Classifier: Operating System :: Microsoft :: Windows
|
|
19
|
+
Project-URL: Documentation, https://github.com/wirestead/wirestead-python#readme
|
|
20
|
+
Project-URL: Source, https://github.com/wirestead/wirestead-python
|
|
21
|
+
Project-URL: Changelog, https://github.com/wirestead/wirestead-python/blob/main/CHANGELOG.md
|
|
22
|
+
Project-URL: Issue Tracker, https://github.com/wirestead/wirestead-python/issues
|
|
23
|
+
Project-URL: Wirestead Core, https://github.com/wirestead/wirestead
|
|
24
|
+
Requires-Python: >=3.10
|
|
25
|
+
Provides-Extra: test
|
|
26
|
+
Requires-Dist: pytest<10,>=8; extra == "test"
|
|
27
|
+
Requires-Dist: pytest-asyncio>=1.4.0; extra == "test"
|
|
28
|
+
Description-Content-Type: text/markdown
|
|
29
|
+
|
|
30
|
+
# Wirestead Python
|
|
31
|
+
|
|
32
|
+
Python bindings for the Wirestead C++ communication library.
|
|
33
|
+
|
|
34
|
+
This repository contains the Python package and pybind11 bindings. The C++ core
|
|
35
|
+
lives in the main Wirestead repository.
|
|
36
|
+
|
|
37
|
+
- Core library: https://github.com/wirestead/wirestead
|
|
38
|
+
- Python bindings: https://github.com/wirestead/wirestead-python
|
|
39
|
+
|
|
40
|
+
## Package Layout
|
|
41
|
+
|
|
42
|
+
- Python package: `wirestead`
|
|
43
|
+
- Compiled extension: `wirestead._core`
|
|
44
|
+
|
|
45
|
+
## Documentation
|
|
46
|
+
|
|
47
|
+
- Installation: [docs/installation.md](docs/installation.md)
|
|
48
|
+
- API overview: [docs/api.md](docs/api.md)
|
|
49
|
+
- Compatibility: [docs/compatibility.md](docs/compatibility.md)
|
|
50
|
+
- Packet Probe Viewer IPC Example: [docs/packet-probe-viewer-ipc.md](docs/packet-probe-viewer-ipc.md)
|
|
51
|
+
- Packaging & PyInstaller Notes: [docs/packaging.md](docs/packaging.md)
|
|
52
|
+
- Contributing: [CONTRIBUTING.md](CONTRIBUTING.md)
|
|
53
|
+
- Release policy: [docs/release.md](docs/release.md)
|
|
54
|
+
- Changelog: [CHANGELOG.md](CHANGELOG.md)
|
|
55
|
+
|
|
56
|
+
The first split release keeps the existing binding API surface. It does not add
|
|
57
|
+
new transport functionality.
|
|
58
|
+
|
|
59
|
+
## Installation
|
|
60
|
+
|
|
61
|
+
### PyPI (recommended)
|
|
62
|
+
|
|
63
|
+
Prebuilt wheels are published for Python 3.10 through 3.13 on Linux
|
|
64
|
+
(`manylinux_2_28` x86_64 and aarch64), macOS (arm64), and Windows (amd64).
|
|
65
|
+
No C++ toolchain or Wirestead core checkout is required.
|
|
66
|
+
|
|
67
|
+
```bash
|
|
68
|
+
pip install wirestead
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
The remaining installation methods below build the extension locally and are
|
|
72
|
+
meant for contributors, other Python versions/platforms, or consuming a
|
|
73
|
+
custom core build.
|
|
74
|
+
|
|
75
|
+
### Development mode with local core source
|
|
76
|
+
|
|
77
|
+
```bash
|
|
78
|
+
git clone https://github.com/wirestead/wirestead.git
|
|
79
|
+
git clone https://github.com/wirestead/wirestead-python.git
|
|
80
|
+
|
|
81
|
+
cd wirestead-python
|
|
82
|
+
|
|
83
|
+
python -m pip install -U pip
|
|
84
|
+
python -m pip install -e . \
|
|
85
|
+
-Ccmake.define.WIRESTEAD_CORE_SOURCE_DIR=../wirestead
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
### Installed core package
|
|
89
|
+
|
|
90
|
+
```bash
|
|
91
|
+
cmake -S ../wirestead -B ../wirestead-build \
|
|
92
|
+
-DCMAKE_BUILD_TYPE=Release \
|
|
93
|
+
-DWIRESTEAD_BUILD_TESTS=OFF \
|
|
94
|
+
-DWIRESTEAD_BUILD_DOCS=OFF
|
|
95
|
+
|
|
96
|
+
cmake --build ../wirestead-build --parallel
|
|
97
|
+
cmake --install ../wirestead-build --prefix ../wirestead-install
|
|
98
|
+
|
|
99
|
+
cd ../wirestead-python
|
|
100
|
+
python -m pip install . \
|
|
101
|
+
-Ccmake.define.CMAKE_PREFIX_PATH=../wirestead-install
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
### vcpkg core package
|
|
105
|
+
|
|
106
|
+
The repository includes a `vcpkg.json` manifest that depends on
|
|
107
|
+
`wirestead`.
|
|
108
|
+
|
|
109
|
+
```bash
|
|
110
|
+
export VCPKG_ROOT=/path/to/vcpkg
|
|
111
|
+
|
|
112
|
+
python -m pip install . \
|
|
113
|
+
-Ccmake.define.CMAKE_TOOLCHAIN_FILE=$VCPKG_ROOT/scripts/buildsystems/vcpkg.cmake
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
## Import Smoke
|
|
117
|
+
|
|
118
|
+
```bash
|
|
119
|
+
python -c "import wirestead; print(wirestead.__version__)"
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
## Tests
|
|
123
|
+
|
|
124
|
+
```bash
|
|
125
|
+
python -m pytest -q -m "not serial"
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
Real TCP loopback coverage is marked as `integration` and is disabled unless
|
|
129
|
+
explicitly requested:
|
|
130
|
+
|
|
131
|
+
```bash
|
|
132
|
+
WIRESTEAD_PYTHON_RUN_LOOPBACK_TESTS=1 python -m pytest -q -m "integration"
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
Release wheels are also validated as installed artifacts from a fresh virtual
|
|
136
|
+
environment:
|
|
137
|
+
|
|
138
|
+
```bash
|
|
139
|
+
python scripts/run_wheel_consumer_smoke.py \
|
|
140
|
+
--wheel-dir dist \
|
|
141
|
+
--project-root .
|
|
142
|
+
```
|
|
143
|
+
|
|
144
|
+
For local validation across supported core consumption paths, use:
|
|
145
|
+
|
|
146
|
+
```bash
|
|
147
|
+
scripts/verify.sh --core-source ../wirestead
|
|
148
|
+
```
|
|
149
|
+
|
|
150
|
+
Set `VCPKG_ROOT` to enable the vcpkg path, or pass `--skip-vcpkg` when it is
|
|
151
|
+
not applicable. Add `--installed-prefix /path/to/wirestead/install` to validate
|
|
152
|
+
against an installed core package.
|
|
153
|
+
|
|
154
|
+
## Compatibility
|
|
155
|
+
|
|
156
|
+
Wirestead Python follows the same minor release line as the Wirestead C++ core.
|
|
157
|
+
|
|
158
|
+
| Wirestead Python | Wirestead core |
|
|
159
|
+
|---|---|
|
|
160
|
+
| 0.9.x | 0.9.x |
|
|
161
|
+
|
|
162
|
+
Patch versions may differ when Python-only packaging, binding, documentation, or
|
|
163
|
+
CI fixes do not require a matching core patch release.
|
|
164
|
+
|
|
165
|
+
The Python package is currently experimental until the C++ public API reaches a
|
|
166
|
+
stable release line.
|
|
167
|
+
|
|
168
|
+
## Support Matrix
|
|
169
|
+
|
|
170
|
+
| Item | Status |
|
|
171
|
+
|---|---|
|
|
172
|
+
| Python wheels | CPython 3.10, 3.11, 3.12, and 3.13 |
|
|
173
|
+
| Linux wheels | `manylinux_2_28` x86_64 and aarch64 |
|
|
174
|
+
| Windows wheels | amd64 |
|
|
175
|
+
| macOS wheels | arm64 |
|
|
176
|
+
| Install command | `pip install wirestead` |
|
|
177
|
+
| Source build | Contributor/custom-core path only |
|
|
178
|
+
| TCP | Supported and wheel-smoke tested on Linux, Windows, and macOS |
|
|
179
|
+
| UDP | Supported and wheel-smoke tested on Linux, Windows, and macOS |
|
|
180
|
+
| Serial | API surface is shipped; hardware loopback is not part of wheel smoke |
|
|
181
|
+
| UDS | Supported and wheel-smoke tested on Linux, Windows, and macOS |
|
|
182
|
+
| Core compatibility | `wirestead` Python 0.9.x targets Wirestead C++ core 0.9.x |
|
|
183
|
+
|
|
184
|
+
Users migrating from Unilink should switch package and import names to
|
|
185
|
+
`wirestead`. See the core migration guide:
|
|
186
|
+
https://github.com/wirestead/wirestead/blob/main/docs/migration-from-unilink.md
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
wirestead/__init__.py,sha256=tNIiLUxwN1qNtg4DRt1SoP1TzklV3FChA7YcCL_3Nxo,1845
|
|
2
|
+
wirestead/_core.cp313-win_amd64.pyd,sha256=wMIPXkelbBIkD4VRT9t_CqcVd_EBMgsUo0vhMgiWs6s,1707008
|
|
3
|
+
wirestead/_version.py,sha256=I3ASgj0LYAmGGQhqxkAYEEiiLOpQ1UAZGOd0bJAXSRw,23
|
|
4
|
+
wirestead/asyncio.py,sha256=NAA3YqM6yIn0MSQjOhE9GmEFHRE3mbUmEh82yIgvUW0,8501
|
|
5
|
+
wirestead/py.typed,sha256=frcCV1k9oG9oKj3dpUqdJg1PxRT2RSN_XKdLCPjaYaY,2
|
|
6
|
+
wirestead-0.9.2.dist-info/METADATA,sha256=IsXagU3bj6Lhm7mYdUjBAV1om0TiuFX0cyWsm1R8gW4,5923
|
|
7
|
+
wirestead-0.9.2.dist-info/WHEEL,sha256=dXz53UX_wVrENU3pg7IjBHl1TfATF0jKSXtQDtrFnLw,105
|
|
8
|
+
wirestead-0.9.2.dist-info/licenses/LICENSE,sha256=HrhfyXIkWY2tGFK11kg7vPCqhgh5DcxleloqdhrpyMY,11558
|
|
9
|
+
wirestead-0.9.2.dist-info/licenses/NOTICE,sha256=WvhgRtCQbrZjp0yX7y1jyhc0JCzi98GLoVw9nJMIqnM,95
|
|
10
|
+
wirestead-0.9.2.dist-info/RECORD,,
|
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|