Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

(experimental) Propagate helptext into subcommands #227

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

(experimental) Propagate helptext into subcommands #227

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c5c8798
Propagate group helptext into subcommands
brentyi Jan 8, 2025
240be27
nit
brentyi Jan 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/tyro/_cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -398,7 +398,7 @@ def _cli_impl(
parser._parsing_known_args = return_unknown_args
parser._console_outputs = console_outputs
parser._args = args
parser_spec.apply(parser, force_required_subparsers=False)
parser_spec.apply(parser, force_required_subparsers=False, parent=None)

# Print help message when no arguments are passed in. (but arguments are
# expected)
Expand Down
54 changes: 34 additions & 20 deletions src/tyro/_parsers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,12 +116,28 @@ def from_callable_or_type(
extern_prefix=extern_prefix,
subcommand_prefix=subcommand_prefix,
)

if isinstance(field_out, _arguments.ArgumentDefinition):
# Handle single arguments.
args.append(field_out)
if field_out.lowered.required:
has_required_args = True
elif isinstance(field_out, SubparsersSpecification):
continue

# Helptext for this field; used as description for grouping
# arguments and not needed for fields that are handled via
# ArgumentDefinition.
#
# This should happen for both subparsers and nested parsers.
class_field_name = _strings.make_field_name(
[intern_prefix, field.intern_name]
)
if field.helptext is not None:
helptext_from_intern_prefixed_field_name[class_field_name] = (
field.helptext
)

if isinstance(field_out, SubparsersSpecification):
# Handle subparsers.
subparsers_from_prefix[field_out.intern_prefix] = field_out
subparsers = add_subparsers_to_leaves(subparsers, field_out)
Expand All @@ -130,6 +146,13 @@ def from_callable_or_type(
nested_parser = field_out
child_from_prefix[field_out.intern_prefix] = nested_parser

# If there's no helptext from the field, we can grab it from
# the callable (docstring) itself.
if field.helptext is None:
helptext_from_intern_prefixed_field_name[class_field_name] = (
_docstrings.get_callable_description(nested_parser.f)
)

if nested_parser.has_required_args:
has_required_args = True

Expand All @@ -142,19 +165,6 @@ def from_callable_or_type(
subparsers, nested_parser.subparsers
)

# Helptext for this field; used as description for grouping arguments.
class_field_name = _strings.make_field_name(
[intern_prefix, field.intern_name]
)
if field.helptext is not None:
helptext_from_intern_prefixed_field_name[class_field_name] = (
field.helptext
)
else:
helptext_from_intern_prefixed_field_name[class_field_name] = (
_docstrings.get_callable_description(nested_parser.f)
)

# If arguments are in an optional group, it indicates that the default_instance
# will be used if none of the arguments are passed in.
if (
Expand Down Expand Up @@ -190,7 +200,10 @@ def from_callable_or_type(
)

def apply(
self, parser: argparse.ArgumentParser, force_required_subparsers: bool
self,
parser: argparse.ArgumentParser,
force_required_subparsers: bool,
parent: ParserSpecification | None,
) -> Tuple[argparse.ArgumentParser, ...]:
"""Create defined arguments and subparsers."""

Expand All @@ -207,7 +220,7 @@ def apply(
# Create subparser tree.
subparser_group = None
if self.subparsers is not None:
leaves = self.subparsers.apply(parser, force_required_subparsers)
leaves = self.subparsers.apply(parser, self, force_required_subparsers)
subparser_group = parser._action_groups.pop()
else:
leaves = (parser,)
Expand All @@ -216,9 +229,9 @@ def apply(
# apply arguments to the intermediate parser or only on the leaves.
if self.consolidate_subcommand_args:
for leaf in leaves:
self.apply_args(leaf)
self.apply_args(leaf, parent=parent)
else:
self.apply_args(parser)
self.apply_args(parser, parent=parent)

if subparser_group is not None:
parser._action_groups.append(subparser_group)
Expand All @@ -237,7 +250,7 @@ def apply(
def apply_args(
self,
parser: argparse.ArgumentParser,
parent: ParserSpecification | None = None,
parent: ParserSpecification | None,
) -> None:
"""Create defined arguments and subparsers."""

Expand Down Expand Up @@ -629,6 +642,7 @@ def from_field(
def apply(
self,
parent_parser: argparse.ArgumentParser,
parent: ParserSpecification | None,
force_required_subparsers: bool,
) -> Tuple[argparse.ArgumentParser, ...]:
title = "subcommands"
Expand Down Expand Up @@ -690,7 +704,7 @@ def apply(
subparser._args = parent_parser._args

subparser_tree_leaves.extend(
subparser_def.apply(subparser, force_required_subparsers)
subparser_def.apply(subparser, force_required_subparsers, parent=parent)
)

return tuple(subparser_tree_leaves)
Expand Down
Loading