repos/jaraco-jaraco.classes-509861e/jaraco/classes/ancestry.py

"""
Routines for obtaining the class names
of an object and its parent classes.
"""

from __future__ import annotations

from typing import TYPE_CHECKING, cast

from more_itertools import unique_everseen

if TYPE_CHECKING:
    from collections.abc import Iterator
    from typing import Any


def all_bases(c: type[object]) -> list[type[Any]]:
    """
    return a tuple of all base classes the class c has as a parent.
    >>> object in all_bases(list)
    True
    """
    return c.mro()[1:]


def all_classes(c: type[object]) -> list[type[Any]]:
    """
    return a tuple of all classes to which c belongs
    >>> list in all_classes(list)
    True
    """
    return c.mro()


# borrowed from
# http://code.activestate.com/recipes/576949-find-all-subclasses-of-a-given-class/


def iter_subclasses(cls: type[object]) -> Iterator[type[Any]]:
    """
    Generator over all subclasses of a given class, in depth-first order.

    >>> bool in list(iter_subclasses(int))
    True
    >>> class A(object): pass
    >>> class B(A): pass
    >>> class C(A): pass
    >>> class D(B,C): pass
    >>> class E(D): pass
    >>>
    >>> for cls in iter_subclasses(A):
    ...     print(cls.__name__)
    B
    D
    E
    C
    >>> # get ALL classes currently defined
    >>> res = [cls.__name__ for cls in iter_subclasses(object)]
    >>> 'type' in res
    True
    >>> 'tuple' in res
    True
    >>> len(res) > 100
    True
    """
    return unique_everseen(_iter_all_subclasses(cls))


def _iter_all_subclasses(cls: type[object]) -> Iterator[type[Any]]:
    try:
        subs = cls.__subclasses__()
    except TypeError:  # fails only when cls is type
        subs = cast('type[type]', cls).__subclasses__(cls)
    for sub in subs:
        yield sub
        yield from iter_subclasses(sub)