Can't access help of subcommands without going through parent's prompts

[philipsd6]

I have a script with subcommands that both require a username/password. I abstracted this to the parent. Here's a short example demonstrating the issue:

import click

@click.group()
@click.option('--username', default='admin', prompt=True)
@click.password_option()
def cli(username, password):
    """This is my parent description"""
    pass

@cli.command()
@click.option('--reference', help="I should be able to see this without entering a username and password.")
def subcommand(reference):
    """This is my subcommand"""
    pass

If you access the main help:

my_prog --help

It displays the help page without any prompting for username or password, as expected. However, if you try to access the help page for the subcommand:

my_prog subcommand --help

It prompts for username and password before displaying the help page of the subcommand. This makes sense, but it still isn't expected behavior by the end user. As my sample program says, I should be able to see help without entering a username and password.

What's the correct way to model my desired behavior? Do I have to move and duplicate the username and password prompt options into each of my sub commands?

[wbashir]

@philipsd6 Same issue, I was going to approach this problem by removing the prompt=True on the option and checking for the required options but realized that sub-commands would have to do the same. Is there no directive for Ignoring prompts on certain options

[dsully]

+1 for fixing this.

[ryanneufeld]

Have you tried using an eager option?
http://click.pocoo.org/3/options/#callbacks-and-eager-options

[wbashir]

@ryanneufeld This is a nice suggestion but how do you define that for the default provided --help option ?

http://click.pocoo.org/3/advanced/#callback-evaluation-order

[ryanneufeld]

@warsamebashir you can override the help command with your own.

[wbashir]

@ryanneufeld do you have an example of how we can do that. I couldn't find anything in the docs. Is it just the traditional @click.option decorator with the is_flag=True set ?

[mitsuhiko]

This is a tough one to fix and I am not sure if it will be entirely possible without causing more issues elsewhere. :(

[kflavin]

+1 for fixing this as well.

[vokal-isaac]

In a similar situation, instead of trying to pull the common behavior up to the group level, I defined a decorator that implemented the behavior and used that on the individual commands. For example, something like (I haven't actually checked that this code works...):

from functools import wraps

def needs_username_and_password(f):
    @wraps(f)
    @click.option('--username', default='admin', prompt=True)
    @click.password_option()
    def wrapper(*args, **kwargs):
        return f(*args, **kwargs)

@click.group()
def cli():
    """This is my parent description"""
    pass

@cli.command()
@click.option('--reference', help="I should be able to see this without entering a username and password.")
@needs_username_and_password
def subcommand(username, password, reference):
    """This is my subcommand"""
    pass

[druchoo]

Hey @vokal-isaac, thanks for your solution! It was throwing an error as-is for me but I was able to fix.

$ python -V; ./test.py subcommand --help
Python 2.7.15
Traceback (most recent call last):
  File "./test.py", line 25, in <module>
    @needs_username_and_password
  File "/usr/local/lib/python2.7/site-packages/click/decorators.py", line 170, in decorator
    _param_memo(f, OptionClass(param_decls, **attrs))
  File "/usr/local/lib/python2.7/site-packages/click/decorators.py", line 135, in _param_memo
    f.__click_params__ = []
AttributeError: 'NoneType' object has no attribute '__click_params__'

Adding return wrapper to needs_username_and_password resolved issue. Complete example:

#!/usr/bin/env python
# -*- coding: utf-8 -*-
import click

from functools import wraps


def needs_username_and_password(f):
    @wraps(f)
    @click.option('--username', default='admin', prompt=True)
    @click.password_option()
    def wrapper(*args, **kwargs):
        return f(*args, **kwargs)
    return wrapper # **** Added return ****


@click.group()
def cli():
    """This is my parent description"""
    pass


@cli.command()
@click.option('--reference', help="I should be able to see this without entering a username and password.")
@needs_username_and_password
def subcommand(username, password, reference):
    """This is my subcommand"""
    pass


if __name__ == '__main__':
    cli()