chatenv 0.2.3__tar.gz → 0.2.4__tar.gz

{chatenv-0.2.3/src/chatenv.egg-info → chatenv-0.2.4}/PKG-INFO

@@ -1,9 +1,12 @@
 Metadata-Version: 2.4
 Name: chatenv
-Version: 0.2.3
+Version: 0.2.4
 Summary: ChatArch typed environment profile manager
 Author-email: rexwzh <1073853456@qq.com>
 License-Expression: MIT
+Project-URL: Homepage, https://github.com/ChatArch/ChatEnv
+Project-URL: Repository, https://github.com/ChatArch/ChatEnv
+Project-URL: Documentation, https://chatarch.github.io/ChatEnv/
 Keywords: chatenv,chatarch,env
 Classifier: Programming Language :: Python :: 3
 Classifier: Operating System :: OS Independent
@@ -18,11 +21,11 @@ Requires-Dist: build>=1.0; extra == "dev"
 Requires-Dist: pytest>=8.0; extra == "dev"
 Requires-Dist: twine>=5.0; extra == "dev"
 Provides-Extra: docs
-Requires-Dist: mkdocs>=1.6; extra == "docs"
-Requires-Dist: mkdocs-material>=9.5; extra == "docs"
-Requires-Dist: mkdocs-minify-plugin>=0.8; extra == "docs"
-Requires-Dist: mkdocs-redirects>=1.2; extra == "docs"
-Requires-Dist: mike>=2.1; extra == "docs"
+Requires-Dist: mkdocs<2.0,>=1.6; extra == "docs"
+Requires-Dist: mkdocs-material<9.7,>=9.5; extra == "docs"
+Requires-Dist: mkdocs-minify-plugin<1.0,>=0.8; extra == "docs"
+Requires-Dist: mkdocs-redirects<2.0,>=1.2; extra == "docs"
+Requires-Dist: mike<3.0,>=2.1; extra == "docs"
 Dynamic: license-file
 
 <div align="center">
@@ -87,6 +90,7 @@ $CHATARCH_HOME/envs/
 
 ```bash
 chatenv --version
+chatenv --tree
 chatenv init -t example
 chatenv status
 chatenv status --detail
@@ -114,6 +118,8 @@ export CHATARCH_AUTO_PROMPT=false
 
 此时只有缺少必要参数的命令会直接报错；参数已经足够的命令行为不变。
 
+`chatenv --tree` 可从当前安装包的 Click 注册表实时输出完整命令树，用于验收和脚本 readback。
+
 更多用法见 `docs/cli.md`。
 
 ## Paste

{chatenv-0.2.3 → chatenv-0.2.4}/README.md

@@ -60,6 +60,7 @@ $CHATARCH_HOME/envs/
 
 ```bash
 chatenv --version
+chatenv --tree
 chatenv init -t example
 chatenv status
 chatenv status --detail
@@ -87,6 +88,8 @@ export CHATARCH_AUTO_PROMPT=false
 
 此时只有缺少必要参数的命令会直接报错；参数已经足够的命令行为不变。
 
+`chatenv --tree` 可从当前安装包的 Click 注册表实时输出完整命令树，用于验收和脚本 readback。
+
 更多用法见 `docs/cli.md`。
 
 ## Paste

{chatenv-0.2.3 → chatenv-0.2.4}/pyproject.toml

@@ -21,6 +21,11 @@ classifiers = [
     "Operating System :: OS Independent",
 ]
 
+[project.urls]
+Homepage = "https://github.com/ChatArch/ChatEnv"
+Repository = "https://github.com/ChatArch/ChatEnv"
+Documentation = "https://chatarch.github.io/ChatEnv/"
+
 [tool.setuptools.dynamic]
 version = {attr = "chatenv.__version__"}
 
@@ -40,9 +45,9 @@ dev = [
     "twine>=5.0",
 ]
 docs = [
-    "mkdocs>=1.6",
-    "mkdocs-material>=9.5",
-    "mkdocs-minify-plugin>=0.8",
-    "mkdocs-redirects>=1.2",
-    "mike>=2.1",
+    "mkdocs>=1.6,<2.0",
+    "mkdocs-material>=9.5,<9.7",
+    "mkdocs-minify-plugin>=0.8,<1.0",
+    "mkdocs-redirects>=1.2,<2.0",
+    "mike>=2.1,<3.0",
 ]

{chatenv-0.2.3 → chatenv-0.2.4}/src/chatenv/__init__.py

@@ -20,4 +20,4 @@ __all__ = [
     "__version__",
 ]
 
-__version__ = "0.2.3"
+__version__ = "0.2.4"

{chatenv-0.2.3 → chatenv-0.2.4}/src/chatenv/cli.py

