tinkerfin-contracts 0.1.1__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.
- tinkerfin_contracts-0.1.1/LICENSE +201 -0
- tinkerfin_contracts-0.1.1/PKG-INFO +100 -0
- tinkerfin_contracts-0.1.1/README.md +79 -0
- tinkerfin_contracts-0.1.1/pyproject.toml +36 -0
- tinkerfin_contracts-0.1.1/setup.cfg +4 -0
- tinkerfin_contracts-0.1.1/src/tinkerfin_contracts/__init__.py +97 -0
- tinkerfin_contracts-0.1.1/src/tinkerfin_contracts/_json.py +26 -0
- tinkerfin_contracts-0.1.1/src/tinkerfin_contracts/_models.py +52 -0
- tinkerfin_contracts-0.1.1/src/tinkerfin_contracts/graph.py +101 -0
- tinkerfin_contracts-0.1.1/src/tinkerfin_contracts/identity.py +95 -0
- tinkerfin_contracts-0.1.1/src/tinkerfin_contracts/media.py +58 -0
- tinkerfin_contracts-0.1.1/src/tinkerfin_contracts/messages.py +28 -0
- tinkerfin_contracts-0.1.1/src/tinkerfin_contracts/observations.py +629 -0
- tinkerfin_contracts-0.1.1/src/tinkerfin_contracts/protocols.py +51 -0
- tinkerfin_contracts-0.1.1/src/tinkerfin_contracts/py.typed +1 -0
- tinkerfin_contracts-0.1.1/src/tinkerfin_contracts/storage.py +85 -0
- tinkerfin_contracts-0.1.1/src/tinkerfin_contracts/workspace.py +84 -0
- tinkerfin_contracts-0.1.1/src/tinkerfin_contracts.egg-info/PKG-INFO +100 -0
- tinkerfin_contracts-0.1.1/src/tinkerfin_contracts.egg-info/SOURCES.txt +22 -0
- tinkerfin_contracts-0.1.1/src/tinkerfin_contracts.egg-info/dependency_links.txt +1 -0
- tinkerfin_contracts-0.1.1/src/tinkerfin_contracts.egg-info/requires.txt +1 -0
- tinkerfin_contracts-0.1.1/src/tinkerfin_contracts.egg-info/top_level.txt +1 -0
- tinkerfin_contracts-0.1.1/tests/test_contracts.py +106 -0
- tinkerfin_contracts-0.1.1/tests/test_finite_json.py +156 -0
|
@@ -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,100 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: tinkerfin-contracts
|
|
3
|
+
Version: 0.1.1
|
|
4
|
+
Summary: Protocol-neutral runtime observation contracts for TinkerFin integrations.
|
|
5
|
+
License-Expression: Apache-2.0
|
|
6
|
+
Project-URL: Homepage, https://github.com/tinkerfin-ai/tinkerfin-harness
|
|
7
|
+
Project-URL: Repository, https://github.com/tinkerfin-ai/tinkerfin-harness
|
|
8
|
+
Project-URL: Issues, https://github.com/tinkerfin-ai/tinkerfin-harness/issues
|
|
9
|
+
Classifier: Development Status :: 3 - Alpha
|
|
10
|
+
Classifier: Programming Language :: Python :: 3
|
|
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 :: Python :: 3.14
|
|
15
|
+
Classifier: Typing :: Typed
|
|
16
|
+
Requires-Python: >=3.11
|
|
17
|
+
Description-Content-Type: text/markdown
|
|
18
|
+
License-File: LICENSE
|
|
19
|
+
Requires-Dist: pydantic<3,>=2
|
|
20
|
+
Dynamic: license-file
|
|
21
|
+
|
|
22
|
+
# TinkerFin Contracts
|
|
23
|
+
|
|
24
|
+
`tinkerfin-contracts` provides protocol-neutral run identities and Runtime observation
|
|
25
|
+
interfaces so integrations can share execution data through one common contract.
|
|
26
|
+
|
|
27
|
+
## Installation
|
|
28
|
+
|
|
29
|
+
```bash
|
|
30
|
+
pip install tinkerfin-contracts
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
## Run identity
|
|
34
|
+
|
|
35
|
+
```python
|
|
36
|
+
from tinkerfin_contracts import RunIdentity, ThreadIdentity
|
|
37
|
+
|
|
38
|
+
identity = RunIdentity(namespace="company-a", thread_id="thread-1", run_id="run-1")
|
|
39
|
+
assert identity.thread == ThreadIdentity(namespace="company-a", thread_id="thread-1")
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
The namespace is required and limited to 128 Unicode characters; thread and run IDs
|
|
43
|
+
are limited to 1,024 characters each. All identifiers are non-empty, immutable,
|
|
44
|
+
case-sensitive UTF-8 strings without surrounding whitespace. Hosts choose namespace
|
|
45
|
+
ownership and enforce authorization. JSON uses flat `namespace`, `threadId`, and
|
|
46
|
+
`runId` fields; the derived `thread` property is not serialized.
|
|
47
|
+
|
|
48
|
+
## Runtime observers
|
|
49
|
+
|
|
50
|
+
`RuntimeObserver.open_run()` creates one request-scoped
|
|
51
|
+
`RunObservationSession`. The session receives validated run and Native observation
|
|
52
|
+
models, owns any work it starts, exposes asynchronous failure notification, and closes
|
|
53
|
+
idempotently at the Runtime boundary.
|
|
54
|
+
|
|
55
|
+
`RunSourceContext` carries the canonical identity, ordinary/branch/resume/abandon input
|
|
56
|
+
kind, parent lineage, Runtime mode, finite input/config snapshots, public resume
|
|
57
|
+
summaries, and Runtime-owned private state keys.
|
|
58
|
+
|
|
59
|
+
The observation union contains:
|
|
60
|
+
|
|
61
|
+
- Run start, input, resume-checkpoint, Observer-failure, terminal, and close values;
|
|
62
|
+
- validated Native message, task, root/subgraph state, interrupt, and declared extra-mode
|
|
63
|
+
values;
|
|
64
|
+
- stable full graph namespace, IDs, UTC time, and monotonic clock evidence.
|
|
65
|
+
|
|
66
|
+
`identity.namespace` identifies the application-defined isolation scope.
|
|
67
|
+
`graph_namespace` identifies a position within the execution graph; `()` is the root.
|
|
68
|
+
Observation JSON uses `graphNamespace` for that position.
|
|
69
|
+
|
|
70
|
+
Runtime observers receive validated models rather than captured Python `repr`.
|
|
71
|
+
JSON fields reject non-finite numbers during Python and JSON validation. Model fields
|
|
72
|
+
cannot be reassigned, but nested dictionaries and lists remain mutable. Treat received
|
|
73
|
+
evidence as read-only; the Runtime supplies an independent copy to each observer.
|
|
74
|
+
`Command(resume=...)` remains invocation input and is represented only through the
|
|
75
|
+
protocol-neutral Run source summary and checkpoint Observation.
|
|
76
|
+
|
|
77
|
+
## Document collections
|
|
78
|
+
|
|
79
|
+
`tinkerfin_contracts.storage.ConditionalStore` lets consumers share a collection
|
|
80
|
+
without depending on a provider's query models. `asearch_exact(namespace,
|
|
81
|
+
limit=100, offset=0)` returns independent `DocumentSnapshot` values containing
|
|
82
|
+
the key, finite JSON value and UTC creation/update times. Descendant namespaces
|
|
83
|
+
are excluded before pagination; pages sort by update time descending and then key.
|
|
84
|
+
|
|
85
|
+
`acompare_and_set(namespace, key, expected=observed, value=replacement)` compares
|
|
86
|
+
the complete JSON value and commits one document atomically across processes.
|
|
87
|
+
Object member order does not affect the condition; array order and scalar types
|
|
88
|
+
do. `expected=None` requires absence and `value=None` deletes. A conflict returns
|
|
89
|
+
`False` without changing data. Consumers retain their draft and reread before
|
|
90
|
+
retrying. Providers define validation and resource failures; these operations
|
|
91
|
+
use borrowed resources and do not transfer ownership to consumers.
|
|
92
|
+
|
|
93
|
+
## Documentation
|
|
94
|
+
|
|
95
|
+
[Complete documentation](https://github.com/tinkerfin-ai/tinkerfin-harness/blob/main/docs/en/index.md).
|
|
96
|
+
|
|
97
|
+
## License
|
|
98
|
+
|
|
99
|
+
Apache License 2.0. See
|
|
100
|
+
[LICENSE](https://github.com/tinkerfin-ai/tinkerfin-harness/blob/main/LICENSE).
|
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
# TinkerFin Contracts
|
|
2
|
+
|
|
3
|
+
`tinkerfin-contracts` provides protocol-neutral run identities and Runtime observation
|
|
4
|
+
interfaces so integrations can share execution data through one common contract.
|
|
5
|
+
|
|
6
|
+
## Installation
|
|
7
|
+
|
|
8
|
+
```bash
|
|
9
|
+
pip install tinkerfin-contracts
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
## Run identity
|
|
13
|
+
|
|
14
|
+
```python
|
|
15
|
+
from tinkerfin_contracts import RunIdentity, ThreadIdentity
|
|
16
|
+
|
|
17
|
+
identity = RunIdentity(namespace="company-a", thread_id="thread-1", run_id="run-1")
|
|
18
|
+
assert identity.thread == ThreadIdentity(namespace="company-a", thread_id="thread-1")
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
The namespace is required and limited to 128 Unicode characters; thread and run IDs
|
|
22
|
+
are limited to 1,024 characters each. All identifiers are non-empty, immutable,
|
|
23
|
+
case-sensitive UTF-8 strings without surrounding whitespace. Hosts choose namespace
|
|
24
|
+
ownership and enforce authorization. JSON uses flat `namespace`, `threadId`, and
|
|
25
|
+
`runId` fields; the derived `thread` property is not serialized.
|
|
26
|
+
|
|
27
|
+
## Runtime observers
|
|
28
|
+
|
|
29
|
+
`RuntimeObserver.open_run()` creates one request-scoped
|
|
30
|
+
`RunObservationSession`. The session receives validated run and Native observation
|
|
31
|
+
models, owns any work it starts, exposes asynchronous failure notification, and closes
|
|
32
|
+
idempotently at the Runtime boundary.
|
|
33
|
+
|
|
34
|
+
`RunSourceContext` carries the canonical identity, ordinary/branch/resume/abandon input
|
|
35
|
+
kind, parent lineage, Runtime mode, finite input/config snapshots, public resume
|
|
36
|
+
summaries, and Runtime-owned private state keys.
|
|
37
|
+
|
|
38
|
+
The observation union contains:
|
|
39
|
+
|
|
40
|
+
- Run start, input, resume-checkpoint, Observer-failure, terminal, and close values;
|
|
41
|
+
- validated Native message, task, root/subgraph state, interrupt, and declared extra-mode
|
|
42
|
+
values;
|
|
43
|
+
- stable full graph namespace, IDs, UTC time, and monotonic clock evidence.
|
|
44
|
+
|
|
45
|
+
`identity.namespace` identifies the application-defined isolation scope.
|
|
46
|
+
`graph_namespace` identifies a position within the execution graph; `()` is the root.
|
|
47
|
+
Observation JSON uses `graphNamespace` for that position.
|
|
48
|
+
|
|
49
|
+
Runtime observers receive validated models rather than captured Python `repr`.
|
|
50
|
+
JSON fields reject non-finite numbers during Python and JSON validation. Model fields
|
|
51
|
+
cannot be reassigned, but nested dictionaries and lists remain mutable. Treat received
|
|
52
|
+
evidence as read-only; the Runtime supplies an independent copy to each observer.
|
|
53
|
+
`Command(resume=...)` remains invocation input and is represented only through the
|
|
54
|
+
protocol-neutral Run source summary and checkpoint Observation.
|
|
55
|
+
|
|
56
|
+
## Document collections
|
|
57
|
+
|
|
58
|
+
`tinkerfin_contracts.storage.ConditionalStore` lets consumers share a collection
|
|
59
|
+
without depending on a provider's query models. `asearch_exact(namespace,
|
|
60
|
+
limit=100, offset=0)` returns independent `DocumentSnapshot` values containing
|
|
61
|
+
the key, finite JSON value and UTC creation/update times. Descendant namespaces
|
|
62
|
+
are excluded before pagination; pages sort by update time descending and then key.
|
|
63
|
+
|
|
64
|
+
`acompare_and_set(namespace, key, expected=observed, value=replacement)` compares
|
|
65
|
+
the complete JSON value and commits one document atomically across processes.
|
|
66
|
+
Object member order does not affect the condition; array order and scalar types
|
|
67
|
+
do. `expected=None` requires absence and `value=None` deletes. A conflict returns
|
|
68
|
+
`False` without changing data. Consumers retain their draft and reread before
|
|
69
|
+
retrying. Providers define validation and resource failures; these operations
|
|
70
|
+
use borrowed resources and do not transfer ownership to consumers.
|
|
71
|
+
|
|
72
|
+
## Documentation
|
|
73
|
+
|
|
74
|
+
[Complete documentation](https://github.com/tinkerfin-ai/tinkerfin-harness/blob/main/docs/en/index.md).
|
|
75
|
+
|
|
76
|
+
## License
|
|
77
|
+
|
|
78
|
+
Apache License 2.0. See
|
|
79
|
+
[LICENSE](https://github.com/tinkerfin-ai/tinkerfin-harness/blob/main/LICENSE).
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
[project]
|
|
2
|
+
name = "tinkerfin-contracts"
|
|
3
|
+
version = "0.1.1"
|
|
4
|
+
description = "Protocol-neutral runtime observation contracts for TinkerFin integrations."
|
|
5
|
+
readme = "README.md"
|
|
6
|
+
requires-python = ">=3.11"
|
|
7
|
+
license = "Apache-2.0"
|
|
8
|
+
license-files = ["LICENSE"]
|
|
9
|
+
classifiers = [
|
|
10
|
+
"Development Status :: 3 - Alpha",
|
|
11
|
+
"Programming Language :: Python :: 3",
|
|
12
|
+
"Programming Language :: Python :: 3.11",
|
|
13
|
+
"Programming Language :: Python :: 3.12",
|
|
14
|
+
"Programming Language :: Python :: 3.13",
|
|
15
|
+
"Programming Language :: Python :: 3.14",
|
|
16
|
+
"Typing :: Typed",
|
|
17
|
+
]
|
|
18
|
+
|
|
19
|
+
dependencies = [
|
|
20
|
+
"pydantic>=2,<3",
|
|
21
|
+
]
|
|
22
|
+
|
|
23
|
+
[project.urls]
|
|
24
|
+
Homepage = "https://github.com/tinkerfin-ai/tinkerfin-harness"
|
|
25
|
+
Repository = "https://github.com/tinkerfin-ai/tinkerfin-harness"
|
|
26
|
+
Issues = "https://github.com/tinkerfin-ai/tinkerfin-harness/issues"
|
|
27
|
+
|
|
28
|
+
[build-system]
|
|
29
|
+
requires = ["setuptools>=77"]
|
|
30
|
+
build-backend = "setuptools.build_meta"
|
|
31
|
+
|
|
32
|
+
[tool.setuptools.packages.find]
|
|
33
|
+
where = ["src"]
|
|
34
|
+
|
|
35
|
+
[tool.setuptools.package-data]
|
|
36
|
+
tinkerfin_contracts = ["py.typed"]
|
|
@@ -0,0 +1,97 @@
|
|
|
1
|
+
"""Protocol-neutral identities and Runtime observation contracts."""
|
|
2
|
+
|
|
3
|
+
from .graph import GraphOrigin as GraphOrigin
|
|
4
|
+
from .graph import GraphTaskReference as GraphTaskReference
|
|
5
|
+
from .graph import SubagentRequestReference as SubagentRequestReference
|
|
6
|
+
from .graph import subagent_request_id as subagent_request_id
|
|
7
|
+
from .identity import RunIdentity as RunIdentity
|
|
8
|
+
from .identity import ThreadIdentity as ThreadIdentity
|
|
9
|
+
from .messages import MessageSource as MessageSource
|
|
10
|
+
from .observations import RUNTIME_OBSERVATION_ADAPTER as RUNTIME_OBSERVATION_ADAPTER
|
|
11
|
+
from .observations import (
|
|
12
|
+
ContextContributionObservation as ContextContributionObservation,
|
|
13
|
+
)
|
|
14
|
+
from .observations import ContextKind as ContextKind
|
|
15
|
+
from .observations import ModelCallObservation as ModelCallObservation
|
|
16
|
+
from .observations import NativeExtraMode as NativeExtraMode
|
|
17
|
+
from .observations import NativeExtraObservation as NativeExtraObservation
|
|
18
|
+
from .observations import NativeInterruptRecord as NativeInterruptRecord
|
|
19
|
+
from .observations import NativeMessageObservation as NativeMessageObservation
|
|
20
|
+
from .observations import NativeMessageRecord as NativeMessageRecord
|
|
21
|
+
from .observations import NativeMessageType as NativeMessageType
|
|
22
|
+
from .observations import NativeObservation as NativeObservation
|
|
23
|
+
from .observations import NativeReasoningObservation as NativeReasoningObservation
|
|
24
|
+
from .observations import NativeStateObservation as NativeStateObservation
|
|
25
|
+
from .observations import NativeTaskObservation as NativeTaskObservation
|
|
26
|
+
from .observations import NativeToolCall as NativeToolCall
|
|
27
|
+
from .observations import NativeToolCallChunk as NativeToolCallChunk
|
|
28
|
+
from .observations import ObservationBoundary as ObservationBoundary
|
|
29
|
+
from .observations import RunClosedObservation as RunClosedObservation
|
|
30
|
+
from .observations import RunInputKind as RunInputKind
|
|
31
|
+
from .observations import RunInputObservation as RunInputObservation
|
|
32
|
+
from .observations import RunMode as RunMode
|
|
33
|
+
from .observations import RunObserverFailedObservation as RunObserverFailedObservation
|
|
34
|
+
from .observations import RunPhase as RunPhase
|
|
35
|
+
from .observations import RunPhaseObservation as RunPhaseObservation
|
|
36
|
+
from .observations import (
|
|
37
|
+
RunResumeCheckpointedObservation as RunResumeCheckpointedObservation,
|
|
38
|
+
)
|
|
39
|
+
from .observations import RunResumeSummary as RunResumeSummary
|
|
40
|
+
from .observations import RunSourceContext as RunSourceContext
|
|
41
|
+
from .observations import RunStartedObservation as RunStartedObservation
|
|
42
|
+
from .observations import RunTerminalObservation as RunTerminalObservation
|
|
43
|
+
from .observations import RunTerminalOutcome as RunTerminalOutcome
|
|
44
|
+
from .observations import RuntimeObservation as RuntimeObservation
|
|
45
|
+
from .observations import ToolExecutionObservation as ToolExecutionObservation
|
|
46
|
+
from .protocols import RunObservationSession as RunObservationSession
|
|
47
|
+
from .protocols import RuntimeObserver as RuntimeObserver
|
|
48
|
+
from .workspace import PreparedWorkspace as PreparedWorkspace
|
|
49
|
+
from .workspace import Workspace as Workspace
|
|
50
|
+
from .workspace import WorkspacePreparationFailure as WorkspacePreparationFailure
|
|
51
|
+
|
|
52
|
+
__all__ = [
|
|
53
|
+
"RUNTIME_OBSERVATION_ADAPTER",
|
|
54
|
+
"ContextContributionObservation",
|
|
55
|
+
"ContextKind",
|
|
56
|
+
"GraphOrigin",
|
|
57
|
+
"GraphTaskReference",
|
|
58
|
+
"MessageSource",
|
|
59
|
+
"ModelCallObservation",
|
|
60
|
+
"NativeExtraMode",
|
|
61
|
+
"NativeExtraObservation",
|
|
62
|
+
"NativeInterruptRecord",
|
|
63
|
+
"NativeMessageObservation",
|
|
64
|
+
"NativeMessageRecord",
|
|
65
|
+
"NativeMessageType",
|
|
66
|
+
"NativeObservation",
|
|
67
|
+
"NativeReasoningObservation",
|
|
68
|
+
"NativeStateObservation",
|
|
69
|
+
"NativeTaskObservation",
|
|
70
|
+
"NativeToolCall",
|
|
71
|
+
"NativeToolCallChunk",
|
|
72
|
+
"ObservationBoundary",
|
|
73
|
+
"PreparedWorkspace",
|
|
74
|
+
"RunClosedObservation",
|
|
75
|
+
"RunIdentity",
|
|
76
|
+
"RunInputKind",
|
|
77
|
+
"RunInputObservation",
|
|
78
|
+
"RunMode",
|
|
79
|
+
"RunObservationSession",
|
|
80
|
+
"RunObserverFailedObservation",
|
|
81
|
+
"RunPhase",
|
|
82
|
+
"RunPhaseObservation",
|
|
83
|
+
"RunResumeCheckpointedObservation",
|
|
84
|
+
"RunResumeSummary",
|
|
85
|
+
"RunSourceContext",
|
|
86
|
+
"RunStartedObservation",
|
|
87
|
+
"RunTerminalObservation",
|
|
88
|
+
"RunTerminalOutcome",
|
|
89
|
+
"RuntimeObservation",
|
|
90
|
+
"RuntimeObserver",
|
|
91
|
+
"SubagentRequestReference",
|
|
92
|
+
"ThreadIdentity",
|
|
93
|
+
"ToolExecutionObservation",
|
|
94
|
+
"Workspace",
|
|
95
|
+
"WorkspacePreparationFailure",
|
|
96
|
+
"subagent_request_id",
|
|
97
|
+
]
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
"""Finite JSON validation shared by every observation payload."""
|
|
2
|
+
|
|
3
|
+
from __future__ import annotations
|
|
4
|
+
|
|
5
|
+
import math
|
|
6
|
+
from typing import Annotated, TypeAlias
|
|
7
|
+
|
|
8
|
+
from pydantic import AfterValidator, JsonValue
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
def _require_finite(value: JsonValue) -> JsonValue:
|
|
12
|
+
# Pydantic's JsonValue uses an unrestricted JSON-input fast path. A validator
|
|
13
|
+
# on the payload type protects both input modes; model float configuration alone
|
|
14
|
+
# does not constrain that path. See test_finite_json.py for the public boundary.
|
|
15
|
+
if isinstance(value, float) and not math.isfinite(value):
|
|
16
|
+
raise ValueError("JSON numbers must be finite")
|
|
17
|
+
if isinstance(value, dict):
|
|
18
|
+
for item in value.values():
|
|
19
|
+
_require_finite(item)
|
|
20
|
+
elif isinstance(value, list):
|
|
21
|
+
for item in value:
|
|
22
|
+
_require_finite(item)
|
|
23
|
+
return value
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
FiniteJsonValue: TypeAlias = Annotated[JsonValue, AfterValidator(_require_finite)]
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
"""Shared validation behavior for protocol-neutral contract values."""
|
|
2
|
+
|
|
3
|
+
from __future__ import annotations
|
|
4
|
+
|
|
5
|
+
from datetime import UTC, datetime
|
|
6
|
+
|
|
7
|
+
from pydantic import BaseModel, ConfigDict, field_validator
|
|
8
|
+
from pydantic.alias_generators import to_camel
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
class ContractModel(BaseModel):
|
|
12
|
+
"""Validate finite boundary values and prevent field reassignment.
|
|
13
|
+
|
|
14
|
+
Nested dictionaries and lists remain mutable. Consumers must treat received
|
|
15
|
+
evidence as read-only; Runtime observer delivery supplies independent copies.
|
|
16
|
+
"""
|
|
17
|
+
|
|
18
|
+
model_config = ConfigDict(
|
|
19
|
+
alias_generator=to_camel,
|
|
20
|
+
extra="forbid",
|
|
21
|
+
frozen=True,
|
|
22
|
+
populate_by_name=True,
|
|
23
|
+
strict=True,
|
|
24
|
+
)
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
class ObservationModel(ContractModel):
|
|
28
|
+
"""Attach comparable wall and monotonic timestamps to one observation."""
|
|
29
|
+
|
|
30
|
+
observed_at: datetime
|
|
31
|
+
monotonic_ns: int
|
|
32
|
+
|
|
33
|
+
@field_validator("observed_at")
|
|
34
|
+
@classmethod
|
|
35
|
+
def observed_at_is_utc(cls, value: datetime) -> datetime:
|
|
36
|
+
"""Require an aware UTC timestamp without rewriting caller evidence."""
|
|
37
|
+
|
|
38
|
+
if value.tzinfo is None or value.utcoffset() != UTC.utcoffset(value):
|
|
39
|
+
raise ValueError("observed_at must be an aware UTC timestamp")
|
|
40
|
+
return value
|
|
41
|
+
|
|
42
|
+
@field_validator("monotonic_ns")
|
|
43
|
+
@classmethod
|
|
44
|
+
def monotonic_ns_is_non_negative(cls, value: int) -> int:
|
|
45
|
+
"""Reject invalid monotonic offsets before observers compare durations."""
|
|
46
|
+
|
|
47
|
+
if value < 0:
|
|
48
|
+
raise ValueError("monotonic_ns must be non-negative")
|
|
49
|
+
return value
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
__all__ = ["ContractModel", "ObservationModel"]
|