frappectl 0.13.1__py3-none-any.whl

frappectl/__init__.py

@@ -0,0 +1,8 @@
+"""frappectl — a command-line client for Frappe sites."""
+
+from importlib.metadata import PackageNotFoundError, version
+
+try:
+    __version__ = version("frappectl")
+except PackageNotFoundError:
+    __version__ = "0.0.0+unknown"

frappectl/__main__.py

@@ -0,0 +1,4 @@
+from frappectl.cli import app
+
+if __name__ == "__main__":
+    app()

frappectl/cli.py

@@ -0,0 +1,148 @@
+"""frappectl — top-level Typer app and global options."""
+
+from __future__ import annotations
+
+import sys
+from typing import Optional
+
+import typer
+
+from . import __version__
+from .commands import api as api_cmd
+from .commands import assistant as assistant_cmd
+from .commands import auth, doc, doctype, file, report
+from .commands import guide as guide_cmd
+from .commands import method as method_cmd
+from .commands import update as update_cmd
+from .config import ConfigError
+from .errors import FrappeError, UsageError
+from .output import Ctx, fail
+
+app = typer.Typer(
+    name="frappectl",
+    help="frappectl — a command-line client for Frappe sites.",
+    no_args_is_help=True,
+    add_completion=True,
+    rich_markup_mode="rich",
+    context_settings={"help_option_names": ["-h", "--help"]},
+)
+
+app.add_typer(auth.app, name="auth")
+app.add_typer(doc.app, name="doc")
+app.add_typer(doctype.app, name="doctype")
+app.add_typer(file.app, name="file")
+app.add_typer(report.app, name="report")
+app.add_typer(method_cmd.app, name="method")
+# `frappectl api <path>` — single command, mounted directly.
+app.command(name="api", help=api_cmd.api.__doc__)(api_cmd.api)
+# `frappectl guide` — static usage primer; the first thing an agent should run.
+app.command(name="guide", help=guide_cmd.guide.__doc__)(guide_cmd.guide)
+# `frappectl update` — self-upgrade via the uv/pip backend it was installed with.
+app.command(name="update", help=update_cmd.update.__doc__)(update_cmd.update)
+# `frappectl assistant [tool] -- <args>` — launch a CLI agent as a Frappe
+# assistant. allow_extra_args/ignore_unknown_options let trailing args (and
+# the child tool's own flags) pass through untouched via ctx.args.
+app.command(
+    name="assistant",
+    help=assistant_cmd.assistant.__doc__,
+    context_settings={"allow_extra_args": True, "ignore_unknown_options": True},
+)(assistant_cmd.assistant)
+
+
+def _version_callback(value: bool) -> None:
+    if value:
+        typer.echo(f"frappectl {__version__}")
+        raise typer.Exit()
+
+
+@app.callback()
+def _root(
+    ctx: typer.Context,
+    site: Optional[str] = typer.Option(
+        None, "-s", "--site", help="Profile to use (overrides the default profile)."
+    ),
+    json_out: bool = typer.Option(
+        False, "--json", help="Force JSON output (default when piped)."
+    ),
+    yes: bool = typer.Option(
+        False, "--yes", "-y", help="Assume yes for confirmation prompts."
+    ),
+    debug: bool = typer.Option(
+        False,
+        "--debug",
+        help="Print each HTTP request (and server SQL, where available) to stderr.",
+    ),
+    version: bool = typer.Option(
+        False,
+        "--version",
+        callback=_version_callback,
+        is_eager=True,
+        help="Show version.",
+    ),
+) -> None:
+    """Global options apply to every subcommand."""
+    ctx.obj = Ctx(json_mode=json_out, assume_yes=yes, profile=site, debug=debug)
+    # Passive, best-effort "a newer version exists" nudge. No-op in JSON/piped
+    # mode and for dev checkouts; network-throttled to once a day.
+    update_cmd.notify_if_outdated(ctx.obj)
+
+
+# Global flags that must reach the top-level callback. We hoist them to the
+# front of argv so they work in gh-style trailing position too, e.g.
+#   frappectl doc list "Sales Invoice" --json
+# is rewritten to `frappectl --json doc list "Sales Invoice"`.
+_VALUELESS_GLOBALS = {"--json", "--yes", "-y", "--debug"}
+_VALUED_GLOBALS = {"-s", "--site"}
+
+
+def _hoist_globals(argv: list[str]) -> list[str]:
+    hoisted: list[str] = []
+    rest: list[str] = []
+    i = 0
+    seen_ddash = False
+    while i < len(argv):
+        tok = argv[i]
+        if tok == "--":
+            seen_ddash = True
+            rest.append(tok)
+            i += 1
+            continue
+        if not seen_ddash and tok in _VALUELESS_GLOBALS:
+            # Normalize -y to --yes for the callback.
+            hoisted.append("--yes" if tok == "-y" else tok)
+            i += 1
+            continue
+        if not seen_ddash and tok in _VALUED_GLOBALS:
+            hoisted.append("--site")
+            if i + 1 < len(argv):
+                hoisted.append(argv[i + 1])
+                i += 2
+            else:
+                i += 1
+            continue
+        if not seen_ddash and (tok.startswith("--site=") or tok.startswith("-s=")):
+            hoisted.extend(["--site", tok.split("=", 1)[1]])
+            i += 1
+            continue
+        rest.append(tok)
+        i += 1
+    return hoisted + rest
+
+
+def main() -> None:
+    sys.argv = [sys.argv[0]] + _hoist_globals(sys.argv[1:])
+    try:
+        app()
+    except UsageError as e:
+        fail(e.message, 2)
+        sys.exit(2)
+    except FrappeError as e:
+        fail(e.message, 1)
+        sys.exit(1)
+    except ConfigError as e:
+        fail(str(e), 2)
+        sys.exit(2)
+
+
+if __name__ == "__main__":
+    main()