cloup.constraints.common

Useful functions used to implement constraints and predicates.

Functions

param_value_is_set(param, value)

Defines what it means for a parameter of a specific kind to be “set”.

get_param_name(param)

Returns the name of a parameter casted to str.

get_params_whose_value_is_set(params, values)

Filters params returning only the parameters that have a value.

get_required_params(params)

get_param_label(param)

join_param_labels(params[, sep])

join_with_and(strings[, sep])

format_param(param)

format_param_list(param_list[, indent])

param_label_by_name(ctx, name)

get_param_labels(ctx, param_names)

param_value_by_name(ctx, name)

Contents

cloup.constraints.common.param_value_is_set(param, value)[source]

Defines what it means for a parameter of a specific kind to be “set”.

All cases are obvious besides that of boolean options: - (common rule) if the value is None, the parameter is unset; - a parameter that takes multiple values is set if at least one argument is provided; - a boolean flag is set only if True; - a boolean option is set if not None, even if it’s False.

Parameters
Return type

bool

cloup.constraints.common.get_param_name(param)[source]

Returns the name of a parameter casted to str. Use this function to avoid typing errors in places where you expect a parameter having a name.

Parameters

param (click.core.Parameter) –

Return type

str

cloup.constraints.common.get_params_whose_value_is_set(params, values)[source]

Filters params returning only the parameters that have a value. Boolean flags are considered “set” if their value is True.

Parameters
Return type

List[click.core.Parameter]

cloup.constraints.common.get_required_params(params)[source]
Parameters

params (Iterable[click.core.Parameter]) –

Return type

List[click.core.Parameter]

cloup.constraints.common.get_param_label(param)[source]
Parameters

param (click.core.Parameter) –

Return type

str

cloup.constraints.common.join_param_labels(params, sep=', ')[source]
Parameters
Return type

str

cloup.constraints.common.join_with_and(strings, sep=', ')[source]
Parameters

  • strings (Sequence[str]) –

  • sep (str) –

Return type

str

cloup.constraints.common.format_param(param)[source]
Parameters

param (click.core.Parameter) –

Return type

str

cloup.constraints.common.format_param_list(param_list, indent=2)[source]
Parameters
Return type

str

cloup.constraints.common.param_label_by_name(ctx, name)[source]
Parameters

  • ctx (Any) –

  • name (str) –

Return type

str

cloup.constraints.common.get_param_labels(ctx, param_names)[source]
Parameters

  • ctx (Any) –

  • param_names (Iterable[str]) –

Return type

List[str]

cloup.constraints.common.param_value_by_name(ctx, name)[source]
Parameters
Return type

Any