Add uv-workspace crate with settings discovery and deserialization
#3007
Conversation
charliermarsh
force-pushed
the
charlie/workspace
branch
4 times, most recently
from
ba01cd1 to
9f3fe96
Compare
charliermarsh
force-pushed
the
charlie/workspace
branch
4 times, most recently
from
87b0f7f to
b331ed5
Compare
| @@ -105,6 +105,9 @@ async fn run() -> Result<ExitStatus> { | |||
| } | |||
| }; | |||
|
|
|||
| // Load the workspace settings. | |||
| let _ = uv_workspace::Workspace::find(env::current_dir()?)?; | |||
There was a problem hiding this comment.
If we don't have read permissions for the current directory should we error or just not attempt to read a workspace there?
There was a problem hiding this comment.
I'm for erroring, i'm assuming we have read and write permissions for the entire repo/project and read permissions for dirs above
| @@ -105,6 +105,9 @@ async fn run() -> Result<ExitStatus> { | |||
| } | |||
| }; | |||
|
|
|||
| // Load the workspace settings. | |||
| let _ = uv_workspace::Workspace::find(env::current_dir()?)?; | |||
There was a problem hiding this comment.
I'm for erroring, i'm assuming we have read and write permissions for the entire repo/project and read permissions for dirs above
crates/uv-workspace/src/workspace.rs
Outdated
| /// found. | ||
| pub fn find(path: impl AsRef<Path>) -> Result<Option<Self>, WorkspaceError> { | ||
| for ancestor in path.as_ref().ancestors() { | ||
| if let Some(options) = read_options(ancestor)? { |
There was a problem hiding this comment.
Does this mean we only pick the closest file?
The scenario i'm thinking about is one where the work dir is /home/ferris/foo/bar/ and we have:
/home/ferris/uv.tomlor/home/ferris/.config/uv.toml: Has some general user-level settings/home/ferris/foo/pyproject.toml: Defines a workspace of python projects and has some project level settings/home/ferris/foo/bar/pyproject.toml: A member of that workspace. Does not contain settings (i think?)
In this case, i want to first load user-level setting, then override them with the project level settings (implicitly), then resolve bar as part of the foo workspace
There was a problem hiding this comment.
Yeah we only pick the closest file. What if we do the same as Ruff, and skip a pyproject.toml that lacks a tool.uv entry?
There was a problem hiding this comment.
What do you think about https://doc.rust-lang.org/cargo/reference/config.html#hierarchical-structure ?
| root: PathBuf, | ||
| } | ||
|
|
||
| impl Workspace { |
There was a problem hiding this comment.
I'm not sure if i'd call that workspace, i'm thinking about having settings, things that are defined e.g. on the user-level, the project level or the cli level which e.g. define indexes, plus having a workspace, an abstraction over a set of packages that are part of single project. That's the main divergence from ruff, in uv (similar to cargo) you're always in a single workspace and/or a single package; i still have to flesh out how to integrate this into uv.
In cargo, you're technically always in a rust workspace, even if you only define a single crate, that's a single crate workspace. Then there's the concept of configuration with hierarchical structure and cli overrides.
There was a problem hiding this comment.
I can call this configuration instead?
There was a problem hiding this comment.
I've been intending to call it a "workspace" whether there's one package or many in your project. I don't know if we need to introduce a separate term?
charliermarsh
force-pushed
the
charlie/workspace
branch
from
b331ed5 to
0dfc4e0
Compare
charliermarsh
force-pushed
the
charlie/workspace
branch
from
0dfc4e0 to
b139389
Compare
|
I'm just gonna leave it as "workspace" for now. Let's revisit when we add actual workspace, that's all internal terminology and abstractions anyway. |
Summary
This PR adds basic struct definitions along with a "workspace" concept for discovering settings. (The "workspace" terminology is used to match Ruff; I did not invent it.)
A few notes:
pyproject.tomloruv.tomlfile in any parent directory of the current working directory. (We could adjust this to look at the directories of the input files.)