<reponame>shamrin/asynctb
import attr
import contextlib
import gc
import importlib
import inspect
import linecache
import math
import sys
import threading
import traceback
import types
import warnings
from typing import (
    Any,
    AsyncGenerator,
    Callable,
    Coroutine,
    Dict,
    Generator,
    Iterator,
    List,
    Mapping,
    Optional,
    Sequence,
    Tuple,
    Union,
    TYPE_CHECKING,
    cast,
)

from ._frames import ContextInfo, contexts_active_in_frame
from ._registry import (
    unwrap_awaitable,
    unwrap_context_manager,
    CodeHandling,
    HANDLING_FOR_CODE,
)
from ._glue import ensure_installed as ensure_glue_is_installed

try:
    if not TYPE_CHECKING:
        from greenlet import (
            greenlet as GreenletType,
            getcurrent as greenlet_getcurrent,
        )
except ImportError:

    class GreenletType:
        parent: Optional["GreenletType"] = None
        gr_frame: Optional[types.FrameType]

    def greenlet_getcurrent() -> GreenletType:
        return GreenletType()


# We'll use the name "genlike" to refer to an instance of any of these types
GeneratorLike = Union[
    Generator[Any, Any, Any], AsyncGenerator[Any, Any], Coroutine[Any, Any, Any]
]


@attr.s(auto_attribs=True, slots=True, eq=True, frozen=True)
class FrameInfo:
    """Information about one frame in a `Traceback`."""

    frame: types.FrameType
    lineno: int = attr.Factory(lambda self: self.frame.f_lineno, takes_self=True)
    override_line: Optional[str] = None
    context_manager: object = None
    context_name: Optional[str] = None

    @property
    def filename(self) -> str:
        """The filename of the Python file from which this frame's code was
        imported."""
        return self.frame.f_code.co_filename

    @property
    def funcname(self) -> str:
        """The name of the function whose code this frame is executing."""
        return self.frame.f_code.co_name

    @property
    def linetext(self) -> str:
        """The text of the line of source code that this frame is executing.

        The return value has leading and trailing whitespace stripped, and
        does not end in a newline. In some cases (such as callbacks in an
        `~contextlib.ExitStack`), where we can't determine the original
        source line, we return a synthesized line beginning with ``#``.
        """
        if self.override_line is not None:
            return self.override_line
        if self.lineno == 0:
            return ""
        return linecache.getline(
            self.filename, self.lineno, self.frame.f_globals
        ).strip()

    @property
    def _context_descr(self) -> str:
        if self.context_manager is not None:
            typename = type(self.context_manager).__name__
            varname = self.context_name or "_"
            return f" ({varname}: {typename})"
        elif self.context_name is not None:
            return f" ({self.context_name})"
        return ""

    def __str__(self) -> str:
        ret = (
            f"  File {self.filename}, line {self.lineno}, in {self.funcname}"
            f"{self._context_descr}"
        )
        line = self.linetext
        if line:
            ret += f"\n    {line}"
        return ret + "\n"

    def as_stdlib_summary(
        self, *, capture_locals: bool = False
    ) -> traceback.FrameSummary:
        """Return a representation of this frame as a standard
        `traceback.FrameSummary`. Unlike this `FrameInfo` object, the
        result can be pickled and will not keep frames alive, at the
        expense of some loss of information.

        If this frame introduces a context manager in an :ref:`enhanced traceback
        <enhanced-tb>`, information about the name and type of the context manager
        will be appended to the function *name* in the returned
        `~traceback.FrameSummary`, in parentheses after a space. This results
        in reasonable output from :meth:`traceback.StackSummary.format`.

        If *capture_locals* is True, then the returned `~traceback.FrameSummary`
        will contain the stringified object representations of all local variables
        in this frame.

        """
        funcname = self.funcname + self._context_descr
        if not capture_locals:
            save_locals = None
        elif self.context_manager is not None:
            save_locals = {"<context manager>": repr(self.context_manager)}
        else:
            save_locals = {
                name: repr(value) for name, value in self.frame.f_locals.items()
            }

        return traceback.FrameSummary(
            self.frame.f_code.co_filename,
            self.lineno,
            funcname,
            locals=save_locals,
            line=self.override_line,
        )


# We have two modes in which we might need to iterate over frames:
# "inward" (when working with a suspended coroutine/generator,
# where the outer object has a cr_await/gi_yieldfrom member that
# refers to the inner) or "outward" (when working with a greenlet or
# with running frames, in which the inner frame has an f_back that
# refers to the outer). We sometimes need to switch between these.
# This is implemented by defining two generator functions, iterate_suspended
# and iterate_running, each of which yields FrameInfos. Mode switching
# is implemented by having one yield from the other.


@attr.s(auto_attribs=True, slots=True, eq=True, frozen=True)
class Traceback:
    """A summary of the current execution context of a running or
    suspended function, coroutine, etc.

    A `Traceback` consists of a series of frames (each represented as a
    `FrameInfo` object), ordered from outermost (earlier call) to
    innermost (more recent call).

    You can get a `Traceback` for a coroutine, greenlet, or (sync or
    async) generator using :meth:`Traceback.of`, or for the current
    stack using :meth:`Traceback.since` or :meth:`Traceback.until`.
    """

    #: The frames that have been extracted as part of this traceback.
    frames: Sequence[FrameInfo]

    #: The error that prevented us from extracting more `frames`, if any.
    error: Optional[Exception] = None

    @classmethod
    def of(
        cls,
        stackref: Union[GeneratorLike, GreenletType, threading.Thread],
        *,
        with_context_info: bool = True,
    ) -> "Traceback":
        """Return a traceback reflecting the current stack of *stackref*,
        which must be a coroutine object, greenlet object, or (sync or
        async) generator iterator. It may be either running or
        suspended. If it's running in a different thread, we'll still
        attempt to extract a traceback, but might not be able to. In
        particular, greenlets running in other threads can never be
        tracebacked, and generator-like objects might fail to extract
        a traceback depending on when thread switches occur.

        Produce an :ref:`enhanced traceback <enhanced-tb>` if *with_context_info*
        is True (the default), or a basic traceback if *with_context_info* is False.
        """
        if isinstance(stackref, GreenletType):
            inner_frame = stackref.gr_frame
            outer_frame = None
            if inner_frame is None:
                if not stackref:  # dead or not started
                    return Traceback(frames=())
                # otherwise a None frame means it's running
                if stackref is not greenlet_getcurrent():
                    return Traceback(
                        frames=(),
                        error=RuntimeError(
                            "Traceback.of(greenlet) can't handle a greenlet running "
                            "in another thread"
                        ),
                    )
                # since it's running in this thread, its stack is our own
                inner_frame = sys._getframe(1)
                if stackref.parent is not None:
                    outer_frame = inner_frame
                    assert outer_frame is not None

                    # On CPython the end of this greenlet's stack is marked
                    # by None. On PyPy it gets seamlessly attached to its
                    # parent's stack.
                    while (
                        outer_frame.f_back is not stackref.parent.gr_frame
                        and outer_frame.f_back is not None
                    ):
                        outer_frame = outer_frame.f_back
            producer = iterate_running(
                outer_frame, inner_frame, with_context_info, stackref
            )
        elif isinstance(stackref, threading.Thread):
            # If the thread is not alive both before and after we try to fetch
            # its frame, then it's possible that its identity was reused, and
            # we shouldn't trust the frame we get.
            was_alive = stackref.is_alive()
            inner_frame = sys._current_frames().get(stackref.ident)  # type: ignore
            if inner_frame is None or not stackref.is_alive() or not was_alive:
                return Traceback(frames=())
            producer = iterate_running(None, inner_frame, with_context_info, stackref)
        else:
            producer = iterate_suspended(stackref, with_context_info)
        return cls._make(producer)

    @classmethod
    def since(
        cls, outer_frame: Optional[types.FrameType], *, with_context_info: bool = True
    ) -> "Traceback":
        """Return a traceback reflecting the currently executing frames
        that were directly or indirectly called by *outer_frame*.

        If *outer_frame* is a frame on the current thread's stack, the resulting
        traceback will start with *outer_frame* and end with the immediate
        caller of :meth:`since`.

        If *outer_frame* is a frame on some other thread's stack, and it remains
        there throughout the traceback extraction process, the resulting
        traceback will start with *outer_frame* and end with some frame
        that was recently the innermost frame on that thread's stack.

        .. note:: If *other_frame* is not continuously on the same other thread's
           stack during the traceback extraction process, you're likely to get
           a one-frame traceback with an `error`. It's not possible to prevent
           thread switching from within Python code, so we can't do better than
           this without a C extension.

        If *outer_frame* is None, the resulting traceback contains all frames
        on the current thread's stack, starting with the outermost and ending
        with the immediate caller of :meth:`since`.

        In any other case -- if *outer_frame* belongs to a suspended coroutine,
        generator, greenlet, or if it starts or stops running on another thread
        while :meth:`since` is executing -- you will get a `Traceback` containing
        information only on *outer_frame* itself, whose `error` member describes
        the reason more information can't be provided.

        Produce an :ref:`enhanced traceback <enhanced-tb>` if *with_context_info*
        is True (the default), or a basic traceback if *with_context_info* is False.
        """
        if outer_frame is not None and not isinstance(outer_frame, types.FrameType):
            raise TypeError(f"outer_frame must be a frame, not {type(outer_frame)!r}")
        return cls._make(iterate_running(outer_frame, None, with_context_info))

    @classmethod
    def until(
        cls,
        inner_frame: types.FrameType,
        *,
        limit: Union[int, types.FrameType, None] = None,
        with_context_info: bool = True,
    ) -> "Traceback":
        """Return a traceback reflecting the currently executing frames
        that are direct or indirect callers of *inner_frame*.

        If *inner_frame* belongs to a suspended coroutine or
        generator, or if it otherwise is not linked to other frames
        via its ``f_back`` attribute, then the returned traceback will
        contain only *inner_frame* and not any of its callers.

        If a *limit* is specified, only some of the callers of *inner_frame*
        will be returned. If the *limit* is a frame, then it must be an indirect
        caller of *inner_frame* and it will be the first frame in the returned
        traceback. Otherwise, the *limit* must be a positive integer, and the
        traceback will start with the *limit*'th parent of *inner_frame*.

        Produce an :ref:`enhanced traceback <enhanced-tb>` if *with_context_info*
        is True (the default), or a basic traceback if *with_context_info* is False.
        """
        if limit is None:
            outer_frame = None
        elif isinstance(limit, types.FrameType):
            outer_frame = inner_frame
            while (
                outer_frame is not limit
                and outer_frame is not None
                # This last condition catches suspended greenlets in PyPy,
                # whose f_back members form a cycle.
                and outer_frame.f_back is not inner_frame
            ):
                outer_frame = outer_frame.f_back
            if outer_frame is None:
                raise RuntimeError(
                    f"{limit} is not an indirect caller of {inner_frame}"
                )
        elif isinstance(limit, int):
            outer_frame = inner_frame
            while (
                limit > 0
                and outer_frame is not None
                and outer_frame.f_back is not inner_frame
            ):
                outer_frame = outer_frame.f_back
                limit -= 1
        else:
            raise TypeError(
                f"'limit' argument must be a frame or integer, not {type(limit)!r}"
            )

        return cls._make(iterate_running(outer_frame, inner_frame, with_context_info))

    @classmethod
    def _make(cls, producer: Iterator[FrameInfo]) -> "Traceback":
        frames: List[FrameInfo] = []
        error: Optional[Exception] = None
        ensure_glue_is_installed()
        try:
            frames.extend(producer)
        except Exception as exc:
            error = exc
        return cls(tuple(frames), error)

    def __len__(self) -> int:
        return len(self.frames)

    def __iter__(self) -> Iterator[FrameInfo]:
        return iter(self.frames)

    def __str__(self) -> str:
        lines = []
        if self.frames:
            lines.append("Traceback (most recent call last):\n")
            lines.extend(self.as_stdlib_summary().format())
        if self.error:
            lines.append(
                "Error while extracting traceback: "
                + "".join(traceback.format_exception_only(type(self.error), self.error))
            )
            lines.extend(traceback.format_tb(self.error.__traceback__))
        return "".join(lines)

    def as_stdlib_summary(
        self, *, capture_locals: bool = False
    ) -> traceback.StackSummary:
        """Return a representation of this frame as a standard
        `traceback.StackSummary`. The result can be pickled and will
        not keep frames alive, at the expense of some loss of information
        (including the values of `FrameInfo.context_manager` and
        `FrameInfo.context_name`).

        If *capture_locals* is True, then the individual `~traceback.FrameSummary`
        objects in the returned `~traceback.StackSummary` will contain the
        stringified object representations of all local variables in each frame.
        """
        return traceback.StackSummary.from_list(
            [
                cast(
                    # typeshed doesn't understand that FrameSummary
                    # implements this tuple protocol too
                    Tuple[str, int, str, Optional[str]],
                    frame.as_stdlib_summary(capture_locals=capture_locals),
                )
                for frame in self.frames
            ]
        )


