Skip to content

frames

Utilities for working with stack traces and frames.

Typical Usage

>>> import inspect
>>> from typelib.py import frames
>>> var = 1
>>> frames.extract("var")
1
>>> current_frame = inspect.currentframe()
>>> frames.getcaller() == current_frame
True

Functions:

  • extract –

    Extract name from the stacktrace of frame.

  • getcaller –

    Get the caller of the current scope, excluding this library.

extract 

extract(name: str, *, frame: FrameType | None = None) -> Any | None

Extract name from the stacktrace of frame.

If frame is not provided, this function will use the current frame.

Parameters:

  • name

    (str) –

    The name of the object to extract from the stacktrace.

  • frame

    (FrameType | None, default: None ) –

    The types.FrameType instance to start from (optional).

Source code in src/typelib/py/frames.py 
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
def extract(name: str, *, frame: types.FrameType | None = None) -> Any | None:
    """Extract `name` from the stacktrace of `frame`.

    If `frame` is not provided, this function will use the current frame.

    Args:
        name: The name of the object to extract from the stacktrace.
        frame: The [`types.FrameType`][] instance to start from (optional).
    """
    frame = frame or inspect.currentframe()
    seen: set[types.FrameType] = set()
    add = seen.add
    while frame and frame not in seen:
        if name in frame.f_globals:
            return frame.f_globals[name]
        if name in frame.f_locals:
            return frame.f_locals[name]
        add(frame)
        frame = frame.f_back

    return None

getcaller 

getcaller(frame: FrameType | None = None) -> FrameType | None

Get the caller of the current scope, excluding this library.

If frame is not provided, this function will use the current frame.

Parameters:

Source code in src/typelib/py/frames.py 
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
def getcaller(frame: types.FrameType | None = None) -> types.FrameType | None:
    """Get the caller of the current scope, excluding this library.

    If `frame` is not provided, this function will use the current frame.

    Args:
        frame: The [`types.FrameType`][] instance to start from (optional).
    """

    frame = frame or inspect.currentframe()
    if not frame:
        return None

    while (f_back := frame.f_back) is not None:
        frame = f_back  # type: ignore[union-attr]
        module = inspect.getmodule(frame)
        if module and module.__name__.startswith(PKG_NAME):
            continue

        code = frame.f_code
        if getattr(code, "co_qualname", "").startswith(PKG_NAME):
            continue
        if PKG_NAME in code.co_filename:
            continue
        return frame

    return frame