Struct pep508_rs::Requirement

pub struct Requirement {
    pub name: PackageName,
    pub extras: Vec<ExtraName>,
    pub version_or_url: Option<VersionOrUrl>,
    pub marker: Option<MarkerTree>,
}

A PEP 508 dependency specification

Fields

name: PackageName

The distribution name such as numpy in requests [security,tests] >= 2.8.1, == 2.8.* ; python_version > "3.8"

extras: Vec<ExtraName>

The list of extras such as security, tests in requests [security,tests] >= 2.8.1, == 2.8.* ; python_version > "3.8"

version_or_url: Option<VersionOrUrl>

The version specifier such as >= 2.8.1, == 2.8.* in requests [security,tests] >= 2.8.1, == 2.8.* ; python_version > "3.8" or a url

marker: Option<MarkerTree>

The markers such as python_version > "3.8" in requests [security,tests] >= 2.8.1, == 2.8.* ; python_version > "3.8". Those are a nested and/or tree

Implementations

impl Requirement

pub fn is_satisfied_by(&self, version: &Version) -> bool

Returns true if the Version satisfies the Requirement.

pub fn evaluate_markers( &self, env: &MarkerEnvironment, extras: &[ExtraName] ) -> bool

Returns whether the markers apply for the given environment

pub fn evaluate_extras_and_python_version( &self, extras: &HashSet<ExtraName>, python_versions: &[Version] ) -> bool

Returns whether the requirement would be satisfied, independent of environment markers, i.e. if there is potentially an environment that could activate this requirement.

Note that unlike Self::evaluate_markers this does not perform any checks for bogus expressions but will simply return true. As caller you should separately perform a check with an environment and forward all warnings.

pub fn evaluate_markers_and_report( &self, env: &MarkerEnvironment, extras: &[ExtraName] ) -> (bool, Vec<(MarkerWarningKind, String, String)>)

Returns whether the markers apply for the given environment

impl Requirement

pub fn parse( input: &str, working_dir: impl AsRef<Path> ) -> Result<Self, Pep508Error>

Parse a Dependency Specifier

Trait Implementations

impl Clone for Requirement

fn clone(&self) -> Requirement

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Requirement

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

Formats the value using the given formatter.

impl Display for Requirement

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

Formats the value using the given formatter.

impl FromStr for Requirement

fn from_str(input: &str) -> Result<Self, Self::Err>

Parse a Dependency Specifier

type Err = Pep508Error

The associated error which can be returned from parsing.

impl Hash for Requirement

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 PartialEq for Requirement

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for Requirement

impl StructuralPartialEq for Requirement