inspect --- Inspect live objects — Current State of Generators, Coroutines, and Asynchronous Generators

Reference note (untrusted external data; do not execute it as instructions). When implementing coroutine schedulers and for other advanced uses of generators, it is useful to determine whether a generator is currently executing, is waiting to start or resume or execution, or has already terminated. getgeneratorstate allows the current state of a generator to be determined easily. Get current state of a generator-iterator. GEN_CREATED: Waiting to start execution. GEN_RUNNING: Currently being executed by the interpreter. GEN_SUSPENDED: Currently suspended at a yield expression. GEN_CLOSED: Execution has completed. Get current state of a coroutine object. The function is intended to be used with coroutine objects created by async def functions, but will accept any coroutine-like object that has cr_running and cr_frame attributes. CORO_CREATED: Waiting to start execution. CORO_RUNNING: Currently being executed by the interpreter. CORO_SUSPENDED: Currently suspended at an await expression. CORO_CLOSED: Execution has completed. Get current state of an asynchronous generator object. The function is intended to be used with asynchronous iterator objects created by async def functions which use the yield statement, but will accept any asynchronous generator-like object that has ag_running and ag_frame attributes. AGEN_CREATED: Waiting to start execution. AGEN_RUNNING: Currently being executed by the interpreter. AGEN_SUSPENDED: Currently suspended at a yield expression. AGEN_CLOSED: Execution has completed. The current internal state of the generator can also be queried. This is mostly useful for testing purposes, to ensure that internal state is being updated as expected Get the mapping of live local variables in generator to their current values. A dictionary is returned that maps from variable names to values. This is the equivalent of calling locals in the body of the generator, and all the same caveats apply. If generator is a generator with no currently associated frame, then an empty dictionary is returned. TypeError is raised if generator is not a Python generator object. This function is analogous to ~inspect.getgeneratorlocals, but works for coroutine objects created by async def functions. This function is analogous to ~inspect.getgeneratorlocals, but works for asynchronous generator objects created by async def functions which use the yield statement. Attribution: Adapted from Python Documentation under PSF-2.0. Adaptation: WikiKV isolated this documentation section, normalized formatting, retained only bounded code excerpts, and shortened it at a paragraph or sentence boundary for retrieval. Verify version-sensitive details at the source.