Runtime modes

Abstract

mode selects how the bar loop executes: interpret (AST walk), compile (transpiled loop), or auto (try compile, fall back to interpret). The default is not the same on every surface. This is the most common footgun when moving a script from the library to the Pro API or between Python and PyneTS.

There is no Runtime.evaluate.

Conceptual model

Interface surface

What each mode means

Defaults by surface

Runtime.run (Python, exact)

Runtime(symbol="AAPL").run(
    source_code,
    ohlcv_data,
    data_feed=None,
    data_provider=None,
    mode=None,            # env PYNE_RUNTIME_MODE else "interpret"
    inputs=None,
    profiler=False,
    timeout_seconds=None,
    libraries=None,
    realtime_last_bar=False,
    realtime_ticks=1,
    realtime_bars=0,
    realtime_from_bar=None,
)

inputs / profiler / libraries / timeout_seconds / realtime_* force or keep the interpret host (or force interpret after compile miss).

Runtime.run (PyneTS)

new Runtime(symbol, { inputs, broker, timeframe })
  .run(source, ohlcv, extra?)

There is no constructor/extra.mode and no libraries option on this host. RuntimeResult.mode is always "interpret".

Internals

Invariants & edge cases

1. Do not document pyne run as mode=auto. It is compile-only smoke (--bars default 50). Use pyne execute --mode … for Runtime.run from the CLI.
2. Do not document pynets run as Python pyne run. PyneTS Runtime.run defaults to interpret; 0.5.0 also has JS compile / auto. Default --bars is 20. The Python equivalent of pynets run is pyne execute (pyne run defaults to 50 bars and is compile-only).
3. result.mode is what executed. After auto, also read auto_backend and compile_fallback_reason.
4. Foreign request.security is na on every host. Compile does not invent bars to become "more complete".
5. AXIS Pyodide compile / auto cannot be Numba (Wasm).

Worked examples

Force interpret everywhere you care about input.* + libraries + alerts:

Runtime(symbol="AAPL").run(src, bars, mode="interpret", inputs={"len": 14})

new Runtime("AAPL", { inputs: { len: 14 } }).run(src, bars);

# Python desk smoke (compile only)
pyne run script.pine --bars 50

# Python Runtime.run from the CLI
pyne execute script.pine --mode interpret --bars 50

# PyneTS desk smoke (Runtime.run; default interpret, --bars 20)
pynets run script.pine --bars 50

Failure modes

See also

• Evaluate scripts
• Python compiler
• PyneTS compile
• Configuration
• Evaluate contract