Struct PyProjectTomlMut 

pub struct PyProjectTomlMut { /* private fields */ }

Raw and mutable representation of a pyproject.toml.

This is useful for operations that require editing an existing pyproject.toml while preserving comments and other structure, such as uv add and uv remove.

Implementations

impl PyProjectTomlMut

pub fn from_toml(raw: &str, target: DependencyTarget) -> Result<Self, Error>

Initialize a PyProjectTomlMut from a str.

pub fn add_workspace(&mut self, path: impl AsRef<Path>) -> Result<(), Error>

Adds a project to the workspace.

pub fn add_dependency( &mut self, req: &Requirement, source: Option<&Source>, raw: bool, ) -> Result<ArrayEdit, Error>

Adds a dependency to project.dependencies.

Returns true if the dependency was added, false if it was updated.

pub fn add_dev_dependency( &mut self, req: &Requirement, source: Option<&Source>, raw: bool, ) -> Result<ArrayEdit, Error>

Adds a development dependency to tool.uv.dev-dependencies.

Returns true if the dependency was added, false if it was updated.

pub fn add_index(&mut self, index: &Index) -> Result<(), Error>

Add an Index to tool.uv.index.

pub fn add_optional_dependency( &mut self, group: &ExtraName, req: &Requirement, source: Option<&Source>, raw: bool, ) -> Result<ArrayEdit, Error>

Adds a dependency to project.optional-dependencies.

Returns true if the dependency was added, false if it was updated.

pub fn ensure_optional_dependency( &mut self, extra: &ExtraName, ) -> Result<(), Error>

Ensure that an optional dependency group exists, creating an empty group if it doesn’t.

pub fn add_dependency_group_requirement( &mut self, group: &GroupName, req: &Requirement, source: Option<&Source>, raw: bool, ) -> Result<ArrayEdit, Error>

Adds a dependency to dependency-groups.

Returns true if the dependency was added, false if it was updated.

pub fn ensure_dependency_group( &mut self, group: &GroupName, ) -> Result<(), Error>

Ensure that a dependency group exists, creating an empty group if it doesn’t.

pub fn set_dependency_bound( &mut self, dependency_type: &DependencyType, index: usize, version: Version, bound_kind: AddBoundsKind, ) -> Result<(), Error>

Set the constraint for a requirement for an existing dependency.

pub fn remove_dependency( &mut self, name: &PackageName, ) -> Result<Vec<Requirement>, Error>

Removes all occurrences of dependencies with the given name.

pub fn remove_dev_dependency( &mut self, name: &PackageName, ) -> Result<Vec<Requirement>, Error>

Removes all occurrences of development dependencies with the given name.

pub fn remove_optional_dependency( &mut self, name: &PackageName, group: &ExtraName, ) -> Result<Vec<Requirement>, Error>

Removes all occurrences of optional dependencies in the group with the given name.

pub fn remove_dependency_group_requirement( &mut self, name: &PackageName, group: &GroupName, ) -> Result<Vec<Requirement>, Error>

Removes all occurrences of the dependency in the group with the given name.

pub fn has_dev_dependencies(&self) -> bool

Returns true if the tool.uv.dev-dependencies table is present.

pub fn has_dependency_group(&self, group: &GroupName) -> bool

Returns true if the dependency-groups table is present and contains the given group.

pub fn find_dependency( &self, name: &PackageName, marker: Option<&MarkerTree>, ) -> Vec<DependencyType>

Returns all the places in this pyproject.toml that contain a dependency with the given name.

This method searches project.dependencies, tool.uv.dev-dependencies, and tool.uv.optional-dependencies.

pub fn version(&mut self) -> Result<Version, Error>

pub fn has_dynamic_version(&mut self) -> bool

pub fn set_version(&mut self, version: &Version) -> Result<(), Error>

Trait Implementations

impl Display for PyProjectTomlMut

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

Formats the value using the given formatter.