aboutsummaryrefslogtreecommitdiff
path: root/.venv/lib/python3.12/site-packages/pydash/predicates.py
diff options
context:
space:
mode:
authorS. Solomon Darnell2025-03-28 21:52:21 -0500
committerS. Solomon Darnell2025-03-28 21:52:21 -0500
commit4a52a71956a8d46fcb7294ac71734504bb09bcc2 (patch)
treeee3dc5af3b6313e921cd920906356f5d4febc4ed /.venv/lib/python3.12/site-packages/pydash/predicates.py
parentcc961e04ba734dd72309fb548a2f97d67d578813 (diff)
downloadgn-ai-4a52a71956a8d46fcb7294ac71734504bb09bcc2.tar.gz
two version of R2R are hereHEADmaster
Diffstat (limited to '.venv/lib/python3.12/site-packages/pydash/predicates.py')
-rw-r--r--.venv/lib/python3.12/site-packages/pydash/predicates.py1664
1 files changed, 1664 insertions, 0 deletions
diff --git a/.venv/lib/python3.12/site-packages/pydash/predicates.py b/.venv/lib/python3.12/site-packages/pydash/predicates.py
new file mode 100644
index 00000000..1c6b457d
--- /dev/null
+++ b/.venv/lib/python3.12/site-packages/pydash/predicates.py
@@ -0,0 +1,1664 @@
+"""
+Predicate functions that return boolean evaluations of objects.
+
+.. versionadded:: 2.0.0
+"""
+
+from __future__ import annotations
+
+from collections.abc import Iterable, Mapping
+import datetime
+from itertools import islice
+import json
+import operator
+import re
+from types import BuiltinFunctionType
+import typing as t
+
+from typing_extensions import TypeGuard
+
+import pydash as pyd
+
+from .helpers import BUILTINS, NUMBER_TYPES, UNSET, base_get, callit, iterator
+
+
+if t.TYPE_CHECKING:
+ from _typeshed import ( # pragma: no cover
+ SupportsDunderGE,
+ SupportsDunderGT,
+ SupportsDunderLE,
+ SupportsDunderLT,
+ SupportsRichComparison,
+ )
+
+
+__all__ = (
+ "eq",
+ "eq_cmp",
+ "gt",
+ "gt_cmp",
+ "gte",
+ "gte_cmp",
+ "lt",
+ "lt_cmp",
+ "lte",
+ "lte_cmp",
+ "in_range",
+ "in_range_cmp",
+ "is_associative",
+ "is_blank",
+ "is_boolean",
+ "is_builtin",
+ "is_date",
+ "is_decreasing",
+ "is_dict",
+ "is_empty",
+ "is_equal",
+ "is_equal_cmp",
+ "is_equal_with",
+ "is_equal_with_cmp",
+ "is_error",
+ "is_even",
+ "is_float",
+ "is_function",
+ "is_increasing",
+ "is_indexed",
+ "is_instance_of",
+ "is_instance_of_cmp",
+ "is_integer",
+ "is_iterable",
+ "is_json",
+ "is_list",
+ "is_match",
+ "is_match_cmp",
+ "is_match_with",
+ "is_match_with_cmp",
+ "is_monotone",
+ "is_monotone_cmp",
+ "is_nan",
+ "is_negative",
+ "is_none",
+ "is_number",
+ "is_object",
+ "is_odd",
+ "is_positive",
+ "is_reg_exp",
+ "is_set",
+ "is_strictly_decreasing",
+ "is_strictly_increasing",
+ "is_string",
+ "is_tuple",
+ "is_zero",
+)
+
+T = t.TypeVar("T")
+T2 = t.TypeVar("T2")
+T3 = t.TypeVar("T3")
+
+RegExp = type(re.compile(""))
+
+
+def eq(value: t.Any, other: t.Any) -> bool:
+ """
+ Checks if :attr:`value` is equal to :attr:`other`.
+
+ Args:
+ value: Value to compare.
+ other: Other value to compare.
+
+ Returns:
+ Whether :attr:`value` is equal to :attr:`other`.
+
+ Example:
+
+ >>> eq(None, None)
+ True
+ >>> eq(None, "")
+ False
+ >>> eq("a", "a")
+ True
+ >>> eq(1, str(1))
+ False
+
+ .. versionadded:: 4.0.0
+ """
+ return value is other
+
+
+def eq_cmp(other: T) -> t.Callable[[T], bool]:
+ """
+ Curried version of :func:`eq`.
+
+ Args:
+ other: Value to compare.
+
+ Returns:
+ A predicate checking whether passed :attr:`value` is equal to :attr:`other`.
+
+ Example:
+
+ >>> eq_cmp(None)(None)
+ True
+ >>> eq_cmp(None)("")
+ False
+ >>> eq_cmp("a")("a")
+ True
+ >>> eq_cmp(1)(str(1))
+ False
+
+ .. versionadded:: 7.1.0
+ """
+ return lambda value: eq(value, other)
+
+
+def gt(value: "SupportsDunderGT[T]", other: T) -> bool:
+ """
+ Checks if `value` is greater than `other`.
+
+ Args:
+ value: Value to compare.
+ other: Other value to compare.
+
+ Returns:
+ Whether `value` is greater than `other`.
+
+ Example:
+
+ >>> gt(5, 3)
+ True
+ >>> gt(3, 5)
+ False
+ >>> gt(5, 5)
+ False
+
+ .. versionadded:: 3.3.0
+ """
+ return value > other
+
+
+def gt_cmp(other: T) -> t.Callable[["SupportsDunderGT[T]"], bool]:
+ """
+ Curried version of :func:`gt`.
+
+ Args:
+ other: Value to compare.
+
+ Returns:
+ A predicate checking whether passed :attr:`value` is greater than :attr:`other`.
+
+ Example:
+
+ >>> gt_cmp(3)(5)
+ True
+ >>> gt_cmp(5)(3)
+ False
+ >>> gt_cmp(5)(5)
+ False
+
+ .. versionadded:: 7.1.0
+ """
+ return lambda value: gt(value, other)
+
+
+def gte(value: "SupportsDunderGE[T]", other: T) -> bool:
+ """
+ Checks if `value` is greater than or equal to `other`.
+
+ Args:
+ value: Value to compare.
+ other: Other value to compare.
+
+ Returns:
+ Whether `value` is greater than or equal to `other`.
+
+ Example:
+
+ >>> gte(5, 3)
+ True
+ >>> gte(3, 5)
+ False
+ >>> gte(5, 5)
+ True
+
+ .. versionadded:: 3.3.0
+ """
+ return value >= other
+
+
+def gte_cmp(other: T) -> t.Callable[["SupportsDunderGE[T]"], bool]:
+ """
+ Curried version of :func:`gte`.
+
+ Args:
+ other: Value to compare.
+
+ Returns:
+ A predicate checking whether passed :attr:`value` is greater than or equal to :attr:`other`.
+
+ Example:
+
+ >>> gte_cmp(3)(5)
+ True
+ >>> gte_cmp(5)(3)
+ False
+ >>> gte_cmp(5)(5)
+ True
+
+ .. versionadded:: 7.1.0
+ """
+ return lambda value: gte(value, other)
+
+
+def lt(value: "SupportsDunderLT[T]", other: T) -> bool:
+ """
+ Checks if `value` is less than `other`.
+
+ Args:
+ value: Value to compare.
+ other: Other value to compare.
+
+ Returns:
+ Whether `value` is less than `other`.
+
+ Example:
+
+ >>> lt(5, 3)
+ False
+ >>> lt(3, 5)
+ True
+ >>> lt(5, 5)
+ False
+
+ .. versionadded:: 3.3.0
+ """
+ return value < other
+
+
+def lt_cmp(other: T) -> t.Callable[["SupportsDunderLT[T]"], bool]:
+ """
+ Curried version of :func:`lt`.
+
+ Args:
+ other: Value to compare.
+
+ Returns:
+ A predicate checking whether passed :attr:`value` is less than :attr:`other`.
+
+ Example:
+
+ >>> lt_cmp(3)(5)
+ False
+ >>> lt_cmp(5)(3)
+ True
+ >>> lt_cmp(5)(5)
+ False
+
+ .. versionadded:: 7.1.0
+ """
+ return lambda value: lt(value, other)
+
+
+def lte(value: "SupportsDunderLE[T]", other: T) -> bool:
+ """
+ Checks if `value` is less than or equal to `other`.
+
+ Args:
+ value: Value to compare.
+ other: Other value to compare.
+
+ Returns:
+ Whether `value` is less than or equal to `other`.
+
+ Example:
+
+ >>> lte(5, 3)
+ False
+ >>> lte(3, 5)
+ True
+ >>> lte(5, 5)
+ True
+
+ .. versionadded:: 3.3.0
+ """
+ return value <= other
+
+
+def lte_cmp(other: T) -> t.Callable[["SupportsDunderLE[T]"], bool]:
+ """
+ Curried version of :func:`lte`.
+
+ Args:
+ other: Value to compare.
+
+ Returns:
+ A predicate checking whether passed :attr:`value` is less than or equal to :attr:`other`.
+
+ Example:
+
+ >>> lte_cmp(3)(5)
+ False
+ >>> lte_cmp(5)(3)
+ True
+ >>> lte_cmp(5)(5)
+ True
+
+ .. versionadded:: 7.1.0
+ """
+ return lambda value: lte(value, other)
+
+
+def in_range(value: t.Any, start: t.Any = 0, end: t.Any = None) -> bool:
+ """
+ Checks if `value` is between `start` and up to but not including `end`. If `end` is not
+ specified it defaults to `start` with `start` becoming ``0``.
+
+ Args:
+
+ value: Number to check.
+ start: Start of range inclusive. Defaults to ``0``.
+ end: End of range exclusive. Defaults to `start`.
+
+ Returns:
+ Whether `value` is in range.
+
+ Example:
+
+ >>> in_range(2, 4)
+ True
+ >>> in_range(4, 2)
+ False
+ >>> in_range(2, 1, 3)
+ True
+ >>> in_range(3, 1, 2)
+ False
+ >>> in_range(2.5, 3.5)
+ True
+ >>> in_range(3.5, 2.5)
+ False
+
+ .. versionadded:: 3.1.0
+ """
+ if not is_number(value):
+ return False
+
+ if not is_number(start):
+ start = 0
+
+ if end is None:
+ end = start
+ start = 0
+ elif not is_number(end):
+ end = 0
+
+ return start <= value < end
+
+
+def in_range_cmp(start: t.Any = 0, end: t.Any = None) -> t.Callable[[t.Any], bool]:
+ """
+ Curried version of :func:`in_range`.
+
+ Args:
+ start: Start of range inclusive. Defaults to ``0``.
+ end: End of range exclusive. Defaults to `start`.
+
+ Returns:
+ A predicate checking whether passed :attr:`value` is in range.
+
+ Example:
+
+ >>> in_range_cmp(4)(2)
+ True
+ >>> in_range_cmp(2)(4)
+ False
+ >>> in_range_cmp(1, 3)(2)
+ True
+ >>> in_range_cmp(1, 2)(3)
+ False
+ >>> in_range_cmp(3.5)(2.5)
+ True
+ >>> in_range_cmp(2.5)(3.5)
+ False
+
+ .. versionadded:: 7.1.0
+ """
+ return lambda value: in_range(value, start, end)
+
+
+def is_associative(value: t.Any) -> bool:
+ """
+ Checks if `value` is an associative object meaning that it can be accessed via an index or key.
+
+ Args:
+ value: Value to check.
+
+ Returns:
+ Whether `value` is associative.
+
+ Example:
+
+ >>> is_associative([])
+ True
+ >>> is_associative({})
+ True
+ >>> is_associative(1)
+ False
+ >>> is_associative(True)
+ False
+
+ .. versionadded:: 2.0.0
+ """
+ return hasattr(value, "__getitem__")
+
+
+def is_blank(text: t.Any) -> TypeGuard[str]:
+ r"""
+ Checks if `text` contains only whitespace characters.
+
+ Args:
+ text: String to test.
+
+ Returns:
+ Whether `text` is blank.
+
+ Example:
+
+ >>> is_blank("")
+ True
+ >>> is_blank(" \r\n ")
+ True
+ >>> is_blank(False)
+ False
+
+ .. versionadded:: 3.0.0
+ """
+ try:
+ ret = bool(re.match(r"^(\s+)?$", text))
+ except TypeError:
+ ret = False
+
+ return ret
+
+
+def is_boolean(value: t.Any) -> TypeGuard[bool]:
+ """
+ Checks if `value` is a boolean value.
+
+ Args:
+ value: Value to check.
+
+ Returns:
+ Whether `value` is a boolean.
+
+ Example:
+
+ >>> is_boolean(True)
+ True
+ >>> is_boolean(False)
+ True
+ >>> is_boolean(0)
+ False
+
+ .. versionadded:: 1.0.0
+
+ .. versionchanged:: 3.0.0
+ Added ``is_bool`` as alias.
+
+ .. versionchanged:: 4.0.0
+ Removed alias ``is_bool``.
+ """
+ return isinstance(value, bool)
+
+
+def is_builtin(value: t.Any) -> bool:
+ """
+ Checks if `value` is a Python builtin function or method.
+
+ Args:
+ value: Value to check.
+
+ Returns:
+ Whether `value` is a Python builtin function or method.
+
+ Example:
+
+ >>> is_builtin(1)
+ True
+ >>> is_builtin(list)
+ True
+ >>> is_builtin("foo")
+ False
+
+ .. versionadded:: 3.0.0
+
+ .. versionchanged:: 4.0.0
+ Removed alias ``is_native``.
+ """
+ try:
+ return isinstance(value, BuiltinFunctionType) or value in BUILTINS
+ except TypeError: # pragma: no cover
+ return False
+
+
+def is_date(value: t.Any) -> bool:
+ """
+ Check if `value` is a date object.
+
+ Args:
+ value: Value to check.
+
+ Returns:
+ Whether `value` is a date object.
+
+ Example:
+
+ >>> import datetime
+ >>> is_date(datetime.date.today())
+ True
+ >>> is_date(datetime.datetime.today())
+ True
+ >>> is_date("2014-01-01")
+ False
+
+ Note:
+ This will also return ``True`` for datetime objects.
+
+ .. versionadded:: 1.0.0
+ """
+ return isinstance(value, datetime.date)
+
+
+def is_decreasing(
+ value: t.Union["SupportsRichComparison", t.List["SupportsRichComparison"]],
+) -> bool:
+ """
+ Check if `value` is monotonically decreasing.
+
+ Args:
+ value: Value to check.
+
+ Returns:
+ Whether `value` is monotonically decreasing.
+
+ Example:
+
+ >>> is_decreasing([5, 4, 4, 3])
+ True
+ >>> is_decreasing([5, 5, 5])
+ True
+ >>> is_decreasing([5, 4, 5])
+ False
+
+ .. versionadded:: 2.0.0
+ """
+ return is_monotone(value, operator.ge) # type: ignore
+
+
+def is_dict(value: t.Any) -> bool:
+ """
+ Checks if `value` is a ``dict``.
+
+ Args:
+ value: Value to check.
+
+ Returns:
+ Whether `value` is a ``dict``.
+
+ Example:
+
+ >>> is_dict({})
+ True
+ >>> is_dict([])
+ False
+
+ .. versionadded:: 1.0.0
+
+ .. versionchanged:: 3.0.0
+ Added :func:`is_dict` as main definition and made `is_plain_object`` an alias.
+
+ .. versionchanged:: 4.0.0
+ Removed alias ``is_plain_object``.
+ """
+ return isinstance(value, dict)
+
+
+def is_empty(value: t.Any) -> bool:
+ """
+ Checks if `value` is empty.
+
+ Args:
+ value: Value to check.
+
+ Returns:
+ Whether `value` is empty.
+
+ Example:
+
+ >>> is_empty(0)
+ True
+ >>> is_empty(1)
+ True
+ >>> is_empty(True)
+ True
+ >>> is_empty("foo")
+ False
+ >>> is_empty(None)
+ True
+ >>> is_empty({})
+ True
+
+ Note:
+ Returns ``True`` for booleans and numbers.
+
+ .. versionadded:: 1.0.0
+ """
+ return is_boolean(value) or is_number(value) or not value
+
+
+def is_equal(value: t.Any, other: t.Any) -> bool:
+ """
+ Performs a comparison between two values to determine if they are equivalent to each other.
+
+ Args:
+ value: Object to compare.
+ other: Object to compare.
+
+ Returns:
+ Whether `value` and `other` are equal.
+
+ Example:
+
+ >>> is_equal([1, 2, 3], [1, 2, 3])
+ True
+ >>> is_equal("a", "A")
+ False
+
+ .. versionadded:: 1.0.0
+
+ .. versionchanged:: 4.0.0
+ Removed :attr:`iteratee` from :func:`is_equal` and added it in
+ :func:`is_equal_with`.
+ """
+ return is_equal_with(value, other, customizer=None)
+
+
+def is_equal_cmp(other: T) -> t.Callable[[T], bool]:
+ """
+ Curried version of :func:`is_equal`.
+
+ Args:
+ other: Value to compare.
+
+ Returns:
+ A predicate checking whether passed :attr:`value` is equal to :attr:`other`.
+
+ Example:
+
+ >>> is_equal_cmp([1, 2, 3])([1, 2, 3])
+ True
+ >>> is_equal_cmp("a")("A")
+ False
+
+ .. versionadded:: 7.1.0
+ """
+ return lambda value: is_equal(value, other)
+
+
+@t.overload
+def is_equal_with(value: T, other: T2, customizer: t.Callable[[T, T2], T3]) -> T3: ...
+
+
+@t.overload
+def is_equal_with(value: t.Any, other: t.Any, customizer: t.Callable[..., t.Any]) -> bool: ...
+
+
+@t.overload
+def is_equal_with(value: t.Any, other: t.Any, customizer: None) -> bool: ...
+
+
+def is_equal_with(value, other, customizer):
+ """
+ This method is like :func:`is_equal` except that it accepts customizer which is invoked to
+ compare values. A customizer is provided which will be executed to compare values. If the
+ customizer returns ``None``, comparisons will be handled by the method instead. The customizer
+ is invoked with two arguments: ``(value, other)``.
+
+ Args:
+ value: Object to compare.
+ other: Object to compare.
+ customizer: Customizer used to compare values from `value` and `other`.
+
+ Returns:
+ Whether `value` and `other` are equal.
+
+ Example:
+
+ >>> is_equal_with([1, 2, 3], [1, 2, 3], None)
+ True
+ >>> is_equal_with("a", "A", None)
+ False
+ >>> is_equal_with("a", "A", lambda a, b: a.lower() == b.lower())
+ True
+
+ .. versionadded:: 4.0.0
+ """
+ # If customizer provided, use it for comparison.
+ equal = customizer(value, other) if callable(customizer) else None
+
+ # Return customizer results if anything but None.
+ if equal is not None:
+ pass
+ elif (
+ callable(customizer)
+ and type(value) is type(other)
+ and isinstance(value, (list, dict))
+ and isinstance(other, (list, dict))
+ and len(value) == len(other)
+ ):
+ # Walk a/b to determine equality using customizer.
+ for key, val in iterator(value):
+ if pyd.has(other, key):
+ equal = is_equal_with(val, other[key], customizer)
+ else:
+ equal = False
+
+ if not equal:
+ break
+ else:
+ # Use basic == comparison.
+ equal = value == other
+
+ return equal
+
+
+def is_equal_with_cmp(other: T, customizer: t.Callable[[T, T], T3]) -> t.Callable[[T], T3]:
+ """
+ Curried version of :func:`is_equal_with`.
+
+ Args:
+ other: Value to compare.
+ customizer: Customizer used to compare values from `value` and `other`.
+
+ Returns:
+ A predicate checking whether passed :attr:`value` and :attr:`other` are equal.
+
+ Example:
+
+ >>> is_equal_with_cmp([1, 2, 3], None)([1, 2, 3])
+ True
+ >>> is_equal_with_cmp("a", None)("A")
+ False
+ >>> is_equal_with_cmp("a", lambda a, b: a.lower() == b.lower())("A")
+ True
+
+ .. versionadded:: 7.1.0
+ """
+ return lambda value: is_equal_with(value, other, customizer)
+
+
+def is_error(value: t.Any) -> bool:
+ """
+ Checks if `value` is an ``Exception``.
+
+ Args:
+ value: Value to check.
+
+ Returns:
+ Whether `value` is an exception.
+
+ Example:
+
+ >>> is_error(Exception())
+ True
+ >>> is_error(Exception)
+ False
+ >>> is_error(None)
+ False
+
+ .. versionadded:: 1.1.0
+ """
+ return isinstance(value, Exception)
+
+
+def is_even(value: t.Any) -> bool:
+ """
+ Checks if `value` is even.
+
+ Args:
+ value: Value to check.
+
+ Returns:
+ Whether `value` is even.
+
+ Example:
+
+ >>> is_even(2)
+ True
+ >>> is_even(3)
+ False
+ >>> is_even(False)
+ False
+
+ .. versionadded:: 2.0.0
+ """
+ return is_number(value) and value % 2 == 0
+
+
+def is_float(value: t.Any) -> TypeGuard[float]:
+ """
+ Checks if `value` is a float.
+
+ Args:
+ value: Value to check.
+
+ Returns:
+ Whether `value` is a float.
+
+ Example:
+
+ >>> is_float(1.0)
+ True
+ >>> is_float(1)
+ False
+
+ .. versionadded:: 2.0.0
+ """
+ return isinstance(value, float)
+
+
+def is_function(value: t.Any) -> bool:
+ """
+ Checks if `value` is a function.
+
+ Args:
+ value: Value to check.
+
+ Returns:
+ Whether `value` is callable.
+
+ Example:
+
+ >>> is_function(list)
+ True
+ >>> is_function(lambda: True)
+ True
+ >>> is_function(1)
+ False
+
+ .. versionadded:: 1.0.0
+ """
+ return callable(value)
+
+
+def is_increasing(
+ value: t.Union["SupportsRichComparison", t.List["SupportsRichComparison"]],
+) -> bool:
+ """
+ Check if `value` is monotonically increasing.
+
+ Args:
+ value: Value to check.
+
+ Returns:
+ Whether `value` is monotonically increasing.
+
+ Example:
+
+ >>> is_increasing([1, 3, 5])
+ True
+ >>> is_increasing([1, 1, 2, 3, 3])
+ True
+ >>> is_increasing([5, 5, 5])
+ True
+ >>> is_increasing([1, 2, 4, 3])
+ False
+
+ .. versionadded:: 2.0.0
+ """
+ return is_monotone(value, operator.le) # type: ignore
+
+
+def is_indexed(value: t.Any) -> bool:
+ """
+ Checks if `value` is integer indexed, i.e., ``list``, ``str`` or ``tuple``.
+
+ Args:
+ value: Value to check.
+
+ Returns:
+ Whether `value` is integer indexed.
+
+ Example:
+
+ >>> is_indexed("")
+ True
+ >>> is_indexed([])
+ True
+ >>> is_indexed(())
+ True
+ >>> is_indexed({})
+ False
+
+ .. versionadded:: 2.0.0
+
+ .. versionchanged:: 3.0.0
+ Return ``True`` for tuples.
+ """
+ return isinstance(value, (list, tuple, str))
+
+
+def is_instance_of(value: t.Any, types: t.Union[type, t.Tuple[type, ...]]) -> bool:
+ """
+ Checks if `value` is an instance of `types`.
+
+ Args:
+ value: Value to check.
+ types: Types to check against. Pass as ``tuple`` to check if `value` is one of
+ multiple types.
+
+ Returns:
+ Whether `value` is an instance of `types`.
+
+ Example:
+
+ >>> is_instance_of({}, dict)
+ True
+ >>> is_instance_of({}, list)
+ False
+
+ .. versionadded:: 2.0.0
+ """
+ return isinstance(value, types)
+
+
+def is_instance_of_cmp(
+ types: t.Union[type, t.Tuple[type, ...]],
+) -> t.Callable[[t.Any], bool]:
+ """
+ Curried version of :func:`is_instance_of`.
+
+ Args:
+ types: Types to check against. Pass as ``tuple`` to check if `value` is one of
+ multiple types.
+
+ Returns:
+ A predicate checking whether passed :attr:`value` is an instance of :attr:`types`.
+
+ Example:
+
+ >>> is_instance_of_cmp(dict)({})
+ True
+ >>> is_instance_of_cmp(list)({})
+ False
+
+ .. versionadded:: 7.1.0
+ """
+ return lambda value: is_instance_of(value, types)
+
+
+def is_integer(value: t.Any) -> TypeGuard[int]:
+ """
+ Checks if `value` is a integer.
+
+ Args:
+ value: Value to check.
+
+ Returns:
+ Whether `value` is an integer.
+
+ Example:
+
+ >>> is_integer(1)
+ True
+ >>> is_integer(1.0)
+ False
+ >>> is_integer(True)
+ False
+
+ .. versionadded:: 2.0.0
+
+ .. versionchanged:: 3.0.0
+ Added ``is_int`` as alias.
+
+ .. versionchanged:: 4.0.0
+ Removed alias ``is_int``.
+ """
+ return is_number(value) and isinstance(value, int)
+
+
+def is_iterable(value: t.Any) -> bool:
+ """
+ Checks if `value` is an iterable.
+
+ Args:
+ value: Value to check.
+
+ Returns:
+ Whether `value` is an iterable.
+
+ Example:
+
+ >>> is_iterable([])
+ True
+ >>> is_iterable({})
+ True
+ >>> is_iterable(())
+ True
+ >>> is_iterable(5)
+ False
+ >>> is_iterable(True)
+ False
+
+ .. versionadded:: 3.3.0
+ """
+ try:
+ iter(value)
+ except TypeError:
+ return False
+ else:
+ return True
+
+
+def is_json(value: t.Any) -> bool:
+ """
+ Checks if `value` is a valid JSON string.
+
+ Args:
+ value: Value to check.
+
+ Returns:
+ Whether `value` is JSON.
+
+ Example:
+
+ >>> is_json({})
+ False
+ >>> is_json("{}")
+ True
+ >>> is_json({"hello": 1, "world": 2})
+ False
+ >>> is_json('{"hello": 1, "world": 2}')
+ True
+
+ .. versionadded:: 2.0.0
+ """
+ try:
+ json.loads(value)
+ return True
+ except Exception:
+ return False
+
+
+def is_list(value: t.Any) -> bool:
+ """
+ Checks if `value` is a list.
+
+ Args:
+ value: Value to check.
+
+ Returns:
+ Whether `value` is a list.
+
+ Example:
+
+ >>> is_list([])
+ True
+ >>> is_list({})
+ False
+ >>> is_list(())
+ False
+
+ .. versionadded:: 1.0.0
+ """
+ return isinstance(value, list)
+
+
+def is_match(obj: t.Any, source: t.Any) -> bool:
+ """
+ Performs a partial deep comparison between `obj` and `source` to determine if `obj` contains
+ equivalent property values.
+
+ Args:
+ obj: Object to compare.
+ source: Object of property values to match.
+
+ Returns:
+ Whether `obj` is a match or not.
+
+ Example:
+
+ >>> is_match({'a': 1, 'b': 2}, {'b': 2})
+ True
+ >>> is_match({'a': 1, 'b': 2}, {'b': 3})
+ False
+ >>> is_match({'a': [{'b': [{'c': 3, 'd': 4}]}]},\
+ {'a': [{'b': [{'d': 4}]}]})
+ True
+
+ .. versionadded:: 3.0.0
+
+ .. versionchanged:: 3.2.0
+ Don't compare `obj` and `source` using ``type``. Use ``isinstance``
+ exclusively.
+
+ .. versionchanged:: 4.0.0
+ Move `iteratee` argument to :func:`is_match_with`.
+ """
+ return is_match_with(obj, source)
+
+
+def is_match_cmp(source: t.Any) -> t.Callable[[t.Any], bool]:
+ """
+ Curried version of :func:`is_match`.
+
+ Args:
+ source: Object of property values to match.
+
+ Returns:
+ A predicate checking whether passed :attr:`obj` is a match or not.
+
+ Example:
+
+ >>> is_match_cmp({"b": 2})({"a": 1, "b": 2})
+ True
+ >>> is_match_cmp({"b": 3})({"a": 1, "b": 2})
+ False
+ >>> is_match_cmp({"a": [{"b": [{"d": 4}]}]})({"a": [{"b": [{"c": 3, "d": 4}]}]})
+ True
+
+ .. versionadded:: 7.1.0
+ """
+ return lambda obj: is_match(obj, source)
+
+
+def is_match_with(
+ obj: t.Any,
+ source: t.Any,
+ customizer: t.Any = None,
+ _key: t.Any = UNSET,
+ _obj: t.Any = UNSET,
+ _source: t.Any = UNSET,
+) -> bool:
+ """
+ This method is like :func:`is_match` except that it accepts customizer which is invoked to
+ compare values. If customizer returns ``None``, comparisons are handled by the method instead.
+ The customizer is invoked with five arguments: ``(obj_value, src_value, index|key, obj,
+ source)``.
+
+ Args:
+ obj: Object to compare.
+ source: Object of property values to match.
+ customizer: Customizer used to compare values from `obj` and `source`.
+
+ Returns:
+ Whether `obj` is a match or not.
+
+ Example:
+
+ >>> is_greeting = lambda val: val in ("hello", "hi")
+ >>> customizer = lambda ov, sv: is_greeting(ov) and is_greeting(sv)
+ >>> obj = {"greeting": "hello"}
+ >>> src = {"greeting": "hi"}
+ >>> is_match_with(obj, src, customizer)
+ True
+
+ .. versionadded:: 4.0.0
+ """
+ if _obj is UNSET:
+ _obj = obj
+
+ if _source is UNSET:
+ _source = source
+
+ if not callable(customizer):
+
+ def cbk(obj_value, src_value):
+ return obj_value == src_value
+
+ # no attribute `_argcount`
+ cbk._argcount = 2 # type: ignore
+ else:
+ cbk = customizer
+
+ if isinstance(source, (Mapping, Iterable)) and not isinstance(source, str):
+ # Set equal to True if source is empty, otherwise, False and then allow deep comparison to
+ # determine equality.
+ equal = not source
+
+ # Walk a/b to determine equality.
+ for key, value in iterator(source):
+ try:
+ obj_value = base_get(obj, key)
+ equal = is_match_with(obj_value, value, cbk, _key=key, _obj=_obj, _source=_source)
+ except Exception:
+ equal = False
+
+ if not equal:
+ break
+ else:
+ equal = callit(cbk, obj, source, _key, _obj, _source)
+
+ return equal
+
+
+def is_match_with_cmp(source: t.Any, customizer: t.Any = None) -> t.Callable[[t.Any], bool]:
+ """
+ Curried version of :func:`is_match_with`.
+
+ Args:
+ source: Object of property values to match.
+ customizer: Customizer used to compare values from `obj` and `source`.
+
+ Returns:
+ A predicate checking whether passed :attr:`obj` is a match or not.
+
+ Example:
+
+ >>> is_greeting = lambda val: val in ("hello", "hi")
+ >>> customizer = lambda ov, sv: is_greeting(ov) and is_greeting(sv)
+ >>> obj = {"greeting": "hello"}
+ >>> src = {"greeting": "hi"}
+ >>> is_match_with_cmp(src, customizer)(obj)
+ True
+
+ .. versionadded:: 7.1.0
+ """
+ return lambda obj: is_match_with(obj, source, customizer)
+
+
+def is_monotone(value: t.Union[T, t.List[T]], op: t.Callable[[T, T], t.Any]) -> bool:
+ """
+ Checks if `value` is monotonic when `operator` used for comparison.
+
+ Args:
+ value: Value to check.
+ op: Operation to used for comparison.
+
+ Returns:
+ Whether `value` is monotone.
+
+ Example:
+
+ >>> is_monotone([1, 1, 2, 3], operator.le)
+ True
+ >>> is_monotone([1, 1, 2, 3], operator.lt)
+ False
+
+ .. versionadded:: 2.0.0
+ """
+ if not is_list(value):
+ l_value = [value]
+ else:
+ l_value = value # type: ignore
+
+ search = (
+ False
+ for x, y in zip(l_value, islice(l_value, 1, None))
+ if not op(x, y) # type: ignore
+ )
+
+ return next(search, True)
+
+
+def is_monotone_cmp(
+ op: t.Callable[[T, T], t.Any],
+) -> t.Callable[[t.Union[T, t.List[T]]], bool]:
+ """
+ Curried version of :func:`is_monotone`.
+
+ Args:
+ op: Operation to used for comparison.
+
+ Returns:
+ A predicate checking whether passed :attr:`value` is monotone.
+
+ Example:
+
+ >>> is_monotone_cmp(operator.le)([1, 1, 2, 3])
+ True
+ >>> is_monotone_cmp(operator.lt)([1, 1, 2, 3])
+ False
+
+ .. versionadded:: 7.1.0
+ """
+ return lambda value: is_monotone(value, op)
+
+
+def is_nan(value: t.Any) -> bool:
+ """
+ Checks if `value` is not a number.
+
+ Args:
+ value: Value to check.
+
+ Returns:
+ Whether `value` is not a number.
+
+ Example:
+
+ >>> is_nan("a")
+ True
+ >>> is_nan(1)
+ False
+ >>> is_nan(1.0)
+ False
+
+ .. versionadded:: 1.0.0
+ """
+ return not is_number(value)
+
+
+def is_negative(value: t.Any) -> bool:
+ """
+ Checks if `value` is negative.
+
+ Args:
+ value: Value to check.
+
+ Returns:
+ Whether `value` is negative.
+
+ Example:
+
+ >>> is_negative(-1)
+ True
+ >>> is_negative(0)
+ False
+ >>> is_negative(1)
+ False
+
+ .. versionadded:: 2.0.0
+ """
+ return is_number(value) and value < 0
+
+
+def is_none(value: t.Any) -> TypeGuard[None]:
+ """
+ Checks if `value` is `None`.
+
+ Args:
+ value: Value to check.
+
+ Returns:
+ Whether `value` is ``None``.
+
+ Example:
+
+ >>> is_none(None)
+ True
+ >>> is_none(False)
+ False
+
+ .. versionadded:: 1.0.0
+ """
+ return value is None
+
+
+def is_number(value: t.Any) -> bool:
+ """
+ Checks if `value` is a number.
+
+ Args:
+ value: Value to check.
+
+ Returns:
+ Whether `value` is a number.
+
+ Note:
+ Returns ``True`` for ``int``, ``long`` (PY2), ``float``, and
+ ``decimal.Decimal``.
+
+ Example:
+
+ >>> is_number(1)
+ True
+ >>> is_number(1.0)
+ True
+ >>> is_number("a")
+ False
+
+ .. versionadded:: 1.0.0
+
+ .. versionchanged:: 3.0.0
+ Added ``is_num`` as alias.
+
+ .. versionchanged:: 4.0.0
+ Removed alias ``is_num``.
+ """
+ return not is_boolean(value) and isinstance(value, NUMBER_TYPES)
+
+
+def is_object(value: t.Any) -> bool:
+ """
+ Checks if `value` is a ``list`` or ``dict``.
+
+ Args:
+ value: Value to check.
+
+ Returns:
+ Whether `value` is ``list`` or ``dict``.
+
+ Example:
+
+ >>> is_object([])
+ True
+ >>> is_object({})
+ True
+ >>> is_object(())
+ False
+ >>> is_object(1)
+ False
+
+ .. versionadded:: 1.0.0
+ """
+ return isinstance(value, (list, dict))
+
+
+def is_odd(value: t.Any) -> bool:
+ """
+ Checks if `value` is odd.
+
+ Args:
+ value: Value to check.
+
+ Returns:
+ Whether `value` is odd.
+
+ Example:
+
+ >>> is_odd(3)
+ True
+ >>> is_odd(2)
+ False
+ >>> is_odd("a")
+ False
+
+ .. versionadded:: 2.0.0
+ """
+ return is_number(value) and value % 2 != 0
+
+
+def is_positive(value: t.Any) -> bool:
+ """
+ Checks if `value` is positive.
+
+ Args:
+ value: Value to check.
+
+ Returns:
+ Whether `value` is positive.
+
+ Example:
+
+ >>> is_positive(1)
+ True
+ >>> is_positive(0)
+ False
+ >>> is_positive(-1)
+ False
+
+ .. versionadded:: 2.0.0
+ """
+ return is_number(value) and value > 0
+
+
+def is_reg_exp(value: t.Any) -> TypeGuard[re.Pattern[t.Any]]:
+ """
+ Checks if `value` is a ``RegExp`` object.
+
+ Args:
+ value: Value to check.
+
+ Returns:
+ Whether `value` is a RegExp object.
+
+ Example:
+
+ >>> is_reg_exp(re.compile(""))
+ True
+ >>> is_reg_exp("")
+ False
+
+ .. versionadded:: 1.1.0
+
+ .. versionchanged:: 4.0.0
+ Removed alias ``is_re``.
+ """
+ return isinstance(value, RegExp)
+
+
+def is_set(value: t.Any) -> bool:
+ """
+ Checks if the given value is a set object or not.
+
+ Args:
+ value: Value passed in by the user.
+
+ Returns:
+ True if the given value is a set else False.
+
+ Example:
+
+ >>> is_set(set([1, 2]))
+ True
+ >>> is_set([1, 2, 3])
+ False
+
+ .. versionadded:: 4.0.0
+ """
+ return isinstance(value, set)
+
+
+def is_strictly_decreasing(
+ value: t.Union["SupportsRichComparison", t.List["SupportsRichComparison"]],
+) -> bool:
+ """
+ Check if `value` is strictly decreasing.
+
+ Args:
+ value: Value to check.
+
+ Returns:
+ Whether `value` is strictly decreasing.
+
+ Example:
+
+ >>> is_strictly_decreasing([4, 3, 2, 1])
+ True
+ >>> is_strictly_decreasing([4, 4, 2, 1])
+ False
+
+ .. versionadded:: 2.0.0
+ """
+ return is_monotone(value, operator.gt) # type: ignore
+
+
+def is_strictly_increasing(
+ value: t.Union["SupportsRichComparison", t.List["SupportsRichComparison"]],
+) -> bool:
+ """
+ Check if `value` is strictly increasing.
+
+ Args:
+ value: Value to check.
+
+ Returns:
+ Whether `value` is strictly increasing.
+
+ Example:
+
+ >>> is_strictly_increasing([1, 2, 3, 4])
+ True
+ >>> is_strictly_increasing([1, 1, 3, 4])
+ False
+
+ .. versionadded:: 2.0.0
+ """
+ return is_monotone(value, operator.lt) # type: ignore
+
+
+def is_string(value: t.Any) -> TypeGuard[str]:
+ """
+ Checks if `value` is a string.
+
+ Args:
+ value: Value to check.
+
+ Returns:
+ Whether `value` is a string.
+
+ Example:
+
+ >>> is_string("")
+ True
+ >>> is_string(1)
+ False
+
+ .. versionadded:: 1.0.0
+ """
+ return isinstance(value, str)
+
+
+def is_tuple(value: t.Any) -> bool:
+ """
+ Checks if `value` is a tuple.
+
+ Args:
+ value: Value to check.
+
+ Returns:
+ Whether `value` is a tuple.
+
+ Example:
+
+ >>> is_tuple(())
+ True
+ >>> is_tuple({})
+ False
+ >>> is_tuple([])
+ False
+
+ .. versionadded:: 3.0.0
+ """
+ return isinstance(value, tuple)
+
+
+def is_zero(value: t.Any) -> TypeGuard[int]:
+ """
+ Checks if `value` is ``0``.
+
+ Args:
+ value: Value to check.
+
+ Returns:
+ Whether `value` is ``0``.
+
+ Example:
+
+ >>> is_zero(0)
+ True
+ >>> is_zero(1)
+ False
+
+ .. versionadded:: 2.0.0
+ """
+ return value == 0 and is_integer(value)