Skip to content

Checkers

toolbox_python.checkers 🔗

is_*() functions🔗

is_value_of_type 🔗

is_value_of_type(
    value: Any, check_type: Union[type, tuple[type, ...]]
) -> bool

Summary

Check if a given value is of a specified type or types.

Details

This function is used to verify if a given value matches a specified type or any of the types in a tuple of types.

Parameters:

Name Type Description Default
value Any

The value to check.

required
check_type Union[type, tuple[type]]

The type or tuple of types to check against.

required

Returns:

Type Description
bool

True if the value is of the specified type or one of the specified types; False otherwise.

Examples

Check if a value is of a specific type:

Prepare data
1
2
>>> value = 42
>>> check_type = int

Example 1: Check if value is of type `#!py int`
1
>>> is_value_of_type(value, check_type)
Output
True

Conclusion: The value is of type int.

Example 2: Check if value is of type `#!py str`
1
>>> is_value_of_type(value, str)
Output
False

Conclusion: The value is not of type str.

See Also
Source code in src/toolbox_python/checkers.py
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
def is_value_of_type(
    value: Any,
    check_type: Union[type, tuple[type, ...]],
) -> bool:
    """
    !!! summary "Summary"
        Check if a given value is of a specified type or types.

    ???+ info "Details"
        This function is used to verify if a given value matches a specified type or any of the types in a tuple of types.

    Params:
        value (Any):
            The value to check.
        check_type (Union[type, tuple[type]]):
            The type or tuple of types to check against.

    Returns:
        (bool):
            `#!py True` if the value is of the specified type or one of the specified types; `#!py False` otherwise.

    ???+ example "Examples"

        Check if a value is of a specific type:

        ```{.py .python linenums="1" title="Prepare data"}
        >>> value = 42
        >>> check_type = int
        ```

        ```{.py .python linenums="1" title="Example 1: Check if value is of type `#!py int`"}
        >>> is_value_of_type(value, check_type)
        ```
        <div class="result" markdown>
        ```{.sh .shell title="Output"}
        True
        ```
        !!! success "Conclusion: The value is of type `#!py int`."

        </div>

        ```{.py .python linenums="1" title="Example 2: Check if value is of type `#!py str`"}
        >>> is_value_of_type(value, str)
        ```
        <div class="result" markdown>
        ```{.sh .shell title="Output"}
        False
        ```
        !!! failure "Conclusion: The value is not of type `#!py str`."

        </div>

    ??? tip "See Also"
        - [`is_value_of_type()`][toolbox_python.checkers.is_value_of_type]
        - [`is_type()`][toolbox_python.checkers.is_type]
    """
    return isinstance(value, check_type)

is_all_values_of_type 🔗

is_all_values_of_type(
    values: any_collection,
    check_type: Union[type, tuple[type, ...]],
) -> bool

Summary

Check if all values in an iterable are of a specified type or types.

Details

This function is used to verify if all values in a given iterable match a specified type or any of the types in a tuple of types.

Parameters:

Name Type Description Default
values any_collection

The iterable containing values to check.

required
check_type Union[type, tuple[type]]

The type or tuple of types to check against.

required

Returns:

Type Description
bool

True if all values are of the specified type or one of the specified types; False otherwise.

Examples

Check if all values in an iterable are of a specific type:

Prepare data
1
2
>>> values = [1, 2, 3]
>>> check_type = int

Example 1: Check if all values are of type `#!py int`
1
>>> is_all_values_of_type(values, check_type)
Output
True

Conclusion: All values are of type int.

Example 2: Check if all values are of type `#!py str`
1
>>> is_all_values_of_type(values, str)
Output
False

Conclusion: Not all values are of type str.

See Also
Source code in src/toolbox_python/checkers.py
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
def is_all_values_of_type(
    values: any_collection,
    check_type: Union[type, tuple[type, ...]],
) -> bool:
    """
    !!! summary "Summary"
        Check if all values in an iterable are of a specified type or types.

    ???+ info "Details"
        This function is used to verify if all values in a given iterable match a specified type or any of the types in a tuple of types.

    Params:
        values (any_collection):
            The iterable containing values to check.
        check_type (Union[type, tuple[type]]):
            The type or tuple of types to check against.

    Returns:
        (bool):
            `#!py True` if all values are of the specified type or one of the specified types; `#!py False` otherwise.

    ???+ example "Examples"

        Check if all values in an iterable are of a specific type:

        ```{.py .python linenums="1" title="Prepare data"}
        >>> values = [1, 2, 3]
        >>> check_type = int
        ```

        ```{.py .python linenums="1" title="Example 1: Check if all values are of type `#!py int`"}
        >>> is_all_values_of_type(values, check_type)
        ```
        <div class="result" markdown>
        ```{.sh .shell title="Output"}
        True
        ```
        !!! success "Conclusion: All values are of type `#!py int`."

        </div>

        ```{.py .python linenums="1" title="Example 2: Check if all values are of type `#!py str`"}
        >>> is_all_values_of_type(values, str)
        ```
        <div class="result" markdown>
        ```{.sh .shell title="Output"}
        False
        ```
        !!! failure "Conclusion: Not all values are of type `#!py str`."

        </div>

    ??? tip "See Also"
        - [`is_value_of_type()`][toolbox_python.checkers.is_value_of_type]
        - [`is_all_values_of_type()`][toolbox_python.checkers.is_all_values_of_type]
        - [`is_type()`][toolbox_python.checkers.is_type]
        - [`is_all_type()`][toolbox_python.checkers.is_all_type]
    """
    return all(isinstance(value, check_type) for value in values)

is_any_values_of_type 🔗

is_any_values_of_type(
    values: any_collection,
    check_type: Union[type, tuple[type, ...]],
) -> bool

Summary

Check if any value in an iterable is of a specified type or types.

Details

This function is used to verify if any value in a given iterable matches a specified type or any of the types in a tuple of types.

Parameters:

Name Type Description Default
values any_collection

The iterable containing values to check.

required
check_type Union[type, tuple[type]]

The type or tuple of types to check against.

required

Returns:

Type Description
bool

True if any value is of the specified type or one of the specified types; False otherwise.

Examples

Check if any value in an iterable is of a specific type:

Prepare data
1
2
>>> values = [1, 'a', 3.0]
>>> check_type = str

Example 1: Check if any value is of type `#!py str`
1
>>> is_any_values_of_type(values, check_type)
Output
True

Conclusion: At least one value is of type str.

Example 2: Check if any value is of type `#!py dict`
1
>>> is_any_values_of_type(values, dict)
Output
False