# -------- Everything below this point is implementation details --------


# Singleton object returned by next_from_genlike() to indicate
# that a generator or coroutine is currently running and that we therefore
# need to switch to iterate_running().
RUNNING = object()


_default_handling = CodeHandling()


def iterate_suspended(
    genlike: GeneratorLike, with_context_info: bool, switch_count: int = 0
) -> Iterator[FrameInfo]:
    """Yield information about a series of frames representing the current
    stack of the suspended generator iterator, async generator iterator,
    or coroutine object *genlike*.

    If *with_context_info* is True, yield additional frames
    representing context managers, to produce an enhanced traceback.

    *switch_count* tracks the number of times we have switched modes
    from inward to outward or vice versa, as a guard against infinite
    loops.
    """

    genlike = unwrap_awaitable(genlike)

    while genlike is not None:
        this_frame = frame_from_genlike(genlike)
        if this_frame is None:
            # Exhausted generator/coroutine has no traceback
            break

        next_genlike = next_from_genlike(genlike)
        if next_genlike is RUNNING:
            # If it's running, cr_await/ag_await/gi_yieldfrom aren't available,
            # so we need an alternate approach.
            yield from iterate_running(
                outer_frame=this_frame,
                inner_frame=None,
                with_context_info=with_context_info,
                parent=genlike,
                switch_count=switch_count + 1,
            )
            break

        # Otherwise, the generator/coroutine is suspended. Yield info
        # about this_frame (and its context managers), then continue
        # down the stack to next_genlike (the thing this genlike is
        # awaiting/yielding-from).

        try:
            next_frame = frame_from_genlike(next_genlike)
        except Exception:
            next_frame = None
        keep_going = yield from handle_frame(
            this_frame=this_frame,
            next_frame=next_frame,
            with_context_info=with_context_info,
            switch_count=switch_count,
        )
        if not keep_going:
            break

        genlike = unwrap_awaitable(next_genlike)


def iterate_running(
    outer_frame: Optional[types.FrameType],
    inner_frame: Optional[types.FrameType],
    with_context_info: bool,
    parent: Union[GeneratorLike, GreenletType, threading.Thread, None] = None,
    switch_count: int = 0,
) -> Iterator[FrameInfo]:
    """Yield information about a series of frames linked via f_back
    members from inner_frame out to outer_frame. (They will be yielded
    in the opposite order, outer_frame first.)

    If outer_frame is None, continue until the outermost frame on inner_frame's
    stack is reached. If inner_frame is None, find a currently-executing frame
    on any thread that has outer_frame on its stack. If both are None, produce
    frames for the current thread's entire stack.

    If these frames represent the stack of a running generator or
    coroutine or greenlet or thread, pass *parent* as that generator
    or coroutine or greenlet or thread. This is used to switch back to
    iterate_suspended() if a generator or coroutine stops running (in
    another thread) while we're looking. (We don't currently do
    anything special with a greenlet or thread *parent*, but maybe
    we'll want to at some point.)

    If *with_context_info* is True, yield additional frames
    representing context managers, to produce an enhanced traceback.

    *switch_count* tracks the number of times we have switched modes
    from inward to outward or vice versa, as a guard against infinite
    loops.

    """

    # Running frames are linked "outward" (from the current frame
    # backwards via f_back members), not "inward" (even if the frames
    # belong to a coroutine/generator/etc, the cr_await / gi_yieldfrom
    # / etc members are None). Thus, in order to know what comes after
    # outer_frame in the traceback, we have to find a currently
    # executing frame that has outer_frame on its stack.

    # This function tries a bunch of different ways to fill out this 'frames'
    # list, as a list of the frames we want to traceback from outermost
    # to innermost.
    frames: List[types.FrameType] = []

    def get_true_caller() -> types.FrameType:
        # Return the frame that called into the traceback-producing machinery.
        # That will be at least 3 frames up (iterate_running, Traceback._make,
        # Traceback.of/since/until) and might be more if we've done some mode
        # switching.
        caller: Optional[types.FrameType] = sys._getframe(3)
        while caller is not None and caller.f_globals is globals():
            caller = caller.f_back
        assert caller is not None
        return caller

    if sys.implementation.name == "cpython" and greenlet_getcurrent().parent:
        # On CPython, each greenlet is its own universe traceback-wise:
        # if you're inside a non-main greenlet and you follow f_back links
        # outward from your current frame, you'll only find the outermost
        # frame in this greenlet, not in this thread. We augment that by
        # following the greenlet parent link (the same path an exception
        # would take) when we reach an f_back of None.
        #
        # This only works on the current thread, since there's no way
        # to call greenlet.getcurrent() for another thread. (There's a key
        # in the thread state dictionary, which we can't safely access because
        # any other thread state can disappear out from under us whenever we
        # yield the GIL, which we can't prevent from happening. Resolving
        # this would require an extension module.)
        #
        # PyPy uses a more sensible scheme where the f_back links in the
        # current callstack always work, so it doesn't need this trick.
        this_thread_frames: List[types.FrameType] = []
        greenlet: Optional[GreenletType] = greenlet_getcurrent()
        current: Optional[types.FrameType] = get_true_caller()
        while greenlet is not None:
            while current is not None:
                this_thread_frames.append(current)
                current = current.f_back
            greenlet = greenlet.parent
            if greenlet is not None:
                current = greenlet.gr_frame
        try:
            from_idx: Optional[int]
            if inner_frame is None or this_thread_frames[0] is inner_frame:
                from_idx = None
            else:
                from_idx = this_thread_frames.index(inner_frame) - 1
            to_idx = (
                len(this_thread_frames)
                if outer_frame is None
                else this_thread_frames.index(outer_frame)
            )
        except ValueError:
            pass
        else:
            frames = this_thread_frames[to_idx:from_idx:-1]

    def try_from(potential_inner_frame: types.FrameType) -> List[types.FrameType]:
        """If potential_inner_frame has outer_frame somewhere up its callstack,
        return the list of frames between them, starting with
        outer_frame and ending with potential_inner_frame. Otherwise, return [].
        If outer_frame is None, return all frames enclosing
        potential_inner_frame, including potential_inner_frame.
        """
        frames: List[types.FrameType] = []
        current: Optional[types.FrameType] = potential_inner_frame
        while current is not None:
            frames.append(current)
            # Note: suspended greenlets on PyPy have frames that form a cycle,
            # thus the 2nd part of this condition
            if current is outer_frame or (
                outer_frame is None and current.f_back is potential_inner_frame
            ):
                break
            current = current.f_back
        if current is outer_frame or outer_frame is None:
            return frames[::-1]
        return []

    if not frames:
        frames = try_from(inner_frame or get_true_caller())

    if not frames and inner_frame is None:
        # outer_frame isn't on *our* stack, but it might be on some
        # other thread's stack. It would be nice to avoid yielding
        # the GIL while we look, but that doesn't appear to be
        # possible -- sys.setswitchinterval() changes apply only
        # to those threads that have yielded the GIL since it was
        # called. We'll just have to accept the potential race
        # condition.
        for ident, inner_frame in sys._current_frames().items():
            if ident != threading.get_ident():
                frames = try_from(inner_frame)
                if frames:
                    break
        else:
            # We couldn't find any thread that had outer_frame
            # on its stack.
            if (
                parent is not None
                and not isinstance(parent, (GreenletType, threading.Thread))
                and switch_count < 50
            ):
                if next_from_genlike(parent) is not RUNNING:
                    # It was running when we started looking, but now
                    # is suspended again. Switch to the logic for suspended
                    # frames. (There's no specific limit to how many times this
                    # can occur; our only argument against an infinite
                    # recursion here is probabilistic, but it's a pretty good
                    # one.)
                    yield from iterate_suspended(
                        genlike=parent,
                        with_context_info=with_context_info,
                        switch_count=switch_count + 1,
                    )
                else:
                    # Possibly it became suspended before we extracted
                    # _current_frames() and then started running again
                    # before we called frame_and_next(). Or possibly
                    # we've become confused and found a frame that
                    # isn't running at all, e.g., because it's part of
                    # a suspended greenlet. Assume the former until we
                    # hit our mode-switching limit, at which point
                    # give up so as not to infinite-loop in the latter case.
                    yield from iterate_running(
                        outer_frame=outer_frame,
                        inner_frame=None,
                        with_context_info=with_context_info,
                        parent=parent,
                        switch_count=switch_count + 1,
                    )
                return

    if not frames:
        # If outer_frame is None, try_from() always returns a non-empty
        # list, so we can only get here if outer_frame is not None.
        assert outer_frame is not None
        yield from one_frame_traceback(outer_frame, None, False)
        raise RuntimeError(
            "Couldn't find where the above frame is running, so "
            "can't continue traceback"
        )

    for this_frame, next_frame in zip(
        frames, cast(List[Optional[types.FrameType]], frames[1:]) + [None]
    ):
        keep_going = yield from handle_frame(
            this_frame=this_frame,
            next_frame=next_frame,
            with_context_info=with_context_info,
            switch_count=switch_count,
        )
        if not keep_going:
            break


