Require one constraint prevents subcommand help from working

[ryancausey]

Require one constraint prevents subcommand help from working

[janluke]

Thanks for the detailed report. I'll check if I can do something about this as soon as I can. Meanwhile, I want to suggest you an alternative, which is in my opinion more flexible and future-proof. My suggestion is to move the group arguments, especially if required, to the subcommands. This if more flexible since if tomorrow you want to add a command that doesn't require those credentials, you will be able to do it.

import cloup
from cloup.constraints import require_one


class Common:
    credentials = cloup.option_group(
        "credentials",
        cloup.option("--foo", help="foo"),
        cloup.option("--bar", help="bar"),
        constraint=require_one,
    )


@cloup.group()
def cli():
    """Top level group text."""
    pass


@cli.command()
@Common.credentials
def subcommand(foo, bar):
    """Subcommand help text."""


if __name__ == "__main__":
    cli()

[janluke]

Btw, Click has the same problem with required Group parameters:

import click

@click.group()
@click.option("--foo", help="foo", required=True)
def cli(foo):
    """Top level group text."""

@cli.command()
def subcommand():
    """Subcommand help text."""

if __name__ == "__main__":
    cli("subcommand --help".split())

I think required parameters at the Group level should probably be avoided.

[janluke]

No, the Cloup part is solvable and I'm going to push the fix.

[ryancausey]

That's a smart idea. I didn't think about giving the decorator a name and re-using it. Thanks!

[ryancausey]

So if this is a Click issue then, should this be closed?