Conclusion: No values are of type dict.

See Also
Source code in src/toolbox_python/checkers.py
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
def is_any_values_of_type(
    values: any_collection,
    check_type: Union[type, tuple[type, ...]],
) -> bool:
    """
    !!! summary "Summary"
        Check if any value in an iterable is of a specified type or types.

    ???+ info "Details"
        This function is used to verify if any value in a given iterable matches a specified type or any of the types in a tuple of types.

    Params:
        values (any_collection):
            The iterable containing values to check.
        check_type (Union[type, tuple[type]]):
            The type or tuple of types to check against.

    Returns:
        (bool):
            `#!py True` if any value is of the specified type or one of the specified types; `#!py False` otherwise.

    ???+ example "Examples"

        Check if any value in an iterable is of a specific type:

        ```{.py .python linenums="1" title="Prepare data"}
        >>> values = [1, 'a', 3.0]
        >>> check_type = str
        ```

        ```{.py .python linenums="1" title="Example 1: Check if any value is of type `#!py str`"}
        >>> is_any_values_of_type(values, check_type)
        ```
        <div class="result" markdown>
        ```{.sh .shell title="Output"}
        True
        ```
        !!! success "Conclusion: At least one value is of type `#!py str`."

        </div>

        ```{.py .python linenums="1" title="Example 2: Check if any value is of type `#!py dict`"}
        >>> is_any_values_of_type(values, dict)
        ```
        <div class="result" markdown>
        ```{.sh .shell title="Output"}
        False
        ```
        !!! failure "Conclusion: No values are of type `#!py dict`."

        </div>

    ??? tip "See Also"
        - [`is_value_of_type()`][toolbox_python.checkers.is_value_of_type]
        - [`is_any_values_of_type()`][toolbox_python.checkers.is_any_values_of_type]
        - [`is_type()`][toolbox_python.checkers.is_type]
        - [`is_any_type()`][toolbox_python.checkers.is_any_type]
    """
    return any(isinstance(value, check_type) for value in values)

is_value_in_iterable 🔗

is_value_in_iterable(
    value: scalar, iterable: any_collection
) -> bool

Summary

Check if a given value is present in an iterable.

Details

This function is used to verify if a given value exists within an iterable such as a list, tuple, or set.

Parameters:

Name Type Description Default
value scalar

The value to check.

required
iterable any_collection

The iterable to check within.

required

Returns:

Type Description
bool

True if the value is found in the iterable; False otherwise.

Examples

Check if a value is in an iterable:

Prepare data
1
2
>>> value = 2
>>> iterable = [1, 2, 3]

Example 1: Check if value is in the iterable
1
>>> is_value_in_iterable(value, iterable)
Output
True

Conclusion: The value is in the iterable.

Example 2: Check if value is not in the iterable
1
>>> is_value_in_iterable(4, iterable)
Output
False

Conclusion: The value is not in the iterable.

See Also
Source code in src/toolbox_python/checkers.py
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
def is_value_in_iterable(
    value: scalar,
    iterable: any_collection,
) -> bool:
    """
    !!! summary "Summary"
        Check if a given value is present in an iterable.

    ???+ info "Details"
        This function is used to verify if a given value exists within an iterable such as a list, tuple, or set.

    Params:
        value (scalar):
            The value to check.
        iterable (any_collection):
            The iterable to check within.

    Returns:
        (bool):
            `#!py True` if the value is found in the iterable; `#!py False` otherwise.

    ???+ example "Examples"

        Check if a value is in an iterable:

        ```{.py .python linenums="1" title="Prepare data"}
        >>> value = 2
        >>> iterable = [1, 2, 3]
        ```

        ```{.py .python linenums="1" title="Example 1: Check if value is in the iterable"}
        >>> is_value_in_iterable(value, iterable)
        ```
        <div class="result" markdown>
        ```{.sh .shell title="Output"}
        True
        ```
        !!! success "Conclusion: The value is in the iterable."

        </div>

        ```{.py .python linenums="1" title="Example 2: Check if value is not in the iterable"}
        >>> is_value_in_iterable(4, iterable)
        ```
        <div class="result" markdown>
        ```{.sh .shell title="Output"}
        False
        ```
        !!! failure "Conclusion: The value is not in the iterable."

        </div>

    ??? tip "See Also"
        - [`is_value_in_iterable()`][toolbox_python.checkers.is_value_in_iterable]
        - [`is_in()`][toolbox_python.checkers.is_in]
    """
    return value in iterable

is_all_values_in_iterable 🔗

is_all_values_in_iterable(
    values: any_collection, iterable: any_collection
) -> bool

Summary

Check if all values in an iterable are present in another iterable.

Details

This function is used to verify if all values in a given iterable exist within another iterable.

Parameters:

Name Type Description Default
values any_collection

The iterable containing values to check.

required
iterable any_collection

The iterable to check within.

required

Returns:

Type Description
bool

True if all values are found in the iterable; False otherwise.

Examples

Check if all values in an iterable are present in another iterable:

Prepare data
1
2
>>> values = [1, 2]
>>> iterable = [1, 2, 3]

Example 1: Check if all values are in the iterable
1
>>> is_all_values_in_iterable(values, iterable)
Output
True

Conclusion: All values are in the iterable.

Example 2: Check if all values are not in the iterable
1
>>> is_all_values_in_iterable([1, 4], iterable)
Output
False

Conclusion: Not all values are in the iterable.

See Also
Source code in src/toolbox_python/checkers.py
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
def is_all_values_in_iterable(
    values: any_collection,
    iterable: any_collection,
) -> bool:
    """
    !!! summary "Summary"
        Check if all values in an iterable are present in another iterable.

    ???+ info "Details"
        This function is used to verify if all values in a given iterable exist within another iterable.

    Params:
        values (any_collection):
            The iterable containing values to check.
        iterable (any_collection):
            The iterable to check within.

    Returns:
        (bool):
            `#!py True` if all values are found in the iterable; `#!py False` otherwise.

    ???+ example "Examples"

        Check if all values in an iterable are present in another iterable:

        ```{.py .python linenums="1" title="Prepare data"}
        >>> values = [1, 2]
        >>> iterable = [1, 2, 3]
        ```

        ```{.py .python linenums="1" title="Example 1: Check if all values are in the iterable"}
        >>> is_all_values_in_iterable(values, iterable)
        ```
        <div class="result" markdown>
        ```{.sh .shell title="Output"}
        True
        ```
        !!! success "Conclusion: All values are in the iterable."

        </div>

        ```{.py .python linenums="1" title="Example 2: Check if all values are not in the iterable"}
        >>> is_all_values_in_iterable([1, 4], iterable)
        ```
        <div class="result" markdown>
        ```{.sh .shell title="Output"}
        False
        ```
        !!! failure "Conclusion: Not all values are in the iterable."

        </div>

    ??? tip "See Also"
        - [`is_value_in_iterable()`][toolbox_python.checkers.is_value_in_iterable]
        - [`is_all_values_of_type()`][toolbox_python.checkers.is_all_values_of_type]
        - [`is_in()`][toolbox_python.checkers.is_in]
        - [`is_all_in()`][toolbox_python.checkers.is_all_in]
    """
    return all(value in iterable for value in values)

