3lc-compute-plugin-sdk 0.2.2__py3-none-any.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.
@@ -0,0 +1,81 @@
1
+ Metadata-Version: 2.1
2
+ Name: 3lc-compute-plugin-sdk
3
+ Version: 0.2.2
4
+ Summary: Public Python SDK for building 3LC compute-service plugins (the import-light plugin contract).
5
+ Project-URL: Homepage, https://github.com/3lc-ai/3lc-compute-plugin-sdk
6
+ Project-URL: Repository, https://github.com/3lc-ai/3lc-compute-plugin-sdk
7
+ Author-email: 3LC <support@3lc.ai>
8
+ License: Apache-2.0
9
+ Keywords: 3lc,data-curation,machine-learning,plugin,sdk
10
+ Classifier: Development Status :: 4 - Beta
11
+ Classifier: Intended Audience :: Developers
12
+ Classifier: License :: OSI Approved :: Apache Software License
13
+ Classifier: Operating System :: OS Independent
14
+ Classifier: Programming Language :: Python :: 3
15
+ Classifier: Programming Language :: Python :: 3.10
16
+ Classifier: Programming Language :: Python :: 3.11
17
+ Classifier: Programming Language :: Python :: 3.12
18
+ Classifier: Typing :: Typed
19
+ Requires-Python: >=3.10
20
+ Requires-Dist: litestar<3.0.0,>=2.22.0
21
+ Requires-Dist: uvicorn>=0.34.0
22
+ Provides-Extra: shared
23
+ Requires-Dist: 3lc[pandas]<4.0.0,>=3.0.0; extra == 'shared'
24
+ Description-Content-Type: text/markdown
25
+
26
+ # 3lc-compute-plugin-sdk
27
+
28
+ [![PyPI](https://img.shields.io/pypi/v/3lc-compute-plugin-sdk)](https://pypi.org/project/3lc-compute-plugin-sdk/)
29
+ [![Docs](https://img.shields.io/badge/docs-3lc--ai.github.io-blue)](https://3lc-ai.github.io/3lc-compute-plugin-sdk/)
30
+ [![Try it](https://img.shields.io/badge/try%20it-use%20the%20plugin%20template-brightgreen)](https://github.com/3lc-ai/3lc-compute-plugin-template/generate)
31
+
32
+ Plugins are how you extend the [3LC Hub](https://docs.3lc.ai/3lc/latest/hub/index.html) —
33
+ your own importers, exporters, training jobs, and data tools, appearing in the Hub right
34
+ next to the built-ins. This SDK is everything a plugin needs: one small Python package to
35
+ program against, while the Hub takes care of discovery, isolation, serving, and job
36
+ orchestration.
37
+
38
+ ```bash
39
+ pip install 3lc-compute-plugin-sdk # import name: tlc_plugin_sdk
40
+ ```
41
+
42
+ > **Distribution `3lc-compute-plugin-sdk` · import `tlc_plugin_sdk`.**
43
+
44
+ ## What it gives you
45
+
46
+ - **`ComputePlugin`** — the base class you subclass. Implement `compute` / `get_ui_fragment`;
47
+ job and lifecycle hooks ship as no-op defaults. There is no `register()` to call — a plugin's
48
+ metadata lives in its `[tool.tlc-compute]` manifest, and the host discovers it from there.
49
+ - **`JobContext`** — the surface a long-running job programs against: `progress` / `metric` /
50
+ `log` / `result` for the generic job panel, `emit` for your plugin's own rich UI, and
51
+ cooperative `cancelled`.
52
+ - **The worker** (`python -m tlc_plugin_sdk.worker`) — serves your plugin's Litestar route
53
+ handlers + the generic reserved routes as an ASGI app, identically whether the host runs it
54
+ in-process or out-of-process in its own venv.
55
+ - **`tlc_plugin_sdk.shared.*`** — batteries the heavy plugins share: URL-alias registration,
56
+ config storage/UI, the generic-job helpers, image/label/modality utilities, script injection.
57
+
58
+ ## Quickstart
59
+
60
+ See **[`docs/plugin-guide.md`](docs/plugin-guide.md)** for the full author guide (manifest
61
+ format, custom routes, the job model, UI fragment, checklist).
62
+
63
+ ## The contract version
64
+
65
+ `tlc_plugin_sdk.SDK_CONTRACT_VERSION` is this package's own version — one source of truth.
66
+ A plugin pins the SDK (`3lc-compute-plugin-sdk>=X,<Y`) and declares the contract it targets via its
67
+ manifest. The host implements a contract range and the SDK version is the lingua franca that
68
+ both sides agree on. Versions are SemVer; see **Status** below for the 0.x stability stance.
69
+
70
+ ## Boundary (the one rule)
71
+
72
+ The SDK is the **root** of the plugin dependency graph: it depends only on `3lc` + `uvicorn` +
73
+ `litestar`, and **never** on the host (`3lc-compute`) or on any plugin. If your plugin only
74
+ needs `tlc_plugin_sdk`, it is portable across host versions and can run in its own isolated venv.
75
+
76
+ ## Status
77
+
78
+ **0.2 is the released contract line.** Within 0.x the contract evolves **additively only**:
79
+ symbols and schemas that exist keep working, and anything breaking waits for a major bump. In
80
+ the browser bridge, `PLUGIN_API.libs.io` is a stable part of the contract; the other bundled
81
+ libs are best-effort (see the guide).
@@ -0,0 +1,28 @@
1
+ tlc_plugin_sdk/__init__.py,sha256=tYQnuJIkCYftAJ_wi4Na37BvnkFDduJcTis81dWaRyU,3186
2
+ tlc_plugin_sdk/asgi_app.py,sha256=AJkAS1avOSEamKj0HjtY0SVCGwJTZZSmXwTqyoxM_Ig,4266
3
+ tlc_plugin_sdk/contract.py,sha256=_OUno9dZ9IPvHG3kxltbenQYosI2P3nZc4tIVZp63Kc,4745
4
+ tlc_plugin_sdk/job_context.py,sha256=3aNqoILUIMtDvaAdjD8_B1PMthPbzKOp3h32kUf6UVM,4955
5
+ tlc_plugin_sdk/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
6
+ tlc_plugin_sdk/worker.py,sha256=NOr7FYncXh_Yj8ad13iaUavU9cmc2YKWcH7GrAheWns,12351
7
+ tlc_plugin_sdk/shared/__init__.py,sha256=ab5fk-l17vOrC0v4C7Wan4-J9sVJbxP5b2HWg29pmTo,583
8
+ tlc_plugin_sdk/shared/alias_override_ui.py,sha256=wgnmbgUzKNAIfQCsZ6AUEPIAk5IyZh2D3YtnjvD0_44,7904
9
+ tlc_plugin_sdk/shared/alias_ui.py,sha256=KSwpWxhI3EHPdRTFKVhC-YCLEKPRzcj0JfHh648dSdE,9051
10
+ tlc_plugin_sdk/shared/aliases.py,sha256=A1GNqcFP6_M3P_Mb4og1VoNZ-BpJYKKkNwDfFeJu_s8,7851
11
+ tlc_plugin_sdk/shared/config_store.py,sha256=MCDPRqHfzXU6L72m7EEinw3pkXotnnxatlcYBLSHGV4,6117
12
+ tlc_plugin_sdk/shared/config_ui.py,sha256=FU1pCBTHZaC5zyMkb--7L1cLDOXGN5UCKRkRQv3jcFg,8634
13
+ tlc_plugin_sdk/shared/data_source_routes.py,sha256=NWpd9f2gIrKGgEU1WiF7TjXCH3SnLntKiH7FEGjbQm4,8999
14
+ tlc_plugin_sdk/shared/data_source_ui.py,sha256=1qeqXL69rpavUOfjO57-TP9q5986IFIj2Y8a27TUQgE,17831
15
+ tlc_plugin_sdk/shared/generic_job.py,sha256=gLsB5VkcthyZJ03Rwin5Dv9K-MJmfZY6LgVdCIbiMHA,1830
16
+ tlc_plugin_sdk/shared/images.py,sha256=f6Qi-CaI6nsJ9CHp9jsxMX-Crlv6XwIM1O_NjUXJOZs,13815
17
+ tlc_plugin_sdk/shared/job_tracker.py,sha256=f6A9EQWYqG0SE98Q2C5zgY5jjYtqupMtmy1Qvz2-qEw,7354
18
+ tlc_plugin_sdk/shared/labels.py,sha256=9gxa6-ECFb05NtccjeI1rIPX00f32SLPT-Rk5JG04kE,8037
19
+ tlc_plugin_sdk/shared/modality.py,sha256=7-klX8kr-fLCOKYL9Op_jAjzW9JHHv-Z2xYw9mf3iDI,20186
20
+ tlc_plugin_sdk/shared/model_storage.py,sha256=qiJotQr5S8oYrtsj_bHpHswn9eO__6wX9juf11EEWag,5059
21
+ tlc_plugin_sdk/shared/naming.py,sha256=B3HSRybchXtEtJ_gPkXKZIfplwD1Lrx6rdjsD28Ds5I,1473
22
+ tlc_plugin_sdk/shared/ui_inject.py,sha256=tPlHb-cqHsIjo3yw-6ulaaJqi9wTyKOIz7fewt5UPj8,2742
23
+ tlc_plugin_sdk/shared/url_utils.py,sha256=n_jZbzQr9Y6qpfX3HTvTkbQKwLj_OTuPogPdrBdI6Z0,3649
24
+ tlc_plugin_sdk/contract/plugin-api.d.ts,sha256=-bybpq76WF2kef5tg9MmNNGjr8HPJlbRSXQ-UZYKHwE,17444
25
+ 3lc_compute_plugin_sdk-0.2.2.dist-info/METADATA,sha256=D6JK2Xv4LLgBHBvH_O3lf3CKX2qYLiWmS0VYeW8lQvI,4182
26
+ 3lc_compute_plugin_sdk-0.2.2.dist-info/WHEEL,sha256=zOwg4jB6zX2kU910N-cMawjivD6tO8NEWvE12je1bVk,87
27
+ 3lc_compute_plugin_sdk-0.2.2.dist-info/licenses/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
28
+ 3lc_compute_plugin_sdk-0.2.2.dist-info/RECORD,,
@@ -0,0 +1,4 @@
1
+ Wheel-Version: 1.0
2
+ Generator: hatchling 1.32.0
3
+ Root-Is-Purelib: true
4
+ Tag: py3-none-any
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
@@ -0,0 +1,58 @@
1
+ # Copyright 2026 3LC Inc.
2
+ # SPDX-License-Identifier: Apache-2.0
3
+ """Import-light plugin SDK — the contract surface a plugin programs against.
4
+
5
+ This is the public import path for the plugin contract. Importing it must **not**
6
+ pull in the heavy server stack (litestar, python-socketio, uvicorn, the queues,
7
+ discovery): a ``venv``-mode plugin installs only this surface, not the full
8
+ service. The ``tests/test_import_light.py`` test enforces the boundary.
9
+
10
+ A plugin subclasses :class:`ComputePlugin` and implements at least
11
+ ``compute``/``get_ui_fragment``; the optional job/lifecycle hooks ship as no-op
12
+ defaults. There is no ``register()`` to call — metadata lives in the plugin
13
+ manifest, and the host discovers the plugin via its manifest ``entrypoint``.
14
+
15
+ The contract is **defined here**, in :mod:`tlc_plugin_sdk.contract`, so it lives
16
+ next to :class:`JobContext` and the venv worker on the import-light side of the SDK
17
+ boundary — nothing in this package pulls in the server stack. This is the standalone
18
+ public ``3lc-compute-plugin-sdk`` distribution: the light base a venv plugin installs (the
19
+ host ``3lc-compute`` depends on it, never the reverse). See ``CLAUDE.md``.
20
+ """
21
+
22
+ from __future__ import annotations
23
+
24
+ from importlib.metadata import PackageNotFoundError
25
+ from importlib.metadata import version as _pkg_version
26
+
27
+ from tlc_plugin_sdk.contract import ComputePlugin
28
+ from tlc_plugin_sdk.job_context import JobContext
29
+
30
+ # Plugin contract (ABI) version = this package's own version — one source of truth
31
+ # (the ``[project] version`` in pyproject), read via importlib.metadata rather than a
32
+ # separately maintained constant. A plugin declares the contract it targets via its
33
+ # manifest's ``sdk_version``.
34
+ try:
35
+ SDK_CONTRACT_VERSION = _pkg_version("3lc-compute-plugin-sdk")
36
+ except PackageNotFoundError: # running from a raw checkout that was never installed
37
+ SDK_CONTRACT_VERSION = "0.0.0"
38
+
39
+ # Capability markers for feature-detection — decoupled from the wheel/SemVer pin.
40
+ #
41
+ # ``SDK_CONTRACT_VERSION`` above is the package version: the *dependency pin* a plugin
42
+ # resolves against (``3lc-compute-plugin-sdk>=X,<Y``). The two constants below are finer-grained
43
+ # *capability* markers a plugin (or the host) can feature-detect against at runtime:
44
+ #
45
+ # * ``PY_CONTRACT`` — the Python-side contract: ``ComputePlugin`` / ``JobContext`` and
46
+ # the ``tlc_plugin_sdk.shared.*`` helpers (what a plugin's Python programs against).
47
+ # * ``JS_CONTRACT`` — the browser-side contract: the ``PLUGIN_API`` / ``PluginJobs`` /
48
+ # ``TlcData`` surface a plugin's ``ui.html`` programs against (see
49
+ # ``contract/plugin-api.d.ts``; the ``PluginJobs`` client ships from THIS package).
50
+ #
51
+ # Each MINOR axis increments **independently** as features are added to one side without
52
+ # the other. Both are always ``<= `` the package version (a capability can only exist in a
53
+ # shipped wheel). Bump the package version when EITHER ``PY_CONTRACT`` or ``JS_CONTRACT``
54
+ # moves — the wheel is the thing a plugin actually pins, so it must cover both axes.
55
+ PY_CONTRACT = "0.1"
56
+ JS_CONTRACT = "0.2"
57
+
58
+ __all__ = ["JS_CONTRACT", "PY_CONTRACT", "SDK_CONTRACT_VERSION", "ComputePlugin", "JobContext"]
@@ -0,0 +1,103 @@
1
+ # Copyright 2026 3LC Inc.
2
+ # SPDX-License-Identifier: Apache-2.0
3
+ """Build a plugin's HTTP surface as a Litestar ASGI app.
4
+
5
+ This is the single route-authoring pattern: a plugin exposes its custom routes as
6
+ relative Litestar route handlers via :meth:`ComputePlugin.get_route_handlers`, and
7
+ the **same** handlers are served two ways from the **same** builder:
8
+
9
+ - **host (in-process):** the compute service builds the app once per plugin
10
+ instance and invokes it directly through the ASGI interface (no socket);
11
+ - **venv (out-of-process):** the worker (``tlc_plugin_sdk.worker``) serves the app
12
+ with uvicorn on a Unix socket and the host reverse-proxies to it.
13
+
14
+ Because both modes serve the identical app, a plugin's routes get a real router,
15
+ request validation, multipart, and binary/streaming responses in **either** mode,
16
+ with no host/venv divergence. Litestar runs ``def`` handlers in a threadpool, so a
17
+ synchronous, CPU-bound custom route (e.g. preview inference) does not block the
18
+ event loop.
19
+
20
+ The app also mounts the host-reserved generic routes (``/health``, ``/ui``,
21
+ ``/compute``) so the worker can answer them over the socket; for the in-process host
22
+ app these are harmless (the host serves ``/ui``/``/compute`` from its own reserved
23
+ param routes and never forwards them here).
24
+
25
+ Litestar is a base dependency of this SDK, but it is imported **here**, not in
26
+ the import-light :mod:`tlc_plugin_sdk` package surface — so
27
+ ``import tlc_plugin_sdk`` stays cheap.
28
+ """
29
+
30
+ from __future__ import annotations
31
+
32
+ from typing import TYPE_CHECKING, Any
33
+
34
+ from litestar import Litestar, Request, get
35
+
36
+ if TYPE_CHECKING:
37
+ from litestar.handlers import BaseRouteHandler
38
+
39
+ from tlc_plugin_sdk.contract import ComputePlugin
40
+
41
+
42
+ def _generic_handlers(plugin: ComputePlugin) -> list[BaseRouteHandler]:
43
+ """The host-reserved generic routes, bound to ``plugin`` (served by the worker)."""
44
+
45
+ @get("/health", sync_to_thread=False)
46
+ def health() -> dict[str, Any]:
47
+ # The version fields are the worker half of a handshake: a venv worker imports its
48
+ # *own* install of this SDK, so the host cannot know which contract is live inside
49
+ # the venv unless the worker says so. The host compares them against its own and
50
+ # flags skew on the plugin card. Reported from the same constants a plugin
51
+ # feature-detects against, so worker and plugin can never disagree.
52
+ from tlc_plugin_sdk import JS_CONTRACT, PY_CONTRACT, SDK_CONTRACT_VERSION
53
+
54
+ return {
55
+ "ok": True,
56
+ "plugin": getattr(plugin, "id", "?"),
57
+ "sdk_version": SDK_CONTRACT_VERSION,
58
+ "py_contract": PY_CONTRACT,
59
+ "js_contract": JS_CONTRACT,
60
+ }
61
+
62
+ # def + sync_to_thread: get_ui_fragment()/compute() are synchronous and may do
63
+ # blocking work, so Litestar runs them in a threadpool, off the event loop.
64
+ @get("/ui", media_type="text/html", sync_to_thread=True)
65
+ def ui() -> str:
66
+ return plugin.get_ui_fragment()
67
+
68
+ @get("/compute", sync_to_thread=True)
69
+ def compute(request: Request[Any, Any, Any]) -> dict[str, Any]:
70
+ params: dict[str, Any] = dict(request.query_params)
71
+ params.setdefault("url", "")
72
+ return plugin.compute(params)
73
+
74
+ return [health, ui, compute]
75
+
76
+
77
+ def build_plugin_app(
78
+ plugin: ComputePlugin,
79
+ *,
80
+ extra_handlers: list[BaseRouteHandler] | None = None,
81
+ debug: bool = False,
82
+ ) -> Litestar:
83
+ """Build the Litestar app serving ``plugin``'s HTTP surface (host + venv).
84
+
85
+ Args:
86
+ plugin: The plugin instance whose behavior the routes invoke.
87
+ extra_handlers: Worker-only handlers (the ``/jobs/{id}/run`` stream,
88
+ ``/jobs/{id}/cancel``, and ``/reclaim``); omitted for the host in-process
89
+ app, whose job lifecycle is owned by the host ``JobManager``.
90
+ debug: Litestar debug flag.
91
+
92
+ Returns:
93
+ A Litestar app mounting, in trie-priority order: the plugin's own relative
94
+ route handlers (most specific), the generic reserved routes, and any
95
+ ``extra_handlers``.
96
+
97
+ """
98
+ handlers: list[Any] = [
99
+ *plugin.get_route_handlers(),
100
+ *_generic_handlers(plugin),
101
+ *(extra_handlers or []),
102
+ ]
103
+ return Litestar(route_handlers=handlers, debug=debug)