Enum VirtualProject 

pub enum VirtualProject {
    Project(ProjectWorkspace),
    NonProject(Workspace),
}

A project that can be discovered.

The project could be a package within a workspace, a real workspace root, or a non-project workspace root, which can define its own dev dependencies.

Variants

Project(ProjectWorkspace)

A project (which could be a workspace root or member).

NonProject(Workspace)

A non-project workspace root.

Implementations

impl VirtualProject

pub async fn discover( path: &Path, options: &DiscoveryOptions, cache: &WorkspaceCache, ) -> Result<Self, WorkspaceError>

Find the current project or virtual workspace root, given the current directory.

Similar to calling ProjectWorkspace::discover with a fallback to Workspace::discover, but avoids rereading the pyproject.toml (and relying on error-handling as control flow).

This method requires an absolute path and panics otherwise, i.e. this method only supports discovering the main workspace.

pub fn with_pyproject_toml( self, pyproject_toml: PyProjectToml, ) -> Result<Option<Self>, WorkspaceError>

Set the pyproject.toml for the current project.

Assumes that the project name is unchanged in the updated PyProjectToml.

pub fn root(&self) -> &Path

Return the root of the project.

pub fn pyproject_toml(&self) -> &PyProjectToml

Return the PyProjectToml of the project.

pub fn workspace(&self) -> &Workspace

Return the Workspace of the project.

pub fn project_name(&self) -> Option<&PackageName>

Return the PackageName of the project, if available.

pub fn is_non_project(&self) -> bool

Returns true if the project is a virtual workspace root.

Trait Implementations

impl Clone for VirtualProject

fn clone(&self) -> VirtualProject

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VirtualProject

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

Formats the value using the given formatter.