Struct ProjectWorkspace 

pub struct ProjectWorkspace { /* private fields */ }

The current project and the workspace it is part of, with all of the workspace members.

Structure

The workspace root is a directory with a pyproject.toml, all members need to be below that directory. The workspace root defines members and exclusions. All packages below it must either be a member or excluded. The workspace root can be a package itself or a virtual manifest.

For a simple single package project, the workspace root is implicitly the current project root and the workspace has only this single member. Otherwise, a workspace root is declared through a tool.uv.workspace section.

A workspace itself does not declare dependencies, instead one member is the current project used as main requirement.

Each member is a directory with a pyproject.toml that contains a [project] section. Each member is a Python package, with a name, a version and dependencies. Workspace members can depend on other workspace members (foo = { workspace = true }). You can consider the workspace another package source or index, similar to --find-links.

Usage

There a two main usage patterns: A root package and helpers, and the flat workspace.

Root package and helpers:

albatross
├── packages
│   ├── provider_a
│   │   ├── pyproject.toml
│   │   └── src
│   │       └── provider_a
│   │           ├── __init__.py
│   │           └── foo.py
│   └── provider_b
│       ├── pyproject.toml
│       └── src
│           └── provider_b
│               ├── __init__.py
│               └── bar.py
├── pyproject.toml
├── Readme.md
├── uv.lock
└── src
    └── albatross
        ├── __init__.py
        └── main.py

Flat workspace:

albatross
├── packages
│   ├── albatross
│   │   ├── pyproject.toml
│   │   └── src
│   │       └── albatross
│   │           ├── __init__.py
│   │           └── main.py
│   ├── provider_a
│   │   ├── pyproject.toml
│   │   └── src
│   │       └── provider_a
│   │           ├── __init__.py
│   │           └── foo.py
│   └── provider_b
│       ├── pyproject.toml
│       └── src
│           └── provider_b
│               ├── __init__.py
│               └── bar.py
├── pyproject.toml
├── Readme.md
└── uv.lock

Implementations

impl ProjectWorkspace

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

Find the current project and workspace, given the current directory.

stop_discovery_at must be either None or an ancestor of the current directory. If set, only directories between the current path and stop_discovery_at are considered.

pub async fn from_maybe_project_root( install_path: &Path, options: &DiscoveryOptions, cache: &WorkspaceCache, ) -> Result<Option<Self>, WorkspaceError>

If the current directory contains a pyproject.toml with a project table, discover the workspace and return it, otherwise it is a dynamic path dependency and we return Ok(None).

pub fn project_root(&self) -> &Path

Returns the directory containing the closest pyproject.toml that defines the current project.

pub fn project_name(&self) -> &PackageName

Returns the PackageName of the current project.

pub fn workspace(&self) -> &Workspace

Returns the Workspace containing the current project.

pub fn current_project(&self) -> &WorkspaceMember

Returns the current project as a WorkspaceMember.

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 async fn from_project( install_path: &Path, project: &Project, project_pyproject_toml: &PyProjectToml, options: &DiscoveryOptions, cache: &WorkspaceCache, ) -> Result<Self, WorkspaceError>

Find the workspace for a project.

Trait Implementations

impl Clone for ProjectWorkspace

fn clone(&self) -> ProjectWorkspace

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProjectWorkspace

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

Formats the value using the given formatter.