Struct Interpreter 

pub struct Interpreter { /* private fields */ }

A Python executable and its associated platform markers.

Implementations

impl Interpreter

pub fn query(executable: impl AsRef<Path>, cache: &Cache) -> Result<Self, Error>

Detect the interpreter info for the given Python executable.

pub fn with_virtualenv(self, virtualenv: VirtualEnvironment) -> Self

Return a new Interpreter with the given virtual environment root.

pub fn with_target(self, target: Target) -> Result<Self>

Return a new Interpreter to install into the given --target directory.

pub fn with_prefix(self, prefix: Prefix) -> Result<Self>

Return a new Interpreter to install into the given --prefix directory.

pub fn to_base_python(&self) -> Result<PathBuf, Error>

Return the base Python executable; that is, the Python executable that should be considered the “base” for the virtual environment. This is typically the Python executable from the Interpreter; however, if the interpreter is a virtual environment itself, then the base Python executable is the Python executable of the interpreter’s base interpreter.

This routine relies on sys._base_executable, falling back to sys.executable if unset. Broadly, this routine should be used when attempting to determine the “base Python executable” in a way that is consistent with the CPython standard library, such as when determining the home key for a virtual environment.

pub fn find_base_python(&self) -> Result<PathBuf, Error>

Determine the base Python executable; that is, the Python executable that should be considered the “base” for the virtual environment. This is typically the Python executable from the Interpreter; however, if the interpreter is a virtual environment itself, then the base Python executable is the Python executable of the interpreter’s base interpreter.

This routine mimics the CPython getpath.py logic in order to make a more robust assessment of the appropriate base Python executable. Broadly, this routine should be used when attempting to determine the “true” base executable for a Python interpreter by resolving symlinks until a valid Python installation is found. In particular, we tend to use this routine for our own managed (or standalone) Python installations.

pub fn platform(&self) -> &Platform

Returns the path to the Python virtual environment.

pub const fn markers(&self) -> &MarkerEnvironment

Returns the MarkerEnvironment for this Python executable.

pub fn resolver_marker_environment(&self) -> ResolverMarkerEnvironment

Return the ResolverMarkerEnvironment for this Python executable.

pub fn key(&self) -> PythonInstallationKey

Returns the PythonInstallationKey for this interpreter.

pub fn variant(&self) -> PythonVariant

pub fn arch(&self) -> Arch

Return the Arch reported by the interpreter platform tags.

pub fn libc(&self) -> Libc

Return the Libc reported by the interpreter platform tags.

pub fn os(&self) -> Os

Return the Os reported by the interpreter platform tags.

pub fn tags(&self) -> Result<&Tags, TagsError>

Returns the Tags for this Python executable.

pub fn is_virtualenv(&self) -> bool

Returns true if the environment is a PEP 405-compliant virtual environment.

See: https://github.com/pypa/pip/blob/0ad4c94be74cc24874c6feb5bb3c2152c398a18e/src/pip/_internal/utils/virtualenv.py#L14

pub fn is_target(&self) -> bool

Returns true if the environment is a --target environment.

pub fn is_prefix(&self) -> bool

Returns true if the environment is a --prefix environment.

pub fn is_managed(&self) -> bool

Returns true if this interpreter is managed by uv.

Returns false if we cannot determine the path of the uv managed Python interpreters.

pub fn is_externally_managed(&self) -> Option<ExternallyManaged>

Returns Some if the environment is externally managed, optionally including an error message from the EXTERNALLY-MANAGED file.

See: https://packaging.python.org/en/latest/specifications/externally-managed-environments/

pub fn python_full_version(&self) -> &StringVersion

Returns the python_full_version marker corresponding to this Python version.

pub fn python_version(&self) -> &Version

Returns the full Python version.

pub fn python_minor_version(&self) -> Version

Returns the Python version up to the minor component.

pub fn python_patch_version(&self) -> Version

Returns the Python version up to the patch component.

pub fn python_major(&self) -> u8

Return the major version component of this Python version.

pub fn python_minor(&self) -> u8

Return the minor version component of this Python version.

pub fn python_patch(&self) -> u8

Return the patch version component of this Python version.

pub fn python_tuple(&self) -> (u8, u8)

Returns the Python version as a simple tuple, e.g., (3, 12).

pub fn implementation_major(&self) -> u8

Return the major version of the implementation (e.g., CPython or PyPy).

pub fn implementation_minor(&self) -> u8

Return the minor version of the implementation (e.g., CPython or PyPy).

