gamesheet_sdk.common.cli.decorators module¶

Common CLI option decorators for all GameSheet CLIs.

gamesheet_sdk.common.cli.decorators.common_output_options(func)[source]¶

Add standard –format and –output options to command.

Parameters:: func (F) – The Click command function to decorate
Returns:: F – The decorated function with –format and –output options
Return type:: F

gamesheet_sdk.common.cli.decorators.columns_option(func)[source]¶

Add the –columns option that restricts output to a subset of keys.

One option covers both shapes of output: on a list it selects table columns, and on a get / create / update it selects fields of the single rendered object. Both are “show me only these keys”, so there is one name for it, and -f is left to mean --force everywhere.

Parameters:: func (F) – The Click command function to decorate.
Returns:: F – The decorated function with the –columns option.
Return type:: F