@@ -123,8 +123,111 @@ class OrderedGroup(click.Group):
         return ordered
 
 
+def _format_metavar(name: str) -> str:
+    return name.replace("_", "-").upper()
+
+
+def _format_argument(param: click.Argument) -> str:
+    metavar = _format_metavar(param.name or "ARG")
+    if not param.required:
+        return f"[{metavar}]"
+    if param.nargs == -1:
+        return f"<{metavar}...>"
+    if param.nargs and param.nargs > 1:
+        return " ".join(f"<{metavar}>" for _ in range(param.nargs))
+    return f"<{metavar}>"
+
+
+def _option_name(param: click.Option) -> str:
+    long_opts = [opt for opt in param.opts if opt.startswith("--")]
+    if long_opts:
+        return long_opts[0]
+    return param.opts[0] if param.opts else _format_metavar(param.name or "OPTION")
+
+
+def _format_option(param: click.Option) -> str:
+    name = _option_name(param)
+    secondary_long = next(
+        (opt for opt in param.secondary_opts if opt.startswith("--")),
+        None,
+    )
+    if param.is_bool_flag and secondary_long:
+        return f"[{name}/{secondary_long}]"
+    if param.is_flag:
+        return f"[{name}]"
+    metavar = param.metavar or _format_metavar(param.name or "VALUE")
+    return f"[{name} <{metavar}>]"
+
+
+def _command_signature(command: click.Command) -> str:
+    parts: list[str] = []
+    for param in command.params:
+        if isinstance(param, click.Argument):
+            parts.append(_format_argument(param))
+    for param in command.params:
+        if isinstance(param, click.Option):
+            if param.name in {"help", "version", "tree"}:
+                continue
+            parts.append(_format_option(param))
+    return " " + " ".join(parts) if parts else ""
+
+
+def _short_help(command: click.Command) -> str:
+    return command.short_help or (command.help or "No description.").strip().splitlines()[0]
+
+
+def _group_items(group: click.Group) -> list[tuple[str, str | click.Command]]:
+    ctx = click.Context(group, resilient_parsing=True)
+    return [(name, group.commands[name]) for name in group.list_commands(ctx)]
+
+
+def render_cli_tree(root: click.Group | None = None) -> str:
+    """Render the registered Click command tree for `chatenv --tree`."""
+    if root is None:
+        root = cli
+    lines = [f"chatenv{_command_signature(root)}  # {_short_help(root)}"]
+    root_items: list[tuple[str, str | click.Command]] = [
+        ("--help", "Show this help message."),
+        ("--version", "Show the installed package version."),
+        ("--tree", "Print the registered command tree."),
+        *_group_items(root),
+    ]
+
+    def walk(items: list[tuple[str, str | click.Command]], prefix: str = "") -> None:
+        for index, (name, item) in enumerate(items):
+            is_last = index == len(items) - 1
+            connector = "└── " if is_last else "├── "
+            child_prefix = prefix + ("    " if is_last else "│   ")
+            if isinstance(item, str):
+                lines.append(f"{prefix}{connector}{name}  # {item}")
+                continue
+            lines.append(f"{prefix}{connector}{name}{_command_signature(item)}  # {_short_help(item)}")
+            if isinstance(item, click.Group) and item.commands:
+                walk(_group_items(item), child_prefix)
+
+    walk(root_items)
+    return "\n".join(lines)
+
+
+def _tree_callback(ctx: click.Context, _param: click.Option, value: bool) -> None:
+    if not value or ctx.resilient_parsing:
+        return
+    if not isinstance(ctx.command, click.Group):
+        raise click.ClickException("--tree is only available on command groups")
+    click.echo(render_cli_tree(ctx.command))
+    ctx.exit()
+
+
 @click.group(name="chatenv", cls=OrderedGroup)
 @click.version_option(__version__, prog_name="chatenv")
+@click.option(
+    "--tree",
+    is_flag=True,
+    is_eager=True,
+    expose_value=False,
+    callback=_tree_callback,
+    help="Print the registered command tree.",
+)
 @click.option("--home", type=click.Path(file_okay=False, path_type=Path), help="Override CHATARCH_HOME for this command.")
 @click.pass_context
 def cli(ctx: click.Context, home: Path | None):

{chatenv-0.2.3 → chatenv-0.2.4/src/chatenv.egg-info}/PKG-INFO

@@ -1,9 +1,12 @@
 Metadata-Version: 2.4
 Name: chatenv
-Version: 0.2.3
+Version: 0.2.4
 Summary: ChatArch typed environment profile manager
 Author-email: rexwzh <1073853456@qq.com>
 License-Expression: MIT
