microio 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.
- microio-0.1.0/CHANGELOG.md +6 -0
- microio-0.1.0/LICENSE +202 -0
- microio-0.1.0/MANIFEST.in +4 -0
- microio-0.1.0/PKG-INFO +241 -0
- microio-0.1.0/README.md +222 -0
- microio-0.1.0/examples/README.md +13 -0
- microio-0.1.0/examples/counter_server.py +91 -0
- microio-0.1.0/microio/__init__.py +10 -0
- microio-0.1.0/microio/_actor.py +51 -0
- microio-0.1.0/microio/_channel.py +160 -0
- microio-0.1.0/microio/_registry.py +91 -0
- microio-0.1.0/microio/_scope.py +44 -0
- microio-0.1.0/microio/_task.py +253 -0
- microio-0.1.0/microio/_thread.py +170 -0
- microio-0.1.0/microio.egg-info/PKG-INFO +241 -0
- microio-0.1.0/microio.egg-info/SOURCES.txt +20 -0
- microio-0.1.0/microio.egg-info/dependency_links.txt +1 -0
- microio-0.1.0/microio.egg-info/requires.txt +6 -0
- microio-0.1.0/microio.egg-info/top_level.txt +1 -0
- microio-0.1.0/pyproject.toml +35 -0
- microio-0.1.0/setup.cfg +4 -0
- microio-0.1.0/tests/test_microio.py +184 -0
microio-0.1.0/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
microio-0.1.0/PKG-INFO
ADDED
|
@@ -0,0 +1,241 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: microio
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Tiny asyncio-first runtime helpers for service threads, loop ownership, channels, and request waiters
|
|
5
|
+
Author: microio contributors
|
|
6
|
+
License: Apache-2.0
|
|
7
|
+
Project-URL: Homepage, https://github.com/AnswerDotAI/microio
|
|
8
|
+
Classifier: Programming Language :: Python :: 3
|
|
9
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
|
10
|
+
Requires-Python: >=3.11
|
|
11
|
+
Description-Content-Type: text/markdown
|
|
12
|
+
License-File: LICENSE
|
|
13
|
+
Provides-Extra: dev
|
|
14
|
+
Requires-Dist: fastship; extra == "dev"
|
|
15
|
+
Requires-Dist: build; extra == "dev"
|
|
16
|
+
Requires-Dist: twine; extra == "dev"
|
|
17
|
+
Requires-Dist: pytest; extra == "dev"
|
|
18
|
+
Dynamic: license-file
|
|
19
|
+
|
|
20
|
+
# microio
|
|
21
|
+
|
|
22
|
+
`microio` is a tiny asyncio-first runtime helper library for services that own
|
|
23
|
+
event loops, sockets, background threads, and request/reply waiters.
|
|
24
|
+
|
|
25
|
+
It is inspired by AnyIO's practical concurrency ideas, especially the problems
|
|
26
|
+
called out in [Why you should be using AnyIO APIs instead of asyncio APIs][anyio-why]:
|
|
27
|
+
|
|
28
|
+
- **task readiness**: a child service should be able to report "ready" or "failed"
|
|
29
|
+
before its parent continues;
|
|
30
|
+
- **cancel scopes**: stopping is a durable state with a reason, not a one-shot flag
|
|
31
|
+
that individual operations may miss;
|
|
32
|
+
- **memory object streams**: producers and consumers should be split into explicit
|
|
33
|
+
sender/receiver endpoints with clear close semantics;
|
|
34
|
+
- **thread bridges**: code outside an event-loop thread needs a safe way to submit
|
|
35
|
+
work into that loop and observe failures.
|
|
36
|
+
|
|
37
|
+
`microio` is not a compatibility layer over asyncio, Trio, and Curio. It is also
|
|
38
|
+
not a reimplementation of AnyIO. It intentionally stays smaller:
|
|
39
|
+
|
|
40
|
+
- asyncio only;
|
|
41
|
+
- stdlib only;
|
|
42
|
+
- no generic networking/file APIs;
|
|
43
|
+
- cooperative level cancellation only where code uses `microio` scopes and checkpoints;
|
|
44
|
+
- no pytest plugin or framework-level dependency injection.
|
|
45
|
+
|
|
46
|
+
The goal is to make the common "small service runtime" patterns reliable and
|
|
47
|
+
testable without pulling a full concurrency abstraction into projects that already
|
|
48
|
+
use asyncio directly.
|
|
49
|
+
|
|
50
|
+
## What It Provides
|
|
51
|
+
|
|
52
|
+
### `TaskGroup` / `CancelScope`
|
|
53
|
+
|
|
54
|
+
`create_task_group()` wraps `asyncio.TaskGroup`. It keeps the stdlib failure
|
|
55
|
+
rules, and adds the missing cancellation/readiness pieces:
|
|
56
|
+
|
|
57
|
+
- `tg.start_soon(fn, *args)` starts a child task;
|
|
58
|
+
- `await tg.start(fn, *args)` starts a child and waits until it calls
|
|
59
|
+
`task_status.started(value)`;
|
|
60
|
+
- `tg.cancel_scope.cancel()` or `tg.cancel()` cancels owned tasks and treats
|
|
61
|
+
that as normal shutdown;
|
|
62
|
+
- `checkpoint()`, `checkpoint_if_cancelled()`, and `sleep()` provide cooperative
|
|
63
|
+
level cancellation for code that uses `microio` primitives;
|
|
64
|
+
- `move_on_after(seconds)` suppresses deadline cancellation;
|
|
65
|
+
- `fail_after(seconds)` turns deadline cancellation into `TimeoutError`.
|
|
66
|
+
|
|
67
|
+
The group-cancel path borrows the small `asyncio_cancel_scope` trick: when a
|
|
68
|
+
child task or another thread asks a group to stop, `microio` injects a private
|
|
69
|
+
task exception into the underlying `asyncio.TaskGroup` and suppresses just that
|
|
70
|
+
private exception on exit.
|
|
71
|
+
|
|
72
|
+
This is still asyncio cancellation. Raw `await something()` follows asyncio's
|
|
73
|
+
edge-cancellation rules. Once code returns to a `microio` checkpoint, cancelled
|
|
74
|
+
scopes keep raising `CancelledError`, even if earlier cancellation was caught.
|
|
75
|
+
|
|
76
|
+
Shielding is not exposed. A partial shield around raw `Task.cancel()` would look
|
|
77
|
+
stronger than it is.
|
|
78
|
+
|
|
79
|
+
```python
|
|
80
|
+
from microio import create_task_group, sleep
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
async def worker():
|
|
84
|
+
while True: await sleep(1)
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
async with create_task_group() as tg:
|
|
88
|
+
tg.start_soon(worker)
|
|
89
|
+
await sleep(0.1)
|
|
90
|
+
tg.cancel()
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
### `CloseScope`
|
|
94
|
+
|
|
95
|
+
`CloseScope` is a small, thread-safe stop/failure state object. It records whether
|
|
96
|
+
a service is closing, why it is closing, and whether there is an exception that
|
|
97
|
+
should be propagated to waiters.
|
|
98
|
+
|
|
99
|
+
This is separate from `CancelScope`. `CloseScope` is for thread-safe service
|
|
100
|
+
lifecycle state. It does not cancel asyncio tasks for you.
|
|
101
|
+
|
|
102
|
+
### `ServiceThread` / `ServiceGroup`
|
|
103
|
+
|
|
104
|
+
`ServiceThread` is a supervised `threading.Thread`:
|
|
105
|
+
|
|
106
|
+
- child code calls `started()` after resources are ready;
|
|
107
|
+
- parents call `wait_started()` and get either readiness or the startup exception;
|
|
108
|
+
- `stop()` marks the thread's `CloseScope`;
|
|
109
|
+
- `join_or_log()` checks timeout results instead of ignoring them.
|
|
110
|
+
|
|
111
|
+
Use it for socket threads, protocol readers, and other owned background services.
|
|
112
|
+
|
|
113
|
+
`ServiceGroup` owns the repeated lifecycle boilerplate for a small set of service
|
|
114
|
+
threads:
|
|
115
|
+
|
|
116
|
+
```python
|
|
117
|
+
services = ServiceGroup(iopub, stdin, heartbeat).start().wait_started()
|
|
118
|
+
...
|
|
119
|
+
services.stop_join(timeout=1)
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
### `LoopServiceThread`
|
|
123
|
+
|
|
124
|
+
`LoopServiceThread` owns an `asyncio.Runner` inside a thread and exposes:
|
|
125
|
+
|
|
126
|
+
- `call_soon()` for thread-safe callbacks;
|
|
127
|
+
- `call_sync()` for thread-safe callbacks with a return value;
|
|
128
|
+
- `submit()` for coroutine submission from other threads;
|
|
129
|
+
- `task_group` for async work owned by the service;
|
|
130
|
+
- the same ready/failed/stop/join behavior as `ServiceThread`.
|
|
131
|
+
|
|
132
|
+
This is the small subset of AnyIO's thread-bridge idea that asyncio services often
|
|
133
|
+
need: create one loop in one thread, keep ownership clear, submit coroutine work
|
|
134
|
+
safely, and synchronously run small functions on the loop thread when needed.
|
|
135
|
+
`stop()` cancels the service task group, so owned child tasks shut down with the
|
|
136
|
+
service.
|
|
137
|
+
|
|
138
|
+
### `ObjectChannel`
|
|
139
|
+
|
|
140
|
+
`create_channel()` returns `(send, receive)` endpoints. A sender can be used from
|
|
141
|
+
other threads before or after the receiver has bound to an event loop. The receiver
|
|
142
|
+
is async and supports `async for`.
|
|
143
|
+
|
|
144
|
+
This is inspired by AnyIO memory object streams, but adjusted for service threads:
|
|
145
|
+
|
|
146
|
+
- the default buffer is unbounded because cross-thread producers often cannot
|
|
147
|
+
await backpressure;
|
|
148
|
+
- close is explicit and wakes async receivers;
|
|
149
|
+
- receivers raise `EndOfStream` on direct receive after close;
|
|
150
|
+
- `fail(exc)` is explicit and wakes async receivers with the exception;
|
|
151
|
+
- late sends raise `ClosedResourceError` unless `late_send="drop"` is selected;
|
|
152
|
+
- the implementation is intentionally single-receiver and simple.
|
|
153
|
+
|
|
154
|
+
### `Mailbox` / `ActorCore`
|
|
155
|
+
|
|
156
|
+
`Mailbox` wraps an `ObjectChannel` for the common actor shape: thread-safe
|
|
157
|
+
`submit()`, async receive, `close()`, `fail()`, and `drain_nowait()`.
|
|
158
|
+
|
|
159
|
+
`ActorCore` is the tiny serialized consumer loop:
|
|
160
|
+
|
|
161
|
+
```python
|
|
162
|
+
actor = ActorCore(handle)
|
|
163
|
+
actor.submit(item)
|
|
164
|
+
await actor.run()
|
|
165
|
+
```
|
|
166
|
+
|
|
167
|
+
It is deliberately not tied to a thread. A service thread, a main-thread runner,
|
|
168
|
+
or a test can all run the same actor core.
|
|
169
|
+
|
|
170
|
+
### `RequestRegistry`
|
|
171
|
+
|
|
172
|
+
`RequestRegistry` tracks request IDs and waiters:
|
|
173
|
+
|
|
174
|
+
- register a request;
|
|
175
|
+
- resolve it from another thread through a `ReplyHandle`;
|
|
176
|
+
- wait with timeout;
|
|
177
|
+
- wrap the common register-send-wait pattern with `request(key, send)`;
|
|
178
|
+
- fail one or all pending requests on service crash/close.
|
|
179
|
+
|
|
180
|
+
This is useful for debug adapters, stdin routers, RPC clients, and any protocol
|
|
181
|
+
where a reader thread must wake request waiters reliably.
|
|
182
|
+
|
|
183
|
+
## Example
|
|
184
|
+
|
|
185
|
+
```python
|
|
186
|
+
import asyncio
|
|
187
|
+
from microio import LoopServiceThread, create_channel
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
class Worker(LoopServiceThread):
|
|
191
|
+
def __init__(self):
|
|
192
|
+
super().__init__(name="worker")
|
|
193
|
+
self.send, self.receive = create_channel()
|
|
194
|
+
|
|
195
|
+
async def run_async(self):
|
|
196
|
+
self.receive.bind(asyncio.get_running_loop())
|
|
197
|
+
self.started()
|
|
198
|
+
async for item in self.receive:
|
|
199
|
+
if item == "stop":
|
|
200
|
+
self.stop()
|
|
201
|
+
break
|
|
202
|
+
print(item)
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
worker = Worker()
|
|
206
|
+
worker.start()
|
|
207
|
+
worker.wait_started()
|
|
208
|
+
worker.send.send_nowait("hello")
|
|
209
|
+
worker.send.send_nowait("stop")
|
|
210
|
+
worker.join_or_log(timeout=1)
|
|
211
|
+
```
|
|
212
|
+
|
|
213
|
+
## Design Rules
|
|
214
|
+
|
|
215
|
+
- Prefer explicit state over hidden magic.
|
|
216
|
+
- Make startup failure visible to the parent.
|
|
217
|
+
- Never ignore a join timeout.
|
|
218
|
+
- Waking pending waiters on close/crash is part of the service contract.
|
|
219
|
+
- Keep asyncio ownership clear: a socket or loop belongs to one service thread.
|
|
220
|
+
|
|
221
|
+
## Development
|
|
222
|
+
|
|
223
|
+
```bash
|
|
224
|
+
pip install -e .[dev]
|
|
225
|
+
pytest -q
|
|
226
|
+
```
|
|
227
|
+
|
|
228
|
+
## Examples
|
|
229
|
+
|
|
230
|
+
Run the counter service example:
|
|
231
|
+
|
|
232
|
+
```bash
|
|
233
|
+
python examples/counter_server.py
|
|
234
|
+
```
|
|
235
|
+
|
|
236
|
+
It shows `LoopServiceThread`, `ObjectChannel`, `RequestRegistry`, and
|
|
237
|
+
`CloseScope` working together in one small service.
|
|
238
|
+
|
|
239
|
+
Version lives in `microio/__init__.py` as `__version__`.
|
|
240
|
+
|
|
241
|
+
[anyio-why]: https://anyio.readthedocs.io/en/stable/why.html
|
microio-0.1.0/README.md
ADDED
|
@@ -0,0 +1,222 @@
|
|
|
1
|
+
# microio
|
|
2
|
+
|
|
3
|
+
`microio` is a tiny asyncio-first runtime helper library for services that own
|
|
4
|
+
event loops, sockets, background threads, and request/reply waiters.
|
|
5
|
+
|
|
6
|
+
It is inspired by AnyIO's practical concurrency ideas, especially the problems
|
|
7
|
+
called out in [Why you should be using AnyIO APIs instead of asyncio APIs][anyio-why]:
|
|
8
|
+
|
|
9
|
+
- **task readiness**: a child service should be able to report "ready" or "failed"
|
|
10
|
+
before its parent continues;
|
|
11
|
+
- **cancel scopes**: stopping is a durable state with a reason, not a one-shot flag
|
|
12
|
+
that individual operations may miss;
|
|
13
|
+
- **memory object streams**: producers and consumers should be split into explicit
|
|
14
|
+
sender/receiver endpoints with clear close semantics;
|
|
15
|
+
- **thread bridges**: code outside an event-loop thread needs a safe way to submit
|
|
16
|
+
work into that loop and observe failures.
|
|
17
|
+
|
|
18
|
+
`microio` is not a compatibility layer over asyncio, Trio, and Curio. It is also
|
|
19
|
+
not a reimplementation of AnyIO. It intentionally stays smaller:
|
|
20
|
+
|
|
21
|
+
- asyncio only;
|
|
22
|
+
- stdlib only;
|
|
23
|
+
- no generic networking/file APIs;
|
|
24
|
+
- cooperative level cancellation only where code uses `microio` scopes and checkpoints;
|
|
25
|
+
- no pytest plugin or framework-level dependency injection.
|
|
26
|
+
|
|
27
|
+
The goal is to make the common "small service runtime" patterns reliable and
|
|
28
|
+
testable without pulling a full concurrency abstraction into projects that already
|
|
29
|
+
use asyncio directly.
|
|
30
|
+
|
|
31
|
+
## What It Provides
|
|
32
|
+
|
|
33
|
+
### `TaskGroup` / `CancelScope`
|
|
34
|
+
|
|
35
|
+
`create_task_group()` wraps `asyncio.TaskGroup`. It keeps the stdlib failure
|
|
36
|
+
rules, and adds the missing cancellation/readiness pieces:
|
|
37
|
+
|
|
38
|
+
- `tg.start_soon(fn, *args)` starts a child task;
|
|
39
|
+
- `await tg.start(fn, *args)` starts a child and waits until it calls
|
|
40
|
+
`task_status.started(value)`;
|
|
41
|
+
- `tg.cancel_scope.cancel()` or `tg.cancel()` cancels owned tasks and treats
|
|
42
|
+
that as normal shutdown;
|
|
43
|
+
- `checkpoint()`, `checkpoint_if_cancelled()`, and `sleep()` provide cooperative
|
|
44
|
+
level cancellation for code that uses `microio` primitives;
|
|
45
|
+
- `move_on_after(seconds)` suppresses deadline cancellation;
|
|
46
|
+
- `fail_after(seconds)` turns deadline cancellation into `TimeoutError`.
|
|
47
|
+
|
|
48
|
+
The group-cancel path borrows the small `asyncio_cancel_scope` trick: when a
|
|
49
|
+
child task or another thread asks a group to stop, `microio` injects a private
|
|
50
|
+
task exception into the underlying `asyncio.TaskGroup` and suppresses just that
|
|
51
|
+
private exception on exit.
|
|
52
|
+
|
|
53
|
+
This is still asyncio cancellation. Raw `await something()` follows asyncio's
|
|
54
|
+
edge-cancellation rules. Once code returns to a `microio` checkpoint, cancelled
|
|
55
|
+
scopes keep raising `CancelledError`, even if earlier cancellation was caught.
|
|
56
|
+
|
|
57
|
+
Shielding is not exposed. A partial shield around raw `Task.cancel()` would look
|
|
58
|
+
stronger than it is.
|
|
59
|
+
|
|
60
|
+
```python
|
|
61
|
+
from microio import create_task_group, sleep
|
|
62
|
+
|
|
63
|
+
|
|
64
|
+
async def worker():
|
|
65
|
+
while True: await sleep(1)
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
async with create_task_group() as tg:
|
|
69
|
+
tg.start_soon(worker)
|
|
70
|
+
await sleep(0.1)
|
|
71
|
+
tg.cancel()
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
### `CloseScope`
|
|
75
|
+
|
|
76
|
+
`CloseScope` is a small, thread-safe stop/failure state object. It records whether
|
|
77
|
+
a service is closing, why it is closing, and whether there is an exception that
|
|
78
|
+
should be propagated to waiters.
|
|
79
|
+
|
|
80
|
+
This is separate from `CancelScope`. `CloseScope` is for thread-safe service
|
|
81
|
+
lifecycle state. It does not cancel asyncio tasks for you.
|
|
82
|
+
|
|
83
|
+
### `ServiceThread` / `ServiceGroup`
|
|
84
|
+
|
|
85
|
+
`ServiceThread` is a supervised `threading.Thread`:
|
|
86
|
+
|
|
87
|
+
- child code calls `started()` after resources are ready;
|
|
88
|
+
- parents call `wait_started()` and get either readiness or the startup exception;
|
|
89
|
+
- `stop()` marks the thread's `CloseScope`;
|
|
90
|
+
- `join_or_log()` checks timeout results instead of ignoring them.
|
|
91
|
+
|
|
92
|
+
Use it for socket threads, protocol readers, and other owned background services.
|
|
93
|
+
|
|
94
|
+
`ServiceGroup` owns the repeated lifecycle boilerplate for a small set of service
|
|
95
|
+
threads:
|
|
96
|
+
|
|
97
|
+
```python
|
|
98
|
+
services = ServiceGroup(iopub, stdin, heartbeat).start().wait_started()
|
|
99
|
+
...
|
|
100
|
+
services.stop_join(timeout=1)
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
### `LoopServiceThread`
|
|
104
|
+
|
|
105
|
+
`LoopServiceThread` owns an `asyncio.Runner` inside a thread and exposes:
|
|
106
|
+
|
|
107
|
+
- `call_soon()` for thread-safe callbacks;
|
|
108
|
+
- `call_sync()` for thread-safe callbacks with a return value;
|
|
109
|
+
- `submit()` for coroutine submission from other threads;
|
|
110
|
+
- `task_group` for async work owned by the service;
|
|
111
|
+
- the same ready/failed/stop/join behavior as `ServiceThread`.
|
|
112
|
+
|
|
113
|
+
This is the small subset of AnyIO's thread-bridge idea that asyncio services often
|
|
114
|
+
need: create one loop in one thread, keep ownership clear, submit coroutine work
|
|
115
|
+
safely, and synchronously run small functions on the loop thread when needed.
|
|
116
|
+
`stop()` cancels the service task group, so owned child tasks shut down with the
|
|
117
|
+
service.
|
|
118
|
+
|
|
119
|
+
### `ObjectChannel`
|
|
120
|
+
|
|
121
|
+
`create_channel()` returns `(send, receive)` endpoints. A sender can be used from
|
|
122
|
+
other threads before or after the receiver has bound to an event loop. The receiver
|
|
123
|
+
is async and supports `async for`.
|
|
124
|
+
|
|
125
|
+
This is inspired by AnyIO memory object streams, but adjusted for service threads:
|
|
126
|
+
|
|
127
|
+
- the default buffer is unbounded because cross-thread producers often cannot
|
|
128
|
+
await backpressure;
|
|
129
|
+
- close is explicit and wakes async receivers;
|
|
130
|
+
- receivers raise `EndOfStream` on direct receive after close;
|
|
131
|
+
- `fail(exc)` is explicit and wakes async receivers with the exception;
|
|
132
|
+
- late sends raise `ClosedResourceError` unless `late_send="drop"` is selected;
|
|
133
|
+
- the implementation is intentionally single-receiver and simple.
|
|
134
|
+
|
|
135
|
+
### `Mailbox` / `ActorCore`
|
|
136
|
+
|
|
137
|
+
`Mailbox` wraps an `ObjectChannel` for the common actor shape: thread-safe
|
|
138
|
+
`submit()`, async receive, `close()`, `fail()`, and `drain_nowait()`.
|
|
139
|
+
|
|
140
|
+
`ActorCore` is the tiny serialized consumer loop:
|
|
141
|
+
|
|
142
|
+
```python
|
|
143
|
+
actor = ActorCore(handle)
|
|
144
|
+
actor.submit(item)
|
|
145
|
+
await actor.run()
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
It is deliberately not tied to a thread. A service thread, a main-thread runner,
|
|
149
|
+
or a test can all run the same actor core.
|
|
150
|
+
|
|
151
|
+
### `RequestRegistry`
|
|
152
|
+
|
|
153
|
+
`RequestRegistry` tracks request IDs and waiters:
|
|
154
|
+
|
|
155
|
+
- register a request;
|
|
156
|
+
- resolve it from another thread through a `ReplyHandle`;
|
|
157
|
+
- wait with timeout;
|
|
158
|
+
- wrap the common register-send-wait pattern with `request(key, send)`;
|
|
159
|
+
- fail one or all pending requests on service crash/close.
|
|
160
|
+
|
|
161
|
+
This is useful for debug adapters, stdin routers, RPC clients, and any protocol
|
|
162
|
+
where a reader thread must wake request waiters reliably.
|
|
163
|
+
|
|
164
|
+
## Example
|
|
165
|
+
|
|
166
|
+
```python
|
|
167
|
+
import asyncio
|
|
168
|
+
from microio import LoopServiceThread, create_channel
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
class Worker(LoopServiceThread):
|
|
172
|
+
def __init__(self):
|
|
173
|
+
super().__init__(name="worker")
|
|
174
|
+
self.send, self.receive = create_channel()
|
|
175
|
+
|
|
176
|
+
async def run_async(self):
|
|
177
|
+
self.receive.bind(asyncio.get_running_loop())
|
|
178
|
+
self.started()
|
|
179
|
+
async for item in self.receive:
|
|
180
|
+
if item == "stop":
|
|
181
|
+
self.stop()
|
|
182
|
+
break
|
|
183
|
+
print(item)
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
worker = Worker()
|
|
187
|
+
worker.start()
|
|
188
|
+
worker.wait_started()
|
|
189
|
+
worker.send.send_nowait("hello")
|
|
190
|
+
worker.send.send_nowait("stop")
|
|
191
|
+
worker.join_or_log(timeout=1)
|
|
192
|
+
```
|
|
193
|
+
|
|
194
|
+
## Design Rules
|
|
195
|
+
|
|
196
|
+
- Prefer explicit state over hidden magic.
|
|
197
|
+
- Make startup failure visible to the parent.
|
|
198
|
+
- Never ignore a join timeout.
|
|
199
|
+
- Waking pending waiters on close/crash is part of the service contract.
|
|
200
|
+
- Keep asyncio ownership clear: a socket or loop belongs to one service thread.
|
|
201
|
+
|
|
202
|
+
## Development
|
|
203
|
+
|
|
204
|
+
```bash
|
|
205
|
+
pip install -e .[dev]
|
|
206
|
+
pytest -q
|
|
207
|
+
```
|
|
208
|
+
|
|
209
|
+
## Examples
|
|
210
|
+
|
|
211
|
+
Run the counter service example:
|
|
212
|
+
|
|
213
|
+
```bash
|
|
214
|
+
python examples/counter_server.py
|
|
215
|
+
```
|
|
216
|
+
|
|
217
|
+
It shows `LoopServiceThread`, `ObjectChannel`, `RequestRegistry`, and
|
|
218
|
+
`CloseScope` working together in one small service.
|
|
219
|
+
|
|
220
|
+
Version lives in `microio/__init__.py` as `__version__`.
|
|
221
|
+
|
|
222
|
+
[anyio-why]: https://anyio.readthedocs.io/en/stable/why.html
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# microio examples
|
|
2
|
+
|
|
3
|
+
## Counter server
|
|
4
|
+
|
|
5
|
+
Run from the `microio` project directory:
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
python examples/counter_server.py
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
The example starts a tiny in-process service. The main thread sends request
|
|
12
|
+
objects through an `ObjectChannel` to a `LoopServiceThread`, waits for replies
|
|
13
|
+
with a `RequestRegistry`, and shuts the service down through its `CloseScope`.
|