pyenv — Inspect or configure the session Python runtime.
environment = pyenv() reports the selected Python installation and status; pyenv('Version', value, 'ExecutionMode', mode) configures it before startup.
Syntax
environment = pyenv()
environment = pyenv(name, value, ...)Inputs
name- Type
StringScalar- Required
- Yes
- Default
- —
- Description
- Version or ExecutionMode option.
value- Type
StringScalar- Required
- Yes
- Default
- —
- Description
- Configuration value.
Returns
environment- Type
Any- Description
- py.PythonEnvironment status object.
Returned values from pyenv depend on how many outputs the caller requests.
Errors
RunMat:Foreign:UnsupportedOnWasm- When
- The current host has no explicitly provided CPython capability.
- Message
Python interoperability is unavailable on this host.
RunMat:Foreign:InvalidCall- When
- Arguments do not satisfy the Python interoperability contract.
- Message
Invalid Python interoperability operation.
RunMat:Foreign:HostUnavailable- When
- A Python operation is invoked without an active runtime context.
- Message
Python operation has no active runtime context.
Configuration
Supported name-value options are Version (a major.minor version or executable path) and ExecutionMode (InProcess or OutOfProcess). Configuration is rejected once the persistent interpreter has started. Status inspection does not start the persistent session, but discovery can launch a short-lived interpreter probe; configuration also discovers a matching installation.
Environment result
The py.PythonEnvironment value object reports Version, Executable, Library, Home, Status, ExecutionMode, ProcessID, and ProcessName. terminate is available only for an out-of-process environment. A browser does not embed CPython and reports unsupported Python interoperability.
Example
Inspect the selected Python environment
env = pyenv();
env.StatusUsing pyenv with coding agents
Open a RunMat example with live inputs, then ask the agent to explain how pyenv changes the result.
Run a small pyenv example, explain the result, then change one input and compare the output.
FAQ
Can I change ExecutionMode after Python starts?⌄
No. Select the mode before startup. An in-process CPython interpreter cannot be unloaded safely.
Related Interop functions
Native
calllib · clibgen.buildInterface · libfunctions · libisloaded · libpointer · libstruct · loadlibrary · setdatatype · unloadlibrary
Java
isjava · javaaddpath · javaArray · javaclasspath · javaMethod · javaMethodEDT · javaObject · javaObjectEDT · javarmpath · jenv · usejava
Related guides
Source you can read
Every RunMat function's source is public. Read exactly how pyenv is executed, line by line, in Rust.
- View the source for pyenv in Rust on GitHub
- Learn how the RunMat runtime works
- Found a bug? Open an issue with a minimal reproduction.
About RunMat
RunMat is a runtime that executes MATLAB-syntax code fast on any GPU. The runtime is free for individuals, including freelancers; students and faculty at an academic institution, for teaching or research there; contributors to an open-source project, for work on that project; organizations with 250 or fewer people and US$10M or less in annual revenue; and anyone, for non-production use. See runmat.com/license.
- RunMat automatically optimizes your math for GPU execution on Apple, Nvidia, and AMD hardware. No code changes needed. Simulations that took hours now take minutes.
- Start running code in seconds. RunMat runs in the browser, on the desktop, or from the CLI. No license server, no IT ticket.