is_any_values_in_iterable 🔗

is_any_values_in_iterable(
    values: any_collection, iterable: any_collection
) -> bool

Summary

Check if any value in an iterable is present in another iterable.

Details

This function is used to verify if any value in a given iterable exists within another iterable.

Parameters:

Name Type Description Default
values any_collection

The iterable containing values to check.

required
iterable any_collection

The iterable to check within.

required

Returns:

Type Description
bool

True if any value is found in the iterable; False otherwise.

Examples

Check if any value in an iterable is present in another iterable:

Prepare data
1
2
>>> values = [1, 4]
>>> iterable = [1, 2, 3]

Example 1: Check if any value is in the iterable
1
>>> is_any_values_in_iterable(values, iterable)
Output
True

Conclusion: At least one value is in the iterable.

Example 2: Check if any value is not in the iterable
1
>>> is_any_values_in_iterable([4, 5], iterable)
Output
False

Conclusion: None of the values are in the iterable.

See Also
Source code in src/toolbox_python/checkers.py
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
def is_any_values_in_iterable(
    values: any_collection,
    iterable: any_collection,
) -> bool:
    """
    !!! summary "Summary"
        Check if any value in an iterable is present in another iterable.

    ???+ info "Details"
        This function is used to verify if any value in a given iterable exists within another iterable.

    Params:
        values (any_collection):
            The iterable containing values to check.
        iterable (any_collection):
            The iterable to check within.

    Returns:
        (bool):
            `#!py True` if any value is found in the iterable; `#!py False` otherwise.

    ???+ example "Examples"

        Check if any value in an iterable is present in another iterable:

        ```{.py .python linenums="1" title="Prepare data"}
        >>> values = [1, 4]
        >>> iterable = [1, 2, 3]
        ```

        ```{.py .python linenums="1" title="Example 1: Check if any value is in the iterable"}
        >>> is_any_values_in_iterable(values, iterable)
        ```
        <div class="result" markdown>
        ```{.sh .shell title="Output"}
        True
        ```
        !!! success "Conclusion: At least one value is in the iterable."

        </div>

        ```{.py .python linenums="1" title="Example 2: Check if any value is not in the iterable"}
        >>> is_any_values_in_iterable([4, 5], iterable)
        ```
        <div class="result" markdown>
        ```{.sh .shell title="Output"}
        False
        ```
        !!! failure "Conclusion: None of the values are in the iterable."

        </div>

    ??? tip "See Also"
        - [`is_value_in_iterable()`][toolbox_python.checkers.is_value_in_iterable]
        - [`is_any_values_of_type()`][toolbox_python.checkers.is_any_values_of_type]
        - [`is_in()`][toolbox_python.checkers.is_in]
        - [`is_any_in()`][toolbox_python.checkers.is_any_in]
    """
    return any(value in iterable for value in values)

is_*() function aliases🔗

is_type module-attribute 🔗

is_type = is_value_of_type

is_all_type module-attribute 🔗

is_all_type = is_all_values_of_type

is_any_type module-attribute 🔗

is_any_type = is_any_values_of_type

is_in module-attribute 🔗

is_in = is_value_in_iterable

is_any_in module-attribute 🔗

is_any_in = is_any_values_in_iterable

is_all_in module-attribute 🔗

is_all_in = is_all_values_in_iterable

assert_*() functions🔗

assert_value_of_type 🔗

assert_value_of_type(
    value: Any, check_type: Union[type, tuple[type, ...]]
) -> None

Summary

Assert that a given value is of a specified type or types.

Details

This function is used to assert that a given value matches a specified type or any of the types in a tuple of types. If the value does not match the specified type(s), a TypeError is raised.

Parameters:

Name Type Description Default
value Any

The value to check.

required
check_type Union[type, tuple[type]]

The type or tuple of types to check against.

required

Raises:

Type Description
TypeError

If the value is not of the specified type or one of the specified types.

Examples

Assert that a value is of a specific type:

Prepare data
1
2
>>> value = 42
>>> check_type = int

Example 1: Assert that value is of type int
1
>>> assert_value_of_type(value, check_type)
Output
(no output, no exception raised)

Conclusion: The value is of type int.

Example 2: Assert that value is of type str
1
>>> assert_value_of_type(value, str)
Output
Traceback (most recent call last):
  ...
TypeError: Value '42' is not correct type: 'int'. Must be: 'str'

Conclusion: The value is not of type str.

Example 3: Assert that value is of type int or float
1
>>> assert_value_of_type(value, (int, float))
Output
(no output, no exception raised)

Conclusion: The value is of type int or float.

Example 4: Assert that value is of type str or dict
1
>>> assert_value_of_type(value, (str, dict))
Output
Traceback (most recent call last):
  ...
TypeError: Value '42' is not correct type: 'int'. Must be: 'str' or 'dict'.

Conclusion: The value is not of type str or dict.