def handle_frame(
    this_frame: types.FrameType,
    next_frame: Optional[types.FrameType],
    with_context_info: bool,
    switch_count: int,
) -> Generator[FrameInfo, None, bool]:
    """Yield traceback information related to a single frame, *this_frame*.

    *next_frame* should preview the following frame in the traceback.
    Its information will not be yielded during this call, but it will be
    used to provide more detail on any context manager that is currently
    being exited.

    If *with_context_info* is False, this will usually be just a single FrameInfo.
    If *with_context_info* is True, it will include additional FrameInfos for
    each context manager active in *this_frame*, and might include even more
    frames representing the state of those context managers.

    If *this_frame* is for a function that manages a suspended callstack,
    as registered using :func:`customize` or :func:`register_get_target`,
    then :func:`handle_frame` will descend into that callstack, yielding
    all of its frames.

    Returns true if the caller should continue tracebacking into more
    frames (if those exist), or false if the traceback should be
    artificially cut off here.
    """

    handling = HANDLING_FOR_CODE.get(this_frame.f_code, _default_handling)

    if not handling.skip_frame:
        yield from one_frame_traceback(this_frame, next_frame, with_context_info)

    if handling.get_target is not None:
        try:
            target = handling.get_target(this_frame, next_frame)
            if isinstance(target, GreenletType):
                # This frame is the runner for a greenlet.
                # Grab gr_frame atomically in case it starts running in
                # another thread.
                gr_frame = target.gr_frame
                if gr_frame is not None:
                    yield from iterate_running(
                        outer_frame=None,
                        inner_frame=gr_frame,
                        with_context_info=with_context_info,
                        parent=target,
                        switch_count=switch_count + 1,
                    )
                # If gr_frame is None, the greenlet is dead, not
                # started, or is running in another thread. If it's
                # running, then its frames are probably next on the
                # stack we're inspecting, and we have no way to access
                # them if they're not.  If it's dead or not started,
                # then there's nothing to yield.  So in all of those
                # cases we yield nothing.
            elif isinstance(target, threading.Thread):
                # This frame is waiting for a thread to complete.
                # Go look at what the thread is doing.
                thread_frame = sys._current_frames().get(target.ident)  # type: ignore
                if thread_frame is not None:
                    yield from iterate_running(
                        outer_frame=None,
                        inner_frame=thread_frame,
                        with_context_info=with_context_info,
                        parent=target,
                        switch_count=switch_count + 1,
                    )
            elif target is not None:
                # This frame is the runner for a genlike
                yield from iterate_suspended(
                    genlike=target,
                    with_context_info=with_context_info,
                    switch_count=switch_count + 1,
                )
        except Exception:
            if handling.skip_frame:
                # We didn't yield the frame traceback before, so yield it now
                # to clarify which frame resulted in the exception
                yield from one_frame_traceback(this_frame, None, False)
            raise

    return not handling.skip_callees


def one_frame_traceback(
    this_frame: types.FrameType,
    next_frame: Optional[types.FrameType],
    with_context_info: bool,
) -> Iterator[FrameInfo]:
    """Yield a series of FrameInfos representing a single frame
    *this_frame* in the straight-line traceback.

    If with_context_info is True, yields a series of zero or more
    FrameInfos describing the context managers active in
    *this_frame*. Then, unconditionally yields one FrameInfo
    describing *this_frame* itself.

    *next_frame* should be the next inner frame in the traceback after
    *this_frame*, or None; it is used to determine the context manager
    object currently being exited, if any.

    """
    if with_context_info:
        for context in contexts_active_in_frame(this_frame):
            if context.is_exiting and next_frame is not None:
                # Infer the context manager being exited based on the
                # self argument to its __exit__ or __aexit__ method in
                # the next frame
                args = inspect.getargvalues(next_frame)
                if args.args:
                    context = attr.evolve(context, manager=args.locals[args.args[0]])
            yield from crawl_context(this_frame, context)
    yield FrameInfo(this_frame)


if sys.version_info >= (3, 7):
    # GCMBase: the common base type of context manager objects returned by
    # functions decorated with either @contextlib.contextmanager or
    # @contextlib.asynccontextmanager
    GCMBase = cast(Any, contextlib)._GeneratorContextManagerBase
    from contextlib import AsyncExitStack

    # async_exit_stack.AsyncExitStack is an alias for
    # contextlib.AsyncExitStack on Pythons that have the latter, so
    # there's no need to consider both separately.
else:
    GCMBase: Any

    class AsyncExitStack:
        pass

    if not TYPE_CHECKING:
        from contextlib import _GeneratorContextManager as GCMBase

        try:
            from async_exit_stack import AsyncExitStack  # noqa: F811
        except ImportError:
            pass


# The type of the context manager object returned by a function that is
# decorated with @async_generator.asynccontextmanager
try:
    if not TYPE_CHECKING:
        from async_generator._util import _AsyncGeneratorContextManager as AGCMBackport
except ImportError:

    class AGCMBackport:
        _agen: AsyncGenerator[Any, Any]
        _func_name: str


def frame_from_genlike(genlike: GeneratorLike) -> Optional[types.FrameType]:
    """Return the outermost frame object associated with *genlike*,
    a coroutine or generator iterator. Returns None if *genlike*
    has already completed execution. Raises an exception if it's
    not a coroutine or generator iterator.
    """
    if isinstance(genlike, types.CoroutineType):
        return genlike.cr_frame
    if isinstance(genlike, types.GeneratorType):
        return genlike.gi_frame
    if isinstance(genlike, types.AsyncGeneratorType):
        return genlike.ag_frame
    raise RuntimeError(
        "Couldn't determine the frame associated with {}.{} {!r}".format(
            getattr(type(genlike), "__module__", "??"),
            type(genlike).__qualname__,
            genlike,
        ),
    )


def next_from_genlike(genlike: GeneratorLike) -> Any:
    """Given *genlike*, a coroutine or generator iterator, return the other
    coroutine/generator/iterator/awaitable that *genlike* is awaiting or
    yielding-from.
    """
    if isinstance(genlike, types.CoroutineType):
        if genlike.cr_running:
            return RUNNING
        return genlike.cr_await
    elif isinstance(genlike, types.GeneratorType):
        if genlike.gi_running:
            return RUNNING
        return genlike.gi_yieldfrom
    elif isinstance(genlike, types.AsyncGeneratorType):
        # On 3.8+, ag_running is true even if the generator
        # is blocked on an event loop trap. Those will
        # have ag_await != None (because the only way to
        # block on an event loop trap is to await something),
        # and we want to treat them as suspended for
        # traceback extraction purposes.
        if genlike.ag_running and genlike.ag_await is None:
            return RUNNING
        return genlike.ag_await
    else:  # pragma: no cover
        # frame_from_genlike() is always called first, and it raises
        # if the argument isn't genlike, so shouldn't be able to get here
        return None


def crawl_context(
    frame: types.FrameType, context: ContextInfo, override_line: Optional[str] = None,
) -> Iterator[FrameInfo]:
    """Yield a series of FrameInfos for the context manager described in *context*,
    which is a context manager active in *frame*.

    The first yielded FrameInfo introduces the context manager, by referring to the
    line in *frame* at which the 'with' or 'async with' block begins; its
    context_name and context_manager attributes allow inspection of the context
    manager and the name of the variable that stores its result.
    For example, in 'with trio.fail_after(1) as scope:', context_name is 'scope'
    and context_manager is a GeneratorContextManager object for fail_after().
    If *override_line* is specified, this first yielded FrameInfo will use
    that text rather than pulling the actual source line. This is used when
    representing ExitStack entries, since there's no way to determine the
    actual source line at which each ExitStack entry was pushed.

    If the context manager is generator-based, successive FrameInfos describe
    the environment in the suspended @contextmanager/@asynccontextmanager
    function, potentially including *its* context managers (recursively).

    If the context manager is an ExitStack or AsyncExitStack, successive
    FrameInfos describe each callback or context manager that remains on the stack
    to be run or exited when the ExitStack or AsyncExitStack is closed or exited.
    If these are generator-based context managers or other ExitStacks, their
    status is yielded recursively.
    """

    manager = unwrap_context_manager(context.manager)
    lineno = context.start_line or 0
    yield FrameInfo(
        frame=frame,
        lineno=lineno,
        context_manager=manager,
        context_name=context.varname,
        override_line=override_line,
    )

    if isinstance(manager, (AsyncExitStack, contextlib.ExitStack)):
        # ExitStack pops each callback right before running it, so if
        # it's exiting we'll crawl the still-pending callbacks here
        # and the running callback as we continue the top-level traceback.
        yield from crawl_exit_stack(manager, context.varname or "_", frame, lineno)
    elif not context.is_exiting:
        # Don't descend into @contextmanager frames if the context manager
        # is currently exiting, since we'll see them later in the traceback
        # anyway
        if isinstance(manager, GCMBase):
            yield from iterate_suspended(manager.gen, with_context_info=True)
        elif isinstance(manager, AGCMBackport):
            yield from iterate_suspended(manager._agen, with_context_info=True)


def format_funcname(func: object) -> str:
    try:
        if isinstance(func, types.MethodType):
            return f"{func.__self__!r}.{func.__name__}"
        else:
            return f"{func.__module__}.{func.__qualname__}"  # type: ignore
    except AttributeError:
        return repr(func)


def format_funcargs(args: Sequence[Any], kw: Mapping[str, Any]) -> List[str]:
    argdescs = [repr(arg) for arg in args]
    kwdescs = [f"{k}={v!r}" for k, v in kw.items()]
    return argdescs + kwdescs


def format_funcall(func: object, args: Sequence[Any], kw: Mapping[str, Any]) -> str:
    return "{}({})".format(format_funcname(func), ", ".join(format_funcargs(args, kw)))


