click-option-group

click-option-group is a Click-extension package that adds option groups missing in Click.

Aim and Motivation

Click is a package for creating powerful and beautiful command line interfaces (CLI) in Python, but it has no the functionality for creating option groups.

Option groups are convenient mechanism for logical structuring CLI, also it allows you to set the specific behavior and set the relationship among grouped options (mutually exclusive options for example). Moreover, argparse stdlib package contains this functionality out of the box.

At the same time, many Click users need this functionality. You can read interesting discussions about it in the following issues:

• issue 257
• issue 373
• issue 509
• issue 1137

The aim of this package is to provide group options with extensible functionality using canonical and clean API (Click-like API as far as possible).

Quickstart

Installing

Install and update using pip:

pip install -U click-option-group

A Simple Example

Here is a simple example how to use option groups in your Click-based CLI. Just use optgroup for declaring option groups by decorating your command function in Click-like API style.

# app.py

import click
from click_option_group import optgroup, RequiredMutuallyExclusiveOptionGroup

@click.command()
@optgroup.group('Server configuration', 
                help='The configuration of some server connection')
@optgroup.option('-h', '--host', default='localhost', help='Server host name')
@optgroup.option('-p', '--port', type=int, default=8888, help='Server port')
@optgroup.option('-n', '--attempts', type=int, default=3, help='The number of connection attempts')
@optgroup.option('-t', '--timeout', type=int, default=30, help='The server response timeout')
@optgroup.group('Input data sources', cls=RequiredMutuallyExclusiveOptionGroup, 
                help='The sources of the input data')
@optgroup.option('--tsv-file', type=click.File(), help='CSV/TSV input data file')
@optgroup.option('--json-file', type=click.File(), help='JSON input data file')
@click.option('--debug/--no-debug', default=False, help='Debug flag')
def cli(**params):
    print(params)

if __name__ == '__main__':
    cli()

$ python app.py --help
Usage: app.py [OPTIONS]

Options:
  Server configuration:           The configuration of some server connection
    -h, --host TEXT               Server host name
    -p, --port INTEGER            Server port
    -n, --attempts INTEGER        The number of connection attempts
    -t, --timeout INTEGER         The server response timeout
  Input data sources: [mutually_exclusive, required]
                                  The sources of the input data
    --tsv-file FILENAME           CSV/TSV input data file
    --json-file FILENAME          JSON input data file
  --debug / --no-debug            Debug flag
  --help                          Show this message and exit.

Documentation

https://click-option-group.readthedocs.io

Changelog

v0.5.4 (12.10.2022)

• Move frame gathering into error code path (PR #34)
• Fix typos (PR #37)
• PEP 561 support (PR #42)
• Update docs dependencies and Travis CI Python version matrix (PR #43)

v0.5.3 (14.05.2021)

• Update Click dependency version to <9 (Issue #33)

v0.5.2 (28.11.2020)

• Do not use default option group name. An empty group name will not be displayed
• Slightly edited error messages
• All arguments except name in optgroup decorator must be keyword-only

v0.5.1 (14.06.2020)

• Fix incompatibility with autocomplete: out of the box Click completion and click-repl (Issue #14)

v0.5.0 (10.06.2020)

• Add AllOptionGroup class: all options from the group must be set or none must be set (PR #13)
• Fix type hints
• Update docs

v0.4.0 (18.05.2020)

• Support multi-layer wrapped functions (PR #10)
• Fix flake8 issues

v0.3.1

• Add hidden=True to _GroupTitleFakeOption as a temporary workaroud for issue #4

v0.3.0

• Add support for hidden options inside groups (PR #2)

v0.2.3

• Transfer the repo to click-contrib organisation

v0.2.2

• Add true lineno in warning when declaring empty option group
• Update readme

v0.2.1

• Use RuntimeWarning and stacklevel 2 when declaring empty option group
• Update readme

v0.2.0

• Implement RequiredMutuallyExclusiveOptionGroup class instead of required argument for MutuallyExclusiveOptionGroup
• Add tests with 100% coverage
• Update readme

v0.1.0

• First public release