marceline 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,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.
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Marceline contributors
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1,5 @@
1
+ # The Rust and Python distributions have separate readmes.
2
+ exclude *.md
3
+ include README.python.md
4
+ include docs/python.md
5
+ include python/tests/test_client.py
@@ -0,0 +1,52 @@
1
+ Metadata-Version: 2.4
2
+ Name: marceline
3
+ Version: 0.1.0
4
+ Summary: Python client for interacting with Marceline plugins in Marcellus.
5
+ License-Expression: MIT OR Apache-2.0
6
+ Project-URL: Source, https://github.com/almanaculum/marcellus
7
+ Classifier: Operating System :: MacOS
8
+ Classifier: Operating System :: POSIX :: Linux
9
+ Classifier: Programming Language :: Python :: 3 :: Only
10
+ Classifier: Typing :: Typed
11
+ Requires-Python: >=3.11
12
+ Description-Content-Type: text/markdown
13
+ License-File: LICENSE-MIT
14
+ License-File: LICENSE-APACHE
15
+ Dynamic: license-file
16
+
17
+ # Marceline for Python
18
+
19
+ Marceline is the plugin platform for Marcellus, an editor, IDE, and agentic
20
+ harness. It brings development tools into the workspace where you write and
21
+ review code. A plugin can mark the line where a test failed, turn a
22
+ patch into proposed edits, or send the paragraph under your cursor to a coding
23
+ agent and show its reply. You choose what each plugin can access.
24
+
25
+ ## Connect a Python tool
26
+
27
+ Use this client when a script, test runner, or coding agent needs to interact
28
+ with a plugin in a running Marcellus session. The plugin offers actions in
29
+ Marcellus. Your Python code can invoke those same actions and check whether
30
+ Marcellus accepted the request.
31
+
32
+ ```sh
33
+ python -m pip install marceline
34
+ ```
35
+
36
+ The client supports Python 3.11 or later on macOS and Linux. The Python
37
+ guide walks through connecting to a session, invoking a plugin action,
38
+ and handling the result. [Python usage guide][python]
39
+
40
+ ## Build plugins and hosts
41
+
42
+ To add a feature to Marcellus, start with the WebAssembly plugin guide.
43
+ To run Marceline plugins in a Rust application, start with the host guide.
44
+ [Write your first plugin][plugins] · [Build a Rust host][hosts]
45
+
46
+ ## License
47
+
48
+ Marceline for Python is available under the MIT License or the Apache License 2.0.
49
+
50
+ [python]: https://docs.rs/marceline/0.1.0/marceline/guides/python/
51
+ [plugins]: https://docs.rs/marceline/0.1.0/marceline/guides/plugins/
52
+ [hosts]: https://docs.rs/marceline/0.1.0/marceline/guides/hosts/
@@ -0,0 +1,36 @@
1
+ # Marceline for Python
2
+
3
+ Marceline is the plugin platform for Marcellus, an editor, IDE, and agentic
4
+ harness. It brings development tools into the workspace where you write and
5
+ review code. A plugin can mark the line where a test failed, turn a
6
+ patch into proposed edits, or send the paragraph under your cursor to a coding
7
+ agent and show its reply. You choose what each plugin can access.
8
+
9
+ ## Connect a Python tool
10
+
11
+ Use this client when a script, test runner, or coding agent needs to interact
12
+ with a plugin in a running Marcellus session. The plugin offers actions in
13
+ Marcellus. Your Python code can invoke those same actions and check whether
14
+ Marcellus accepted the request.
15
+
16
+ ```sh
17
+ python -m pip install marceline
18
+ ```
19
+
20
+ The client supports Python 3.11 or later on macOS and Linux. The Python
21
+ guide walks through connecting to a session, invoking a plugin action,
22
+ and handling the result. [Python usage guide][python]
23
+
24
+ ## Build plugins and hosts
25
+
26
+ To add a feature to Marcellus, start with the WebAssembly plugin guide.
27
+ To run Marceline plugins in a Rust application, start with the host guide.
28
+ [Write your first plugin][plugins] · [Build a Rust host][hosts]
29
+
30
+ ## License
31
+
32
+ Marceline for Python is available under the MIT License or the Apache License 2.0.
33
+
34
+ [python]: https://docs.rs/marceline/0.1.0/marceline/guides/python/
35
+ [plugins]: https://docs.rs/marceline/0.1.0/marceline/guides/plugins/
36
+ [hosts]: https://docs.rs/marceline/0.1.0/marceline/guides/hosts/
@@ -0,0 +1,202 @@
1
+ # Use Marceline from Python
2
+
3
+ ## Clear a test tally from Python
4
+
5
+ The `test-meter` plugin counts passing, failing, and ignored Rust tests.
6
+ While its tally is visible, a test runner can clear it by calling `reset`.
7
+
8
+ Use Python 3.11 or later on macOS or Linux. The session needs matching
9
+ Idaemon and native Marcellus binaries, Marcellus built with `plugin-runtime`,
10
+ and Idaemon started with `--plugin-actions`. Open a file in the workspace
11
+ and wait for the enabled plugin to show a tally.
12
+
13
+ For a session using `$DEMO/receiver` as Idaemon's private runtime directory,
14
+ set `DEMO` to the absolute workspace path and install the client.
15
+
16
+ ```sh
17
+ export DEMO=/absolute/path/to/demo/workspace
18
+ python -m pip install marceline==0.1.0
19
+ ```
20
+
21
+ ```python
22
+ import os
23
+ from pathlib import Path
24
+
25
+ from marceline import Client, InvokeReceipt
26
+
27
+ client = Client(Path(os.environ["DEMO"]) / "receiver")
28
+ receipt = client.invoke("test-meter", "reset")
29
+ if receipt is InvokeReceipt.ACCEPTED:
30
+ print("Marcellus accepted the reset action.")
31
+ ```
32
+
33
+ An `ACCEPTED` receipt means Marcellus queued the action. The tally clears
34
+ when the plugin handles it. Use the walkthrough below to set up a new
35
+ session from source.
36
+
37
+ ## Build the native binaries
38
+
39
+ This walkthrough builds Marcellus and its Idaemon broker from the same revision.
40
+
41
+ For a source build, obtain an authorized Almanaculum checkout and access to
42
+ its reviewed dependency sources. The Marceline `0.1.0` Cargo source archive
43
+ records the corresponding Almanaculum revision in the `git.sha1` field of
44
+ `.cargo_vcs_info.json`. Install Git, rustup, and a native C compiler and linker.
45
+ On Debian or Ubuntu, the native build also requires `pkg-config` and
46
+ `libasound2-dev`. Follow **Run from source** in the checkout's
47
+ `crates/marcellus/README.md`. From the checkout root, use the shell recipes and
48
+ exact revisions in `crates/marcellus/docs/supply-chain.adoc` to seat the reviewed
49
+ dependency checkouts under `projects/.source-pins/`. The checkout's
50
+ `rust-toolchain.toml` selects Rust 1.98.0.
51
+
52
+ From the checkout root, choose an absolute directory for Cargo build artifacts
53
+ and build both binaries in the editor workspace.
54
+
55
+ ```sh
56
+ export ALMANACULUM="$(pwd -P)"
57
+ export MARCELLUS_TARGET_DIR=/absolute/path/to/marcellus-target
58
+ (cd "$ALMANACULUM/crates/marcellus" &&
59
+ cargo build --locked --target-dir "$MARCELLUS_TARGET_DIR" \
60
+ -p marcellus -p idaemon --features plugin-runtime)
61
+ export IDAEMON="$MARCELLUS_TARGET_DIR/debug/idaemon"
62
+ export MARCELLUS="$MARCELLUS_TARGET_DIR/debug/marcellus"
63
+ ```
64
+
65
+ ## Prepare the `test-meter` example
66
+
67
+ Use the checked-in plugin and manifest described in
68
+ `crates/marcellus/plugins/test-meter/README.adoc`. In the same terminal, create a
69
+ fresh workspace, build the guest component, and give it a line of Rust test
70
+ output to count.
71
+
72
+ ```sh
73
+ export DEMO="$(mktemp -d "$HOME/marcellus-test-meter.XXXXXXXX")"
74
+ PLUGIN_SOURCE="$ALMANACULUM/crates/marcellus/plugins/test-meter"
75
+ mkdir -p "$DEMO/plugins/test-meter" "$DEMO/.alma" "$DEMO/.alma-review"
76
+ cp "$PLUGIN_SOURCE/manifest.json" "$DEMO/plugins/test-meter/manifest.json"
77
+ cargo run --quiet --locked --target-dir "$MARCELLUS_TARGET_DIR" \
78
+ --manifest-path "$ALMANACULUM/crates/marceline/Cargo.toml" \
79
+ --features packaging --bin marceline-pack -- "$PLUGIN_SOURCE/component.wat" \
80
+ > "$DEMO/plugins/test-meter/component.wasm"
81
+ printf 'test sample ... ok\n' > "$DEMO/.alma-review/test-output.txt"
82
+ printf 'Test meter example\n' > "$DEMO/demo.txt"
83
+ ```
84
+
85
+ Enable the plugin and grant the capabilities in its manifest.
86
+
87
+ ```sh
88
+ cat > "$DEMO/.alma/config.json" <<'JSON'
89
+ {
90
+ "filesystem": { "workspace_root": "." },
91
+ "plugins": {
92
+ "plugins": [
93
+ {
94
+ "identity": "test-meter",
95
+ "enabled": true,
96
+ "component_path": "plugins/test-meter/component.wasm",
97
+ "manifest_path": "plugins/test-meter/manifest.json",
98
+ "capabilities": {
99
+ "workspace.observe": [{ "prefix": ".alma-review" }],
100
+ "chrome.publish_surface": true,
101
+ "chrome.observe_choice": true
102
+ },
103
+ "scheduled_period_seconds": 5,
104
+ "runtime_limits": { "fuel_per_update": 90000000, "timeout_ms": 250 }
105
+ }
106
+ ]
107
+ }
108
+ }
109
+ JSON
110
+ ```
111
+
112
+ ## Connect to Marcellus
113
+
114
+ Start Idaemon from the demo workspace. Keep it running in this terminal and use
115
+ the printed paths in the next terminal.
116
+
117
+ ```sh
118
+ printf 'Demo workspace %s\nIdaemon executable %s\n' "$DEMO" "$IDAEMON"
119
+ cd "$DEMO"
120
+ ALMA_CONFIG="$DEMO/.alma/config.json" "$IDAEMON" serve "$DEMO/receiver" "$MARCELLUS" --plugin-actions
121
+ ```
122
+
123
+ In the second terminal, set `DEMO` and `IDAEMON` to the printed absolute paths.
124
+ Open the demo file and wait for `test-meter` to show one passing test in the
125
+ editor's indicator band. The tally advertises `reset` while it stands.
126
+
127
+ ```sh
128
+ export DEMO=/absolute/path/to/demo/workspace
129
+ export IDAEMON=/absolute/path/to/idaemon
130
+ "$IDAEMON" open "$DEMO/receiver" "$DEMO/demo.txt"
131
+ python -m pip install marceline==0.1.0
132
+ ```
133
+
134
+ Run the [Python example](#clear-a-test-tally-from-python) in this terminal. Quit
135
+ Marcellus, then run `"$IDAEMON" stop "$DEMO/receiver"` to stop Idaemon.
136
+
137
+ `Client` connects directly to the Unix socket in the absolute runtime directory
138
+ you select. It checks that the directory is private, its ancestors are
139
+ protected, and its peer belongs to the same user. Use the directory's real path
140
+ with no symlink ancestors. Idaemon and the editor apply their existing plugin
141
+ and workspace policy.
142
+
143
+ The complete socket pathname, including `/command.sock`, can use up to 103
144
+ encoded bytes on macOS or 107 on Linux. The constructor normalizes repeated
145
+ slashes and dot components once. If the resulting pathname exceeds the limit,
146
+ `invoke` returns `UNAVAILABLE` before checking the filesystem.
147
+
148
+ ## Invocation receipts
149
+
150
+ | Receipt | Meaning |
151
+ | --- | --- |
152
+ | `ACCEPTED` | The editor owner admitted the advertised action to its bounded queue. The plugin can observe it on a later update. |
153
+ | `UNAVAILABLE` | Delivery was ruled out locally, or the broker reported that the session or advertised action is unavailable. |
154
+ | `DENIED` | The receiver refused the invocation under its policy. |
155
+ | `BUSY` | The session is at capacity or still settling an earlier request. |
156
+ | `OUTCOME_UNKNOWN` | Delivery may have started and the receiver could not establish the owner outcome. |
157
+
158
+ An opted-in broker is idle until `idaemon open` starts Marcellus. Invoking during
159
+ that idle state returns `UNAVAILABLE`. Invoking after the broker stops also
160
+ returns `UNAVAILABLE`. Restart Idaemon with `--plugin-actions` and open the
161
+ workspace file again, following [Connect to Marcellus](#connect-to-marcellus).
162
+
163
+ The default timeout is 33 seconds. Socket polling uses signed 32-bit
164
+ milliseconds, so `Client` accepts finite positive timeouts up to 2,147,483
165
+ seconds or the runtime's `threading.TIMEOUT_MAX`, whichever is lower. Larger
166
+ timeouts raise `ValueError` during construction.
167
+
168
+ One deadline covers preparing the connection, waiting for readiness, sending
169
+ the request, and receiving the receipt. A timeout known to occur before
170
+ delivery returns `UNAVAILABLE`. A failure on the first attempted write can
171
+ leave delivery uncertain if the client receives no byte count.
172
+
173
+ `ClientUnavailableError` means a local problem prevented the attempt, such as
174
+ an unencodable path or an exhausted connection limit. A Python process can have
175
+ up to 32 connections in use. An endpoint check stalled in filesystem I/O retains
176
+ its slot until the operating system returns control.
177
+
178
+ The client holds a slot until native socket close returns. If repeated
179
+ interrupts cut cleanup short, collection or a later invocation can reclaim the
180
+ slot after the caller has exited and the preparation worker has stopped using
181
+ the socket, even if the traceback remains in use. On macOS and Linux, Python's
182
+ registered fork callbacks close socket descriptors the child can identify.
183
+ If native creation or close was in progress and Python cannot identify a
184
+ descriptor, the child keeps that slot reserved. Its other slots remain
185
+ available, and later forks inherit the reservations. Starting a fresh
186
+ interpreter with inherited descriptors closed restores full capacity.
187
+ An existing connection can continue in the parent. The parent discards sockets
188
+ whose creation overlapped the fork before connecting them.
189
+ A new invocation that reaches socket preparation while a fork is in progress
190
+ can return `UNAVAILABLE` before delivery.
191
+
192
+ `OutcomeUnknownError` means delivery may have started and the client could not
193
+ obtain a recognized receipt. During `invoke`, `KeyboardInterrupt` propagates to
194
+ the caller. If Marceline's fork bookkeeping catches an interrupt on the thread
195
+ running an invocation, it finishes the fork cleanup and delivers the interrupt
196
+ when the invocation next checks for it or exits. A native operation may need
197
+ to return first. Python reports interrupts escaping a fork callback through
198
+ `sys.unraisablehook`, including outside an invocation or before the callback's
199
+ bookkeeping starts.
200
+
201
+ After an unknown outcome or an interrupt during submission, inspect Marcellus
202
+ before submitting again. The SDK makes one attempt per call.
@@ -0,0 +1,29 @@
1
+ [build-system]
2
+ requires = ["setuptools==84.2.1"]
3
+ build-backend = "setuptools.build_meta"
4
+
5
+ [project]
6
+ name = "marceline"
7
+ version = "0.1.0"
8
+ description = "Python client for interacting with Marceline plugins in Marcellus."
9
+ readme = "README.python.md"
10
+ requires-python = ">=3.11"
11
+ license = "MIT OR Apache-2.0"
12
+ license-files = ["LICENSE-MIT", "LICENSE-APACHE"]
13
+ classifiers = [
14
+ "Operating System :: MacOS",
15
+ "Operating System :: POSIX :: Linux",
16
+ "Programming Language :: Python :: 3 :: Only",
17
+ "Typing :: Typed",
18
+ ]
19
+
20
+ [project.urls]
21
+ Source = "https://github.com/almanaculum/marcellus"
22
+
23
+ [tool.setuptools]
24
+ package-dir = {"" = "python"}
25
+ packages = ["marceline"]
26
+ include-package-data = false
27
+
28
+ [tool.setuptools.package-data]
29
+ marceline = ["py.typed"]