def crawl_exit_stack(
    stack: object, stackname: str, frame: types.FrameType, lineno: int
) -> Iterator[FrameInfo]:
    """Yield FrameInfos describing the individual entries in the ExitStack or
    AsyncExitStack described by *context*, which is active in *frame* and was
    entered at line *lineno* in that frame.

    The result is the concatenated output of crawl_context() for each
    ExitStack callback.
    """

    # List of (is_sync, callback) tuples, from outermost to innermost, where
    # each callback takes parameters following the signature of a __exit__ method
    callbacks: List[Tuple[bool, Callable[..., Any]]]

    raw_callbacks = stack._exit_callbacks  # type: ignore
    if sys.version_info >= (3, 7) or isinstance(stack, AsyncExitStack):
        callbacks = list(raw_callbacks)
    else:
        # Before 3.7, the native ExitStack didn't support async, so its callbacks
        # list didn't have the is_sync information.
        callbacks = [(True, cb) for cb in raw_callbacks]

    for idx, (is_sync, callback) in enumerate(callbacks):
        tag = ""
        manager = None
        if hasattr(callback, "__self__"):
            manager = callback.__self__  # type: ignore
            if (
                # 3.6 used a wrapper function with a __self__ attribute
                # for actual __exit__ invocations. Later versions use a method.
                not isinstance(callback, types.MethodType)
                or callback.__func__.__name__ in ("__exit__", "__aexit__")
            ):
                # stack.enter_context(some_cm) or stack.push(some_cm)
                tag = "" if is_sync else "await "
                method = "enter_context" if is_sync else "enter_async_context"
                if isinstance(manager, GCMBase):
                    if hasattr(manager, "func"):
                        arg = format_funcall(manager.func, manager.args, manager.kwds)
                    else:
                        # 3.7+ delete the func/args/etc attrs once entered
                        arg = f"{manager.gen.__qualname__}(...)"
                elif isinstance(manager, AGCMBackport):
                    arg = f"{manager._func_name}(...)"
                else:
                    arg = repr(manager)
            else:
                # stack.push(something.exit_ish_method)
                method = "push" if is_sync else "push_async_exit"
                arg = format_funcname(callback)
        elif (
            hasattr(callback, "__wrapped__")
            and getattr(callback, "__name__", None) == "_exit_wrapper"
            and isinstance(callback, types.FunctionType)
            and set(callback.__code__.co_freevars) >= {"args", "kwds"}
        ):
            # Normal callback wrapped in internal _exit_wrapper function
            # to adapt it to the __exit__ protocol
            args_idx = callback.__code__.co_freevars.index("args")
            kwds_idx = callback.__code__.co_freevars.index("kwds")
            assert callback.__closure__ is not None
            arg = ", ".join(
                [
                    format_funcname(callback.__wrapped__),  # type: ignore
                    *format_funcargs(
                        callback.__closure__[args_idx].cell_contents,
                        callback.__closure__[kwds_idx].cell_contents,
                    ),
                ],
            )
            method = "callback" if is_sync else "push_async_callback"
        else:
            # stack.push(exit_ish_function)
            method = "push" if is_sync else "push_async_exit"
            arg = format_funcname(callback)

        yield from crawl_context(
            frame=frame,
            context=ContextInfo(
                is_async=not is_sync,
                manager=manager,
                varname=f"{stackname}[{idx}]",
                start_line=lineno,
            ),
            override_line=f"# {tag}{stackname}.{method}({arg})",
        )

import attr
import contextlib
import gc
import importlib
import inspect
import linecache
import math
import sys
import threading
import traceback
import types
import warnings
from typing import (
    Any,
    AsyncGenerator,
    Callable,
    Coroutine,
    Dict,
    Generator,
    Iterator,
    List,
    Mapping,
    Optional,
    Sequence,
    Tuple,
    Union,
    TYPE_CHECKING,
    cast,
)

from ._frames import ContextInfo, contexts_active_in_frame
from ._registry import (
    unwrap_awaitable,
    unwrap_context_manager,
    CodeHandling,
    HANDLING_FOR_CODE,
)
from ._glue import ensure_installed as ensure_glue_is_installed

try:
    if not TYPE_CHECKING:
        from greenlet import (
            greenlet as GreenletType,
            getcurrent as greenlet_getcurrent,
        )
except ImportError:

    class GreenletType:
        parent: Optional["GreenletType"] = None
        gr_frame: Optional[types.FrameType]

    def greenlet_getcurrent() -> GreenletType:
        return GreenletType()


# We'll use the name "genlike" to refer to an instance of any of these types
GeneratorLike = Union[
    Generator[Any, Any, Any], AsyncGenerator[Any, Any], Coroutine[Any, Any, Any]
]


@attr.s(auto_attribs=True, slots=True, eq=True, frozen=True)
class FrameInfo:
    """Information about one frame in a `Traceback`."""

    frame: types.FrameType
    lineno: int = attr.Factory(lambda self: self.frame.f_lineno, takes_self=True)
    override_line: Optional[str] = None
    context_manager: object = None
    context_name: Optional[str] = None

    @property
    def filename(self) -> str:
        """The filename of the Python file from which this frame's code was
        imported."""
        return self.frame.f_code.co_filename

    @property
    def funcname(self) -> str:
        """The name of the function whose code this frame is executing."""
        return self.frame.f_code.co_name

    @property
    def linetext(self) -> str:
        """The text of the line of source code that this frame is executing.

        The return value has leading and trailing whitespace stripped, and
        does not end in a newline. In some cases (such as callbacks in an
        `~contextlib.ExitStack`), where we can't determine the original
        source line, we return a synthesized line beginning with ``#``.
        """
        if self.override_line is not None:
            return self.override_line
        if self.lineno == 0:
            return ""
        return linecache.getline(
            self.filename, self.lineno, self.frame.f_globals
        ).strip()

    @property
    def _context_descr(self) -> str:
        if self.context_manager is not None:
            typename = type(self.context_manager).__name__
            varname = self.context_name or "_"
            return f" ({varname}: {typename})"
        elif self.context_name is not None:
            return f" ({self.context_name})"
        return ""

    def __str__(self) -> str:
        ret = (
            f"  File {self.filename}, line {self.lineno}, in {self.funcname}"
            f"{self._context_descr}"
        )
        line = self.linetext
        if line:
            ret += f"\n    {line}"
        return ret + "\n"

    def as_stdlib_summary(
        self, *, capture_locals: bool = False
    ) -> traceback.FrameSummary:
        """Return a representation of this frame as a standard
        `traceback.FrameSummary`. Unlike this `FrameInfo` object, the
        result can be pickled and will not keep frames alive, at the
        expense of some loss of information.

        If this frame introduces a context manager in an :ref:`enhanced traceback
        <enhanced-tb>`, information about the name and type of the context manager
        will be appended to the function *name* in the returned
        `~traceback.FrameSummary`, in parentheses after a space. This results
        in reasonable output from :meth:`traceback.StackSummary.format`.

        If *capture_locals* is True, then the returned `~traceback.FrameSummary`
        will contain the stringified object representations of all local variables
        in this frame.

        """
        funcname = self.funcname + self._context_descr
        if not capture_locals:
            save_locals = None
        elif self.context_manager is not None:
            save_locals = {"<context manager>": repr(self.context_manager)}
        else:
            save_locals = {
                name: repr(value) for name, value in self.frame.f_locals.items()
            }

        return traceback.FrameSummary(
            self.frame.f_code.co_filename,
            self.lineno,
            funcname,
            locals=save_locals,
            line=self.override_line,
        )


# We have two modes in which we might need to iterate over frames:
# "inward" (when working with a suspended coroutine/generator,
# where the outer object has a cr_await/gi_yieldfrom member that
# refers to the inner) or "outward" (when working with a greenlet or
# with running frames, in which the inner frame has an f_back that
# refers to the outer). We sometimes need to switch between these.
# This is implemented by defining two generator functions, iterate_suspended
# and iterate_running, each of which yields FrameInfos. Mode switching
# is implemented by having one yield from the other.


