ex-minimal-plugin-py 0.0.1a1__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,231 @@
1
+ # Byte-compiled / optimized / DLL files
2
+ __pycache__/
3
+ *.py[codz]
4
+ *$py.class
5
+
6
+ # C extensions
7
+ *.so
8
+
9
+ # Distribution / packaging
10
+ .Python
11
+ build/
12
+ develop-eggs/
13
+ dist/
14
+ downloads/
15
+ eggs/
16
+ .eggs/
17
+ lib/
18
+ lib64/
19
+ parts/
20
+ sdist/
21
+ var/
22
+ wheels/
23
+ share/python-wheels/
24
+ *.egg-info/
25
+ .installed.cfg
26
+ *.egg
27
+ MANIFEST
28
+
29
+ # PyInstaller
30
+ # Usually these files are written by a python script from a template
31
+ # before PyInstaller builds the exe, so as to inject date/other infos into it.
32
+ *.manifest
33
+ *.spec
34
+
35
+ # Installer logs
36
+ pip-log.txt
37
+ pip-delete-this-directory.txt
38
+
39
+ # Unit test / coverage reports
40
+ htmlcov/
41
+ .tox/
42
+ .nox/
43
+ .coverage
44
+ .coverage.*
45
+ .cache
46
+ nosetests.xml
47
+ coverage.xml
48
+ *.cover
49
+ *.py.cover
50
+ .hypothesis/
51
+ .pytest_cache/
52
+ cover/
53
+
54
+ # Translations
55
+ *.mo
56
+ *.pot
57
+
58
+ # Django stuff:
59
+ *.log
60
+ local_settings.py
61
+ db.sqlite3
62
+ db.sqlite3-journal
63
+
64
+ # Flask stuff:
65
+ instance/
66
+ .webassets-cache
67
+
68
+ # Scrapy stuff:
69
+ .scrapy
70
+
71
+ # Sphinx documentation
72
+ docs/_build/
73
+
74
+ # PyBuilder
75
+ .pybuilder/
76
+ target/
77
+
78
+ # Jupyter Notebook
79
+ .ipynb_checkpoints
80
+
81
+ # IPython
82
+ profile_default/
83
+ ipython_config.py
84
+
85
+ # pyenv
86
+ # For a library or package, you might want to ignore these files since the code is
87
+ # intended to run in multiple environments; otherwise, check them in:
88
+ # .python-version
89
+
90
+ # pipenv
91
+ # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
92
+ # However, in case of collaboration, if having platform-specific dependencies or dependencies
93
+ # having no cross-platform support, pipenv may install dependencies that don't work, or not
94
+ # install all needed dependencies.
95
+ # Pipfile.lock
96
+
97
+ # UV
98
+ # Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
99
+ # This is especially recommended for binary packages to ensure reproducibility, and is more
100
+ # commonly ignored for libraries.
101
+ # uv.lock
102
+
103
+ # poetry
104
+ # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
105
+ # This is especially recommended for binary packages to ensure reproducibility, and is more
106
+ # commonly ignored for libraries.
107
+ # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
108
+ # poetry.lock
109
+ # poetry.toml
110
+
111
+ # pdm
112
+ # Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
113
+ # pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
114
+ # https://pdm-project.org/en/latest/usage/project/#working-with-version-control
115
+ # pdm.lock
116
+ # pdm.toml
117
+ .pdm-python
118
+ .pdm-build/
119
+
120
+ # pixi
121
+ # Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
122
+ # pixi.lock
123
+ # Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
124
+ # in the .venv directory. It is recommended not to include this directory in version control.
125
+ .pixi
126
+
127
+ # PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
128
+ __pypackages__/
129
+
130
+ # Celery stuff
131
+ celerybeat-schedule
132
+ celerybeat.pid
133
+
134
+ # Redis
135
+ *.rdb
136
+ *.aof
137
+ *.pid
138
+
139
+ # RabbitMQ
140
+ mnesia/
141
+ rabbitmq/
142
+ rabbitmq-data/
143
+
144
+ # ActiveMQ
145
+ activemq-data/
146
+
147
+ # SageMath parsed files
148
+ *.sage.py
149
+
150
+ # Environments
151
+ .env
152
+ .envrc
153
+ .venv
154
+ env/
155
+ venv/
156
+ ENV/
157
+ env.bak/
158
+ venv.bak/
159
+
160
+ # Spyder project settings
161
+ .spyderproject
162
+ .spyproject
163
+
164
+ # Rope project settings
165
+ .ropeproject
166
+
167
+ # mkdocs documentation
168
+ /site
169
+
170
+ # mypy
171
+ .mypy_cache/
172
+ .dmypy.json
173
+ dmypy.json
174
+
175
+ # Pyre type checker
176
+ .pyre/
177
+
178
+ # pytype static type analyzer
179
+ .pytype/
180
+
181
+ # Cython debug symbols
182
+ cython_debug/
183
+
184
+ # PyCharm
185
+ # JetBrains specific template is maintained in a separate JetBrains.gitignore that can
186
+ # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
187
+ # and can be added to the global gitignore or merged into this file. For a more nuclear
188
+ # option (not recommended) you can uncomment the following to ignore the entire idea folder.
189
+ # .idea/
190
+
191
+ # Abstra
192
+ # Abstra is an AI-powered process automation framework.
193
+ # Ignore directories containing user credentials, local state, and settings.
194
+ # Learn more at https://abstra.io/docs
195
+ .abstra/
196
+
197
+ # Visual Studio Code
198
+ # Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
199
+ # that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
200
+ # and can be added to the global gitignore or merged into this file. However, if you prefer,
201
+ # you could uncomment the following to ignore the entire vscode folder
202
+ # .vscode/
203
+ # Temporary file for partial code execution
204
+ tempCodeRunnerFile.py
205
+
206
+ # Ruff stuff:
207
+ .ruff_cache/
208
+
209
+ # PyPI configuration file
210
+ .pypirc
211
+
212
+ # Marimo
213
+ marimo/_static/
214
+ marimo/_lsp/
215
+ __marimo__/
216
+
217
+ # Streamlit
218
+ .streamlit/secrets.toml
219
+
220
+ # === promptex init 產生的忽略規則(重跑以本行判定,勿改寫)===
221
+ # 框架的建置快取。整個 .promptex/ 不忽略:查詢進入點的覆寫檔 .promptex/query
222
+ # 是作者手寫的內容,要入版控;匯出的 .promptex/preview/ 入不入版控由你決定。
223
+ .promptex/cache/
224
+ # 框架每次建置重寫的中繼(結構與內容本體),可重建、不入版控。逐檔明列而非
225
+ # 用 .promptex/*/ 這類萬用:同一層還住著所有權登記 {平台}.json,那是要入版控的。
226
+ .promptex/*/graph.json
227
+ .promptex/*/content.json
228
+ .promptex/*/content-index.json
229
+ # 虛擬環境與直譯器的位元碼快取。
230
+ .venv/
231
+ __pycache__/
@@ -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,58 @@
1
+ Metadata-Version: 2.5
2
+ Name: ex-minimal-plugin-py
3
+ Version: 0.0.1a1
4
+ Summary: promptex plugin 擴展範例(alpha):在改寫遍為 skill 與 rule 追加一行
5
+ Project-URL: Homepage, https://github.com/promptex-ai/ex-minimal-project-py
6
+ Project-URL: Repository, https://github.com/promptex-ai/ex-minimal-project-py
7
+ Project-URL: Issues, https://github.com/promptex-ai/ex-minimal-project-py/issues
8
+ Author: promptex-ai
9
+ License: Apache-2.0
10
+ License-File: LICENSE
11
+ Keywords: agent,ai,codegen,llm,prompt,promptex,promptex-plugin
12
+ Classifier: Development Status :: 3 - Alpha
13
+ Classifier: Intended Audience :: Developers
14
+ Classifier: License :: OSI Approved :: Apache Software License
15
+ Classifier: Programming Language :: Python :: 3
16
+ Classifier: Programming Language :: Python :: 3.10
17
+ Classifier: Programming Language :: Python :: 3.11
18
+ Classifier: Programming Language :: Python :: 3.12
19
+ Classifier: Programming Language :: Python :: 3.13
20
+ Classifier: Topic :: Software Development :: Build Tools
21
+ Classifier: Topic :: Software Development :: Code Generators
22
+ Requires-Python: >=3.10
23
+ Requires-Dist: promptex-py~=0.0.0
24
+ Description-Content-Type: text/markdown
25
+
26
+ # ex-minimal-plugin-py
27
+
28
+ [ex-minimal-project-py](../../) 的 plugin 擴展。由專案以路徑來源(`[tool.uv.sources]` 的 editable path)掛上:Python 的 import 走發布名對應的 import 套件名,帶連字號的目錄無法直接 import;同時保持可發布形態——中繼欄位、參數宣告與授權都隨套件出貨,版號比照 promptex 的 alpha 原型套件。
29
+
30
+ plugin 掛在求值管線的三個生命週期上,順序固定:
31
+
32
+ 1. `prepare`——唯一 async 的階段,跑在收集遍之前。真實 plugin 在這裡請求外部資源,或以 `ctx.cacheDir` 快取、`ctx.writeLock` 記錄鎖定,再經閉包把資料交給後續階段。
33
+ 2. `transform`——改寫遍。改寫既有節點一律經 ctx 操作函式(`appendContent`/`patchConfig`),型別安全、變更可追蹤、衝突可偵測;也可在此以 `define*` 新增節點。
34
+ 3. `validate`——解析遍,核心檢查在先。對註冊表做結構驗證並回傳診斷,空清單即通過。
35
+
36
+ plugin 產出的是節點而非檔案:要落地的內容以 `define*` 新增資源節點,由核心落地為產物。
37
+
38
+ ## 在本專案的接法
39
+
40
+ `promptex.config.py` 以 `plugins=[create_plugin()]` 掛上。跑 `uv run promptex install .` 後,兩個平台的 `example-rule` 產物末尾都會多出本 plugin 在 `transform` 追加的那一行——那是它有生效的可見證據。
41
+
42
+ ## 參數宣告
43
+
44
+ 參數宣告(標準 JSON Schema)住import 套件目錄裡的 `promptex.config.schema.json`,由 `__init__.py` 自己讀進來,隨中介表示交給讀取端;`promptex config declare ex-minimal-plugin-py` 讀的是同一份檔案。
45
+
46
+ ## 發布
47
+
48
+ ```bash
49
+ uv build
50
+ uvx twine check dist/*
51
+ uvx twine upload dist/*
52
+ ```
53
+
54
+ 版號寫 PEP 440 的 `0.0.1a1`,與另兩個生態的 `0.0.1-alpha.1` 指同一個版本——三生態版號無法逐字相同,這是預發布版號的既有限制。安裝端要 `pip install --pre ex-minimal-plugin-py`:預發布版號不會被 pip 預設選中。
55
+
56
+ SDK 依賴不必換:`dependencies` 的 `promptex-py~=0.0.0` 在 registry 上對到的是 promptex-prototype 發的 `0.0.0` **介面樁**——型別與簽名逐字複製正式版、方法本體一律拋錯。發布驗證(尤其 `cargo publish` 的建置)拿它編得過;裝到消費端也裝得起來,但實際執行要靠工作區覆寫指向本地的正式版 SDK,否則第一個碰到樁的呼叫就會以「promptex 介面樁」開頭的錯誤中止。
57
+
58
+ 名稱刻意不帶 `promptex-plugin-` 前綴——那是給要被消費端搜尋到的套件用的;本擴展的定位是示範,改以 keywords 的 `promptex-plugin` 承載可搜尋性。
@@ -0,0 +1,33 @@
1
+ # ex-minimal-plugin-py
2
+
3
+ [ex-minimal-project-py](../../) 的 plugin 擴展。由專案以路徑來源(`[tool.uv.sources]` 的 editable path)掛上:Python 的 import 走發布名對應的 import 套件名,帶連字號的目錄無法直接 import;同時保持可發布形態——中繼欄位、參數宣告與授權都隨套件出貨,版號比照 promptex 的 alpha 原型套件。
4
+
5
+ plugin 掛在求值管線的三個生命週期上,順序固定:
6
+
7
+ 1. `prepare`——唯一 async 的階段,跑在收集遍之前。真實 plugin 在這裡請求外部資源,或以 `ctx.cacheDir` 快取、`ctx.writeLock` 記錄鎖定,再經閉包把資料交給後續階段。
8
+ 2. `transform`——改寫遍。改寫既有節點一律經 ctx 操作函式(`appendContent`/`patchConfig`),型別安全、變更可追蹤、衝突可偵測;也可在此以 `define*` 新增節點。
9
+ 3. `validate`——解析遍,核心檢查在先。對註冊表做結構驗證並回傳診斷,空清單即通過。
10
+
11
+ plugin 產出的是節點而非檔案:要落地的內容以 `define*` 新增資源節點,由核心落地為產物。
12
+
13
+ ## 在本專案的接法
14
+
15
+ `promptex.config.py` 以 `plugins=[create_plugin()]` 掛上。跑 `uv run promptex install .` 後,兩個平台的 `example-rule` 產物末尾都會多出本 plugin 在 `transform` 追加的那一行——那是它有生效的可見證據。
16
+
17
+ ## 參數宣告
18
+
19
+ 參數宣告(標準 JSON Schema)住import 套件目錄裡的 `promptex.config.schema.json`,由 `__init__.py` 自己讀進來,隨中介表示交給讀取端;`promptex config declare ex-minimal-plugin-py` 讀的是同一份檔案。
20
+
21
+ ## 發布
22
+
23
+ ```bash
24
+ uv build
25
+ uvx twine check dist/*
26
+ uvx twine upload dist/*
27
+ ```
28
+
29
+ 版號寫 PEP 440 的 `0.0.1a1`,與另兩個生態的 `0.0.1-alpha.1` 指同一個版本——三生態版號無法逐字相同,這是預發布版號的既有限制。安裝端要 `pip install --pre ex-minimal-plugin-py`:預發布版號不會被 pip 預設選中。
30
+
31
+ SDK 依賴不必換:`dependencies` 的 `promptex-py~=0.0.0` 在 registry 上對到的是 promptex-prototype 發的 `0.0.0` **介面樁**——型別與簽名逐字複製正式版、方法本體一律拋錯。發布驗證(尤其 `cargo publish` 的建置)拿它編得過;裝到消費端也裝得起來,但實際執行要靠工作區覆寫指向本地的正式版 SDK,否則第一個碰到樁的呼叫就會以「promptex 介面樁」開頭的錯誤中止。
32
+
33
+ 名稱刻意不帶 `promptex-plugin-` 前綴——那是給要被消費端搜尋到的套件用的;本擴展的定位是示範,改以 keywords 的 `promptex-plugin` 承載可搜尋性。
@@ -0,0 +1,43 @@
1
+ [project]
2
+ name = "ex-minimal-plugin-py"
3
+ # PEP 440 的正規化形態:npm 與 crates.io 側的同一份擴展寫的是 semver 的
4
+ # `0.0.1-alpha.1`,PyPI 會把它正規化成 `0.0.1a1`,兩者指同一個版本。三生態
5
+ # 版號無法逐字相同,這是預發布版號的既有限制。
6
+ version = "0.0.1a1"
7
+ description = "promptex plugin 擴展範例(alpha):在改寫遍為 skill 與 rule 追加一行"
8
+ requires-python = ">=3.10"
9
+ license = { text = "Apache-2.0" }
10
+ readme = "README.md"
11
+ authors = [{ name = "promptex-ai" }]
12
+ keywords = ["promptex", "promptex-plugin", "prompt", "ai", "llm", "agent", "codegen"]
13
+ classifiers = [
14
+ "Development Status :: 3 - Alpha",
15
+ "Intended Audience :: Developers",
16
+ "License :: OSI Approved :: Apache Software License",
17
+ "Programming Language :: Python :: 3",
18
+ "Programming Language :: Python :: 3.10",
19
+ "Programming Language :: Python :: 3.11",
20
+ "Programming Language :: Python :: 3.12",
21
+ "Programming Language :: Python :: 3.13",
22
+ "Topic :: Software Development :: Build Tools",
23
+ "Topic :: Software Development :: Code Generators",
24
+ ]
25
+ dependencies = ["promptex-py~=0.0.0"]
26
+
27
+ [project.urls]
28
+ Homepage = "https://github.com/promptex-ai/ex-minimal-project-py"
29
+ Repository = "https://github.com/promptex-ai/ex-minimal-project-py"
30
+ Issues = "https://github.com/promptex-ai/ex-minimal-project-py/issues"
31
+
32
+ [build-system]
33
+ requires = ["hatchling>=1.25"]
34
+ build-backend = "hatchling.build"
35
+
36
+ [tool.hatch.build.targets.wheel]
37
+ packages = ["src/ex_minimal_plugin_py"]
38
+
39
+ [tool.hatch.build]
40
+ # 開發樹本身就是 python-source,直譯器跑過留下的 __pycache__ 會被收進 wheel。
41
+ # 那些 .pyc 綁死在建置機的 Python 版本上,對安裝端無用,卻讓 wheel 的內容
42
+ # 清單隨「誰在哪台機器上建的」而變。
43
+ exclude = ["**/__pycache__/**"]
@@ -0,0 +1,63 @@
1
+ """最小可發布 plugin:三個生命週期各示範一件事,發布前把內容換成你的邏輯。
2
+
3
+ 生命週期固定順序:prepare(唯一 async 的階段,收集遍之前)→ 源碼求值 →
4
+ transform(改寫遍)→ validate(解析遍,核心檢查在先)。plugin 產出的是
5
+ 「節點」而非檔案:要落地的內容以 define_* 新增資源節點,由核心落地為產物。
6
+ """
7
+
8
+ from __future__ import annotations
9
+
10
+ import json
11
+ from pathlib import Path
12
+ from typing import Optional
13
+
14
+ from promptex import Diagnostic, Plugin
15
+
16
+ # 參數宣告(標準 JSON Schema):由本套件自己讀進來、隨中介表示交給讀取端;
17
+ # `promptex config declare` 讀的是套件目錄裡的同一份檔案。
18
+ _SCHEMA = json.loads((Path(__file__).parent / "promptex.config.schema.json").read_text(encoding="utf-8"))
19
+
20
+ _DEFAULT_BANNER = "(本節點由 ex-minimal-plugin-py plugin 追加此行)"
21
+
22
+
23
+ def create_plugin(banner: Optional[str] = None) -> Plugin:
24
+ # prepare 取得的資料存進閉包,transform 只讀閉包、不知道資料從何而來。
25
+ resolved: list[str] = []
26
+
27
+ async def _prepare(ctx) -> None:
28
+ # 準備:唯一 async 的生命週期。真實 plugin 在這裡請求外部資源,或以
29
+ # ctx.cache_dir 快取、ctx.write_lock 記錄鎖定;本範例只把參數收斂成
30
+ # transform 要用的值。
31
+ resolved[:] = [banner or _DEFAULT_BANNER]
32
+
33
+ def _transform(ctx) -> None:
34
+ # 改寫:改寫既有節點一律經 ctx 操作函式(append_content/patch_config),
35
+ # 變更可追蹤、衝突可偵測;也可在此以 define_* 新增節點。
36
+ for entry in ctx.entries:
37
+ if entry.kind in ("skill", "rule"):
38
+ ctx.append_content(entry, resolved[0])
39
+
40
+ def _validate(ctx) -> list[Diagnostic]:
41
+ # 驗證:對註冊表做結構驗證,回傳診斷(空清單即通過)。
42
+ return [
43
+ Diagnostic(
44
+ code="ex-minimal-plugin-py-reserved-id",
45
+ message=f"節點 {entry.id} 以保留前綴 promptex- 命名,請改用其他 id",
46
+ at=[entry.at],
47
+ severity="error",
48
+ )
49
+ for entry in ctx.entries
50
+ if entry.id.startswith("promptex-")
51
+ ]
52
+
53
+ return Plugin(
54
+ name="ex-minimal-plugin-py",
55
+ # 宣告本擴充作用在哪幾種節點類型(供文件與讀取端),不隱含過濾。
56
+ kinds=["skill", "rule"],
57
+ # 相容的框架版本範圍:安裝的 promptex-py 落在範圍外時於編譯開始前報錯。
58
+ version="^0.0.0",
59
+ config_schema=_SCHEMA,
60
+ prepare=_prepare,
61
+ validate=_validate,
62
+ transform=_transform,
63
+ )
@@ -0,0 +1,12 @@
1
+ {
2
+ "$schema": "https://json-schema.org/draft/2020-12/schema",
3
+ "title": "ex-minimal-plugin-py options",
4
+ "type": "object",
5
+ "properties": {
6
+ "banner": {
7
+ "type": "string",
8
+ "description": "Appended to every skill and rule at the transform stage. Defaults to a built-in notice."
9
+ }
10
+ },
11
+ "additionalProperties": false
12
+ }