Function skip_ellipsis

ormar/models/excludable.py:19–39

Descend one level into an include/exclude dict by ``key``, returning ``default`` when the lookup yields ``Ellipsis``. Ellipsis at this position means "all fields below" rather than a concrete set/dict to recurse into. :param items: current include/exclude value :type items: Uni

(
    items: Union[set, dict, None],
    key: str,
    default: Any = None,
)

def skip_ellipsis(
    items: Union[set, dict, None],
    key: str,
    default: Any = None,
) -> Union[set, dict, None]:
    """
    Descend one level into an include/exclude dict by ``key``, returning
    ``default`` when the lookup yields ``Ellipsis``. Ellipsis at this position
    means "all fields below" rather than a concrete set/dict to recurse into.

    :param items: current include/exclude value
    :type items: Union[set, dict, None]
    :param key: key for nested relations to check
    :type key: str
    :param default: value returned when the lookup yields Ellipsis
    :type default: Any
    :return: nested value of the items
    :rtype: Union[set, dict, None]
    """
    result = items.get(key, {}) if isinstance(items, dict) else items
    return result if result is not Ellipsis else default


def convert_all(items: Union[set, dict, None]) -> Union[set, dict, None]: