API reference: the version selector

Generated from src/uiops's own AST; never hand-typed. Regenerate with docs/_build/apidoc.py.

The version selector – the entry point that returns the UIOOPS engine; this package ships one, v3.5. It dispatches and computes nothing: no number changes because a call came through here.

See also CLI reference · Reference.

uiops.__init__

Choose which UIOOPS translation processes your data.

VERSIONS

VERSIONS: versions

DEFAULT_VERSION

DEFAULT_VERSION: str

Engine

class Engine

A chosen UIOOPS version, and the modules that implement it.

engine

def engine(version: str | None=None) -> Engine

The engine for `version, or DEFAULT_VERSION` if none is named.

UnknownVersion

class UnknownVersion(ValueError)

A version string that is not one of VERSIONS.

UnknownModule

class UnknownModule(KeyError)

A module name that is not in CATALOGUE.

CATALOGUE

(re-exported from elsewhere; not defined in this module)

Entry

class Entry

One module of the UIOOPS v3.1.4 translation, and how v3.5 covers it.

`sources names the MATLAB/C++ file(s) the module translates, so the classification can be checked against the UIOOPS v3.1.4 and v3.5 sources. v35` is the v3.5 module that replaces it, if there is one.

OVERRIDDEN

OVERRIDDEN: str

SHARED

SHARED: str

TOOLING

TOOLING: str

FORK_ONLY

FORK_ONLY: str

READ_SHARED

READ_SHARED: str