Dev: help: support multi level subcommands #1542
Conversation
nicholasyang2022
force-pushed
the
multilevel-help
branch
2 times, most recently
from
8463bc4 to
c85362e
Compare
Codecov ReportAttention: Patch coverage is
Additional details and impacted files
Flags with carried forward coverage won't be shown. Click here to find out more.
☔ View full report in Codecov by Sentry. |
nicholasyang2022
force-pushed
the
multilevel-help
branch
from
c85362e to
de9eabd
Compare
crmsh/help.py
Outdated
| self._cmd_args = cmd_args | ||
|
|
||
| @functools.cached_property | ||
| def long(self): |
There was a problem hiding this comment.
rename as long_help might look more descriptive
crmsh/help.py
Outdated
| args = ['crm'] | ||
| args.extend(self._cmd_args) | ||
| args.append('--help-without-redirect') | ||
| rc, stdout = ShellUtils.get_stdout(args, shell=False) |
There was a problem hiding this comment.
use get_stdout_stderr should be better for storing error msg
| return str(self) | ||
|
|
||
|
|
||
| class LazyHelpEntryFromCli(HelpEntry): |
crmsh/help.py
Outdated
| children: dict[str, typing.Self] | ||
|
|
||
| def is_leaf(self) -> bool: | ||
| return bool(self.children) |
There was a problem hiding this comment.
Typically, a leaf node is a node with, or without children?
There was a problem hiding this comment.
I removed this method as it is not used. In recursions, it is more straightforward to loop over children directly without checking whether it is a leaf node.
|
|
||
|
|
||
| @dataclasses.dataclass | ||
| class SubcommandTreeNode: |
There was a problem hiding this comment.
docstring needed for this new class
crmsh/help.py
Outdated
| return max_width | ||
|
|
||
|
|
||
| def _render_commmad_tree(out: io.StringIO, node: SubcommandTreeNode, indent: int): |
… separated subclass
so that they do not conflict with `_` in subcommands, such as `geo_init`.
so that it supports multiple levels of subcommands.
add an option `mix_stderr` to `ShellUtils.get_stdout_stderr` to allow mixing stdout and stderr stream.
nicholasyang2022
force-pushed
the
multilevel-help
branch
from
de9eabd to
4e8e1e2
Compare
2 participants
#1471 adds 3rd level subcommands to crmsh. However, the
helpmodule is hardcoded to uses 2 levels of subcommands. This pull request modifies thehelpmodule to support arbitrary levels of subcommands.It consists of 2 parts:
_, the subcommand level separators used incrm.8.adoc, with., to avoid ambiguity with_used in subcommand names (such asgeo_init).