See Also
Source code in src/toolbox_python/checkers.py
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
def assert_value_of_type(
    value: Any,
    check_type: Union[type, tuple[type, ...]],
) -> None:
    """
    !!! summary "Summary"
        Assert that a given value is of a specified type or types.

    ???+ info "Details"
        This function is used to assert that a given value matches a specified type or any of the types in a tuple of types. If the value does not match the specified type(s), a `#!py TypeError` is raised.

    Params:
        value (Any):
            The value to check.
        check_type (Union[type, tuple[type]]):
            The type or tuple of types to check against.

    Raises:
        (TypeError):
            If the value is not of the specified type or one of the specified types.

    ???+ example "Examples"

        Assert that a value is of a specific type:

        ```{.py .python linenums="1" title="Prepare data"}
        >>> value = 42
        >>> check_type = int
        ```

        ```{.py .python linenums="1" title="Example 1: Assert that value is of type int"}
        >>> assert_value_of_type(value, check_type)
        ```
        <div class="result" markdown>
        ```{.sh .shell title="Output"}
        (no output, no exception raised)
        ```
        !!! success "Conclusion: The value is of type `#!py int`."

        </div>

        ```{.py .python linenums="1" title="Example 2: Assert that value is of type str"}
        >>> assert_value_of_type(value, str)
        ```
        <div class="result" markdown>
        ```{.sh .shell title="Output"}
        Traceback (most recent call last):
          ...
        TypeError: Value '42' is not correct type: 'int'. Must be: 'str'
        ```
        !!! failure "Conclusion: The value is not of type `#!py str`."

        </div>

        ```{.py .python linenums="1" title="Example 3: Assert that value is of type int or float"}
        >>> assert_value_of_type(value, (int, float))
        ```
        <div class="result" markdown>
        ```{.sh .shell title="Output"}
        (no output, no exception raised)
        ```
        !!! success "Conclusion: The value is of type `#!py int` or `#!py float`."

        </div>

        ```{.py .python linenums="1" title="Example 4: Assert that value is of type str or dict"}
        >>> assert_value_of_type(value, (str, dict))
        ```
        <div class="result" markdown>
        ```{.sh .shell title="Output"}
        Traceback (most recent call last):
          ...
        TypeError: Value '42' is not correct type: 'int'. Must be: 'str' or 'dict'.
        ```
        !!! failure "Conclusion: The value is not of type `#!py str` or `#!py dict`."

        </div>

    ??? tip "See Also"
        - [`is_value_of_type()`][toolbox_python.checkers.is_value_of_type]
        - [`is_type()`][toolbox_python.checkers.is_type]
    """
    if not is_type(value=value, check_type=check_type):
        msg: str = f"Value '{value}' is not correct type: '{type(value).__name__}'. "
        if isinstance(check_type, type):
            msg += f"Must be: '{check_type.__name__}'."
        else:
            msg += f"Must be: '{' or '.join([typ.__name__ for typ in check_type])}'."
        raise TypeError(msg)

assert_all_values_of_type 🔗

assert_all_values_of_type(
    values: any_collection,
    check_type: Union[type, tuple[type, ...]],
) -> None

Summary

Assert that all values in an iterable are of a specified type or types.

Details

This function is used to assert that all values in a given iterable match a specified type or any of the types in a tuple of types. If any value does not match the specified type(s), a TypeError is raised.

Parameters:

Name Type Description Default
values any_collection

The iterable containing values to check.

required
check_type Union[type, tuple[type]]

The type or tuple of types to check against.

required

Raises:

Type Description
TypeError

If any value is not of the specified type or one of the specified types.

Examples

Assert that all values in an iterable are of a specific type:

Prepare data
1
2
>>> values = [1, 2, 3]
>>> check_type = int

Example 1: Assert that all values are of type int
1
>>> assert_all_values_of_type(values, check_type)
Output
(no output, no exception raised)

Conclusion: All values are of type int.

Example 2: Assert that all values are of type str
1
>>> assert_all_values_of_type(values, str)
Output
Traceback (most recent call last):
    ...
TypeError: Some elements [1, 2, 3] have the incorrect type ['int', 'int', 'int']. Must be 'str'

Conclusion: Not all values are of type str.

Example 3: Assert that all values are of type int or float
1
>>> assert_all_values_of_type(values, (int, float))
Output
(no output, no exception raised)

Conclusion: All values are of type int or float.

Example 4: Assert that all values are of type str or dict
1
>>> assert_all_values_of_type(values, (str, dict))
Output
Traceback (most recent call last):
    ...
TypeError: Some elements [1, 2, 3] have the incorrect type ['int', 'int', 'int']. Must be: 'str' or 'dict'

Conclusion: Not all values are of type str or dict.

See Also
Source code in src/toolbox_python/checkers.py
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
def assert_all_values_of_type(
    values: any_collection,
    check_type: Union[type, tuple[type, ...]],
) -> None:
    """
    !!! summary "Summary"
        Assert that all values in an iterable are of a specified type or types.

    ???+ info "Details"
        This function is used to assert that all values in a given iterable match a specified type or any of the types in a tuple of types. If any value does not match the specified type(s), a `#!py TypeError` is raised.

    Params:
        values (any_collection):
            The iterable containing values to check.
        check_type (Union[type, tuple[type]]):
            The type or tuple of types to check against.

    Raises:
        (TypeError):
            If any value is not of the specified type or one of the specified types.

    ???+ example "Examples"

        Assert that all values in an iterable are of a specific type:

        ```{.py .python linenums="1" title="Prepare data"}
        >>> values = [1, 2, 3]
        >>> check_type = int
        ```

        ```{.py .python linenums="1" title="Example 1: Assert that all values are of type int"}
        >>> assert_all_values_of_type(values, check_type)
        ```
        <div class="result" markdown>
        ```{.sh .shell title="Output"}
        (no output, no exception raised)
        ```
        !!! success "Conclusion: All values are of type `#!py int`."

        </div>

        ```{.py .python linenums="1" title="Example 2: Assert that all values are of type str"}
        >>> assert_all_values_of_type(values, str)
        ```
        <div class="result" markdown>
        ```{.sh .shell title="Output"}
        Traceback (most recent call last):
            ...
        TypeError: Some elements [1, 2, 3] have the incorrect type ['int', 'int', 'int']. Must be 'str'
        ```
        !!! failure "Conclusion: Not all values are of type `#!py str`."

        </div>

        ```{.py .python linenums="1" title="Example 3: Assert that all values are of type int or float"}
        >>> assert_all_values_of_type(values, (int, float))
        ```
        <div class="result" markdown>
        ```{.sh .shell title="Output"}
        (no output, no exception raised)
        ```
        !!! success "Conclusion: All values are of type `#!py int` or `#!py float`."

        </div>

        ```{.py .python linenums="1" title="Example 4: Assert that all values are of type str or dict"}
        >>> assert_all_values_of_type(values, (str, dict))
        ```
        <div class="result" markdown>
        ```{.sh .shell title="Output"}
        Traceback (most recent call last):
            ...
        TypeError: Some elements [1, 2, 3] have the incorrect type ['int', 'int', 'int']. Must be: 'str' or 'dict'
        ```
        !!! failure "Conclusion: Not all values are of type `#!py str` or `#!py dict`."

        </div>

    ??? tip "See Also"
        - [`is_value_of_type()`][toolbox_python.checkers.is_value_of_type]
        - [`is_all_values_of_type()`][toolbox_python.checkers.is_all_values_of_type]
        - [`is_type()`][toolbox_python.checkers.is_type]
        - [`is_all_type()`][toolbox_python.checkers.is_all_type]
    """
    if not is_all_type(values=values, check_type=check_type):
        invalid_values = [value for value in values if not is_type(value, check_type)]
        invalid_types = [
            f"'{type(value).__name__}'"
            for value in values
            if not is_type(value, check_type)
        ]
        msg: str = (
            f"Some elements {invalid_values} have the incorrect type {invalid_types}. "
        )
        if isinstance(check_type, type):
            msg += f"Must be '{check_type}'"
        else:
            types: str_list = [f"'{typ.__name__}'" for typ in check_type]
            msg += f"Must be: {' or '.join(types)}"
        raise TypeError(msg)

