Initializing playground…
← Back to roadmap

pd.options system

The options system mirrors pandas.get_option / pandas.set_option. It manages display, mode, and compute settings with full validation support.

1 — getOption / setOption / resetOption

Read, write, and restore option values by dot-separated key.

TypeScript
Click ▶ Run to execute
Ctrl+Enter to run · Tab to indent

2 — describeOption

Pretty-print documentation for one or all options.

TypeScript
Click ▶ Run to execute
Ctrl+Enter to run · Tab to indent

3 — optionContext (scoped override)

Temporarily override options and restore them with enter() / exit().

TypeScript
Click ▶ Run to execute
Ctrl+Enter to run · Tab to indent

4 — options proxy

Access options via a deeply-nested proxy object for ergonomic reads and writes.

TypeScript
Click ▶ Run to execute
Ctrl+Enter to run · Tab to indent

5 — registerOption (custom option)

Extend the registry with application-specific options, including custom validators.

TypeScript
Click ▶ Run to execute
Ctrl+Enter to run · Tab to indent