Enum RequirementSource 

pub enum RequirementSource {
    Registry {
        specifier: VersionSpecifiers,
        index: Option<IndexMetadata>,
        conflict: Option<ConflictItem>,
    },
    Url {
        location: DisplaySafeUrl,
        subdirectory: Option<Box<Path>>,
        ext: DistExtension,
        url: VerbatimUrl,
    },
    Git {
        git: GitUrl,
        subdirectory: Option<Box<Path>>,
        url: VerbatimUrl,
    },
    Path {
        install_path: Box<Path>,
        ext: DistExtension,
        url: VerbatimUrl,
    },
    Directory {
        install_path: Box<Path>,
        editable: Option<bool>,
        virtual: Option<bool>,
        url: VerbatimUrl,
    },
}

The different locations with can install a distribution from: Version specifier (from an index), HTTP(S) URL, git repository, and path.

We store both the parsed fields (such as the plain url and the subdirectory) and the joined PEP 508 style url (e.g. file:///<path>#subdirectory=<subdirectory>) since we need both in different locations.

Variants

Registry

The requirement has a version specifier, such as foo >1,<2.

Fields

specifier: VersionSpecifiers

index: Option<IndexMetadata>

Choose a version from the index at the given URL.

conflict: Option<ConflictItem>

The conflict item associated with the source, if any.

Url

A remote http:// or https:// URL, either a built distribution, e.g. foo @ https://example.org/foo-1.0-py3-none-any.whl, or a source distribution, e.g.foo @ https://example.org/foo-1.0.zip.

Fields

location: DisplaySafeUrl

The remote location of the archive file, without subdirectory fragment.

subdirectory: Option<Box<Path>>

For source distributions, the path to the distribution if it is not in the archive root.

ext: DistExtension

The file extension, e.g. tar.gz, zip, etc.

url: VerbatimUrl

The PEP 508 style URL in the format <scheme>://<domain>/<path>#subdirectory=<subdirectory>.

Git

A remote Git repository, over either HTTPS or SSH.

Fields

git: GitUrl

The repository URL and reference to the commit to use.

subdirectory: Option<Box<Path>>

The path to the source distribution if it is not in the repository root.

url: VerbatimUrl

The PEP 508 style url in the format git+<scheme>://<domain>/<path>@<rev>#subdirectory=<subdirectory>.

Path

A local built or source distribution, either from a path or a file:// URL. It can either be a binary distribution (a .whl file) or a source distribution archive (a .zip or .tar.gz file).

Fields

install_path: Box<Path>

The absolute path to the distribution which we use for installing.

ext: DistExtension

The file extension, e.g. tar.gz, zip, etc.

url: VerbatimUrl

The PEP 508 style URL in the format file:///<path>#subdirectory=<subdirectory>.

Directory

A local source tree (a directory with a pyproject.toml in, or a legacy source distribution with only a setup.py but non pyproject.toml in it).

Fields

install_path: Box<Path>

The absolute path to the distribution which we use for installing.

editable: Option<bool>

For a source tree (a directory), whether to install as an editable.

virtual: Option<bool>

For a source tree (a directory), whether the project should be built and installed.

url: VerbatimUrl

The PEP 508 style URL in the format file:///<path>#subdirectory=<subdirectory>.

Implementations

impl RequirementSource

pub fn from_parsed_url(parsed_url: ParsedUrl, url: VerbatimUrl) -> Self

Construct a RequirementSource for a URL source, given a URL parsed into components and the PEP 508 string (after the @) as VerbatimUrl.

pub fn to_verbatim_parsed_url(&self) -> Option<VerbatimParsedUrl>

Convert the source to a VerbatimParsedUrl, if it’s a URL source.

pub fn version_or_url(&self) -> Option<VersionOrUrl<VerbatimParsedUrl>>

Convert the source to a version specifier or URL.

If the source is a registry and the specifier is empty, it returns None.

pub fn is_editable(&self) -> bool

Returns true if the source is editable.

pub fn is_empty(&self) -> bool

Returns true if the source is empty.

pub fn version_specifiers(&self) -> Option<&VersionSpecifiers>

If the source is the registry, return the version specifiers

pub fn relative_to(self, path: &Path) -> Result<Self, Error>

Convert the source to a RequirementSource relative to the given path.

pub fn to_absolute(self, root: &Path) -> Self

Convert the source to a RequirementSource with an absolute path based on the given root.

Trait Implementations

impl Clone for RequirementSource

fn clone(&self) -> RequirementSource

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RequirementSource

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RequirementSource

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for RequirementSource

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

Display the RequirementSource, with the intention of being shown directly to a user, rather than for inclusion in a requirements.txt file.

impl From<&ResolvedDist> for RequirementSource

fn from(resolved_dist: &ResolvedDist) -> Self

Converts to this type from the input type.

impl Hash for RequirementSource

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for RequirementSource

fn cmp(&self, other: &RequirementSource) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for RequirementSource

fn eq(&self, other: &RequirementSource) -> 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 PartialOrd for RequirementSource

fn partial_cmp(&self, other: &RequirementSource) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for RequirementSource

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 RequirementSource

impl StructuralPartialEq for RequirementSource