Skip to main content

PypiDependency

Struct PypiDependency 

Source
pub struct PypiDependency {
    pub name: PackageName,
    pub name_range: Range,
    pub version_req: Option<VersionReq>,
    pub version_range: Option<Range>,
    pub extras: Vec<String>,
    pub extras_range: Option<Range>,
    pub markers: Option<String>,
    pub markers_range: Option<Range>,
    pub section: PypiDependencySection,
    pub source: PypiDependencySource,
}
Expand description

Parsed dependency from pyproject.toml with position tracking.

Stores all information about a Python dependency declaration, including its name, version requirement, extras, environment markers, and source positions for LSP operations. Positions are critical for features like hover, completion, and inlay hints.

§Examples

use deps_pypi::types::{PypiDependency, PypiDependencySection, PypiDependencySource};
use tower_lsp_server::ls_types::{Position, Range};

let dep = PypiDependency {
    name: "requests".into(),
    name_range: Range::new(Position::new(5, 4), Position::new(5, 12)),
    version_req: Some(">=2.28.0,<3.0".into()),
    version_range: Some(Range::new(Position::new(5, 13), Position::new(5, 27))),
    extras: vec!["security".into()],
    extras_range: None,
    markers: Some("python_full_version >= '3.8'".into()),
    markers_range: None,
    section: PypiDependencySection::Dependencies,
    source: PypiDependencySource::Registry,
};

assert_eq!(dep.name, "requests");
assert!(matches!(dep.section, PypiDependencySection::Dependencies));

Fields§

§name: PackageName

The package name as produced by the parse path that created this dependency — normalization is non-uniform, not a property callers can rely on directly:

  • PEP 508 string paths (PEP 621 [project] dependencies, PEP 735 dependency groups, requirements.txt) — already PEP 503-normalized, because pep508_rs::PackageName normalizes at construction.
  • Poetry table-key paths ([tool.poetry.dependencies], [tool.poetry.group.*.dependencies]) — the verbatim TOML key, unnormalized.

Callers must therefore never assume a normalized name. Apply crate::name::normalize (via EcosystemFormatter::normalize_package_name) at lookup time.

§name_range: Range

LSP range of the package name

§version_req: Option<VersionReq>

PEP 440 version specifier (e.g., “>=2.28.0,<3.0”)

§version_range: Option<Range>

LSP range of the version specifier

§extras: Vec<String>

PEP 508 extras (e.g., [“security”, “socks”])

§extras_range: Option<Range>

LSP range of the extras specification

§markers: Option<String>

PEP 508 environment markers (e.g., “python_full_version >= ‘3.8’”; pep508_rs canonicalizes python_version comparisons to python_full_version on serialization)

§markers_range: Option<Range>

LSP range of the markers specification

§section: PypiDependencySection

Section where this dependency is declared

§source: PypiDependencySource

Source of the dependency (PyPI, Git, Path, URL)

Trait Implementations§

Source§

impl Clone for PypiDependency

Source§

fn clone(&self) -> PypiDependency

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for PypiDependency

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Dependency for PypiDependency

Source§

fn name(&self) -> &PackageName

Package name
Source§

fn name_range(&self) -> Range

LSP range of the dependency name
Source§

fn version_requirement(&self) -> Option<&VersionReq>

Version requirement string (e.g., “^1.0”, “>=2.0”)
Source§

fn version_range(&self) -> Option<Range>

LSP range of the version string
Source§

fn source(&self) -> DependencySource

Dependency source (registry, git, path)
Source§

fn features(&self) -> &[String]

Feature flags (ecosystem-specific, empty if not supported)
Source§

fn markers(&self) -> Option<&str>

Environment marker expression gating this dependency (e.g. PEP 508’s python_version >= '3.8'). Ecosystem-specific, None if not supported or not present on this dependency.
Source§

fn markers_range(&self) -> Option<Range>

LSP range of the environment marker expression (ecosystem-specific, None if not supported or not present).
Source§

fn as_any(&self) -> &dyn Any

Downcast to concrete type
Source§

fn features_range(&self) -> Option<Range>

LSP range of the features array (ecosystem-specific, None if not supported)
Source§

fn version_literal(&self) -> Option<&str>

The raw manifest text spanned by version_range, when it differs from version_requirement. Read more
Source§

impl PartialEq for PypiDependency

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

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

impl StructuralPartialEq for PypiDependency

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more