line_profiler.profiler_mixin module

line_profiler.profiler_mixin.is_c_level_callable(func: Any) → TypeIs[CLevelCallable]

Returns:

Whether a callable is defined at the C-level (and is thus non-profilable).

Return type:

func_is_c_level (bool)

line_profiler.profiler_mixin.is_cython_callable(func: Any) → TypeIs[CythonCallable]

line_profiler.profiler_mixin.is_classmethod(f: Any) → TypeIs[classmethod]

line_profiler.profiler_mixin.is_staticmethod(f: Any) → TypeIs[staticmethod]

line_profiler.profiler_mixin.is_boundmethod(f: Any) → TypeIs[types.MethodType]

line_profiler.profiler_mixin.is_partialmethod(f: Any) → TypeIs[partialmethod]

line_profiler.profiler_mixin.is_partial(f: Any) → TypeIs[partial]

line_profiler.profiler_mixin.is_property(f: Any) → TypeIs[property]

line_profiler.profiler_mixin.is_cached_property(f: Any) → TypeIs[cached_property]

class line_profiler.profiler_mixin.ByCountProfilerMixin

Bases: object

Mixin class for profiler methods built around the enable_by_count() and disable_by_count() methods, rather than the enable() and disable() methods.

Used by line_profiler.line_profiler.LineProfiler and kernprof.ContextualProfile.

enable_by_count() → None

disable_by_count() → None

wrap_callable(func: Callable) → Callable

Decorate a function to start the profiler on function entry and stop it on function exit.

classmethod get_underlying_functions(func: object) → list[LambdaType | cython_function_or_method]

Get the underlying function objects of a callable or an adjacent object.

Returns:

funcs (list[Callable])

wrap_classmethod(func)

Wrap a classmethod() or staticmethod() to profile it.

wrap_staticmethod(func)

Wrap a classmethod() or staticmethod() to profile it.

wrap_boundmethod(func)

Wrap a types.MethodType to profile it.

wrap_partial(func)

Wrap a functools.partial() or functools.partialmethod to profile it.

wrap_partialmethod(func)

Wrap a functools.partial() or functools.partialmethod to profile it.

wrap_property(func)

Wrap a property to profile it.

wrap_cached_property(func)

Wrap a functools.cached_property() to profile it.

wrap_async_generator(func)

Wrap an async generator function to profile it.

wrap_coroutine(func)

Wrap a coroutine function to profile it.

wrap_generator(func)

Wrap a generator function to profile it.

wrap_function(func)

Wrap a function to profile it.

wrap_class(func)

Wrap a class by wrapping all locally-defined callables and callable wrappers.

Returns:

The class passed in, with its locally-defined callables and wrappers wrapped.

Return type:

func (type)

Warns:

UserWarning – If any of the locally-defined callables and wrappers cannot be replaced with the appropriate wrapper returned from wrap_callable().

run(cmd)

Profile a single executable statment in the main namespace.

runctx(cmd, globals, locals)

Profile a single executable statement in the given namespaces.

runcall(func, /, *args, **kw)

Profile a single function call.