cli.md•2.33 kB
# CLI Reference
```python exec="1" idprefix=""
import argparse
import re
from pdm.core import Core
parser = Core().parser
MONOSPACED = ("pyproject.toml", "pdm.lock", ".pdm-python", ":pre", ":post", ":all")
def clean_help(help: str) -> str:
# Make dunders monospaced avoiding italic markdown rendering
help = re.sub(r"__([\w\d\_]+)__", r"`__\1__`", help)
# Make env vars monospaced
help = re.sub(r"env var: ([A-Z_]+)", r"env var: `\1`", help)
for monospaced in MONOSPACED:
help = re.sub(rf"\s(['\"]?{monospaced}['\"]?)", f"`{monospaced}`", help)
return help
def render_parser(
parser: argparse.ArgumentParser, title: str, heading_level: int = 2
) -> str:
"""Render the parser help documents as a string."""
result = [f"{'#' * heading_level} {title}\n"]
if parser.description and title != "pdm":
result.append("> " + parser.description + "\n")
for group in sorted(
parser._action_groups, key=lambda g: g.title.lower(), reverse=True
):
if not any(
bool(action.option_strings or action.dest)
or isinstance(action, argparse._SubParsersAction)
for action in group._group_actions
):
continue
result.append(f"{group.title.title()}:\n")
for action in group._group_actions:
if isinstance(action, argparse._SubParsersAction):
for name, subparser in action._name_parser_map.items():
result.append(render_parser(subparser, name, heading_level + 1))
continue
opts = [f"`{opt}`" for opt in action.option_strings]
if not opts:
line = f"- `{action.dest}`"
else:
line = f"- {', '.join(opts)}"
if action.metavar:
line += f" `{action.metavar}`"
line += f": {clean_help(action.help)}"
if action.default and action.default != argparse.SUPPRESS:
default = action.default
if any(opt.startswith("--no-") for opt in action.option_strings) and default is True:
default = not default
line += f" (default: `{default}`)"
result.append(line)
result.append("")
return "\n".join(result)
print(render_parser(parser, "pdm"))
```