-
Notifications
You must be signed in to change notification settings - Fork 983
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
## Summary Basic implementation of `uv add` and `uv remove` that supports writing PEP508 requirements to `project.dependencies`. First step for #3959 and #3960.
- Loading branch information
1 parent
60431ce
commit eefa9e6
Showing
16 changed files
with
1,278 additions
and
17 deletions.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,161 @@ | ||
| use std::fmt; | ||
| use std::str::FromStr; | ||
|
|
||
| use thiserror::Error; | ||
| use toml_edit::{Array, DocumentMut, Item, RawString, TomlError, Value}; | ||
|
|
||
| use pep508_rs::{PackageName, Requirement}; | ||
| use pypi_types::VerbatimParsedUrl; | ||
|
|
||
| use crate::pyproject::PyProjectToml; | ||
|
|
||
| /// 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`. | ||
| pub struct PyProjectTomlMut { | ||
| doc: DocumentMut, | ||
| } | ||
|
|
||
| #[derive(Error, Debug)] | ||
| pub enum Error { | ||
| #[error("Failed to parse `pyproject.toml`")] | ||
| Parse(#[from] Box<TomlError>), | ||
| #[error("Dependencies in `pyproject.toml` are malformed")] | ||
| MalformedDependencies, | ||
| } | ||
|
|
||
| impl PyProjectTomlMut { | ||
| /// Initialize a `PyProjectTomlMut` from a `PyProjectToml`. | ||
| pub fn from_toml(pyproject: &PyProjectToml) -> Result<Self, Error> { | ||
| Ok(Self { | ||
| doc: pyproject.raw.parse().map_err(Box::new)?, | ||
| }) | ||
| } | ||
|
|
||
| /// Adds a dependency. | ||
| pub fn add_dependency(&mut self, req: &Requirement) -> Result<(), Error> { | ||
| let deps = &mut self.doc["project"]["dependencies"]; | ||
| if deps.is_none() { | ||
| *deps = Item::Value(Value::Array(Array::new())); | ||
| } | ||
| let deps = deps.as_array_mut().ok_or(Error::MalformedDependencies)?; | ||
|
|
||
| // Try to find matching dependencies. | ||
| let mut to_replace = Vec::new(); | ||
| for (i, dep) in deps.iter().enumerate() { | ||
| if dep | ||
| .as_str() | ||
| .and_then(try_parse_requirement) | ||
| .filter(|dep| dep.name == req.name) | ||
| .is_some() | ||
| { | ||
| to_replace.push(i); | ||
| } | ||
| } | ||
|
|
||
| if to_replace.is_empty() { | ||
| deps.push(req.to_string()); | ||
| } else { | ||
| // Replace the first occurrence of the dependency and remove the rest. | ||
| deps.replace(to_replace[0], req.to_string()); | ||
| for &i in to_replace[1..].iter().rev() { | ||
| deps.remove(i); | ||
| } | ||
| } | ||
|
|
||
| reformat_array_multiline(deps); | ||
| Ok(()) | ||
| } | ||
|
|
||
| /// Removes all occurrences of dependencies with the given name. | ||
| pub fn remove_dependency(&mut self, req: &PackageName) -> Result<Vec<Requirement>, Error> { | ||
| let deps = &mut self.doc["project"]["dependencies"]; | ||
| if deps.is_none() { | ||
| return Ok(Vec::new()); | ||
| } | ||
|
|
||
| let deps = deps.as_array_mut().ok_or(Error::MalformedDependencies)?; | ||
|
|
||
| // Try to find matching dependencies. | ||
| let mut to_remove = Vec::new(); | ||
| for (i, dep) in deps.iter().enumerate() { | ||
| if dep | ||
| .as_str() | ||
| .and_then(try_parse_requirement) | ||
| .filter(|dep| dep.name == *req) | ||
| .is_some() | ||
| { | ||
| to_remove.push(i); | ||
| } | ||
| } | ||
|
|
||
| let removed = to_remove | ||
| .into_iter() | ||
| .rev() // Reverse to preserve indices as we remove them. | ||
| .filter_map(|i| { | ||
| deps.remove(i) | ||
| .as_str() | ||
| .and_then(|req| Requirement::from_str(req).ok()) | ||
| }) | ||
| .collect::<Vec<_>>(); | ||
|
|
||
| if !removed.is_empty() { | ||
| reformat_array_multiline(deps); | ||
| } | ||
|
|
||
| Ok(removed) | ||
| } | ||
| } | ||
|
|
||
| impl fmt::Display for PyProjectTomlMut { | ||
| fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { | ||
| self.doc.fmt(f) | ||
| } | ||
| } | ||
|
|
||
| fn try_parse_requirement(req: &str) -> Option<Requirement<VerbatimParsedUrl>> { | ||
| Requirement::from_str(req).ok() | ||
| } | ||
|
|
||
| /// Reformats a TOML array to multi line while trying to preserve all comments | ||
| /// and move them around. This also formats the array to have a trailing comma. | ||
| fn reformat_array_multiline(deps: &mut Array) { | ||
| fn find_comments(s: Option<&RawString>) -> impl Iterator<Item = &str> { | ||
| s.and_then(|x| x.as_str()) | ||
| .unwrap_or("") | ||
| .lines() | ||
| .filter_map(|line| { | ||
| let line = line.trim(); | ||
| line.starts_with('#').then_some(line) | ||
| }) | ||
| } | ||
|
|
||
| for item in deps.iter_mut() { | ||
| let decor = item.decor_mut(); | ||
| let mut prefix = String::new(); | ||
| for comment in find_comments(decor.prefix()).chain(find_comments(decor.suffix())) { | ||
| prefix.push_str("\n "); | ||
| prefix.push_str(comment); | ||
| } | ||
| prefix.push_str("\n "); | ||
| decor.set_prefix(prefix); | ||
| decor.set_suffix(""); | ||
| } | ||
|
|
||
| deps.set_trailing(&{ | ||
| let mut comments = find_comments(Some(deps.trailing())).peekable(); | ||
| let mut rv = String::new(); | ||
| if comments.peek().is_some() { | ||
| for comment in comments { | ||
| rv.push_str("\n "); | ||
| rv.push_str(comment); | ||
| } | ||
| } | ||
| if !rv.is_empty() || !deps.is_empty() { | ||
| rv.push('\n'); | ||
| } | ||
| rv | ||
| }); | ||
| deps.set_trailing_comma(true); | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.