pub fn implementation_tuple(&self) -> (u8, u8)

Returns the implementation version as a simple tuple.

pub fn implementation_name(&self) -> &str

Returns the implementation name (e.g., CPython or PyPy).

pub fn sys_base_exec_prefix(&self) -> &Path

Return the sys.base_exec_prefix path for this Python interpreter.

pub fn sys_base_prefix(&self) -> &Path

Return the sys.base_prefix path for this Python interpreter.

pub fn sys_prefix(&self) -> &Path

Return the sys.prefix path for this Python interpreter.

pub fn sys_base_executable(&self) -> Option<&Path>

Return the sys._base_executable path for this Python interpreter. Some platforms do not have this attribute, so it may be None.

pub fn sys_executable(&self) -> &Path

Return the sys.executable path for this Python interpreter.

pub fn real_executable(&self) -> &Path

Return the “real” queried executable path for this Python interpreter.

pub fn sys_path(&self) -> &[PathBuf]

Return the sys.path for this Python interpreter.

pub fn runtime_site_packages(&self) -> &[PathBuf]

Return the site.getsitepackages for this Python interpreter.

These are the paths Python will search for packages in at runtime. We use this for environment layering, but not for checking for installed packages. We could use these paths to check for installed packages, but it introduces a lot of complexity, so instead we use a simplified version that does not respect customized site-packages. See Interpreter::site_packages.

pub fn stdlib(&self) -> &Path

Return the stdlib path for this Python interpreter, as returned by sysconfig.get_paths().

pub fn purelib(&self) -> &Path

Return the purelib path for this Python interpreter, as returned by sysconfig.get_paths().

pub fn platlib(&self) -> &Path

Return the platlib path for this Python interpreter, as returned by sysconfig.get_paths().

pub fn scripts(&self) -> &Path

Return the scripts path for this Python interpreter, as returned by sysconfig.get_paths().

pub fn data(&self) -> &Path

Return the data path for this Python interpreter, as returned by sysconfig.get_paths().

pub fn include(&self) -> &Path

Return the include path for this Python interpreter, as returned by sysconfig.get_paths().

pub fn virtualenv(&self) -> &Scheme

Return the Scheme for a virtual environment created by this Interpreter.

pub fn manylinux_compatible(&self) -> bool

Return whether this interpreter is manylinux compatible.

pub fn pointer_size(&self) -> PointerSize

Return the PointerSize of the Python interpreter (i.e., 32- vs. 64-bit).

pub fn gil_disabled(&self) -> bool

Return whether this is a Python 3.13+ freethreading Python, as specified by the sysconfig var Py_GIL_DISABLED.

freethreading Python is incompatible with earlier native modules, re-introducing abiflags with a t flag. https://peps.python.org/pep-0703/#build-configuration-changes

pub fn debug_enabled(&self) -> bool

Return whether this is a debug build of Python, as specified by the sysconfig var Py_DEBUG.

pub fn target(&self) -> Option<&Target>

Return the --target directory for this interpreter, if any.

pub fn prefix(&self) -> Option<&Prefix>

Return the --prefix directory for this interpreter, if any.

pub fn is_standalone(&self) -> bool

Returns true if an Interpreter may be a python-build-standalone interpreter.

This method may return false positives, but it should not return false negatives. In other words, if this method returns true, the interpreter may be from python-build-standalone; if it returns false, the interpreter is definitely not from python-build-standalone.

See: https://github.com/astral-sh/python-build-standalone/issues/382

pub fn layout(&self) -> Layout

Return the Layout environment used to install wheels into this interpreter.

pub fn site_packages(&self) -> impl Iterator<Item = Cow<'_, Path>>

Returns an iterator over the site-packages directories inside the environment.

In most cases, purelib and platlib will be the same, and so the iterator will contain a single element; however, in some distributions, they may be different.

Some distributions also create symbolic links from purelib to platlib; in such cases, we still deduplicate the entries, returning a single path.

Note this does not include all runtime site-packages directories if the interpreter has been customized. See Interpreter::runtime_site_packages.

pub fn satisfies(&self, version: &PythonVersion) -> bool

Check if the interpreter matches the given Python version.

If a patch version is present, we will require an exact match. Otherwise, just the major and minor version numbers need to match.

pub async fn lock(&self) -> Result<LockedFile, Error>

Grab a file lock for the environment to prevent concurrent writes across processes.

Trait Implementations

impl Clone for Interpreter

fn clone(&self) -> Interpreter

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Interpreter

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.