cloup._util
¶
Generic utilities.
Classes¶
|
|
A class used just as frozen namespace for constants. |
Functions¶
|
|
|
|
|
|
|
Generate repr(obj). |
|
|
|
|
|
Return the first value that is not |
|
Return the first bool (or raises |
|
|
|
|
|
|
|
|
|
Attributes¶
Contents¶
- cloup._util.click_version_tuple¶
- cloup._util.click_major¶
- cloup._util.click_minor¶
- cloup._util.click_version_ge_8_1¶
- cloup._util.T¶
- cloup._util.K¶
- cloup._util.V¶
- cloup._util.pick_non_missing(d)[source]¶
- Parameters:
d (Dict[K, Union[_Missing, V]]) –
- Return type:
Dict[K, V]
- cloup._util.check_arg(condition, msg='')[source]¶
- Parameters:
condition (bool) –
msg (str) –
- Return type:
None
- cloup._util.indent_lines(lines, width=2)[source]¶
- Parameters:
lines (Iterable[str]) –
width (int) –
- Return type:
List[str]
- cloup._util.make_repr(obj, *args, _line_len=60, _indent=2, **kwargs)[source]¶
Generate repr(obj).
- Parameters:
obj (Any) – object to represent
args (Any) – positional arguments in the repr
_line_len (int) – if the repr length exceeds this, arguments will be on their own line; if negative, the repr will be in a single line regardless of its length
_indent (int) – indentation width of arguments in case they are shown in their own line
kwargs (Any) – keyword arguments in the repr
- Returns:
str
- Return type:
str
- cloup._util.make_one_line_repr(obj, *args, **kwargs)[source]¶
- Parameters:
obj (object) –
args (Any) –
kwargs (Any) –
- Return type:
str
- cloup._util.pluralize(count, zero='', one='', many='')[source]¶
- Parameters:
count (int) –
zero (str) –
one (str) –
many (str) –
- Return type:
str
- cloup._util.coalesce(*values)[source]¶
Return the first value that is not
None
(orNone
if no such value exists).- Parameters:
values (Optional[T]) –
- Return type:
Optional[T]
- cloup._util.first_bool(*values)[source]¶
Return the first bool (or raises
StopIteration
if no bool is found).- Parameters:
values (Any) –
- Return type:
bool
- cloup._util.pick_not_none(iterable)[source]¶
- Parameters:
iterable (Iterable[Optional[T]]) –
- Return type:
List[T]
- cloup._util.check_positive_int(value, arg_name)[source]¶
- Parameters:
value (Any) –
arg_name (str) –
- Return type:
None
- class cloup._util.FrozenSpaceMeta(*args)[source]¶
Bases:
type
- Parameters:
args (Any) –