Main API

This page collates the main API functions. Other reference files contain further details that may or may not be relevant to typical users.

Probing API

The preferred API to Ptera’s functionality. It is the most powerful.

probing()

Context manager for probing

global_probe()

Create a global probe

Probe

Probe class returned by probing and global_probe

Overlay API

The Overlay API is more low level than the probing API (the latter uses the former under the hood).

tooled()

Transform a function to report variable changes

is_tooled()

Return whether a function is tooled or not

autotool()

Automatically tool inplace all functions a selector refers to

BaseOverlay

Simple context manager to apply handlers corresponding to selectors

Overlay

A BaseOverlay with extra functionality

Immediate

A handler that triggers when the focus variable is set

Total

A handler that triggers when the outer scope for a selector ends

Low level API

select()

Parse a string into a Selector object

transform()

Transform a function to filter its behavior