Struct PythonEnvironment 

pub struct PythonEnvironment(/* private fields */);

A Python environment, consisting of a Python Interpreter and its associated paths.

Implementations

impl PythonEnvironment

pub fn find( request: &PythonRequest, preference: EnvironmentPreference, python_preference: PythonPreference, cache: &Cache, preview: Preview, ) -> Result<Self, Error>

Find a PythonEnvironment matching the given request and preference.

If looking for a Python interpreter to create a new environment, use PythonInstallation::find instead.

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

Create a PythonEnvironment from the virtual environment at the given root.

N.B. This function also works for system Python environments and users depend on this.

pub fn from_installation(installation: PythonInstallation) -> Self

Create a PythonEnvironment from an existing PythonInstallation.

pub fn from_interpreter(interpreter: Interpreter) -> Self

Create a PythonEnvironment from an existing Interpreter.

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

Create a PythonEnvironment from an existing Interpreter and --target directory.

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

Create a PythonEnvironment from an existing Interpreter and --prefix directory.

pub fn root(&self) -> &Path

Returns the root (i.e., prefix) of the Python interpreter.

pub fn interpreter(&self) -> &Interpreter

Return the Interpreter for this virtual environment.

See also PythonEnvironment::into_interpreter.

pub fn cfg(&self) -> Result<PyVenvConfiguration, Error>

Return the PyVenvConfiguration for this environment, as extracted from the pyvenv.cfg file.

pub fn set_pyvenv_cfg(&self, key: &str, value: &str) -> Result<(), Error>

Set a key-value pair in the pyvenv.cfg file.

pub fn relocatable(&self) -> bool

Returns true if the environment is “relocatable”.

pub fn python_executable(&self) -> &Path

Returns the location of the Python executable.

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.

pub fn scripts(&self) -> &Path

Returns the path to the bin directory inside this environment.

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

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

pub fn into_interpreter(self) -> Interpreter

Return the Interpreter for this environment.

See also PythonEnvironment::interpreter.

pub fn uses(&self, interpreter: &Interpreter) -> bool

Returns true if the PythonEnvironment uses the same underlying Interpreter.

pub fn get_pyvenv_version_conflict(&self) -> Option<(Version, Version)>

Check if the pyvenv.cfg version is the same as the interpreter’s Python version.

Returns None if the versions are the consistent or there is no pyvenv.cfg. If the versions do not match, returns a tuple of the pyvenv.cfg and interpreter’s Python versions for display.

Trait Implementations

impl Clone for PythonEnvironment

fn clone(&self) -> PythonEnvironment

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PythonEnvironment

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

Formats the value using the given formatter.