Struct Workspace 

pub struct Workspace { /* private fields */ }

A workspace, consisting of a root directory and members. See ProjectWorkspace.

Implementations

impl Workspace

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

Find the workspace containing the given path.

Unlike the ProjectWorkspace discovery, this does not require a current project. It also always uses absolute path, i.e., this method only supports discovering the main workspace.

Steps of workspace discovery: Start by looking at the closest pyproject.toml:

• If it’s an explicit workspace root: Collect workspace from this root, we’re done.
• If it’s also not a project: Error, must be either a workspace root or a project.
• Otherwise, try to find an explicit workspace root above:
  • If an explicit workspace root exists: Collect workspace from this root, we’re done.
  • If there is no explicit workspace: We have a single project workspace, we’re done.

Note that there are two kinds of workspace roots: projects, and (legacy) non-project roots. The non-project roots lack a [project] table, and so are not themselves projects, as in:

[tool.uv.workspace]
members = ["packages/*"]

[tool.uv]
dev-dependencies = ["ruff"]

pub fn with_current_project( self, package_name: PackageName, ) -> Option<ProjectWorkspace>

Set the current project to the given workspace member.

Returns None if the package is not part of the workspace.

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

Set the ProjectWorkspace for a given workspace member.

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

pub fn is_non_project(&self) -> bool

Returns true if the workspace has a (legacy) non-project root.

pub fn members_requirements(&self) -> impl Iterator<Item = Requirement> + '_

Returns the set of all workspace members.

pub fn required_members(&self) -> &BTreeMap<PackageName, Editability>

The workspace members that are required my another member of the workspace.

pub fn is_required_member(&self, name: &PackageName) -> bool

Whether a given workspace member is required by another member.

pub fn group_requirements(&self) -> impl Iterator<Item = Requirement> + '_

Returns the set of all workspace member dependency groups.

pub fn environments(&self) -> Option<&SupportedEnvironments>

Returns the set of supported environments for the workspace.

pub fn required_environments(&self) -> Option<&SupportedEnvironments>

Returns the set of required platforms for the workspace.

pub fn conflicts(&self) -> Conflicts

Returns the set of conflicts for the workspace.

pub fn requires_python( &self, groups: &DependencyGroupsWithDefaults, ) -> Result<RequiresPythonSources, DependencyGroupError>

Returns an iterator over the requires-python values for each member of the workspace.

pub fn requirements(&self) -> Vec<Requirement<VerbatimParsedUrl>>

Returns any requirements that are exclusive to the workspace root, i.e., not included in any of the workspace members.

For now, there are no such requirements.

pub fn workspace_dependency_groups( &self, ) -> Result<BTreeMap<GroupName, FlatDependencyGroup>, DependencyGroupError>

Returns any dependency groups that are exclusive to the workspace root, i.e., not included in any of the workspace members.

For workspaces with non-[project] roots, returns the dependency groups defined in the corresponding pyproject.toml.

Otherwise, returns an empty list.

pub fn overrides(&self) -> Vec<Requirement<VerbatimParsedUrl>>

Returns the set of overrides for the workspace.

pub fn exclude_dependencies(&self) -> Vec<PackageName>

Returns the set of dependency exclusions for the workspace.

pub fn constraints(&self) -> Vec<Requirement<VerbatimParsedUrl>>

Returns the set of constraints for the workspace.

pub fn build_constraints(&self) -> Vec<Requirement<VerbatimParsedUrl>>

Returns the set of build constraints for the workspace.

pub fn install_path(&self) -> &PathBuf

The path to the workspace root, the directory containing the top level pyproject.toml with the uv.tool.workspace, or the pyproject.toml in an implicit single workspace project.

pub fn venv(&self, active: Option<bool>) -> PathBuf

The path to the workspace virtual environment.

Uses .venv in the install path directory by default.

If UV_PROJECT_ENVIRONMENT is set, it will take precedence. If a relative path is provided, it is resolved relative to the install path.

If active is true, the VIRTUAL_ENV variable will be preferred. If it is false, any warnings about mismatch between the active environment and the project environment will be silenced.

pub fn packages(&self) -> &BTreeMap<PackageName, WorkspaceMember>

The members of the workspace.

pub fn sources(&self) -> &BTreeMap<PackageName, Sources>

The sources table from the workspace pyproject.toml.

pub fn indexes(&self) -> &[Index]

The index table from the workspace pyproject.toml.

pub fn pyproject_toml(&self) -> &PyProjectToml

The pyproject.toml of the workspace.

pub fn excludes(&self, project_path: &Path) -> Result<bool, WorkspaceError>

Returns true if the path is excluded by the workspace.

pub fn includes(&self, project_path: &Path) -> Result<bool, WorkspaceError>

Returns true if the path is included by the workspace.

Trait Implementations

impl Clone for Workspace

fn clone(&self) -> Workspace

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Workspace

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

Formats the value using the given formatter.