@attr.s(auto_attribs=True, slots=True, eq=True, frozen=True)
class Traceback:
    """A summary of the current execution context of a running or
    suspended function, coroutine, etc.

    A `Traceback` consists of a series of frames (each represented as a
    `FrameInfo` object), ordered from outermost (earlier call) to
    innermost (more recent call).

    You can get a `Traceback` for a coroutine, greenlet, or (sync or
    async) generator using :meth:`Traceback.of`, or for the current
    stack using :meth:`Traceback.since` or :meth:`Traceback.until`.
    """

    #: The frames that have been extracted as part of this traceback.
    frames: Sequence[FrameInfo]

    #: The error that prevented us from extracting more `frames`, if any.
    error: Optional[Exception] = None

    @classmethod
    def of(
        cls,
        stackref: Union[GeneratorLike, GreenletType, threading.Thread],
        *,
        with_context_info: bool = True,
    ) -> "Traceback":
        """Return a traceback reflecting the current stack of *stackref*,
        which must be a coroutine object, greenlet object, or (sync or
        async) generator iterator. It may be either running or
        suspended. If it's running in a different thread, we'll still
        attempt to extract a traceback, but might not be able to. In
        particular, greenlets running in other threads can never be
        tracebacked, and generator-like objects might fail to extract
        a traceback depending on when thread switches occur.

        Produce an :ref:`enhanced traceback <enhanced-tb>` if *with_context_info*
        is True (the default), or a basic traceback if *with_context_info* is False.
        """
        if isinstance(stackref, GreenletType):
            inner_frame = stackref.gr_frame
            outer_frame = None
            if inner_frame is None:
                if not stackref:  # dead or not started
                    return Traceback(frames=())
                # otherwise a None frame means it's running
                if stackref is not greenlet_getcurrent():
                    return Traceback(
                        frames=(),
                        error=RuntimeError(
                            "Traceback.of(greenlet) can't handle a greenlet running "
                            "in another thread"
                        ),
                    )
                # since it's running in this thread, its stack is our own
                inner_frame = sys._getframe(1)
                if stackref.parent is not None:
                    outer_frame = inner_frame
                    assert outer_frame is not None

                    # On CPython the end of this greenlet's stack is marked
                    # by None. On PyPy it gets seamlessly attached to its
                    # parent's stack.
                    while (
                        outer_frame.f_back is not stackref.parent.gr_frame
                        and outer_frame.f_back is not None
                    ):
                        outer_frame = outer_frame.f_back
            producer = iterate_running(
                outer_frame, inner_frame, with_context_info, stackref
            )
        elif isinstance(stackref, threading.Thread):
            # If the thread is not alive both before and after we try to fetch
            # its frame, then it's possible that its identity was reused, and
            # we shouldn't trust the frame we get.
            was_alive = stackref.is_alive()
            inner_frame = sys._current_frames().get(stackref.ident)  # type: ignore
            if inner_frame is None or not stackref.is_alive() or not was_alive:
                return Traceback(frames=())
            producer = iterate_running(None, inner_frame, with_context_info, stackref)
        else:
            producer = iterate_suspended(stackref, with_context_info)
        return cls._make(producer)

    @classmethod
    def since(
        cls, outer_frame: Optional[types.FrameType], *, with_context_info: bool = True
    ) -> "Traceback":
        """Return a traceback reflecting the currently executing frames
        that were directly or indirectly called by *outer_frame*.

        If *outer_frame* is a frame on the current thread's stack, the resulting
        traceback will start with *outer_frame* and end with the immediate
        caller of :meth:`since`.

        If *outer_frame* is a frame on some other thread's stack, and it remains
        there throughout the traceback extraction process, the resulting
        traceback will start with *outer_frame* and end with some frame
        that was recently the innermost frame on that thread's stack.

        .. note:: If *other_frame* is not continuously on the same other thread's
           stack during the traceback extraction process, you're likely to get
           a one-frame traceback with an `error`. It's not possible to prevent
           thread switching from within Python code, so we can't do better than
           this without a C extension.

        If *outer_frame* is None, the resulting traceback contains all frames
        on the current thread's stack, starting with the outermost and ending
        with the immediate caller of :meth:`since`.

        In any other case -- if *outer_frame* belongs to a suspended coroutine,
        generator, greenlet, or if it starts or stops running on another thread
        while :meth:`since` is executing -- you will get a `Traceback` containing
        information only on *outer_frame* itself, whose `error` member describes
        the reason more information can't be provided.

        Produce an :ref:`enhanced traceback <enhanced-tb>` if *with_context_info*
        is True (the default), or a basic traceback if *with_context_info* is False.
        """
        if outer_frame is not None and not isinstance(outer_frame, types.FrameType):
            raise TypeError(f"outer_frame must be a frame, not {type(outer_frame)!r}")
        return cls._make(iterate_running(outer_frame, None, with_context_info))

    @classmethod
    def until(
        cls,
        inner_frame: types.FrameType,
        *,
        limit: Union[int, types.FrameType, None] = None,
        with_context_info: bool = True,
    ) -> "Traceback":
        """Return a traceback reflecting the currently executing frames
        that are direct or indirect callers of *inner_frame*.

        If *inner_frame* belongs to a suspended coroutine or
        generator, or if it otherwise is not linked to other frames
        via its ``f_back`` attribute, then the returned traceback will
        contain only *inner_frame* and not any of its callers.

        If a *limit* is specified, only some of the callers of *inner_frame*
        will be returned. If the *limit* is a frame, then it must be an indirect
        caller of *inner_frame* and it will be the first frame in the returned
        traceback. Otherwise, the *limit* must be a positive integer, and the
        traceback will start with the *limit*'th parent of *inner_frame*.

        Produce an :ref:`enhanced traceback <enhanced-tb>` if *with_context_info*
        is True (the default), or a basic traceback if *with_context_info* is False.
        """
        if limit is None:
            outer_frame = None
        elif isinstance(limit, types.FrameType):
            outer_frame = inner_frame
            while (
                outer_frame is not limit
                and outer_frame is not None
                # This last condition catches suspended greenlets in PyPy,
                # whose f_back members form a cycle.
                and outer_frame.f_back is not inner_frame
            ):
                outer_frame = outer_frame.f_back
            if outer_frame is None:
                raise RuntimeError(
                    f"{limit} is not an indirect caller of {inner_frame}"
                )
        elif isinstance(limit, int):
            outer_frame = inner_frame
            while (
                limit > 0
                and outer_frame is not None
                and outer_frame.f_back is not inner_frame
            ):
                outer_frame = outer_frame.f_back
                limit -= 1
        else:
            raise TypeError(
                f"'limit' argument must be a frame or integer, not {type(limit)!r}"
            )

        return cls._make(iterate_running(outer_frame, inner_frame, with_context_info))

    @classmethod
    def _make(cls, producer: Iterator[FrameInfo]) -> "Traceback":
        frames: List[FrameInfo] = []
        error: Optional[Exception] = None
        ensure_glue_is_installed()
        try:
            frames.extend(producer)
        except Exception as exc:
            error = exc
        return cls(tuple(frames), error)

    def __len__(self) -> int:
        return len(self.frames)

    def __iter__(self) -> Iterator[FrameInfo]:
        return iter(self.frames)

    def __str__(self) -> str:
        lines = []
        if self.frames:
            lines.append("Traceback (most recent call last):\n")
            lines.extend(self.as_stdlib_summary().format())
        if self.error:
            lines.append(
                "Error while extracting traceback: "
                + "".join(traceback.format_exception_only(type(self.error), self.error))
            )
            lines.extend(traceback.format_tb(self.error.__traceback__))
        return "".join(lines)

    def as_stdlib_summary(
        self, *, capture_locals: bool = False
    ) -> traceback.StackSummary:
        """Return a representation of this frame as a standard
        `traceback.StackSummary`. The result can be pickled and will
        not keep frames alive, at the expense of some loss of information
        (including the values of `FrameInfo.context_manager` and
        `FrameInfo.context_name`).

        If *capture_locals* is True, then the individual `~traceback.FrameSummary`
        objects in the returned `~traceback.StackSummary` will contain the
        stringified object representations of all local variables in each frame.
        """
        return traceback.StackSummary.from_list(
            [
                cast(
                    # typeshed doesn't understand that FrameSummary
                    # implements this tuple protocol too
                    Tuple[str, int, str, Optional[str]],
                    frame.as_stdlib_summary(capture_locals=capture_locals),
                )
                for frame in self.frames
            ]
        )


# -------- Everything below this point is implementation details --------


# Singleton object returned by next_from_genlike() to indicate
# that a generator or coroutine is currently running and that we therefore
# need to switch to iterate_running().
RUNNING = object()


_default_handling = CodeHandling()


def iterate_suspended(
    genlike: GeneratorLike, with_context_info: bool, switch_count: int = 0
) -> Iterator[FrameInfo]:
    """Yield information about a series of frames representing the current
    stack of the suspended generator iterator, async generator iterator,
    or coroutine object *genlike*.

    If *with_context_info* is True, yield additional frames
    representing context managers, to produce an enhanced traceback.

    *switch_count* tracks the number of times we have switched modes
    from inward to outward or vice versa, as a guard against infinite
    loops.
    """

    genlike = unwrap_awaitable(genlike)

    while genlike is not None:
        this_frame = frame_from_genlike(genlike)
        if this_frame is None:
            # Exhausted generator/coroutine has no traceback
            break

        next_genlike = next_from_genlike(genlike)
        if next_genlike is RUNNING:
            # If it's running, cr_await/ag_await/gi_yieldfrom aren't available,
            # so we need an alternate approach.
            yield from iterate_running(
                outer_frame=this_frame,
                inner_frame=None,
                with_context_info=with_context_info,
                parent=genlike,
                switch_count=switch_count + 1,
            )
            break

        # Otherwise, the generator/coroutine is suspended. Yield info
        # about this_frame (and its context managers), then continue
        # down the stack to next_genlike (the thing this genlike is
        # awaiting/yielding-from).

        try:
            next_frame = frame_from_genlike(next_genlike)
        except Exception:
            next_frame = None
        keep_going = yield from handle_frame(
            this_frame=this_frame,
            next_frame=next_frame,
            with_context_info=with_context_info,
            switch_count=switch_count,
        )
        if not keep_going:
            break

        genlike = unwrap_awaitable(next_genlike)


