PyPI - deepcell-cli - Versions diffs - 0.6.1__py3-none-any.whl - Mend

deepcell-cli 0.6.1__py3-none-any.whl

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.

Files changed (67) hide show

deepcell_cli/__init__.py +12 -0
deepcell_cli/__main__.py +5 -0
deepcell_cli/_findings.py +84 -0
deepcell_cli/capabilities.py +560 -0
deepcell_cli/capability-contract.json +15622 -0
deepcell_cli/client.py +503 -0
deepcell_cli/commands/__init__.py +1 -0
deepcell_cli/commands/_batch_input.py +29 -0
deepcell_cli/commands/_datatypes.py +56 -0
deepcell_cli/commands/_negative_args.py +133 -0
deepcell_cli/commands/_swapped_args.py +153 -0
deepcell_cli/commands/_version_display.py +40 -0
deepcell_cli/commands/_write_opts.py +139 -0
deepcell_cli/commands/account.py +123 -0
deepcell_cli/commands/auth.py +610 -0
deepcell_cli/commands/changes.py +307 -0
deepcell_cli/commands/deck.py +594 -0
deepcell_cli/commands/defs.py +3890 -0
deepcell_cli/commands/describe.py +902 -0
deepcell_cli/commands/doc.py +529 -0
deepcell_cli/commands/doctor.py +257 -0
deepcell_cli/commands/download.py +36 -0
deepcell_cli/commands/edit.py +384 -0
deepcell_cli/commands/example.py +161 -0
deepcell_cli/commands/export.py +81 -0
deepcell_cli/commands/export_docx.py +57 -0
deepcell_cli/commands/export_pdf.py +66 -0
deepcell_cli/commands/export_pptx.py +45 -0
deepcell_cli/commands/files.py +386 -0
deepcell_cli/commands/grep.py +90 -0
deepcell_cli/commands/guide.py +431 -0
deepcell_cli/commands/help_cmd.py +348 -0
deepcell_cli/commands/impact.py +382 -0
deepcell_cli/commands/import_cmd.py +208 -0
deepcell_cli/commands/ingest.py +110 -0
deepcell_cli/commands/merge.py +399 -0
deepcell_cli/commands/query.py +718 -0
deepcell_cli/commands/reasoning.py +2981 -0
deepcell_cli/commands/ref.py +279 -0
deepcell_cli/commands/replace.py +326 -0
deepcell_cli/commands/rules.py +206 -0
deepcell_cli/commands/share.py +186 -0
deepcell_cli/commands/sync.py +804 -0
deepcell_cli/commands/upgrade.py +185 -0
deepcell_cli/commands/variant.py +353 -0
deepcell_cli/commands/version.py +445 -0
deepcell_cli/commands/viewer.py +54 -0
deepcell_cli/commands/workspace.py +101 -0
deepcell_cli/config.py +352 -0
deepcell_cli/context.py +187 -0
deepcell_cli/errors.py +141 -0
deepcell_cli/logging_setup.py +161 -0
deepcell_cli/main.py +518 -0
deepcell_cli/mcp_server.py +906 -0
deepcell_cli/oauth_provider.py +580 -0
deepcell_cli/output.py +503 -0
deepcell_cli/revision.py +164 -0
deepcell_cli/stages.py +223 -0
deepcell_cli/surface.py +628 -0
deepcell_cli/sync_state.py +120 -0
deepcell_cli/upgrade_check.py +399 -0
deepcell_cli/xml_replace.py +89 -0
deepcell_cli-0.6.1.dist-info/METADATA +264 -0
deepcell_cli-0.6.1.dist-info/RECORD +67 -0
deepcell_cli-0.6.1.dist-info/WHEEL +5 -0
deepcell_cli-0.6.1.dist-info/entry_points.txt +3 -0
deepcell_cli-0.6.1.dist-info/top_level.txt +1 -0

deepcell_cli/commands/changes.py ADDED Viewed

