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¶
A |
|
|
Logical NOT of a predicate. |
|
True if the parameter is set. |
|
True if all listed parameters are set. |
|
True if any of the listed parameters is set. |
|
True if the parameter value equals |
Contents¶
-
cloup.constraints.conditions.
P
¶
-
class
cloup.constraints.conditions.
Predicate
[source]¶ Bases:
abc.ABC
A
Callable
that takes aContext
and returns a boolean, with an associated description. Meant to be used as condition in a conditional constraint (seeIf
).-
abstract
description
(self, ctx)[source]¶ Succint description of the predicate (alias: desc).
- Parameters
ctx (click.Context) –
- Return type
-
negated_description
(self, ctx)[source]¶ Succint description of the negation of this predicate (alias: neg_desc).
- Parameters
ctx (click.Context) –
- Return type
-
desc
(self, ctx)[source]¶ Short alias for
description()
.- Parameters
ctx (click.Context) –
- Return type
-
neg_desc
(self, ctx)[source]¶ Short alias for
negated_description()
.- Parameters
ctx (click.Context) –
- Return type
-
abstract
__call__
(self, ctx)[source]¶ Evaluate the predicate on the given context.
- Parameters
ctx (click.Context) –
- Return type
-
abstract
-
class
cloup.constraints.conditions.
Not
(predicate)[source]¶ -
Logical NOT of a predicate.
-
description
(self, ctx)[source]¶ Succint description of the predicate (alias: desc).
- Parameters
ctx (click.Context) –
- Return type
-
negated_description
(self, ctx)[source]¶ Succint description of the negation of this predicate (alias: neg_desc).
- Parameters
ctx (click.Context) –
- Return type
-
__call__
(self, ctx)[source]¶ Evaluate the predicate on the given context.
- Parameters
ctx (click.Context) –
- Return type
-
-
class
cloup.constraints.conditions.
IsSet
(param_name)[source]¶ Bases:
Predicate
True if the parameter is set.
- Parameters
param_name (str) –
-
description
(self, ctx)[source]¶ Succint description of the predicate (alias: desc).
- Parameters
ctx (click.Context) –
- Return type
-
negated_description
(self, ctx)[source]¶ Succint description of the negation of this predicate (alias: neg_desc).
- Parameters
ctx (click.Context) –
- Return type
-
__call__
(self, ctx)[source]¶ Evaluate the predicate on the given context.
- Parameters
ctx (click.Context) –
- Return type
-
class
cloup.constraints.conditions.
AllSet
(*param_names)[source]¶ Bases:
Predicate
True if all listed parameters are set.
New in version 0.8.0.
- Parameters
param_names (str) –
-
negated_description
(self, ctx)[source]¶ Succint description of the negation of this predicate (alias: neg_desc).
- Parameters
ctx (click.Context) –
- Return type
-
description
(self, ctx)[source]¶ Succint description of the predicate (alias: desc).
- Parameters
ctx (click.Context) –
- Return type
-
__call__
(self, ctx)[source]¶ Evaluate the predicate on the given context.
- Parameters
ctx (click.Context) –
- Return type
-
class
cloup.constraints.conditions.
AnySet
(*param_names)[source]¶ Bases:
Predicate
True if any of the listed parameters is set.
New in version 0.8.0.
- Parameters
param_names (str) –
-
negated_description
(self, ctx)[source]¶ Succint description of the negation of this predicate (alias: neg_desc).
- Parameters
ctx (click.Context) –
- Return type
-
description
(self, ctx)[source]¶ Succint description of the predicate (alias: desc).
- Parameters
ctx (click.Context) –
- Return type
-
__call__
(self, ctx)[source]¶ Evaluate the predicate on the given context.
- Parameters
ctx (click.Context) –
- Return type
-
class
cloup.constraints.conditions.
Equal
(param_name, value)[source]¶ Bases:
Predicate
True if the parameter value equals
value
.- Parameters
param_name (str) –
value (Any) –
-
description
(self, ctx)[source]¶ Succint description of the predicate (alias: desc).
- Parameters
ctx (click.Context) –
- Return type
-
negated_description
(self, ctx)[source]¶ Succint description of the negation of this predicate (alias: neg_desc).
- Parameters
ctx (click.Context) –
- Return type
-
__call__
(self, ctx)[source]¶ Evaluate the predicate on the given context.
- Parameters
ctx (click.Context) –
- Return type