assert_any_values_of_type 🔗

assert_any_values_of_type(
    values: any_collection,
    check_type: Union[type, tuple[type, ...]],
) -> None

Summary

Assert that any value in an iterable is of a specified type or types.

Details

This function is used to assert that at least one value in a given iterable matches a specified type or any of the types in a tuple of types. If none of the values match the specified type(s), a TypeError is raised.

Parameters:

Name Type Description Default
values any_collection

The iterable containing values to check.

required
check_type Union[type, tuple[type]]

The type or tuple of types to check against.

required

Raises:

Type Description
TypeError

If none of the values are of the specified type or one of the specified types.

Examples

Assert that any value in an iterable is of a specific type:

Prepare data
1
2
>>> values = [1, 'a', 3.0]
>>> check_type = str

Example 1: Assert that any value is of type str
1
>>> assert_any_values_of_type(values, check_type)
Output
(no output, no exception raised)

Conclusion: At least one value is of type str.

Example 2: Assert that any value is of type dict
1
>>> assert_any_values_of_type(values, dict)
Output
Traceback (most recent call last):
    ...
TypeError: None of the elements in [1, 'a', 3.0] have the correct type. Must be: 'dict'

Conclusion: None of the values are of type dict.

Example 3: Assert that any value is of type int or float
1
>>> assert_any_values_of_type(values, (int, float))
Output
(no output, no exception raised)

Conclusion: At least one value is of type int or float.

Example 4: Assert that any value is of type dict or list
1
>>> assert_any_values_of_type(values, (dict, list))
Output
Traceback (most recent call last):
    ...
TypeError: None of the elements in [1, 'a', 3.0] have the correct type. Must be: 'dict' or 'list'

Conclusion: None of the values are of type dict or list.

See Also
Source code in src/toolbox_python/checkers.py
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
def assert_any_values_of_type(
    values: any_collection,
    check_type: Union[type, tuple[type, ...]],
) -> None:
    """
    !!! summary "Summary"
        Assert that any value in an iterable is of a specified type or types.

    ???+ info "Details"
        This function is used to assert that at least one value in a given iterable matches a specified type or any of the types in a tuple of types. If none of the values match the specified type(s), a `#!py TypeError` is raised.

    Params:
        values (any_collection):
            The iterable containing values to check.
        check_type (Union[type, tuple[type]]):
            The type or tuple of types to check against.

    Raises:
        (TypeError):
            If none of the values are of the specified type or one of the specified types.

    ???+ example "Examples"

        Assert that any value in an iterable is of a specific type:

        ```{.py .python linenums="1" title="Prepare data"}
        >>> values = [1, 'a', 3.0]
        >>> check_type = str
        ```

        ```{.py .python linenums="1" title="Example 1: Assert that any value is of type str"}
        >>> assert_any_values_of_type(values, check_type)
        ```
        <div class="result" markdown>
        ```{.sh .shell title="Output"}
        (no output, no exception raised)
        ```
        !!! success "Conclusion: At least one value is of type `#!py str`."

        </div>

        ```{.py .python linenums="1" title="Example 2: Assert that any value is of type dict"}
        >>> assert_any_values_of_type(values, dict)
        ```
        <div class="result" markdown>
        ```{.sh .shell title="Output"}
        Traceback (most recent call last):
            ...
        TypeError: None of the elements in [1, 'a', 3.0] have the correct type. Must be: 'dict'
        ```
        !!! failure "Conclusion: None of the values are of type `#!py dict`."

        </div>

        ```{.py .python linenums="1" title="Example 3: Assert that any value is of type int or float"}
        >>> assert_any_values_of_type(values, (int, float))
        ```
        <div class="result" markdown>
        ```{.sh .shell title="Output"}
        (no output, no exception raised)
        ```
        !!! success "Conclusion: At least one value is of type `#!py int` or `#!py float`."

        </div>

        ```{.py .python linenums="1" title="Example 4: Assert that any value is of type dict or list"}
        >>> assert_any_values_of_type(values, (dict, list))
        ```
        <div class="result" markdown>
        ```{.sh .shell title="Output"}
        Traceback (most recent call last):
            ...
        TypeError: None of the elements in [1, 'a', 3.0] have the correct type. Must be: 'dict' or 'list'
        ```
        !!! failure "Conclusion: None of the values are of type `#!py dict` or `#!py list`."

        </div>

    ??? tip "See Also"
        - [`is_value_of_type()`][toolbox_python.checkers.is_value_of_type]
        - [`is_any_values_of_type()`][toolbox_python.checkers.is_any_values_of_type]
        - [`is_type()`][toolbox_python.checkers.is_type]
        - [`is_any_type()`][toolbox_python.checkers.is_any_type]
    """
    if not is_any_type(values=values, check_type=check_type):
        invalid_values = [value for value in values if not is_type(value, check_type)]
        msg: str = f"None of the elements in {invalid_values} have the correct type. "
        if isinstance(check_type, type):
            msg += f"Must be: '{check_type.__name__}'"
        else:
            types: str_list = [f"'{typ.__name__}'" for typ in check_type]
            msg += f"Must be: {' or '.join(types)}"
        raise TypeError(msg)

assert_value_in_iterable 🔗

assert_value_in_iterable(
    value: scalar, iterable: any_collection
) -> None

Summary

Assert that a given value is present in an iterable.

Details

This function is used to assert that a given value exists within an iterable such as a list, tuple, or set. If the value is not found in the iterable, a LookupError is raised.

Parameters:

Name Type Description Default
value scalar

The value to check.

required
iterable any_collection

The iterable to check within.

required

Raises:

Type Description
LookupError

If the value is not found in the iterable.

Examples

Assert that a value is in an iterable:

Prepare data
1
2
>>> value = 2
>>> iterable = [1, 2, 3]