@@ -0,0 +1,307 @@
+"""Document change review: list, diff, revert.
+Mirrors ``GET/POST /workspaces/{slug}/changes*`` one-for-one, the way every
+command under this package mirrors a router. `log`/`diff`/`restore` in
+`version.py` answer "what commits exist"; these answer "what *changes* landed,
+by whom, and can I undo one" — the same grouped feed the browser's Changes
+navigator reads, so a CLI user and a browser user see the same history.
+"""
+from __future__ import annotations
+import re
+import click
+from deepcell_cli.errors import APIError
+from deepcell_cli.context import Ctx, pass_ctx
+from deepcell_cli.output import (
+    echo_error, echo_info, echo_success, output, output_mutation,
+)
+from deepcell_cli.commands.version import _print_semantic_diff
+_REVISION_RE = re.compile(r"^[0-9a-fA-F]{7,64}$")
+class RevisionParam(click.ParamType):
+    """A commit sha, checked here rather than at the router.
+    These three endpoints declare ``pattern=^[0-9a-fA-F]{7,64}$`` on their
+    revision query params — unlike `/versions/diff`, which takes a bare string.
+    Forwarding `HEAD` (or `main`, or a 4-character short sha) therefore bought
+    a pydantic 422 that quoted the regex back at the user:
+        Error: request validation failed:
+          - from_revision: String should match pattern '^[0-9a-fA-F]{7,64}$'
+    A regex is not an answer to "what should I have typed", and `HEAD` is the
+    first thing anyone with git in their fingers reaches for. Same reasoning as
+    the `IntRange(1, 200)` on ``--limit``: mirror the constraint the endpoint
+    already declares, and spend the error message on the way out.
+    """
+    name = "revision"
+    def convert(self, value, param, ctx):  # noqa: D102
+        if _REVISION_RE.match(value):
+            return value
+        self.fail(
+            f"{value!r} is not a revision. Pass a commit sha — 7 to 64 hex "
+            "characters, as printed by `deepcell changes list` and "
+            "`deepcell log`. Names like HEAD, main or a tag are not resolved "
+            "here.",
+            param,
+            ctx,
+        )
+REVISION = RevisionParam()
+_SOURCE_LABELS = {
+    "workbench-agent": "agent",
+    "cli": "CLI",
+    "browser": "browser",
+    "import": "import",
+    "restore": "restore",
+    "revert": "undo",
+    "api": "API",
+    "excel-addin": "Excel add-in",
+    "document": "document",
+}
+@click.group()
+def changes() -> None:
+    """Review document changes from every writer (agent, CLI, browser, import).
+    \b
+    deepcell changes list                     # newest changes in the workspace
+    deepcell changes list model.deepcell      # only changes touching one file
+    deepcell changes diff <base> <head>       # what one change actually did
+    deepcell changes revert <base> <head>     # undo it as a new commit
+    """
+@changes.command("list")
+@click.argument("filename_pos", metavar="[FILENAME]", required=False)
+@click.option("--file", "filename", default=None, help="Filter by filename.")
+@click.option(
+    "-n",
+    "--limit",
+    default=20,
+    # The endpoint declares ge=1, le=200; without this the CLI forwards 500 and
+    # the user gets a raw pydantic 422 instead of a usage error.
+    type=click.IntRange(1, 200),
+    help="Number of changes to show (1-200).",
+)
+@click.option(
+    "--since",
+    "since_revision",
+    default=None,
+    type=REVISION,
+    help="Only changes that moved the branch forward from this revision.",
+)
+@pass_ctx
+def list_changes(
+    ctx: Ctx,
+    filename_pos: str | None,
+    filename: str | None,
+    limit: int,
+    since_revision: str | None,
+) -> None:
+    """List document changes, newest first.
+    Consecutive commits from one agent run or one CLI invocation are grouped
+    into a single change, so `base_revision`..`head_revision` is the range you
+    pass to `changes diff` and `changes revert`.
+    """
+    if filename_pos and filename:
+        raise click.UsageError("Pass FILENAME positionally or via --file, not both.")
+    filename = filename_pos or filename
+    slug = ctx.require_workspace()
+    params: dict = {"max_count": limit}
+    if filename:
+        params["filename"] = filename
+    if since_revision:
+        params["since_revision"] = since_revision
+    data = ctx.client.get(f"/workspaces/{slug}/changes", params=params)
+    if ctx.fmt != "plain":
+        output(data, ctx.fmt)
+        return
+    if data.get("resync_required"):
+        # Two situations, opposite remedies. Overflow means the revision was
+        # fine and more changes had landed than were asked for — one agent run
+        # of 21 commits does it against this command's default of 20 — and
+        # saying "unreachable" there sent the user to fix a revision that was
+        # never the problem. Anything else is a cursor this history cannot walk
+        # from (too far back, unknown, rewritten, not an ancestor), and the
+        # server does not say which, so neither do we.
+        if data.get("resync_reason") == "overflow":
+            echo_info(
+                f"More than {limit} changes since that revision. Re-run with a "
+                f"larger -n to see them all."
+            )
+        else:
+            echo_info(
+                "Cannot list changes from that revision — it is unreachable or "
+                "too far back. Re-run without --since for the current history."
+            )
+        return
+    entries = data.get("changes") or []
+    if not entries:
+        echo_info("No changes yet.")
+        return
+    for entry in entries:
+        _print_change(entry)
+_TITLE_KEYS = {
+    "revert": lambda p: f"Undo of {p.get('revision', '?')}",
+    "untitled": lambda p: "Document update",
+    "syncFromCli": lambda p: "Synced from the terminal",
+    "batchEdit": lambda p: f"Edited {p['detail']}" if p.get("detail") else "Edited values",
+}
+def _change_title(entry: dict) -> str:
+    """What to print for a change whose subject this server wrote.
+    `Revert change a1b2c3d4` and `[batch-edit] Revenue[FY2025]` are commit
+    bookkeeping, not a description anybody typed. The server says which of the
+    two it is via `title_key`; an unknown key falls back to the raw subject, so
+    an older CLI against a newer server keeps exactly what it had.
+    """
+    key = entry.get("title_key")
+    render = _TITLE_KEYS.get(key) if key else None
+    if render:
+        return render(entry.get("title_params") or {})
+    return entry.get("title") or "(no title)"
+def _print_change(entry: dict) -> None:
+    """One change as a three-line block: title, provenance, revision range."""
+    source = _SOURCE_LABELS.get(entry.get("source", ""), entry.get("source", "?"))
+    click.echo(click.style(_change_title(entry), bold=True))
+    detail = f"  {source} · {entry.get('author', '?')} · {entry.get('timestamp', '?')}"
+    if entry.get("command"):
+        detail += f" · {entry['command']}"
+    click.echo(detail)
+    base = entry.get("base_revision")
+    head = entry.get("head_revision") or "?"
+    files = entry.get("files_changed") or []
+    click.echo(
+        f"  {(base[:8] if base else '(root)')}..{head[:8]} · "
+        + (", ".join(str(f) for f in files) if files else "no files")
+    )
+    click.echo("")
+@changes.command("diff")
+@click.argument("base_revision", type=REVISION)
+@click.argument("head_revision", required=False, type=REVISION)
+@click.option("--file", "filename", default=None, help="Filter diff by filename.")
+@pass_ctx
+def diff_change(
+    ctx: Ctx,
+    base_revision: str,
+    head_revision: str | None,
+    filename: str | None,
+) -> None:
+    """Show what one change did, semantically.
+    \b
+    deepcell changes diff abc1234            # that revision to HEAD
+    deepcell changes diff abc1234 def5678    # one change's exact range
+    """
+    slug = ctx.require_workspace()
+    params: dict = {"from_revision": base_revision}
+    if head_revision:
+        params["to_revision"] = head_revision
+    if filename:
+        params["filename"] = filename
+    try:
+        data = ctx.client.get(f"/workspaces/{slug}/changes/diff", params=params)
+    except APIError as e:
+        if e.status_code == 400:
+            echo_error(e.detail)
+            raise SystemExit(1) from e
+        raise
+    if ctx.fmt != "plain":
+        # The list, not the envelope: `output`'s table path wraps a dict as a
+        # single row, which put the repr of every change in one cell.
+        output(data.get("files") if ctx.fmt == "table" else data, ctx.fmt)
+        return
+    files = data.get("files") or []
+    if not files:
+        echo_info("No differences found.")
+        return
+    for entry in files:
+        click.echo(
+            click.style(
+                f"--- {entry.get('file_path', '')} "
+                f"({entry.get('change_type', 'modified')})",
+                bold=True,
+            )
+        )
+        if entry.get("semantic_diff"):
+            _print_semantic_diff(entry["semantic_diff"])
+        else:
+            # A semantic diff needs BOTH sides of a `.deepcell` file, so an
+            # added or deleted document — and any non-`.deepcell` file in a
+            # mixed commit — has none. Saying so beats printing a bare header
+            # and exiting 0, which reads as "this change did nothing".
+            echo_info(
+                "  No semantic diff for this file "
+                "(added, deleted, or not a .deepcell document)."
+            )
+        click.echo("")
+@changes.command("revert")
+@click.argument("base_revision", type=REVISION)
+@click.argument("head_revision", type=REVISION)
+@click.option("-y", "--yes", is_flag=True, help="Skip confirmation prompt.")
+@pass_ctx
+def revert_change(
+    ctx: Ctx,
+    base_revision: str,
+    head_revision: str,
+    yes: bool,
+) -> None:
+    """Undo one change by committing its inverse onto the current tip.
+    This is not a restore: work committed *after* the change survives, as long
+    as it touched different content. If it overlaps, nothing is committed and
+    the command reports the conflict — resolve it by editing, not by reverting.
+    Reverting is itself a new commit, so nothing is lost for good.
+    """
+    slug = ctx.require_workspace()
+    if not yes:
+        # After `require_workspace`, not before: approving a revert and only
+        # then being told there is no workspace wastes the one question this
+        # command asks, and trains people to type -y.
+        click.confirm(
+            f"Revert the change {base_revision[:8]}..{head_revision[:8]}?",
+            abort=True,
+        )
+    try:
+        data = ctx.client.post(
+            f"/workspaces/{slug}/changes/revert",
+            json={"base_revision": base_revision, "head_revision": head_revision},
+        )
+    except APIError as e:
+        if e.status_code == 409:
+            # The server refuses rather than committing a half-undo; say which
+            # files collided so the next step is obvious.
+            echo_error(e.detail)
+            raise SystemExit(1) from e
+        raise
+    output_mutation(data, ctx.fmt, plain_key="sha")
+    echo_success(f"Reverted {head_revision[:8]} as a new revision")