ls-algorithm-plugin-sdk 0.3.0__py3-none-any.whl → 0.3.1__py3-none-any.whl

algorithm_plugin_sdk/cli_impl/configure.py

@@ -1,11 +1,14 @@
 from __future__ import annotations
 
 import argparse
+import ipaddress
 import os
 import re
+import socket
 import subprocess
 import sys
 from pathlib import Path
+from urllib.parse import urlparse
 
 from ..deployment import (
     DEFAULT_CONFIG_NAME,
@@ -17,6 +20,11 @@ from .parsing import environment, gpu_ids
 
 
 SYSTEMD_UNIT_DIR = Path("/etc/systemd/system")
+INPUT_ROOT = Path("/mnt/ldp_uploads/ldp-uploads")
+PRIVATE_IPV4_NETWORKS = tuple(
+    ipaddress.ip_network(network)
+    for network in ("10.0.0.0/8", "172.16.0.0/12", "192.168.0.0/16")
+)
 
 SERVICE_NAME_PATTERN = re.compile(
     r"^[A-Za-z0-9][A-Za-z0-9_.@-]*$"
@@ -65,18 +73,6 @@ def configure_parser(parser: argparse.ArgumentParser) -> None:
         "--api-key",
         default=os.getenv("LDP_INTERNAL_API_KEY"),
     )
-    parser.add_argument(
-        "--public-url",
-        default=os.getenv("LDP_PLUGIN_PUBLIC_URL"),
-    )
-    parser.add_argument(
-        "--input-root",
-        default=os.getenv("LDP_JOB_INPUT_ROOT"),
-    )
-    parser.add_argument(
-        "--workspace-root",
-        default=os.getenv("LDP_JOB_WORKSPACE_ROOT"),
-    )
     parser.add_argument(
         "--instance-key",
         default=os.getenv("LDP_PLUGIN_INSTANCE_KEY"),
@@ -85,14 +81,6 @@ def configure_parser(parser: argparse.ArgumentParser) -> None:
         "--cluster",
         default=os.getenv("LDP_CLUSTER"),
     )
-    parser.add_argument(
-        "--namespace",
-        default=os.getenv("POD_NAMESPACE"),
-    )
-    parser.add_argument(
-        "--node-name",
-        default=os.getenv("NODE_NAME"),
-    )
     parser.add_argument(
         "--local",
         action="store_true",
@@ -105,10 +93,6 @@ def configure_parser(parser: argparse.ArgumentParser) -> None:
         default=[],
         metavar="NAME=VALUE",
     )
-    parser.add_argument(
-        "--service-name",
-        help="systemd unit name without .service; defaults to repository name",
-    )
     parser.add_argument(
         "--force",
         action="store_true",
@@ -119,33 +103,35 @@ def configure_parser(parser: argparse.ArgumentParser) -> None:
 
 def resolve_service_name(
     repository: Path,
-    requested: str | None,
 ) -> str:
-    name = requested or repository.name
+    name = repository.name
     if name.endswith(".service"):
         raise ValueError(
-            "service name must not include the .service suffix"
+            "repository name must not include the .service suffix"
         )
     if not SERVICE_NAME_PATTERN.fullmatch(name):
         raise ValueError(
-            "service name may contain only letters, numbers, "
+            "repository name may contain only letters, numbers, "
             "underscore, dot, @, and hyphen"
         )
     return name
 
 
-def _quote_systemd_path(value: Path) -> str:
+def _escape_systemd_path(value: Path) -> str:
     text = str(value)
     if "\n" in text or "\r" in text or "\0" in text:
         raise ValueError(
             f"systemd path contains control characters: {value}"
         )
-    escaped = (
+    return (
         text.replace("\\", "\\\\")
         .replace('"', '\\"')
         .replace("%", "%%")
     )
-    return f'"{escaped}"'
+
+
+def _quote_systemd_path(value: Path) -> str:
+    return f'"{_escape_systemd_path(value)}"'
 
 
 def render_systemd_unit(
@@ -167,7 +153,7 @@ def render_systemd_unit(
             "[Service]",
             "Type=simple",
             "User=root",
-            f"WorkingDirectory={_quote_systemd_path(root)}",
+            f"WorkingDirectory={_escape_systemd_path(root)}",
             (
                 f"ExecStart={_quote_systemd_path(launcher)} "
                 f"serve --config {_quote_systemd_path(config)}"
@@ -317,6 +303,35 @@ def resolve_config_path(
     return path.resolve()
 
 
+def resolve_private_ipv4(compute_url: str) -> str:
+    parsed = urlparse(compute_url)
+    if parsed.scheme not in {"http", "https"} or not parsed.hostname:
+        raise ValueError("compute URL must be an http or https URL")
+    try:
+        port = parsed.port or (443 if parsed.scheme == "https" else 80)
+    except ValueError as exc:
+        raise ValueError("compute URL has an invalid port") from exc
+
+    try:
+        with socket.socket(socket.AF_INET, socket.SOCK_DGRAM) as probe:
+            probe.connect((parsed.hostname, port))
+            value = probe.getsockname()[0]
+    except OSError as exc:
+        raise RuntimeError(
+            f"cannot resolve the local IP used to reach {parsed.hostname}: {exc}"
+        ) from exc
+
+    address = ipaddress.ip_address(value)
+    if not isinstance(address, ipaddress.IPv4Address) or not any(
+        address in network for network in PRIVATE_IPV4_NETWORKS
+    ):
+        raise RuntimeError(
+            f"the local IP used to reach {parsed.hostname} is not a private IPv4: "
+            f"{address}"
+        )
+    return str(address)
+
+
 def registration_from_args(
     args: argparse.Namespace,
     repository: Path,
@@ -327,12 +342,9 @@ def registration_from_args(
     supplied = {
         "computeUrl": args.compute_url,
         "apiKey": args.api_key,
-        "publicUrl": args.public_url,
-        "inputRoot": args.input_root,
-        "workspaceRoot": args.workspace_root,
+        "inputRoot": str(INPUT_ROOT),
+        "workspaceRoot": str(repository.resolve()),
         "cluster": args.cluster,
-        "namespace": args.namespace,
-        "nodeName": args.node_name,
     }
     missing = [
         name
@@ -350,6 +362,9 @@ def registration_from_args(
         name: str(value)
         for name, value in supplied.items()
     }
+    private_ipv4 = resolve_private_ipv4(registration["computeUrl"])
+    registration["publicUrl"] = f"http://{private_ipv4}:{args.port}"
+    registration["nodeName"] = private_ipv4
     registration["instanceKey"] = stable_instance_key(
         repository / ".algorithm-plugin" / "instance-key",
         requested=args.instance_key,
@@ -383,10 +398,7 @@ def execute(args: argparse.Namespace) -> int:
     require_root()
     repository = validate_repository(args.repository)
     validate_configure_runtime(repository)
-    service_name = resolve_service_name(
-        repository,
-        args.service_name,
-    )
+    service_name = resolve_service_name(repository)
     config_path = resolve_config_path(
         repository,
         args.config_output,
@@ -418,4 +430,5 @@ def execute(args: argparse.Namespace) -> int:
     print("  sudo systemctl daemon-reload")
     print(f"  sudo systemctl enable {service_name}.service")
     print(f"  sudo systemctl restart {service_name}.service")
-    return 0
+    print(f"  sudo systemctl status {service_name}.service --no-pager")
+    return 0

algorithm_plugin_sdk/deployment.py

@@ -154,6 +154,8 @@ class DeploymentConfig:
             instance,
             repository=repository,
         )
+        if registration is not None:
+            registration = {**registration, "namespace": release.name}
         release_path = release.save(
             repository / "release-manifest.json"
         )

{ls_algorithm_plugin_sdk-0.3.0.dist-info → ls_algorithm_plugin_sdk-0.3.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ls-algorithm-plugin-sdk
-Version: 0.3.0
+Version: 0.3.1
 Summary: Protocol-independent runtime SDK for dataset algorithms
 Author: Ling Robotics
 License: Proprietary
@@ -15,10 +15,6 @@ Requires-Dist: build>=1.2; extra == "dev"
 
 # Algorithm Plugin SDK
 
-算法仓库只实现一个 `Algorithm` 类并声明 entry point。SDK 统一提供单次运行、
-WebUI、HTTP service、release manifest、compute 注册和心跳。算法仓库不需要
-Dockerfile 或 Web 框架代码。
-
 ## 算法侧最小接口
 
 ```python
@@ -30,8 +26,7 @@ class MyAlgorithm(Algorithm):
     def execute(self, request, context): ...
 ```
 
-算法包需要声明 `algorithm_plugin_sdk.algorithms` entry point。同一个 `execute()`
-会被所有运行方式复用。
+算法包需要声明 `algorithm_plugin_sdk.algorithms` entry point。
 
 ## 单次运行
 
@@ -49,10 +44,9 @@ algorithm-plugin run camera-space-mano \
 
 目标算法仓库必须满足：
 
-- 仓库本身是 Git 工作树根目录，并且至少有一个 commit。
+- 仓库本身是 Git 工作树根目录。
 - 仓库包含自己的 `.venv`。
 - `<repository>/.venv/bin/algorithm-plugin` 存在且可执行。
-- 该启动器的 `run --help` 和 `serve --help` 均可正常加载。
 
 建议将生成的 `release-manifest.json` 和 `algorithm-plugin.json` 加入算法仓库的
 `.gitignore`，不要手动编辑或提交它们。
@@ -64,16 +58,11 @@ sudo /srv/camera-space-mano/.venv/bin/algorithm-plugin configure \
   --repository /srv/camera-space-mano \
   --compute-url http://compute:5180 \
   --api-key "$LDP_INTERNAL_API_KEY" \
-  --public-url http://10.0.0.4:9000 \
-  --input-root /data/jobs/input \
-  --workspace-root /data/jobs/workspace \
+  --port 9030 \
   --cluster production \
-  --namespace camera-space-mano \
-  --node-name 10.0.0.4 \
   --gpu-ids 0,1
 ```
 
-service name 默认使用仓库目录名，也可以通过 `--service-name` 指定。
 重复执行 configure 需要显式提供 `--force`。
 
 确认输出后执行：
@@ -82,7 +71,7 @@ service name 默认使用仓库目录名，也可以通过 `--service-name` 指
 sudo systemctl daemon-reload
 sudo systemctl enable camera-space-mano.service
 sudo systemctl restart camera-space-mano.service
-sudo systemctl status camera-space-mano.service
+sudo systemctl status camera-space-mano.service --no-pager
 ```
 
 ## serve
@@ -95,6 +84,6 @@ sudo systemctl status camera-space-mano.service
 ## 安装与测试
 
 ```bash
-python -m pip install '.[service]'
+python -m pip install .
 python -m unittest discover -s tests -v
 ```

{ls_algorithm_plugin_sdk-0.3.0.dist-info → ls_algorithm_plugin_sdk-0.3.1.dist-info}/RECORD

@@ -2,7 +2,7 @@ algorithm_plugin_sdk/__init__.py,sha256=OKj2VcNXTwZmRgPlECI6QUBlxW1YLtflr4RAgs6w
 algorithm_plugin_sdk/algorithm.py,sha256=INjX-ygMQfHk8D1AZbEEdCw1P4VNQLGF989lP1J1H1k,1025
 algorithm_plugin_sdk/cli.py,sha256=V9HFJ98iyhM1q6PZqd-366g1AoKuieC_Fn4u9RJcMNI,1252
 algorithm_plugin_sdk/context.py,sha256=Kj-eDZg7PgX6xNzrWrQs37UfepTP8fXv4_8hCgsAIDA,11016
-algorithm_plugin_sdk/deployment.py,sha256=hFX6kJXia2gF2mOCDJlgWK-BAUT6tAvr2t70u32mg1A,13823
+algorithm_plugin_sdk/deployment.py,sha256=yv6UCMtbX1pglfq7H7N2xI4_-bM-YLSPXFST5m_pW-g,13931
 algorithm_plugin_sdk/errors.py,sha256=DNmI2c36Pd7K6tTaonqfEgpBzwX0o6pXzYrc8r2Z--k,730
 algorithm_plugin_sdk/loader.py,sha256=XKmyqbJMoUMdKoo2eRQFGdbsmlz6NBgtUeIdqzumJFs,2561
 algorithm_plugin_sdk/models.py,sha256=FIwUm8QDK8L37pV7AcCMnmYlDP-2l93zp8yc0KSu4yo,12196
@@ -12,7 +12,7 @@ algorithm_plugin_sdk/runner.py,sha256=583Y9_7efvW5rrmM2nt316NEpCRO6kd8dKYjFRjgtC
 algorithm_plugin_sdk/service.py,sha256=Xj99UiCZtqtu7U4IVghAr4Mu3I9nR1AvP6vNzdD4sAk,24002
 algorithm_plugin_sdk/webui_app.py,sha256=Gvt2FPt0xZBjYi39sqTQqcosllifYeJam49_mGfkEVw,1530
 algorithm_plugin_sdk/cli_impl/__init__.py,sha256=uLknQVGipNd7eSJegDHZS0NVowMa0qAaOf63wFI3zHM,78
-algorithm_plugin_sdk/cli_impl/configure.py,sha256=acCGDJ6Khn3G8hay8ISsYVlKDmhDH1i-UpNZU5bb0fU,11668
+algorithm_plugin_sdk/cli_impl/configure.py,sha256=fr_xDLh82YKV8Csuxi5M2z4dPpXWv9j7SZUHa1n14dA,12496
 algorithm_plugin_sdk/cli_impl/parsing.py,sha256=TDX45Spu4WMrczuzTMN9ZC2SYyHE11OPBCvN45yPsxs,1399
 algorithm_plugin_sdk/cli_impl/run.py,sha256=EnqqCdGWYK-iB5s1DMlGRXNpnCWA25xoAex0f4l36Ic,5893
 algorithm_plugin_sdk/cli_impl/serve.py,sha256=9_nJcdzerwqczGm7xTIcMYKShpmoltYD6r_nBQjAlWU,4324
@@ -23,8 +23,8 @@ algorithm_plugin_sdk/webui/__init__.py,sha256=cvtaktJXz_DYG4QbV5ppoqY2bFaMLuiUcT
 algorithm_plugin_sdk/webui/app.css,sha256=5HGDKlbUFLZMgCknlRuwCjiNcCr8poIF5YGHchyaamE,2965
 algorithm_plugin_sdk/webui/app.js,sha256=0YsXsocEY3yDseG3jh0RhzI8xo_bYmsbSxdN3FdCswQ,7657
 algorithm_plugin_sdk/webui/index.html,sha256=Z222OuaacWdbr0s-sjJq6wmg45u96tIneM5-LP55Z8I,2261
-ls_algorithm_plugin_sdk-0.3.0.dist-info/METADATA,sha256=YewSjuTdWCstRq4c6h4-fy-7pSbs31JRoui_J5GhV7M,2943
-ls_algorithm_plugin_sdk-0.3.0.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
-ls_algorithm_plugin_sdk-0.3.0.dist-info/entry_points.txt,sha256=TU0R_TxuB5OuOiZ5BHOEmUPtHvN3v8ARUW8d3PztHcE,67
-ls_algorithm_plugin_sdk-0.3.0.dist-info/top_level.txt,sha256=8lsgxZ8HJGLlzJ5Rt8CiVzw9Ccme286i3akbmeMjBos,21
-ls_algorithm_plugin_sdk-0.3.0.dist-info/RECORD,,
+ls_algorithm_plugin_sdk-0.3.1.dist-info/METADATA,sha256=m3-0HP49-i6sFKAgZjcsWLMGdUdVL-jLUag4siJ9i3Q,2317
+ls_algorithm_plugin_sdk-0.3.1.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+ls_algorithm_plugin_sdk-0.3.1.dist-info/entry_points.txt,sha256=TU0R_TxuB5OuOiZ5BHOEmUPtHvN3v8ARUW8d3PztHcE,67
+ls_algorithm_plugin_sdk-0.3.1.dist-info/top_level.txt,sha256=8lsgxZ8HJGLlzJ5Rt8CiVzw9Ccme286i3akbmeMjBos,21
+ls_algorithm_plugin_sdk-0.3.1.dist-info/RECORD,,