Example 1: Assert that value is in the iterable
1
>>> assert_value_in_iterable(value, iterable)
Output
(no output, no exception raised)

Conclusion: The value is in the iterable.

Example 2: Assert that value is not in the iterable
1
>>> assert_value_in_iterable(4, iterable)
Output
Traceback (most recent call last):
    ...
LookupError: Value '4' not found in iterable: [1, 2, 3]

Conclusion: The value is not in the iterable.

See Also
Source code in src/toolbox_python/checkers.py
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
def assert_value_in_iterable(
    value: scalar,
    iterable: any_collection,
) -> None:
    """
    !!! summary "Summary"
        Assert that a given value is present in an iterable.

    ???+ info "Details"
        This function is used to assert that a given value exists within an iterable such as a `#!py list`, `#!py tuple`, or `#!py set`. If the value is not found in the iterable, a `#!py LookupError` is raised.

    Params:
        value (scalar):
            The value to check.
        iterable (any_collection):
            The iterable to check within.

    Raises:
        (LookupError):
            If the value is not found in the iterable.

    ???+ example "Examples"

        Assert that a value is in an iterable:

        ```{.py .python linenums="1" title="Prepare data"}
        >>> value = 2
        >>> iterable = [1, 2, 3]
        ```

        ```{.py .python linenums="1" title="Example 1: Assert that value is in the iterable"}
        >>> assert_value_in_iterable(value, iterable)
        ```
        <div class="result" markdown>
        ```{.sh .shell title="Output"}
        (no output, no exception raised)
        ```
        !!! success "Conclusion: The value is in the iterable."

        </div>

        ```{.py .python linenums="1" title="Example 2: Assert that value is not in the iterable"}
        >>> assert_value_in_iterable(4, iterable)
        ```
        <div class="result" markdown>
        ```{.sh .shell title="Output"}
        Traceback (most recent call last):
            ...
        LookupError: Value '4' not found in iterable: [1, 2, 3]
        ```
        !!! failure "Conclusion: The value is not in the iterable."

        </div>

    ??? tip "See Also"
        - [`is_value_in_iterable()`][toolbox_python.checkers.is_value_in_iterable]
        - [`is_in()`][toolbox_python.checkers.is_in]
    """
    if not is_in(value=value, iterable=iterable):
        raise LookupError(f"Value '{value}' not found in iterable: {iterable}")

assert_any_values_in_iterable 🔗

assert_any_values_in_iterable(
    values: any_collection, iterable: any_collection
) -> None

Summary

Assert that any value in an iterable is present in another iterable.

Details

This function is used to assert that at least one value in a given iterable exists within another iterable. If none of the values are found in the iterable, a LookupError is raised.

Parameters:

Name Type Description Default
values any_collection

The iterable containing values to check.

required
iterable any_collection

The iterable to check within.

required

Raises:

Type Description
LookupError

If none of the values are found in the iterable.

Examples

Assert that any value in an iterable is present in another iterable:

Prepare data
1
2
>>> values = [1, 4]
>>> iterable = [1, 2, 3]

Example 1: Assert that any value is in the iterable
1
>>> assert_any_values_in_iterable(values, iterable)
Output
(no output, no exception raised)

Conclusion: At least one value is in the iterable.

Example 2: Assert that any value is not in the iterable
1
>>> assert_any_values_in_iterable([4, 5], iterable)
Output
Traceback (most recent call last):
    ...
LookupError: None of the values in [4, 5] can be found in [1, 2, 3]

Conclusion: None of the values are in the iterable.

See Also
Source code in src/toolbox_python/checkers.py
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
def assert_any_values_in_iterable(
    values: any_collection,
    iterable: any_collection,
) -> None:
    """
    !!! summary "Summary"
        Assert that any value in an iterable is present in another iterable.

    ???+ info "Details"
        This function is used to assert that at least one value in a given iterable exists within another iterable. If none of the values are found in the iterable, a `#!py LookupError` is raised.

    Params:
        values (any_collection):
            The iterable containing values to check.
        iterable (any_collection):
            The iterable to check within.

    Raises:
        (LookupError):
            If none of the values are found in the iterable.

    ???+ example "Examples"

        Assert that any value in an iterable is present in another iterable:

        ```{.py .python linenums="1" title="Prepare data"}
        >>> values = [1, 4]
        >>> iterable = [1, 2, 3]
        ```

        ```{.py .python linenums="1" title="Example 1: Assert that any value is in the iterable"}
        >>> assert_any_values_in_iterable(values, iterable)
        ```
        <div class="result" markdown>
        ```{.sh .shell title="Output"}
        (no output, no exception raised)
        ```
        !!! success "Conclusion: At least one value is in the iterable."

        </div>

        ```{.py .python linenums="1" title="Example 2: Assert that any value is not in the iterable"}
        >>> assert_any_values_in_iterable([4, 5], iterable)
        ```
        <div class="result" markdown>
        ```{.sh .shell title="Output"}
        Traceback (most recent call last):
            ...
        LookupError: None of the values in [4, 5] can be found in [1, 2, 3]
        ```
        !!! failure "Conclusion: None of the values are in the iterable."

        </div>

    ??? tip "See Also"
        - [`is_value_in_iterable()`][toolbox_python.checkers.is_value_in_iterable]
        - [`is_any_values_of_type()`][toolbox_python.checkers.is_any_values_of_type]
        - [`is_in()`][toolbox_python.checkers.is_in]
        - [`is_any_in()`][toolbox_python.checkers.is_any_in]
    """
    if not is_any_in(values=values, iterable=iterable):
        raise LookupError(f"None of the values in {values} can be found in {iterable}")

assert_all_values_in_iterable 🔗

assert_all_values_in_iterable(
    values: any_collection, iterable: any_collection
) -> None

Summary

Assert that all values in an iterable are present in another iterable.

Details

This function is used to assert that all values in a given iterable exist within another iterable. If any value is not found in the iterable, a LookupError is raised.

Parameters:

Name Type Description Default
values any_collection

The iterable containing values to check.

required
iterable any_collection

The iterable to check within.

required

Raises:

Type Description
LookupError

If any value is not found in the iterable.

Examples

Assert that all values in an iterable are present in another iterable:

Prepare data
1
2
>>> values = [1, 2]
>>> iterable = [1, 2, 3]

Example 1: Assert that all values are in the iterable
1
>>> assert_all_values_in_iterable(values, iterable)
Output
(no output, no exception raised)

Conclusion: All values are in the iterable.

