licos-platform-cli 0.4.6__tar.gz → 0.4.8__tar.gz

{licos_platform_cli-0.4.6 → licos_platform_cli-0.4.8}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: licos-platform-cli
-Version: 0.4.6
+Version: 0.4.8
 Summary: LICOS platform CLI
 Requires-Python: >=3.10
-Requires-Dist: licos-platform-sdk>=0.5.4
+Requires-Dist: licos-platform-sdk>=0.5.5

{licos_platform_cli-0.4.6 → licos_platform_cli-0.4.8}/pyproject.toml

@@ -4,11 +4,11 @@ build-backend = "hatchling.build"
 
 [project]
 name = "licos-platform-cli"
-version = "0.4.6"
+version = "0.4.8"
 description = "LICOS platform CLI"
 requires-python = ">=3.10"
 dependencies = [
-    "licos-platform-sdk>=0.5.4",
+    "licos-platform-sdk>=0.5.5",
 ]
 
 [project.scripts]

{licos_platform_cli-0.4.6 → licos_platform_cli-0.4.8}/src/licos_platform_cli/help_commands.py

@@ -817,10 +817,23 @@ ONTOLOGY_HELP = {
         "Resolve elements by stable IDs before querying context, model checks, or mapped data.",
         "READ tools query state, PREPARE tools validate a change draft, and PERSIST tools apply an explicitly confirmed draft.",
         "PERSIST commands require --confirm. Never reuse a catalog result after its catalogVersion changes.",
+        "实时订阅由项目后端 SDK 完成，CLI 不提供常驻 WebSocket 命令；不得读取 Token 或自行拼上游连接。",
     ],
+    "realtimeSdk": {
+        "node": "const subscription = await ontology.subscribeRealtime({ elementIds, attributeIds });\ntry { for await (const event of subscription) { sendBusinessEvent(event); } }\nfinally { await subscription.close(); }",
+        "python": "with ontology.subscribe_realtime(element_ids, attribute_ids=attribute_ids) as subscription:\n    for event in subscription:\n        send_business_event(event)",
+        "minimum_versions": {"node": "0.10.5", "python": "0.5.5"},
+        "parameters": {
+            "elementIds / element_ids": "必填，非空字符串 ID 数组；已解析且授权的元素，不递归子元素。",
+            "attributeIds / attribute_ids": "可选，字符串 ID 数组；省略或空数组表示所选元素的全部授权属性。",
+        },
+        "returns": "收到订阅确认后返回订阅对象；单消费者迭代 property.changed 原始业务事件，close 取消订阅。Node 使用异步迭代，Python 使用同步 with/for，异步服务放入工作线程。",
+        "errors": "创建错误直接抛出，后续错误从迭代器抛出；401 仅刷新一次，403/协议错误不重试，网络重连累计默认 3 次。不得把获取连接计划当成订阅成功。",
+        "reference": "industrial-ontology/references/realtime-sdk.md",
+    },
     "sdk": {
-        "python": "from licos_platform_sdk import ontology\ncatalog = ontology.search_tools('查询设备实时数据')\nselected = catalog['items'][0]\n# 按 selected['definition']['function']['parameters'] 构造 arguments 后调用 selected 中的精确函数名。",
-        "node": "import { ontology } from '@kmlckj/licos-platform-sdk';\nconst catalog = await ontology.searchTools('查询设备实时数据');\nconst selected = catalog.items[0];\n// 按 selected.definition.function.parameters 构造 arguments 后调用 selected 中的精确函数名。",
+        "python": "from licos_platform_sdk import ontology\ncatalog = ontology.search_tools('查询设备实时数据')\nselected = next((item for item in catalog['items'] if item['selection'] == 'MATCH' and item['mode'] == 'READ' and item['definition']['function']['name'] == requested_tool_name), None)\nif selected is None:\n    raise RuntimeError('当前目录中没有匹配的只读本体工具')\n# 按 selected['definition']['function']['parameters'] 校验参数后调用精确函数名。",
+        "node": "import { ontology } from '@kmlckj/licos-platform-sdk';\nconst catalog = await ontology.searchTools('查询设备实时数据');\nconst selected = catalog.items.find((item) => item.selection === 'MATCH' && item.mode === 'READ' && item.definition.function.name === requestedToolName);\nif (!selected) throw new Error('当前目录中没有匹配的只读本体工具');\n// 按 selected.definition.function.parameters 校验参数后调用精确函数名。",
     },
     "commands": {
         "search": {
@@ -851,7 +864,7 @@ HELP_TOPICS = {
     "database": DATABASE_HELP,
     "knowledge": KNOWLEDGE_HELP,
     "oauth": OAUTH_HELP,
-    "project-config": PROJECT_CONFIG_HELP,
+    "project-config": PROJECT_CONFIG_HELP,
     "ontology": ONTOLOGY_HELP,
 }
 

{licos_platform_cli-0.4.6 → licos_platform_cli-0.4.8}/tests/test_cli.py

@@ -109,6 +109,14 @@ class PlatformCliTests(unittest.TestCase):
         self.assertEqual(payload["topic"], "ontology")
         self.assertEqual(set(payload["commands"]), {"search", "invoke"})
         self.assertTrue(any("catalogVersion" in rule for rule in payload["rules"]))
+        sdk_help = "\n".join(payload["sdk"].values())
+        self.assertNotIn("items[0]", sdk_help)
+        self.assertNotIn("items'][0]", sdk_help)
+        self.assertIn("selection", sdk_help)
+        self.assertIn("mode", sdk_help)
+        self.assertIn("subscribeRealtime", payload["realtimeSdk"]["node"])
+        self.assertIn("subscribe_realtime", payload["realtimeSdk"]["python"])
+        self.assertEqual(payload["realtimeSdk"]["minimum_versions"], {"node": "0.10.5", "python": "0.5.5"})
 
     def test_ontology_search_forwards_catalog_pagination(self) -> None:
         result = {"catalogVersion": "v1", "items": []}