[Bug] unable to use hydra with click module

🐛 Bug

I tried to use hydra with click module for creating CLI tools, but got an error.

To reproduce

import click
import hydra


@click.command()
@click.option('--foo', default='foo')
def main(**kwargs):
    my_app()
    print('hoge')
    print(kwargs)


@hydra.main(config_path='config.yml')
def my_app(cfg):
    print(cfg.pretty())


if __name__ == '__main__':
    main()

** Stack trace/error message **

hydra.errors.MissingConfigException: Cannot find primary config file: config.yml
Search path:
	pkg://hydra.conf (from hydra)
	pkg://click (from main)

Expected Behavior

System information

• hydra-core==0.11.3
• Click==7.0
• python 3.6.10

Additional context

This error might be due to the arguement 3 of this line: https://github.com/facebookresearch/hydra/blob/2a9916133693247775472a4968904b7a05cca1c1/hydra/_internal/utils.py#L142

If I change this argument to -1, then it works well.

[tasercake]

Does Hydra offer anything analogous to Click’s group?

I’m used to doing:

@click.group()
def main():
    pass

@main.command()
def sub_command_1():
    # Sub-functionality

@main.command()
def sub_command_2():
    # Sub-functionality

in Click and was hoping to do something similar with Hydra.

The workaround I’m using for now involves setting a task key in my config and calling various functions according to its value, but that seems brittle compared to what Click offers.

[boweeb]

For anyone late to the party (like me), there is a supported way to decouple the CLI and thus use click and hydra together. I just discovered this project this morning so this may not be the best answer but the the “compose api” looks like the correct path.

Reference:

• Docs: Compose API
• Compose API Example