Example 2: Assert that all values are not in the iterable
1
>>> assert_all_values_in_iterable([1, 4], iterable)
Output
Traceback (most recent call last):
    ...
LookupError: Some values [4] are missing from [1, 2, 3]

Conclusion: Not all values are in the iterable.

See Also
Source code in src/toolbox_python/checkers.py
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
def assert_all_values_in_iterable(
    values: any_collection,
    iterable: any_collection,
) -> None:
    """
    !!! summary "Summary"
        Assert that all values in an iterable are present in another iterable.

    ???+ info "Details"
        This function is used to assert that all values in a given iterable exist within another iterable. If any value is not found in the iterable, a `#!py LookupError` is raised.

    Params:
        values (any_collection):
            The iterable containing values to check.
        iterable (any_collection):
            The iterable to check within.

    Raises:
        (LookupError):
            If any value is not found in the iterable.

    ???+ example "Examples"

        Assert that all values in an iterable are present in another iterable:

        ```{.py .python linenums="1" title="Prepare data"}
        >>> values = [1, 2]
        >>> iterable = [1, 2, 3]
        ```

        ```{.py .python linenums="1" title="Example 1: Assert that all values are in the iterable"}
        >>> assert_all_values_in_iterable(values, iterable)
        ```
        <div class="result" markdown>
        ```{.sh .shell title="Output"}
        (no output, no exception raised)
        ```
        !!! success "Conclusion: All values are in the iterable."

        </div>

        ```{.py .python linenums="1" title="Example 2: Assert that all values are not in the iterable"}
        >>> assert_all_values_in_iterable([1, 4], iterable)
        ```
        <div class="result" markdown>
        ```{.sh .shell title="Output"}
        Traceback (most recent call last):
            ...
        LookupError: Some values [4] are missing from [1, 2, 3]
        ```
        !!! failure "Conclusion: Not all values are in the iterable."

        </div>

    ??? tip "See Also"
        - [`is_value_in_iterable()`][toolbox_python.checkers.is_value_in_iterable]
        - [`is_all_values_of_type()`][toolbox_python.checkers.is_all_values_of_type]
        - [`is_in()`][toolbox_python.checkers.is_in]
        - [`is_all_in()`][toolbox_python.checkers.is_all_in]
    """
    if not is_all_in(values=values, iterable=iterable):
        missing_values = [value for value in values if not is_in(value, iterable)]
        raise LookupError(f"Some values {missing_values} are missing from {iterable}")

assert_*() function aliases🔗

assert_type module-attribute 🔗

assert_type = assert_value_of_type

assert_all_type module-attribute 🔗

assert_all_type = assert_all_values_of_type

assert_any_type module-attribute 🔗

assert_any_type = assert_any_values_of_type

assert_in module-attribute 🔗

assert_in = assert_value_in_iterable

assert_any_in module-attribute 🔗

assert_any_in = assert_any_values_in_iterable

assert_all_in module-attribute 🔗

assert_all_in = assert_all_values_in_iterable

*_contains() functions🔗

any_element_contains 🔗

any_element_contains(
    iterable: str_collection, check: str
) -> bool

Summary

Check to see if any element in a given iterable contains a given string value.

Note: This check is case sensitive.

Details

This function is helpful for doing a quick check to see if any element in a list contains a given str value. For example, checking if any column header contains a specific string value.

Parameters:

Name Type Description Default
iterable str_collection

The iterables to check within. Because this function uses an in operation to check if check string exists in the elements of iterable, therefore all elements of iterable must be str type.

required
check str

The string value to check exists in any of the elements in iterable.

required

Raises:

Type Description
TypeError

If any of the inputs parsed to the parameters of this function are not the correct type. Uses the @typeguard.typechecked decorator.

Returns:

Type Description
bool

True if at least one element in iterable contains check string; False if no elements contain check.

Examples

Check if any element in an iterable contains a specific string:

Prepare data
1
2
>>> iterable = ["apple", "banana", "cherry"]
>>> check = "an"

Example 1: Check if any element contains 'an'
1
>>> any_element_contains(iterable, check)
Output
True

Conclusion: At least one element contains 'an'.

Example 2: Check if any element contains 'xy'
1
>>> any_element_contains(iterable, "xy")
Output
False

Conclusion: No elements contain 'xy'.

Source code in src/toolbox_python/checkers.py
 951
 952
 953
 954
 955
 956
 957
 958
 959
 960
 961
 962
 963
 964
 965
 966
 967
 968
 969
 970
 971
 972
 973
 974
 975
 976
 977
 978
 979
 980
 981
 982
 983
 984
 985
 986
 987
 988
 989
 990
 991
 992
 993
 994
 995
 996
 997
 998
 999
1000
1001
1002
1003
1004
1005
1006
1007
1008
@typechecked
def any_element_contains(
    iterable: str_collection,
    check: str,
) -> bool:
    """
    !!! note "Summary"
        Check to see if any element in a given iterable contains a given string value.
        !!! warning "Note: This check _is_ case sensitive."

    ???+ abstract "Details"
        This function is helpful for doing a quick check to see if any element in a `#!py list` contains a given `#!py str` value. For example, checking if any column header contains a specific string value.

    Params:
        iterable (str_collection):
            The iterables to check within. Because this function uses an `#!py in` operation to check if `check` string exists in the elements of `iterable`, therefore all elements of `iterable` must be `#!py str` type.
        check (str):
            The string value to check exists in any of the elements in `iterable`.

    Raises:
        TypeError: If any of the inputs parsed to the parameters of this function are not the correct type. Uses the [`@typeguard.typechecked`](https://typeguard.readthedocs.io/en/stable/api.html#typeguard.typechecked) decorator.

    Returns:
        (bool):
            `#!py True` if at least one element in `iterable` contains `check` string; `#!py False` if no elements contain `check`.

    ???+ example "Examples"

        Check if any element in an iterable contains a specific string:

        ```{.py .python linenums="1" title="Prepare data"}
        >>> iterable = ["apple", "banana", "cherry"]
        >>> check = "an"
        ```

        ```{.py .python linenums="1" title="Example 1: Check if any element contains 'an'"}
        >>> any_element_contains(iterable, check)
        ```
        <div class="result" markdown>
        ```{.sh .shell title="Output"}
        True
        ```
        !!! success "Conclusion: At least one element contains `'an'`."

        </div>

        ```{.py .python linenums="1" title="Example 2: Check if any element contains 'xy'"}
        >>> any_element_contains(iterable, "xy")
        ```
        <div class="result" markdown>
        ```{.sh .shell title="Output"}
        False
        ```
        !!! failure "Conclusion: No elements contain `'xy'`."

        </div>
    """
    return any(check in elem for elem in iterable)