def iterate_running(
    outer_frame: Optional[types.FrameType],
    inner_frame: Optional[types.FrameType],
    with_context_info: bool,
    parent: Union[GeneratorLike, GreenletType, threading.Thread, None] = None,
    switch_count: int = 0,
) -> Iterator[FrameInfo]:
    """Yield information about a series of frames linked via f_back
    members from inner_frame out to outer_frame. (They will be yielded
    in the opposite order, outer_frame first.)

    If outer_frame is None, continue until the outermost frame on inner_frame's
    stack is reached. If inner_frame is None, find a currently-executing frame
    on any thread that has outer_frame on its stack. If both are None, produce
    frames for the current thread's entire stack.

    If these frames represent the stack of a running generator or
    coroutine or greenlet or thread, pass *parent* as that generator
    or coroutine or greenlet or thread. This is used to switch back to
    iterate_suspended() if a generator or coroutine stops running (in
    another thread) while we're looking. (We don't currently do
    anything special with a greenlet or thread *parent*, but maybe
    we'll want to at some point.)

    If *with_context_info* is True, yield additional frames
    representing context managers, to produce an enhanced traceback.

    *switch_count* tracks the number of times we have switched modes
    from inward to outward or vice versa, as a guard against infinite
    loops.

    """

    # Running frames are linked "outward" (from the current frame
    # backwards via f_back members), not "inward" (even if the frames
    # belong to a coroutine/generator/etc, the cr_await / gi_yieldfrom
    # / etc members are None). Thus, in order to know what comes after
    # outer_frame in the traceback, we have to find a currently
    # executing frame that has outer_frame on its stack.

    # This function tries a bunch of different ways to fill out this 'frames'
    # list, as a list of the frames we want to traceback from outermost
    # to innermost.
    frames: List[types.FrameType] = []

    def get_true_caller() -> types.FrameType:
        # Return the frame that called into the traceback-producing machinery.
        # That will be at least 3 frames up (iterate_running, Traceback._make,
        # Traceback.of/since/until) and might be more if we've done some mode
        # switching.
        caller: Optional[types.FrameType] = sys._getframe(3)
        while caller is not None and caller.f_globals is globals():
            caller = caller.f_back
        assert caller is not None
        return caller

    if sys.implementation.name == "cpython" and greenlet_getcurrent().parent:
        # On CPython, each greenlet is its own universe traceback-wise:
        # if you're inside a non-main greenlet and you follow f_back links
        # outward from your current frame, you'll only find the outermost
        # frame in this greenlet, not in this thread. We augment that by
        # following the greenlet parent link (the same path an exception
        # would take) when we reach an f_back of None.
        #
        # This only works on the current thread, since there's no way
        # to call greenlet.getcurrent() for another thread. (There's a key
        # in the thread state dictionary, which we can't safely access because
        # any other thread state can disappear out from under us whenever we
        # yield the GIL, which we can't prevent from happening. Resolving
        # this would require an extension module.)
        #
        # PyPy uses a more sensible scheme where the f_back links in the
        # current callstack always work, so it doesn't need this trick.
        this_thread_frames: List[types.FrameType] = []
        greenlet: Optional[GreenletType] = greenlet_getcurrent()
        current: Optional[types.FrameType] = get_true_caller()
        while greenlet is not None:
            while current is not None:
                this_thread_frames.append(current)
                current = current.f_back
            greenlet = greenlet.parent
            if greenlet is not None:
                current = greenlet.gr_frame
        try:
            from_idx: Optional[int]
            if inner_frame is None or this_thread_frames[0] is inner_frame:
                from_idx = None
            else:
                from_idx = this_thread_frames.index(inner_frame) - 1
            to_idx = (
                len(this_thread_frames)
                if outer_frame is None
                else this_thread_frames.index(outer_frame)
            )
        except ValueError:
            pass
        else:
            frames = this_thread_frames[to_idx:from_idx:-1]

    def try_from(potential_inner_frame: types.FrameType) -> List[types.FrameType]:
        """If potential_inner_frame has outer_frame somewhere up its callstack,
        return the list of frames between them, starting with
        outer_frame and ending with potential_inner_frame. Otherwise, return [].
        If outer_frame is None, return all frames enclosing
        potential_inner_frame, including potential_inner_frame.
        """
        frames: List[types.FrameType] = []
        current: Optional[types.FrameType] = potential_inner_frame
        while current is not None:
            frames.append(current)
            # Note: suspended greenlets on PyPy have frames that form a cycle,
            # thus the 2nd part of this condition
            if current is outer_frame or (
                outer_frame is None and current.f_back is potential_inner_frame
            ):
                break
            current = current.f_back
        if current is outer_frame or outer_frame is None:
            return frames[::-1]
        return []

    if not frames:
        frames = try_from(inner_frame or get_true_caller())

    if not frames and inner_frame is None:
        # outer_frame isn't on *our* stack, but it might be on some
        # other thread's stack. It would be nice to avoid yielding
        # the GIL while we look, but that doesn't appear to be
        # possible -- sys.setswitchinterval() changes apply only
        # to those threads that have yielded the GIL since it was
        # called. We'll just have to accept the potential race
        # condition.
        for ident, inner_frame in sys._current_frames().items():
            if ident != threading.get_ident():
                frames = try_from(inner_frame)
                if frames:
                    break
        else:
            # We couldn't find any thread that had outer_frame
            # on its stack.
            if (
                parent is not None
                and not isinstance(parent, (GreenletType, threading.Thread))
                and switch_count < 50
            ):
                if next_from_genlike(parent) is not RUNNING:
                    # It was running when we started looking, but now
                    # is suspended again. Switch to the logic for suspended
                    # frames. (There's no specific limit to how many times this
                    # can occur; our only argument against an infinite
                    # recursion here is probabilistic, but it's a pretty good
                    # one.)
                    yield from iterate_suspended(
                        genlike=parent,
                        with_context_info=with_context_info,
                        switch_count=switch_count + 1,
                    )
                else:
                    # Possibly it became suspended before we extracted
                    # _current_frames() and then started running again
                    # before we called frame_and_next(). Or possibly
                    # we've become confused and found a frame that
                    # isn't running at all, e.g., because it's part of
                    # a suspended greenlet. Assume the former until we
                    # hit our mode-switching limit, at which point
                    # give up so as not to infinite-loop in the latter case.
                    yield from iterate_running(
                        outer_frame=outer_frame,
                        inner_frame=None,
                        with_context_info=with_context_info,
                        parent=parent,
                        switch_count=switch_count + 1,
                    )
                return

    if not frames:
        # If outer_frame is None, try_from() always returns a non-empty
        # list, so we can only get here if outer_frame is not None.
        assert outer_frame is not None
        yield from one_frame_traceback(outer_frame, None, False)
        raise RuntimeError(
            "Couldn't find where the above frame is running, so "
            "can't continue traceback"
        )

    for this_frame, next_frame in zip(
        frames, cast(List[Optional[types.FrameType]], frames[1:]) + [None]
    ):
        keep_going = yield from handle_frame(
            this_frame=this_frame,
            next_frame=next_frame,
            with_context_info=with_context_info,
            switch_count=switch_count,
        )
        if not keep_going:
            break


def handle_frame(
    this_frame: types.FrameType,
    next_frame: Optional[types.FrameType],
    with_context_info: bool,
    switch_count: int,
) -> Generator[FrameInfo, None, bool]:
    """Yield traceback information related to a single frame, *this_frame*.

    *next_frame* should preview the following frame in the traceback.
    Its information will not be yielded during this call, but it will be
    used to provide more detail on any context manager that is currently
    being exited.

    If *with_context_info* is False, this will usually be just a single FrameInfo.
    If *with_context_info* is True, it will include additional FrameInfos for
    each context manager active in *this_frame*, and might include even more
    frames representing the state of those context managers.

    If *this_frame* is for a function that manages a suspended callstack,
    as registered using :func:`customize` or :func:`register_get_target`,
    then :func:`handle_frame` will descend into that callstack, yielding
    all of its frames.

    Returns true if the caller should continue tracebacking into more
    frames (if those exist), or false if the traceback should be
    artificially cut off here.
    """

    handling = HANDLING_FOR_CODE.get(this_frame.f_code, _default_handling)

    if not handling.skip_frame:
        yield from one_frame_traceback(this_frame, next_frame, with_context_info)

    if handling.get_target is not None:
        try:
            target = handling.get_target(this_frame, next_frame)
            if isinstance(target, GreenletType):
                # This frame is the runner for a greenlet.
                # Grab gr_frame atomically in case it starts running in
                # another thread.
                gr_frame = target.gr_frame
                if gr_frame is not None:
                    yield from iterate_running(
                        outer_frame=None,
                        inner_frame=gr_frame,
                        with_context_info=with_context_info,
                        parent=target,
                        switch_count=switch_count + 1,
                    )
                # If gr_frame is None, the greenlet is dead, not
                # started, or is running in another thread. If it's
                # running, then its frames are probably next on the
                # stack we're inspecting, and we have no way to access
                # them if they're not.  If it's dead or not started,
                # then there's nothing to yield.  So in all of those
                # cases we yield nothing.
            elif isinstance(target, threading.Thread):
                # This frame is waiting for a thread to complete.
                # Go look at what the thread is doing.
                thread_frame = sys._current_frames().get(target.ident)  # type: ignore
                if thread_frame is not None:
                    yield from iterate_running(
                        outer_frame=None,
                        inner_frame=thread_frame,
                        with_context_info=with_context_info,
                        parent=target,
                        switch_count=switch_count + 1,
                    )
            elif target is not None:
                # This frame is the runner for a genlike
                yield from iterate_suspended(
                    genlike=target,
                    with_context_info=with_context_info,
                    switch_count=switch_count + 1,
                )
        except Exception:
            if handling.skip_frame:
                # We didn't yield the frame traceback before, so yield it now
                # to clarify which frame resulted in the exception
                yield from one_frame_traceback(this_frame, None, False)
            raise

    return not handling.skip_callees


def one_frame_traceback(
    this_frame: types.FrameType,
    next_frame: Optional[types.FrameType],
    with_context_info: bool,
) -> Iterator[FrameInfo]:
    """Yield a series of FrameInfos representing a single frame
    *this_frame* in the straight-line traceback.

    If with_context_info is True, yields a series of zero or more
    FrameInfos describing the context managers active in
    *this_frame*. Then, unconditionally yields one FrameInfo
    describing *this_frame* itself.

    *next_frame* should be the next inner frame in the traceback after
    *this_frame*, or None; it is used to determine the context manager
    object currently being exited, if any.

    """
    if with_context_info:
        for context in contexts_active_in_frame(this_frame):
            if context.is_exiting and next_frame is not None:
                # Infer the context manager being exited based on the
                # self argument to its __exit__ or __aexit__ method in
                # the next frame
                args = inspect.getargvalues(next_frame)
                if args.args:
                    context = attr.evolve(context, manager=args.locals[args.args[0]])
            yield from crawl_context(this_frame, context)
    yield FrameInfo(this_frame)


if sys.version_info >= (3, 7):
    # GCMBase: the common base type of context manager objects returned by
    # functions decorated with either @contextlib.contextmanager or
    # @contextlib.asynccontextmanager
    GCMBase = cast(Any, contextlib)._GeneratorContextManagerBase
    from contextlib import AsyncExitStack

    # async_exit_stack.AsyncExitStack is an alias for
    # contextlib.AsyncExitStack on Pythons that have the latter, so
    # there's no need to consider both separately.
else:
    GCMBase: Any

    class AsyncExitStack:
        pass

    if not TYPE_CHECKING:
        from contextlib import _GeneratorContextManager as GCMBase

        try:
            from async_exit_stack import AsyncExitStack  # noqa: F811
        except ImportError:
            pass


# The type of the context manager object returned by a function that is
# decorated with @async_generator.asynccontextmanager
try:
    if not TYPE_CHECKING:
        from async_generator._util import _AsyncGeneratorContextManager as AGCMBackport
except ImportError:

    class AGCMBackport:
        _agen: AsyncGenerator[Any, Any]
        _func_name: str


def frame_from_genlike(genlike: GeneratorLike) -> Optional[types.FrameType]:
    """Return the outermost frame object associated with *genlike*,
    a coroutine or generator iterator. Returns None if *genlike*
    has already completed execution. Raises an exception if it's
    not a coroutine or generator iterator.
    """
    if isinstance(genlike, types.CoroutineType):
        return genlike.cr_frame
    if isinstance(genlike, types.GeneratorType):
        return genlike.gi_frame
    if isinstance(genlike, types.AsyncGeneratorType):
        return genlike.ag_frame
    raise RuntimeError(
        "Couldn't determine the frame associated with {}.{} {!r}".format(
            getattr(type(genlike), "__module__", "??"),
            type(genlike).__qualname__,
            genlike,
        ),
    )


def next_from_genlike(genlike: GeneratorLike) -> Any:
    """Given *genlike*, a coroutine or generator iterator, return the other
    coroutine/generator/iterator/awaitable that *genlike* is awaiting or
    yielding-from.
    """
    if isinstance(genlike, types.CoroutineType):
        if genlike.cr_running:
            return RUNNING
        return genlike.cr_await
    elif isinstance(genlike, types.GeneratorType):
        if genlike.gi_running:
            return RUNNING
        return genlike.gi_yieldfrom
    elif isinstance(genlike, types.AsyncGeneratorType):
        # On 3.8+, ag_running is true even if the generator
        # is blocked on an event loop trap. Those will
        # have ag_await != None (because the only way to
        # block on an event loop trap is to await something),
        # and we want to treat them as suspended for
        # traceback extraction purposes.
        if genlike.ag_running and genlike.ag_await is None:
            return RUNNING
        return genlike.ag_await
    else:  # pragma: no cover
        # frame_from_genlike() is always called first, and it raises
        # if the argument isn't genlike, so shouldn't be able to get here
        return None


