simplecadapi 2.2.1__tar.gz → 2.2.2__tar.gz

{simplecadapi-2.2.1 → simplecadapi-2.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: simplecadapi
-Version: 2.2.1
+Version: 2.2.2
 Summary: A simplified OCP-native CAD modeling Python API
 Project-URL: Homepage, https://github.com/PhySpace/SimpleCADAPI
 Project-URL: Repository, https://github.com/PhySpace/SimpleCADAPI
@@ -412,37 +412,24 @@ the full crank cycle sweeps clean in the same sim ·
 
 ---
 
-## Update Notes (2.2.1)
+## Update Notes (2.2.2)
 
 > Validate generated definitions, assembly constraints, and manufacturing
 > geometry before production use.
 
-- **New editor.** `sca edit` is part of the SDK now (`pip install
-  "simplecadapi[editor]"`). It runs a workspace's notebooks in a marimo kernel
-  with the SDK's own cell executor, previews the live model straight from the
-  solids, writes your viewport picks as selection code, and lets an agent see
-  what you see (`sca snapshot`). **Re-Studio is removed**: the reverse-
-  engineering studio (the `Re-mode` workspace of the standalone sca-web-editor)
-  is gone, and the standalone sca-web-editor is replaced by `sca edit`. STEP
-  reconstruction continues through the inspection API and the skill's
-  step-reconstruction workflow.
-- **One runtime, one cache.** The editor, `sca run` and
-  `simplecadapi.runtime.run_notebook()` share the per-cell cache, so what one
-  computed the others restore. Notebook parameters come from `# ---- params
-  ----` cells with an optional `# ui:` comment; local modules (shared
-  dimensions) get their own view in the editor.
-- **Landing path.** `docs/landing.md` is the script an agent follows to install
-  the SDK and its skill and open an example; `sca example u_link` copies the
-  bundled workspace and `sca skill where` shows where the skill goes.
-- Earlier: 2.1.3b1 shipped the addon ecosystem (`sca addon ...`, the
-  `sca-addon.toml` descriptor, the `.scadpkg` format spec); see its
-  [update notes](docs/updates/2.1.3b1.md).
-
-Every example model is a notebook; its export scripts load the product with
-`run_notebook`, capture one `.scadpkg`, and translate AP242 `.step` and
-editable `.FCStd` from that same package. The AP242/Gmsh example under
-`examples/ap242_gmsh_volume_mesh/` exposes each export and FEM stage as a
-separate directly runnable script.
+- **Code completion from the SDK.** In the editor, `scad.` (and `scad.ql.`,
+  `scad.std.gear.`) lists the real functions with their signatures and
+  docstrings. Accepting one, or typing `(` after its name, writes the call with
+  every required parameter as `name=`, and Tab moves between them; inside a call
+  the parameters not given yet complete as `name=`.
+- **New notebooks from the workspace tab.** A **new** action starts a part, or
+  an assembly that uses the first two parts, from the SDK's template; an empty
+  workspace opens on that form.
+- **Fix.** The cell editors no longer rebuild their configuration on every
+  render, which dropped a snippet in progress.
+
+Full notes for this version: [`docs/updates/2.2.2.md`](docs/updates/2.2.2.md).
+Earlier versions: the [changelog](CHANGELOG.md) and [`docs/updates/`](docs/updates/).
 
 ---
 
@@ -462,7 +449,7 @@ in a compact public API for creating solids, applying features, tagging semantic
 intent, querying topology, exporting manufacturing files, and translating recorded
 models into FreeCAD workflows.
 
-Current release: `simplecadapi==2.2.1`.
+Current release: `simplecadapi==2.2.2`.
 
 ## What It Provides
 
@@ -977,6 +964,7 @@ and the [STEP reconstruction workflow](docs/skill/references/workflows/step-reco
 
 ## Documentation
 
+- 2.2.2 update notes: [`docs/updates/2.2.2.md`](docs/updates/2.2.2.md)
 - 2.2.1 update notes: [`docs/updates/2.2.1.md`](docs/updates/2.2.1.md)
 - 2.1.3b1 update notes: [`docs/updates/2.1.3b1.md`](docs/updates/2.1.3b1.md)
 - 2.1.2 update notes: [`docs/updates/2.1.2.md`](docs/updates/2.1.2.md)

{simplecadapi-2.2.1 → simplecadapi-2.2.2}/README.md

@@ -149,37 +149,24 @@ the full crank cycle sweeps clean in the same sim ·
 
 ---
 
-## Update Notes (2.2.1)
+## Update Notes (2.2.2)
 
 > Validate generated definitions, assembly constraints, and manufacturing
 > geometry before production use.
 
-- **New editor.** `sca edit` is part of the SDK now (`pip install
-  "simplecadapi[editor]"`). It runs a workspace's notebooks in a marimo kernel
-  with the SDK's own cell executor, previews the live model straight from the
-  solids, writes your viewport picks as selection code, and lets an agent see
-  what you see (`sca snapshot`). **Re-Studio is removed**: the reverse-
-  engineering studio (the `Re-mode` workspace of the standalone sca-web-editor)
-  is gone, and the standalone sca-web-editor is replaced by `sca edit`. STEP
-  reconstruction continues through the inspection API and the skill's
-  step-reconstruction workflow.
-- **One runtime, one cache.** The editor, `sca run` and
-  `simplecadapi.runtime.run_notebook()` share the per-cell cache, so what one
-  computed the others restore. Notebook parameters come from `# ---- params
-  ----` cells with an optional `# ui:` comment; local modules (shared
-  dimensions) get their own view in the editor.
-- **Landing path.** `docs/landing.md` is the script an agent follows to install
-  the SDK and its skill and open an example; `sca example u_link` copies the
-  bundled workspace and `sca skill where` shows where the skill goes.
-- Earlier: 2.1.3b1 shipped the addon ecosystem (`sca addon ...`, the
-  `sca-addon.toml` descriptor, the `.scadpkg` format spec); see its
-  [update notes](docs/updates/2.1.3b1.md).
-
-Every example model is a notebook; its export scripts load the product with
-`run_notebook`, capture one `.scadpkg`, and translate AP242 `.step` and
-editable `.FCStd` from that same package. The AP242/Gmsh example under
-`examples/ap242_gmsh_volume_mesh/` exposes each export and FEM stage as a
-separate directly runnable script.
+- **Code completion from the SDK.** In the editor, `scad.` (and `scad.ql.`,
+  `scad.std.gear.`) lists the real functions with their signatures and
+  docstrings. Accepting one, or typing `(` after its name, writes the call with
+  every required parameter as `name=`, and Tab moves between them; inside a call
+  the parameters not given yet complete as `name=`.
+- **New notebooks from the workspace tab.** A **new** action starts a part, or
+  an assembly that uses the first two parts, from the SDK's template; an empty
+  workspace opens on that form.
+- **Fix.** The cell editors no longer rebuild their configuration on every
+  render, which dropped a snippet in progress.
+
+Full notes for this version: [`docs/updates/2.2.2.md`](docs/updates/2.2.2.md).
+Earlier versions: the [changelog](CHANGELOG.md) and [`docs/updates/`](docs/updates/).
 
 ---
 
@@ -199,7 +186,7 @@ in a compact public API for creating solids, applying features, tagging semantic
 intent, querying topology, exporting manufacturing files, and translating recorded
 models into FreeCAD workflows.
 
-Current release: `simplecadapi==2.2.1`.
+Current release: `simplecadapi==2.2.2`.
 
 ## What It Provides
 
@@ -714,6 +701,7 @@ and the [STEP reconstruction workflow](docs/skill/references/workflows/step-reco
 
 ## Documentation
 
+- 2.2.2 update notes: [`docs/updates/2.2.2.md`](docs/updates/2.2.2.md)
 - 2.2.1 update notes: [`docs/updates/2.2.1.md`](docs/updates/2.2.1.md)
 - 2.1.3b1 update notes: [`docs/updates/2.1.3b1.md`](docs/updates/2.1.3b1.md)
 - 2.1.2 update notes: [`docs/updates/2.1.2.md`](docs/updates/2.1.2.md)

{simplecadapi-2.2.1 → simplecadapi-2.2.2}/docs/skill/SKILL.md

@@ -4,9 +4,9 @@ description: Build, assemble, inspect, reconstruct, and export parametric CAD mo
 license: Apache-2.0
 metadata:
   project: simplecadapi
-  version: 2.2.1
+  version: 2.2.2
   package-name: simplecadapi
-  package-version: 2.2.1
+  package-version: 2.2.2
 ---
 
 # SimpleCAD SDK Skill

simplecadapi-2.2.2/docs/updates/2.2.2.md

@@ -0,0 +1,27 @@
+# 2.2.2 Update Notes
+
+Two additions to the code-first editor (`sca edit`), and a fix that made one of them usable.
+
+## Code completion from the SDK
+
+`scad.` (and `scad.ql.`, `scad.std.gear.`, `ql.`, `Q.`) lists the real functions with their
+signatures; the side panel shows every parameter with its default and the docstring.
+
+- Accepting a function, or typing `(` after a known name, writes the call with every
+  **required** parameter as `name=`: `scad.make_box_rsolid(width=, height=, depth=)`.
+  **Tab** moves to the next parameter.
+- Inside a call, the parameters not given yet complete as `name=`, required ones first.
+- The names come from the running package (`GET /api/sdk`), so they cannot drift from the code.
+
+## Create a notebook from the workspace tab
+
+A **new** action in the notebooks header starts a notebook from the SDK's template: a part, or an
+assembly that uses the first two parts of the workspace. The name is checked as you type. An empty
+workspace opens on that form, so `sca edit` on an empty directory is usable.
+
+## Fixed
+
+The cell editors rebuilt their configuration on every render, which dropped a snippet in progress
+and could disturb typing; the editor's `onChange` and options are stable now.
+
+See the [changelog](../../CHANGELOG.md) for the complete list.

simplecadapi-2.2.2/docs/updates/2.2.2.zh-CN.md

@@ -0,0 +1,25 @@
+# 2.2.2 更新说明
+
+`sca edit` 编辑器的两项新增，以及一个让其中一项能正常使用的修复。
+
+## 来自 SDK 的代码补全
+
+输入 `scad.`（以及 `scad.ql.`、`scad.std.gear.`、`ql.`、`Q.`）会列出真实存在的函数和签名；
+右侧面板显示每个参数、默认值和文档说明。
+
+- 选中一个函数，或在已知函数名后输入 `(`，会把每个**必填**参数写成 `name=`：
+  `scad.make_box_rsolid(width=, height=, depth=)`。**Tab** 跳到下一个参数。
+- 在调用括号内，还没写的参数会补全成 `name=`，必填的排在最前。
+- 名字来自正在运行的包（`GET /api/sdk`），不会和代码不一致。
+
+## 在工作区页面创建 notebook
+
+notebooks 标题处新增 **new**，按 SDK 模板创建 notebook：一个零件，或一个使用工作区前两个零件的装配。
+边输入边检查名字。空工作区会直接打开这个表单，所以对空目录运行 `sca edit` 也能用了。
+
+## 修复
+
+cell 编辑器每次渲染都会重建配置，导致进行中的占位跳转丢失，也可能干扰输入；现在编辑器的
+`onChange` 和选项都是稳定的。
+
+完整列表见[更新日志](../../CHANGELOG.md)。

{simplecadapi-2.2.1 → simplecadapi-2.2.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "simplecadapi"
-version = "2.2.1"
+version = "2.2.2"
 description = "A simplified OCP-native CAD modeling Python API"
 readme = "README.md"
 license = { file = "LICENSE" }

simplecadapi-2.2.2/src/simplecadapi/editor/apiindex.py

@@ -0,0 +1,120 @@
+"""The SDK's public API as plain data, for the editor's code completion.
+
+The cell editor completes ``scad.<name>``, and a call's parameters as ``name=`` placeholders, from
+this index.  It is read from the live package (``inspect``), so it is always the API of the
+version that is running and cannot drift from the code.  Namespaces are the places a notebook
+reaches names through: ``scad`` (the package), ``scad.ql`` and ``scad.std.<module>``.
+"""
+
+from __future__ import annotations
+
+import functools
+import inspect
+import types
+from typing import Any
+
+import simplecadapi
+
+_KINDS = {
+    inspect.Parameter.POSITIONAL_ONLY: "p",
+    inspect.Parameter.POSITIONAL_OR_KEYWORD: "",
+    inspect.Parameter.KEYWORD_ONLY: "",
+    inspect.Parameter.VAR_POSITIONAL: "a",
+    inspect.Parameter.VAR_KEYWORD: "w",
+}
+_DOC_LIMIT = 240
+_DEFAULT_LIMIT = 40
+
+
+def _summary(obj: Any) -> str:
+    """The first paragraph of the docstring, on one line."""
+
+    doc = inspect.getdoc(obj) or ""
+    first = doc.strip().split("\n\n", 1)[0]
+    text = " ".join(first.split())
+    return text if len(text) <= _DOC_LIMIT else text[: _DOC_LIMIT - 1].rstrip() + "…"
+
+
+def _parameters(obj: Any) -> list[dict[str, Any]] | None:
+    try:
+        signature = inspect.signature(obj)
+    except (TypeError, ValueError):
+        return None
+    rows: list[dict[str, Any]] = []
+    for parameter in signature.parameters.values():
+        if parameter.name == "self" or parameter.name.startswith("_"):
+            continue
+        required = parameter.default is inspect.Parameter.empty and parameter.kind in (
+            inspect.Parameter.POSITIONAL_ONLY,
+            inspect.Parameter.POSITIONAL_OR_KEYWORD,
+            inspect.Parameter.KEYWORD_ONLY,
+        )
+        row: dict[str, Any] = {"n": parameter.name, "r": required, "k": _KINDS[parameter.kind]}
+        if parameter.default is not inspect.Parameter.empty and not str(parameter.default).startswith("<"):
+            text = repr(parameter.default)
+            row["d"] = text if len(text) <= _DEFAULT_LIMIT else text[: _DEFAULT_LIMIT - 1] + "…"
+        rows.append(row)
+    return rows
+
+
+def _entry(name: str, obj: Any) -> dict[str, Any] | None:
+    if inspect.isclass(obj):
+        kind = "c"
+    elif inspect.isfunction(obj) or inspect.isbuiltin(obj):
+        kind = "f"
+    else:
+        return None
+    parameters = _parameters(obj)
+    if parameters is None:
+        return None
+    return {"n": name, "k": kind, "p": parameters, "d": _summary(obj)}
+
+
+def _ours(obj: Any) -> bool:
+    """Defined by the SDK itself, not a typing helper or another library re-exported."""
+
+    module = getattr(obj, "__module__", "") or ""
+    return module == "simplecadapi" or module.startswith("simplecadapi.")
+
+
+def _entries(module: types.ModuleType, names: list[str] | None = None, *, own: bool = False) -> list[dict[str, Any]]:
+    """Entries for the callables of *module*; with *own*, only those defined in that module (not re-exports)."""
+
+    rows = []
+    for name in sorted(names if names is not None else dir(module)):
+        if name.startswith("_"):
+            continue
+        obj = getattr(module, name, None)
+        if obj is None or isinstance(obj, types.ModuleType) or not _ours(obj):
+            continue
+        if own and not (getattr(obj, "__module__", "") or "").startswith(module.__name__):
+            continue
+        row = _entry(name, obj)
+        if row is not None:
+            rows.append(row)
+    return rows
+
+
+@functools.lru_cache(maxsize=1)
+def build_index() -> dict[str, Any]:
+    """``{"namespaces": {path: [entry]}, "submodules": {path: [name]}}``.
+
+    An entry is ``{"n": name, "k": "f"|"c", "p": [parameter], "d": summary}``; a parameter is
+    ``{"n": name, "r": required, "k": "p"|"a"|"w"|"", "d"?: default}`` (``p`` positional only,
+    ``a`` the ``*args`` one, ``w`` the ``**kwargs`` one).
+    """
+
+    from simplecadapi import ql, std
+
+    namespaces: dict[str, list[dict[str, Any]]] = {
+        "scad": _entries(simplecadapi, list(getattr(simplecadapi, "__all__", dir(simplecadapi)))),
+        "scad.ql": _entries(ql, own=True),
+    }
+    std_modules = sorted(
+        name for name in dir(std) if not name.startswith("_") and isinstance(getattr(std, name), types.ModuleType)
+    )
+    for name in std_modules:
+        module = getattr(std, name)
+        namespaces[f"scad.std.{name}"] = _entries(module, list(getattr(module, "__all__", dir(module))), own=True)
+    submodules = {"scad": ["ql", "std"], "scad.std": std_modules}
+    return {"version": getattr(simplecadapi, "__version__", ""), "namespaces": namespaces, "submodules": submodules}

{simplecadapi-2.2.1 → simplecadapi-2.2.2}/src/simplecadapi/editor/server.py

@@ -1365,6 +1365,12 @@ def create_app(state: WorkspaceState) -> Starlette:
             )
         return JSONResponse({"error": "no package made yet"}, status_code=404)
 
+    async def sdk_index(request: Request) -> JSONResponse:
+        """The SDK's public API (names and parameters), for the cell editor's completion."""
+        from .apiindex import build_index
+
+        return JSONResponse(build_index(), headers={"Cache-Control": "max-age=3600"})
+
     async def workspace_list(request: Request) -> JSONResponse:
         """The SimpleCAD notebooks of the workspace."""
         current = state.notebook.relative_to(state.workspace).as_posix() if state.notebook else None
@@ -1484,6 +1490,7 @@ def create_app(state: WorkspaceState) -> Starlette:
         Route("/api/preview/latest", latest_preview, methods=["GET"]),
         Route("/api/runtime/package", push_package, methods=["POST"]),
         Route("/api/package/latest", latest_package, methods=["GET"]),
+        Route("/api/sdk", sdk_index, methods=["GET"]),
         Route("/api/workspace", workspace_list, methods=["GET"]),
         Route("/api/workspace/open", workspace_open, methods=["POST"]),
         Route("/api/workspace/new", workspace_new, methods=["POST"]),