Enum Source 

pub enum Source {
    Git {
        git: DisplaySafeUrl,
        subdirectory: Option<PortablePathBuf>,
        rev: Option<String>,
        tag: Option<String>,
        branch: Option<String>,
        lfs: Option<bool>,
        marker: MarkerTree,
        extra: Option<ExtraName>,
        group: Option<GroupName>,
    },
    Url {
        url: DisplaySafeUrl,
        subdirectory: Option<PortablePathBuf>,
        marker: MarkerTree,
        extra: Option<ExtraName>,
        group: Option<GroupName>,
    },
    Path {
        path: PortablePathBuf,
        editable: Option<bool>,
        package: Option<bool>,
        marker: MarkerTree,
        extra: Option<ExtraName>,
        group: Option<GroupName>,
    },
    Registry {
        index: IndexName,
        marker: MarkerTree,
        extra: Option<ExtraName>,
        group: Option<GroupName>,
    },
    Workspace {
        workspace: bool,
        editable: Option<bool>,
        marker: MarkerTree,
        extra: Option<ExtraName>,
        group: Option<GroupName>,
    },
}

A tool.uv.sources value.

Variants

Git

A remote Git repository, available over HTTPS or SSH.

Example:

flask = { git = "https://github.com/pallets/flask", tag = "3.0.0" }

Fields

git: DisplaySafeUrl

The repository URL (without the git+ prefix).

subdirectory: Option<PortablePathBuf>

The path to the directory with the pyproject.toml, if it’s not in the archive root.

rev: Option<String>

tag: Option<String>

branch: Option<String>

lfs: Option<bool>

Whether to use Git LFS when cloning the repository.

marker: MarkerTree

extra: Option<ExtraName>

group: Option<GroupName>

Url

A remote http:// or https:// URL, either a wheel (.whl) or a source distribution (.zip, .tar.gz).

Example:

flask = { url = "https://files.pythonhosted.org/packages/61/80/ffe1da13ad9300f87c93af113edd0638c75138c42a0994becfacac078c06/flask-3.0.3-py3-none-any.whl" }

Fields

url: DisplaySafeUrl

subdirectory: Option<PortablePathBuf>

For source distributions, the path to the directory with the pyproject.toml, if it’s not in the archive root.

marker: MarkerTree

extra: Option<ExtraName>

group: Option<GroupName>

Path

The path to a dependency, either a wheel (a .whl file), source distribution (a .zip or .tar.gz file), or source tree (i.e., a directory containing a pyproject.toml or setup.py file in the root).

Fields

path: PortablePathBuf

editable: Option<bool>

false by default.

package: Option<bool>

Whether to treat the dependency as a buildable Python package (true) or as a virtual package (false). If false, the package will not be built or installed, but its dependencies will be included in the virtual environment.

When omitted, the package status is inferred based on the presence of a [build-system] in the project’s pyproject.toml.

marker: MarkerTree

extra: Option<ExtraName>

group: Option<GroupName>

Registry

A dependency pinned to a specific index, e.g., torch after setting torch to https://download.pytorch.org/whl/cu118.

Fields

index: IndexName

marker: MarkerTree

extra: Option<ExtraName>

group: Option<GroupName>

Workspace

A dependency on another package in the workspace.

Fields

workspace: bool

When set to false, the package will be fetched from the remote index, rather than included as a workspace package.

editable: Option<bool>

Whether the package should be installed as editable. Defaults to true.

marker: MarkerTree

extra: Option<ExtraName>

group: Option<GroupName>

Implementations

impl Source

pub fn from_requirement( name: &PackageName, source: RequirementSource, workspace: bool, editable: Option<bool>, index: Option<IndexName>, rev: Option<String>, tag: Option<String>, branch: Option<String>, lfs: GitLfsSetting, root: &Path, existing_sources: Option<&BTreeMap<PackageName, Sources>>, ) -> Result<Option<Self>, SourceError>

pub fn marker(&self) -> MarkerTree

Return the MarkerTree for the source.

pub fn extra(&self) -> Option<&ExtraName>

Return the extra name for the source.

pub fn group(&self) -> Option<&GroupName>

Return the dependency group name for the source.

Trait Implementations

impl Clone for Source

fn clone(&self) -> Source

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Source

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Source

A custom deserialization implementation for Source. This is roughly equivalent to #[serde(untagged)], but provides more detailed error messages.

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromIterator<Source> for Sources

fn from_iter<T: IntoIterator<Item = Source>>(iter: T) -> Self

Creates a value from an iterator.

impl PartialEq for Source

fn eq(&self, other: &Source) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Source

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Source

impl StructuralPartialEq for Source