def crawl_context(
    frame: types.FrameType, context: ContextInfo, override_line: Optional[str] = None,
) -> Iterator[FrameInfo]:
    """Yield a series of FrameInfos for the context manager described in *context*,
    which is a context manager active in *frame*.

    The first yielded FrameInfo introduces the context manager, by referring to the
    line in *frame* at which the 'with' or 'async with' block begins; its
    context_name and context_manager attributes allow inspection of the context
    manager and the name of the variable that stores its result.
    For example, in 'with trio.fail_after(1) as scope:', context_name is 'scope'
    and context_manager is a GeneratorContextManager object for fail_after().
    If *override_line* is specified, this first yielded FrameInfo will use
    that text rather than pulling the actual source line. This is used when
    representing ExitStack entries, since there's no way to determine the
    actual source line at which each ExitStack entry was pushed.

    If the context manager is generator-based, successive FrameInfos describe
    the environment in the suspended @contextmanager/@asynccontextmanager
    function, potentially including *its* context managers (recursively).

    If the context manager is an ExitStack or AsyncExitStack, successive
    FrameInfos describe each callback or context manager that remains on the stack
    to be run or exited when the ExitStack or AsyncExitStack is closed or exited.
    If these are generator-based context managers or other ExitStacks, their
    status is yielded recursively.
    """

    manager = unwrap_context_manager(context.manager)
    lineno = context.start_line or 0
    yield FrameInfo(
        frame=frame,
        lineno=lineno,
        context_manager=manager,
        context_name=context.varname,
        override_line=override_line,
    )

    if isinstance(manager, (AsyncExitStack, contextlib.ExitStack)):
        # ExitStack pops each callback right before running it, so if
        # it's exiting we'll crawl the still-pending callbacks here
        # and the running callback as we continue the top-level traceback.
        yield from crawl_exit_stack(manager, context.varname or "_", frame, lineno)
    elif not context.is_exiting:
        # Don't descend into @contextmanager frames if the context manager
        # is currently exiting, since we'll see them later in the traceback
        # anyway
        if isinstance(manager, GCMBase):
            yield from iterate_suspended(manager.gen, with_context_info=True)
        elif isinstance(manager, AGCMBackport):
            yield from iterate_suspended(manager._agen, with_context_info=True)


def format_funcname(func: object) -> str:
    try:
        if isinstance(func, types.MethodType):
            return f"{func.__self__!r}.{func.__name__}"
        else:
            return f"{func.__module__}.{func.__qualname__}"  # type: ignore
    except AttributeError:
        return repr(func)


def format_funcargs(args: Sequence[Any], kw: Mapping[str, Any]) -> List[str]:
    argdescs = [repr(arg) for arg in args]
    kwdescs = [f"{k}={v!r}" for k, v in kw.items()]
    return argdescs + kwdescs


def format_funcall(func: object, args: Sequence[Any], kw: Mapping[str, Any]) -> str:
    return "{}({})".format(format_funcname(func), ", ".join(format_funcargs(args, kw)))


def crawl_exit_stack(
    stack: object, stackname: str, frame: types.FrameType, lineno: int
) -> Iterator[FrameInfo]:
    """Yield FrameInfos describing the individual entries in the ExitStack or
    AsyncExitStack described by *context*, which is active in *frame* and was
    entered at line *lineno* in that frame.

    The result is the concatenated output of crawl_context() for each
    ExitStack callback.
    """

    # List of (is_sync, callback) tuples, from outermost to innermost, where
    # each callback takes parameters following the signature of a __exit__ method
    callbacks: List[Tuple[bool, Callable[..., Any]]]

    raw_callbacks = stack._exit_callbacks  # type: ignore
    if sys.version_info >= (3, 7) or isinstance(stack, AsyncExitStack):
        callbacks = list(raw_callbacks)
    else:
        # Before 3.7, the native ExitStack didn't support async, so its callbacks
        # list didn't have the is_sync information.
        callbacks = [(True, cb) for cb in raw_callbacks]

    for idx, (is_sync, callback) in enumerate(callbacks):
        tag = ""
        manager = None
        if hasattr(callback, "__self__"):
            manager = callback.__self__  # type: ignore
            if (
                # 3.6 used a wrapper function with a __self__ attribute
                # for actual __exit__ invocations. Later versions use a method.
                not isinstance(callback, types.MethodType)
                or callback.__func__.__name__ in ("__exit__", "__aexit__")
            ):
                # stack.enter_context(some_cm) or stack.push(some_cm)
                tag = "" if is_sync else "await "
                method = "enter_context" if is_sync else "enter_async_context"
                if isinstance(manager, GCMBase):
                    if hasattr(manager, "func"):
                        arg = format_funcall(manager.func, manager.args, manager.kwds)
                    else:
                        # 3.7+ delete the func/args/etc attrs once entered
                        arg = f"{manager.gen.__qualname__}(...)"
                elif isinstance(manager, AGCMBackport):
                    arg = f"{manager._func_name}(...)"
                else:
                    arg = repr(manager)
            else:
                # stack.push(something.exit_ish_method)
                method = "push" if is_sync else "push_async_exit"
                arg = format_funcname(callback)
        elif (
            hasattr(callback, "__wrapped__")
            and getattr(callback, "__name__", None) == "_exit_wrapper"
            and isinstance(callback, types.FunctionType)
            and set(callback.__code__.co_freevars) >= {"args", "kwds"}
        ):
            # Normal callback wrapped in internal _exit_wrapper function
            # to adapt it to the __exit__ protocol
            args_idx = callback.__code__.co_freevars.index("args")
            kwds_idx = callback.__code__.co_freevars.index("kwds")
            assert callback.__closure__ is not None
            arg = ", ".join(
                [
                    format_funcname(callback.__wrapped__),  # type: ignore
                    *format_funcargs(
                        callback.__closure__[args_idx].cell_contents,
                        callback.__closure__[kwds_idx].cell_contents,
                    ),
                ],
            )
            method = "callback" if is_sync else "push_async_callback"
        else:
            # stack.push(exit_ish_function)
            method = "push" if is_sync else "push_async_exit"
            arg = format_funcname(callback)

        yield from crawl_context(
            frame=frame,
            context=ContextInfo(
                is_async=not is_sync,
                manager=manager,
                varname=f"{stackname}[{idx}]",
                start_line=lineno,
            ),
            override_line=f"# {tag}{stackname}.{method}({arg})",
        )
