better_launch.utils.introspection moduleο
- better_launch.utils.introspection.find_calling_frame(func: Callable, thread_id: int = -1) FrameInfoο
Find the most recent stack frame the specified function is called in that is NOT in the same file as the function. This is useful to e.g. identify the python file a function is imported from and called in.
Parametersο
- funcCallable
A defined function.
- thread_idint, optional
The ID of the thread to search in. Search the main thread if 0, or the current thread if -1.
Returnsο
- inspect.FrameInfo
A frame which called the provided function but lives in a different file than the function itself.
Raisesο
- ValueError
If no such frame could be found.
- better_launch.utils.introspection.find_decorated_function_args(decorator_func: Callable) dict[str, Any]ο
Retrieve the arguments of the function that the specified decorator is wrapping.
Note that the function must be part of the current stack frame that led to the invocation of this function.
Parametersο
- decorator_funcCallable
A decorator function.
Returnsο
- dict[str, Any]
The arguments that were used to invoke the function decorated by the provided decorator.
Raisesο
- ValueError
If the function could not be extracted from the decorator or the function frame could not be identified.
- better_launch.utils.introspection.find_function_frame(func: Callable) FrameInfoο
Find the most recent stack frame the specified function is called in.
Note that the function must be part of the current stack frame that led to the invocation of this function.
Parametersο
- funcCallable
A defined function.
Returnsο
- inspect.FrameInfo
The frame the specified function was called from.
Raisesο
- ValueError
If no such frame could be found.
- better_launch.utils.introspection.find_launchthis_function(filepath: str) FunctionDefο
Parses a source file into an AST tree and searches for a function decorated by [better_launch.launch_this][].
Parametersο
- filepathstr
Path to a python source file.
Returnsο
- ast.FunctionDef
A representation of the function decorated by launch_this, or None if it could not be found.
- better_launch.utils.introspection.get_bound_arguments(func: Callable, with_defaults: bool = True) dict[str, Any]ο
Retrieve the arguments that were passed to the specified function.
Note that the function must be part of the current stack frame that led to the invocation of this function.
Parametersο
- funcCallable
A defined function.
- with_defaultsbool
If True the returned dict will include defaults according to the functionβs signature for arguments that were not passed to it.
Returnsο
- dict[str, Any]
The arguments that were used to invoke the function.
Raisesο
- ValueError
If the function frame could not be identified.
- better_launch.utils.introspection.get_launchfunc_signature_from_file(filepath: str) tuple[str, Signature, str]ο
Searches for a launch function in the specified source file and returns its name, signature and docstring.
See also
[find_launchthis_function][]
Parametersο
- filepathstr
Path to a python source file
Returnsο
- tuple[str, inspect.Signature]
The name, signature and docstring of the function decorated by launch_this. If no docstring is defined for the function it will be None. Likewise, if no such function could be found all parts of the returned tuple will be None.
- better_launch.utils.introspection.get_stack(thread_id: int = -1) list[FrameInfo]ο
Returns a stack of frame info for the specified thread_id.
Parametersο
- thread_idint, optional
ID of the thread to get the frame info for. -1 will return for the callerβs frame, -2 for the callerβs caller, and so on. Return for the main thread if 0.
Returnsο
- list
A list of inspect.FrameInfo objects.
Raisesο
- IndexError
If the specified thread_id does not identify a valid frame.