all_elements_contains 🔗

all_elements_contains(
    iterable: str_collection, check: str
) -> bool

Summary

Check to see if all elements in a given iterable contains a given string value.

Note: This check is case sensitive.

Details

This function is helpful for doing a quick check to see if all element in a list contains a given str value. For example, checking if all columns in a DataFrame contains a specific string value.

Parameters:

Name Type Description Default
iterable str_collection

The iterables to check within. Because this function uses an in operation to check if check string exists in the elements of iterable, therefore all elements of iterable must be str type.

required
check str

The string value to check exists in any of the elements in iterable.

required

Raises:

Type Description
TypeError

If any of the inputs parsed to the parameters of this function are not the correct type. Uses the @typeguard.typechecked decorator.

Returns:

Type Description
bool

True if all elements in iterable contains check string; False otherwise.

Examples

Check if all elements in an iterable contain a specific string:

Prepare data
1
2
>>> iterable = ["apple", "banana", "peach"]
>>> check = "a"

Example 1: Check if all elements contain 'a'
1
>>> all_elements_contains(iterable, check)
Output
True

Conclusion: All elements contain 'a'.

Example 2: Check if all elements contain 'e'
1
>>> all_elements_contains(iterable, "e")
Output
False

Conclusion: Not all elements contain 'e'.

Source code in src/toolbox_python/checkers.py
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
@typechecked
def all_elements_contains(iterable: str_collection, check: str) -> bool:
    """
    !!! note "Summary"
        Check to see if all elements in a given iterable contains a given string value.
        !!! warning "Note: This check _is_ case sensitive."

    ???+ abstract "Details"
        This function is helpful for doing a quick check to see if all element in a `#!py list` contains a given `#!py str` value. For example, checking if all columns in a DataFrame contains a specific string value.

    Params:
        iterable (str_collection):
            The iterables to check within. Because this function uses an `#!py in` operation to check if `check` string exists in the elements of `iterable`, therefore all elements of `iterable` must be `#!py str` type.
        check (str):
            The string value to check exists in any of the elements in `iterable`.

    Raises:
        TypeError: If any of the inputs parsed to the parameters of this function are not the correct type. Uses the [`@typeguard.typechecked`](https://typeguard.readthedocs.io/en/stable/api.html#typeguard.typechecked) decorator.

    Returns:
        (bool):
            `#!py True` if all elements in `iterable` contains `check` string; `#!py False` otherwise.

    ???+ example "Examples"

        Check if all elements in an iterable contain a specific string:

        ```{.py .python linenums="1" title="Prepare data"}
        >>> iterable = ["apple", "banana", "peach"]
        >>> check = "a"
        ```

        ```{.py .python linenums="1" title="Example 1: Check if all elements contain 'a'"}
        >>> all_elements_contains(iterable, check)
        ```
        <div class="result" markdown>
        ```{.sh .shell title="Output"}
        True
        ```
        !!! success "Conclusion: All elements contain `'a'`."

        </div>

        ```{.py .python linenums="1" title="Example 2: Check if all elements contain 'e'"}
        >>> all_elements_contains(iterable, "e")
        ```
        <div class="result" markdown>
        ```{.sh .shell title="Output"}
        False
        ```
        !!! failure "Conclusion: Not all elements contain `'e'`."

        </div>
    """
    return all(check in elem for elem in iterable)

get_elements_containing 🔗

get_elements_containing(
    iterable: str_collection, check: str
) -> tuple[str, ...]

Summary

Extract all elements in a given iterable which contains a given string value.

Note: This check is case sensitive.

Parameters:

Name Type Description Default
iterable str_collection

The iterables to check within. Because this function uses an in operation to check if check string exists in the elements of iterable, therefore all elements of iterable must be str type.

required
check str

The string value to check exists in any of the elements in iterable.

required

Raises:

Type Description
TypeError

If any of the inputs parsed to the parameters of this function are not the correct type. Uses the @typeguard.typechecked decorator.

Returns:

Type Description
tuple

A tuple containing all the string elements from iterable which contains the check string.

Examples

Extract elements in an iterable that contain a specific string:

Prepare data
1
2
>>> iterable = ["apple", "banana", "cherry"]
>>> check = "an"

Example 1: Extract elements containing 'an'
1
>>> get_elements_containing(iterable, check)
Output
('banana',)

Conclusion: The element(s) containing 'an' are extracted.

Example 2: Extract elements containing 'xy'
1
>>> get_elements_containing(iterable, "xy")
Output
()

Conclusion: No elements contain 'xy'.

Source code in src/toolbox_python/checkers.py
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
@typechecked
def get_elements_containing(iterable: str_collection, check: str) -> tuple[str, ...]:
    """
    !!! note "Summary"
        Extract all elements in a given iterable which contains a given string value.
        !!! warning "Note: This check _is_ case sensitive."

    Params:
        iterable (str_collection):
            The iterables to check within. Because this function uses an `#!py in` operation to check if `check` string exists in the elements of `iterable`, therefore all elements of `iterable` must be `#!py str` type.
        check (str):
            The string value to check exists in any of the elements in `iterable`.

    Raises:
        TypeError: If any of the inputs parsed to the parameters of this function are not the correct type. Uses the [`@typeguard.typechecked`](https://typeguard.readthedocs.io/en/stable/api.html#typeguard.typechecked) decorator.

    Returns:
        (tuple):
            A `#!py tuple` containing all the string elements from `iterable` which contains the `check` string.

    ???+ example "Examples"

        Extract elements in an iterable that contain a specific string:

        ```{.py .python linenums="1" title="Prepare data"}
        >>> iterable = ["apple", "banana", "cherry"]
        >>> check = "an"
        ```

        ```{.py .python linenums="1" title="Example 1: Extract elements containing 'an'"}
        >>> get_elements_containing(iterable, check)
        ```
        <div class="result" markdown>
        ```{.sh .shell title="Output"}
        ('banana',)
        ```
        !!! success "Conclusion: The element(s) containing `'an'` are extracted."

        </div>

        ```{.py .python linenums="1" title="Example 2: Extract elements containing 'xy'"}
        >>> get_elements_containing(iterable, "xy")
        ```
        <div class="result" markdown>
        ```{.sh .shell title="Output"}
        ()
        ```
        !!! failure "Conclusion: No elements contain `'xy'`."

        </div>
    """
    return tuple(elem for elem in iterable if check in elem)