# We'll use the name "genlike" to refer to an instance of any of these types Information about one frame in a `Traceback`. The filename of the Python file from which this frame's code was         imported. The name of the function whose code this frame is executing. The text of the line of source code that this frame is executing.          The return value has leading and trailing whitespace stripped, and         does not end in a newline. In some cases (such as callbacks in an         `~contextlib.ExitStack`), where we can't determine the original         source line, we return a synthesized line beginning with ``#``. Return a representation of this frame as a standard         `traceback.FrameSummary`. Unlike this `FrameInfo` object, the         result can be pickled and will not keep frames alive, at the         expense of some loss of information.          If this frame introduces a context manager in an :ref:`enhanced traceback         <enhanced-tb>`, information about the name and type of the context manager         will be appended to the function *name* in the returned         `~traceback.FrameSummary`, in parentheses after a space. This results         in reasonable output from :meth:`traceback.StackSummary.format`.          If *capture_locals* is True, then the returned `~traceback.FrameSummary`         will contain the stringified object representations of all local variables         in this frame. # We have two modes in which we might need to iterate over frames: # "inward" (when working with a suspended coroutine/generator, # where the outer object has a cr_await/gi_yieldfrom member that # refers to the inner) or "outward" (when working with a greenlet or # with running frames, in which the inner frame has an f_back that # refers to the outer). We sometimes need to switch between these. # This is implemented by defining two generator functions, iterate_suspended # and iterate_running, each of which yields FrameInfos. Mode switching # is implemented by having one yield from the other. A summary of the current execution context of a running or     suspended function, coroutine, etc.      A `Traceback` consists of a series of frames (each represented as a     `FrameInfo` object), ordered from outermost (earlier call) to     innermost (more recent call).      You can get a `Traceback` for a coroutine, greenlet, or (sync or     async) generator using :meth:`Traceback.of`, or for the current     stack using :meth:`Traceback.since` or :meth:`Traceback.until`. #: The frames that have been extracted as part of this traceback. #: The error that prevented us from extracting more `frames`, if any. Return a traceback reflecting the current stack of *stackref*,         which must be a coroutine object, greenlet object, or (sync or         async) generator iterator. It may be either running or         suspended. If it's running in a different thread, we'll still         attempt to extract a traceback, but might not be able to. In         particular, greenlets running in other threads can never be         tracebacked, and generator-like objects might fail to extract         a traceback depending on when thread switches occur.          Produce an :ref:`enhanced traceback <enhanced-tb>` if *with_context_info*         is True (the default), or a basic traceback if *with_context_info* is False. # dead or not started # otherwise a None frame means it's running # since it's running in this thread, its stack is our own # On CPython the end of this greenlet's stack is marked # by None. On PyPy it gets seamlessly attached to its # parent's stack. # If the thread is not alive both before and after we try to fetch # its frame, then it's possible that its identity was reused, and # we shouldn't trust the frame we get. # type: ignore Return a traceback reflecting the currently executing frames         that were directly or indirectly called by *outer_frame*.          If *outer_frame* is a frame on the current thread's stack, the resulting         traceback will start with *outer_frame* and end with the immediate         caller of :meth:`since`.          If *outer_frame* is a frame on some other thread's stack, and it remains         there throughout the traceback extraction process, the resulting         traceback will start with *outer_frame* and end with some frame         that was recently the innermost frame on that thread's stack.          .. note:: If *other_frame* is not continuously on the same other thread's            stack during the traceback extraction process, you're likely to get            a one-frame traceback with an `error`. It's not possible to prevent            thread switching from within Python code, so we can't do better than            this without a C extension.          If *outer_frame* is None, the resulting traceback contains all frames         on the current thread's stack, starting with the outermost and ending         with the immediate caller of :meth:`since`.          In any other case -- if *outer_frame* belongs to a suspended coroutine,         generator, greenlet, or if it starts or stops running on another thread         while :meth:`since` is executing -- you will get a `Traceback` containing         information only on *outer_frame* itself, whose `error` member describes         the reason more information can't be provided.          Produce an :ref:`enhanced traceback <enhanced-tb>` if *with_context_info*         is True (the default), or a basic traceback if *with_context_info* is False. Return a traceback reflecting the currently executing frames         that are direct or indirect callers of *inner_frame*.          If *inner_frame* belongs to a suspended coroutine or         generator, or if it otherwise is not linked to other frames         via its ``f_back`` attribute, then the returned traceback will         contain only *inner_frame* and not any of its callers.          If a *limit* is specified, only some of the callers of *inner_frame*         will be returned. If the *limit* is a frame, then it must be an indirect         caller of *inner_frame* and it will be the first frame in the returned         traceback. Otherwise, the *limit* must be a positive integer, and the         traceback will start with the *limit*'th parent of *inner_frame*.          Produce an :ref:`enhanced traceback <enhanced-tb>` if *with_context_info*         is True (the default), or a basic traceback if *with_context_info* is False. # This last condition catches suspended greenlets in PyPy, # whose f_back members form a cycle. Return a representation of this frame as a standard         `traceback.StackSummary`. The result can be pickled and will         not keep frames alive, at the expense of some loss of information         (including the values of `FrameInfo.context_manager` and         `FrameInfo.context_name`).          If *capture_locals* is True, then the individual `~traceback.FrameSummary`         objects in the returned `~traceback.StackSummary` will contain the         stringified object representations of all local variables in each frame. # typeshed doesn't understand that FrameSummary # implements this tuple protocol too # -------- Everything below this point is implementation details -------- # Singleton object returned by next_from_genlike() to indicate # that a generator or coroutine is currently running and that we therefore # need to switch to iterate_running(). Yield information about a series of frames representing the current     stack of the suspended generator iterator, async generator iterator,     or coroutine object *genlike*.      If *with_context_info* is True, yield additional frames     representing context managers, to produce an enhanced traceback.      *switch_count* tracks the number of times we have switched modes     from inward to outward or vice versa, as a guard against infinite     loops. # Exhausted generator/coroutine has no traceback # If it's running, cr_await/ag_await/gi_yieldfrom aren't available, # so we need an alternate approach. # Otherwise, the generator/coroutine is suspended. Yield info # about this_frame (and its context managers), then continue # down the stack to next_genlike (the thing this genlike is # awaiting/yielding-from). Yield information about a series of frames linked via f_back     members from inner_frame out to outer_frame. (They will be yielded     in the opposite order, outer_frame first.)      If outer_frame is None, continue until the outermost frame on inner_frame's     stack is reached. If inner_frame is None, find a currently-executing frame     on any thread that has outer_frame on its stack. If both are None, produce     frames for the current thread's entire stack.      If these frames represent the stack of a running generator or     coroutine or greenlet or thread, pass *parent* as that generator     or coroutine or greenlet or thread. This is used to switch back to     iterate_suspended() if a generator or coroutine stops running (in     another thread) while we're looking. (We don't currently do     anything special with a greenlet or thread *parent*, but maybe     we'll want to at some point.)      If *with_context_info* is True, yield additional frames     representing context managers, to produce an enhanced traceback.      *switch_count* tracks the number of times we have switched modes     from inward to outward or vice versa, as a guard against infinite     loops. # Running frames are linked "outward" (from the current frame # backwards via f_back members), not "inward" (even if the frames # belong to a coroutine/generator/etc, the cr_await / gi_yieldfrom # / etc members are None). Thus, in order to know what comes after # outer_frame in the traceback, we have to find a currently # executing frame that has outer_frame on its stack. # This function tries a bunch of different ways to fill out this 'frames' # list, as a list of the frames we want to traceback from outermost # to innermost. # Return the frame that called into the traceback-producing machinery. # That will be at least 3 frames up (iterate_running, Traceback._make, # Traceback.of/since/until) and might be more if we've done some mode # switching. # On CPython, each greenlet is its own universe traceback-wise: # if you're inside a non-main greenlet and you follow f_back links # outward from your current frame, you'll only find the outermost # frame in this greenlet, not in this thread. We augment that by # following the greenlet parent link (the same path an exception # would take) when we reach an f_back of None. # # This only works on the current thread, since there's no way # to call greenlet.getcurrent() for another thread. (There's a key # in the thread state dictionary, which we can't safely access because # any other thread state can disappear out from under us whenever we # yield the GIL, which we can't prevent from happening. Resolving # this would require an extension module.) # # PyPy uses a more sensible scheme where the f_back links in the # current callstack always work, so it doesn't need this trick. If potential_inner_frame has outer_frame somewhere up its callstack,         return the list of frames between them, starting with         outer_frame and ending with potential_inner_frame. Otherwise, return [].         If outer_frame is None, return all frames enclosing         potential_inner_frame, including potential_inner_frame. # Note: suspended greenlets on PyPy have frames that form a cycle, # thus the 2nd part of this condition # outer_frame isn't on *our* stack, but it might be on some # other thread's stack. It would be nice to avoid yielding # the GIL while we look, but that doesn't appear to be # possible -- sys.setswitchinterval() changes apply only # to those threads that have yielded the GIL since it was # called. We'll just have to accept the potential race # condition. # We couldn't find any thread that had outer_frame # on its stack. # It was running when we started looking, but now # is suspended again. Switch to the logic for suspended # frames. (There's no specific limit to how many times this # can occur; our only argument against an infinite # recursion here is probabilistic, but it's a pretty good # one.) # Possibly it became suspended before we extracted # _current_frames() and then started running again # before we called frame_and_next(). Or possibly # we've become confused and found a frame that # isn't running at all, e.g., because it's part of # a suspended greenlet. Assume the former until we # hit our mode-switching limit, at which point # give up so as not to infinite-loop in the latter case. # If outer_frame is None, try_from() always returns a non-empty # list, so we can only get here if outer_frame is not None. Yield traceback information related to a single frame, *this_frame*.      *next_frame* should preview the following frame in the traceback.     Its information will not be yielded during this call, but it will be     used to provide more detail on any context manager that is currently     being exited.      If *with_context_info* is False, this will usually be just a single FrameInfo.     If *with_context_info* is True, it will include additional FrameInfos for     each context manager active in *this_frame*, and might include even more     frames representing the state of those context managers.      If *this_frame* is for a function that manages a suspended callstack,     as registered using :func:`customize` or :func:`register_get_target`,     then :func:`handle_frame` will descend into that callstack, yielding     all of its frames.      Returns true if the caller should continue tracebacking into more     frames (if those exist), or false if the traceback should be     artificially cut off here. # This frame is the runner for a greenlet. # Grab gr_frame atomically in case it starts running in # another thread. # If gr_frame is None, the greenlet is dead, not # started, or is running in another thread. If it's # running, then its frames are probably next on the # stack we're inspecting, and we have no way to access # them if they're not.  If it's dead or not started, # then there's nothing to yield.  So in all of those # cases we yield nothing. # This frame is waiting for a thread to complete. # Go look at what the thread is doing. # type: ignore # This frame is the runner for a genlike # We didn't yield the frame traceback before, so yield it now # to clarify which frame resulted in the exception Yield a series of FrameInfos representing a single frame     *this_frame* in the straight-line traceback.      If with_context_info is True, yields a series of zero or more     FrameInfos describing the context managers active in     *this_frame*. Then, unconditionally yields one FrameInfo     describing *this_frame* itself.      *next_frame* should be the next inner frame in the traceback after     *this_frame*, or None; it is used to determine the context manager     object currently being exited, if any. # Infer the context manager being exited based on the # self argument to its __exit__ or __aexit__ method in # the next frame # GCMBase: the common base type of context manager objects returned by # functions decorated with either @contextlib.contextmanager or # @contextlib.asynccontextmanager # async_exit_stack.AsyncExitStack is an alias for # contextlib.AsyncExitStack on Pythons that have the latter, so # there's no need to consider both separately. # noqa: F811 # The type of the context manager object returned by a function that is # decorated with @async_generator.asynccontextmanager Return the outermost frame object associated with *genlike*,     a coroutine or generator iterator. Returns None if *genlike*     has already completed execution. Raises an exception if it's     not a coroutine or generator iterator. Given *genlike*, a coroutine or generator iterator, return the other     coroutine/generator/iterator/awaitable that *genlike* is awaiting or     yielding-from. # On 3.8+, ag_running is true even if the generator # is blocked on an event loop trap. Those will # have ag_await != None (because the only way to # block on an event loop trap is to await something), # and we want to treat them as suspended for # traceback extraction purposes. # pragma: no cover # frame_from_genlike() is always called first, and it raises # if the argument isn't genlike, so shouldn't be able to get here Yield a series of FrameInfos for the context manager described in *context*,     which is a context manager active in *frame*.      The first yielded FrameInfo introduces the context manager, by referring to the     line in *frame* at which the 'with' or 'async with' block begins; its     context_name and context_manager attributes allow inspection of the context     manager and the name of the variable that stores its result.     For example, in 'with trio.fail_after(1) as scope:', context_name is 'scope'     and context_manager is a GeneratorContextManager object for fail_after().     If *override_line* is specified, this first yielded FrameInfo will use     that text rather than pulling the actual source line. This is used when     representing ExitStack entries, since there's no way to determine the     actual source line at which each ExitStack entry was pushed.      If the context manager is generator-based, successive FrameInfos describe     the environment in the suspended @contextmanager/@asynccontextmanager     function, potentially including *its* context managers (recursively).      If the context manager is an ExitStack or AsyncExitStack, successive     FrameInfos describe each callback or context manager that remains on the stack     to be run or exited when the ExitStack or AsyncExitStack is closed or exited.     If these are generator-based context managers or other ExitStacks, their     status is yielded recursively. # ExitStack pops each callback right before running it, so if # it's exiting we'll crawl the still-pending callbacks here # and the running callback as we continue the top-level traceback. # Don't descend into @contextmanager frames if the context manager # is currently exiting, since we'll see them later in the traceback # anyway # type: ignore Yield FrameInfos describing the individual entries in the ExitStack or     AsyncExitStack described by *context*, which is active in *frame* and was     entered at line *lineno* in that frame.      The result is the concatenated output of crawl_context() for each     ExitStack callback. # List of (is_sync, callback) tuples, from outermost to innermost, where # each callback takes parameters following the signature of a __exit__ method # type: ignore # Before 3.7, the native ExitStack didn't support async, so its callbacks # list didn't have the is_sync information. # type: ignore # 3.6 used a wrapper function with a __self__ attribute # for actual __exit__ invocations. Later versions use a method. # stack.enter_context(some_cm) or stack.push(some_cm) # 3.7+ delete the func/args/etc attrs once entered # stack.push(something.exit_ish_method) # Normal callback wrapped in internal _exit_wrapper function # to adapt it to the __exit__ protocol # type: ignore # stack.push(exit_ish_function)