+Project-URL: Homepage, https://github.com/ChatArch/ChatEnv
+Project-URL: Repository, https://github.com/ChatArch/ChatEnv
+Project-URL: Documentation, https://chatarch.github.io/ChatEnv/
 Keywords: chatenv,chatarch,env
 Classifier: Programming Language :: Python :: 3
 Classifier: Operating System :: OS Independent
@@ -18,11 +21,11 @@ Requires-Dist: build>=1.0; extra == "dev"
 Requires-Dist: pytest>=8.0; extra == "dev"
 Requires-Dist: twine>=5.0; extra == "dev"
 Provides-Extra: docs
-Requires-Dist: mkdocs>=1.6; extra == "docs"
-Requires-Dist: mkdocs-material>=9.5; extra == "docs"
-Requires-Dist: mkdocs-minify-plugin>=0.8; extra == "docs"
-Requires-Dist: mkdocs-redirects>=1.2; extra == "docs"
-Requires-Dist: mike>=2.1; extra == "docs"
+Requires-Dist: mkdocs<2.0,>=1.6; extra == "docs"
+Requires-Dist: mkdocs-material<9.7,>=9.5; extra == "docs"
+Requires-Dist: mkdocs-minify-plugin<1.0,>=0.8; extra == "docs"
+Requires-Dist: mkdocs-redirects<2.0,>=1.2; extra == "docs"
+Requires-Dist: mike<3.0,>=2.1; extra == "docs"
 Dynamic: license-file
 
 <div align="center">
@@ -87,6 +90,7 @@ $CHATARCH_HOME/envs/
 
 ```bash
 chatenv --version
+chatenv --tree
 chatenv init -t example
 chatenv status
 chatenv status --detail
@@ -114,6 +118,8 @@ export CHATARCH_AUTO_PROMPT=false
 
 此时只有缺少必要参数的命令会直接报错；参数已经足够的命令行为不变。
 
+`chatenv --tree` 可从当前安装包的 Click 注册表实时输出完整命令树，用于验收和脚本 readback。
+
 更多用法见 `docs/cli.md`。
 
 ## Paste

{chatenv-0.2.3 → chatenv-0.2.4}/src/chatenv.egg-info/requires.txt

@@ -8,8 +8,8 @@ pytest>=8.0
 twine>=5.0
 
 [docs]
-mkdocs>=1.6
-mkdocs-material>=9.5
-mkdocs-minify-plugin>=0.8
-mkdocs-redirects>=1.2
-mike>=2.1
+mkdocs<2.0,>=1.6
+mkdocs-material<9.7,>=9.5
+mkdocs-minify-plugin<1.0,>=0.8
+mkdocs-redirects<2.0,>=1.2
+mike<3.0,>=2.1

chatenv-0.2.4/tests/test_version.py

@@ -0,0 +1,44 @@
+from chatenv import __version__
+from chatenv.cli import cli
+from click.testing import CliRunner
+
+
+def test_version_present():
+    assert __version__ == "0.2.4"
+
+
+def test_cli_version_option():
+    result = CliRunner().invoke(cli, ["--version"])
+
+    assert result.exit_code == 0
+    assert __version__ in result.output
+
+
+def test_help_lists_tree_option():
+    result = CliRunner().invoke(cli, ["--help"])
+
+    assert result.exit_code == 0
+    assert "--tree" in result.output
+
+
+def test_tree_option_renders_registered_command_surface():
+    result = CliRunner().invoke(cli, ["--tree"])
+
+    assert result.exit_code == 0
+    assert "chatenv [--home <HOME>]  # Manage typed env profiles" in result.output
+    assert "├── --help" in result.output
+    assert "├── --version" in result.output
+    assert "├── --tree" in result.output
+    assert "├── init" in result.output
+    assert "├── new [NAME]" in result.output
+    assert "├── paste" in result.output
+    assert "├── use [NAME]" in result.output
+    assert "├── list" in result.output
+    assert "├── status" in result.output
+    assert "├── cat [NAME]" in result.output
+    assert "├── get [KEY]" in result.output
+    assert "├── set [KEY-VALUE]" in result.output
+    assert "├── save [NAME]" in result.output
+    assert "├── delete [NAME]" in result.output
+    assert "└── test" in result.output
+    assert "hello" not in result.output.lower()

chatenv-0.2.3/tests/test_version.py

@@ -1,14 +0,0 @@
-from chatenv import __version__
-from chatenv.cli import cli
-from click.testing import CliRunner
-
-
-def test_version_present():
-    assert __version__ == "0.2.3"
-
-
-def test_cli_version_option():
-    result = CliRunner().invoke(cli, ["--version"])
-
-    assert result.exit_code == 0
-    assert __version__ in result.output