cloup.constraints.conditions

This modules contains predicates with an associated description that you can use as conditions of conditional constraints (see cloup.constraints.If).

Predicates should be treated as immutable objects, even though immutability is not (at the moment) enforced.

Classes

Predicate

A Callable that takes a click.Context and returns a boolean, with an

Not

Logical NOT of a predicate.

IsSet

True if the parameter is set.

AllSet

True if all listed parameters are set.

AnySet

True if any of the listed parameters is set.

Equal

True if the parameter value equals value.

Attributes

P

Contents

cloup.constraints.conditions.P
class cloup.constraints.conditions.Predicate[source]

Bases: abc.ABC

A Callable that takes a click.Context and returns a boolean, with an associated description. Meant to be used as condition in a conditional constraint (see If).

abstract description(ctx)[source]

Succinct description of the predicate (alias: desc).

Parameters:

ctx (click.Context)

Return type:

str

negated_description(ctx)[source]

Succinct description of the negation of this predicate (alias: neg_desc).

Parameters:

ctx (click.Context)

Return type:

str

desc(ctx)[source]

Short alias for description().

Parameters:

ctx (click.Context)

Return type:

str

neg_desc(ctx)[source]

Short alias for negated_description().

Parameters:

ctx (click.Context)

Return type:

str

negated()[source]
Return type:

Predicate

abstract __call__(ctx)[source]

Evaluate the predicate on the given context.

Parameters:

ctx (click.Context)

Return type:

bool

__invert__()[source]
Return type:

Predicate

__or__(other)[source]
Parameters:

other (Predicate)

Return type:

Predicate

__and__(other)[source]
Parameters:

other (Predicate)

Return type:

Predicate

__repr__()[source]
Return type:

str

__eq__(other)[source]
Parameters:

other (object)

Return type:

bool

class cloup.constraints.conditions.Not(predicate)[source]

Bases: Predicate, Generic[P]

Logical NOT of a predicate.

Parameters:

predicate (P)

predicate
description(ctx)[source]

Succinct description of the predicate (alias: desc).

Parameters:

ctx (click.Context)

Return type:

str

negated_description(ctx)[source]

Succinct description of the negation of this predicate (alias: neg_desc).

Parameters:

ctx (click.Context)

Return type:

str

__call__(ctx)[source]

Evaluate the predicate on the given context.

Parameters:

ctx (click.Context)

Return type:

bool

__invert__()[source]
Return type:

P

__repr__()[source]
Return type:

str

class cloup.constraints.conditions.IsSet(param_name)[source]

Bases: Predicate

True if the parameter is set.

Parameters:

param_name (str)

param_name
description(ctx)[source]

Succinct description of the predicate (alias: desc).

Parameters:

ctx (click.Context)

Return type:

str

negated_description(ctx)[source]

Succinct description of the negation of this predicate (alias: neg_desc).

Parameters:

ctx (click.Context)

Return type:

str

__call__(ctx)[source]

Evaluate the predicate on the given context.

Parameters:

ctx (click.Context)

Return type:

bool

__and__(other)[source]
Parameters:

other (Predicate)

Return type:

Predicate

__or__(other)[source]
Parameters:

other (Predicate)

Return type:

Predicate

class cloup.constraints.conditions.AllSet(*param_names)[source]

Bases: Predicate

True if all listed parameters are set.

Added in version 0.8.0.

Parameters:

param_names (str)

param_names = ()
negated_description(ctx)[source]

Succinct description of the negation of this predicate (alias: neg_desc).

Parameters:

ctx (click.Context)

Return type:

str

description(ctx)[source]

Succinct description of the predicate (alias: desc).

Parameters:

ctx (click.Context)

Return type:

str

__call__(ctx)[source]

Evaluate the predicate on the given context.

Parameters:

ctx (click.Context)

Return type:

bool

__and__(other)[source]
Parameters:

other (Predicate)

Return type:

Predicate

class cloup.constraints.conditions.AnySet(*param_names)[source]

Bases: Predicate

True if any of the listed parameters is set.

Added in version 0.8.0.

Parameters:

param_names (str)

param_names = ()
negated_description(ctx)[source]

Succinct description of the negation of this predicate (alias: neg_desc).

Parameters:

ctx (click.Context)

Return type:

str

description(ctx)[source]

Succinct description of the predicate (alias: desc).

Parameters:

ctx (click.Context)

Return type:

str

__call__(ctx)[source]

Evaluate the predicate on the given context.

Parameters:

ctx (click.Context)

Return type:

bool

__or__(other)[source]
Parameters:

other (Predicate)

Return type:

Predicate

class cloup.constraints.conditions.Equal(param_name, value)[source]

Bases: Predicate

True if the parameter value equals value.

Parameters:

  • param_name (str)

  • value (Any)

param_name
value
description(ctx)[source]

Succinct description of the predicate (alias: desc).

Parameters:

ctx (click.Context)

Return type:

str

negated_description(ctx)[source]

Succinct description of the negation of this predicate (alias: neg_desc).

Parameters:

ctx (click.Context)

Return type:

str

__call__(ctx)[source]

Evaluate the predicate on the given context.

Parameters:

ctx (click.Context)

Return type:

bool