mirror of
https://github.com/astral-sh/uv.git
synced 2025-10-22 00:02:32 +00:00
Split metadata parsing into a module (#7656)
This commit is contained in:
konsti
GitHub
parent
83f1abdf57
commit
484717d42f
18 changed files with 984 additions and 925 deletions
|
|
@ -1,864 +0,0 @@
|
|||
//! Derived from `pypi_types_crate`.
|
||||
|
||||
use std::io::BufRead;
|
||||
use std::str::FromStr;
|
||||
|
||||
use indexmap::IndexMap;
|
||||
use itertools::Itertools;
|
||||
use mailparse::{MailHeaderMap, MailParseError};
|
||||
use serde::de::IntoDeserializer;
|
||||
use serde::{Deserialize, Serialize};
|
||||
use thiserror::Error;
|
||||
use tracing::warn;
|
||||
|
||||
use pep440_rs::{Version, VersionParseError, VersionSpecifiers, VersionSpecifiersParseError};
|
||||
use pep508_rs::marker::MarkerValueExtra;
|
||||
use pep508_rs::{ExtraOperator, MarkerExpression, MarkerTree, Pep508Error, Requirement};
|
||||
use uv_normalize::{ExtraName, InvalidNameError, PackageName};
|
||||
|
||||
use crate::lenient_requirement::LenientRequirement;
|
||||
use crate::{LenientVersionSpecifiers, VerbatimParsedUrl};
|
||||
|
||||
/// Python Package Metadata 2.3 as specified in
|
||||
/// <https://packaging.python.org/specifications/core-metadata/>.
|
||||
///
|
||||
/// This is a subset of the full metadata specification, and only includes the
|
||||
/// fields that are relevant to dependency resolution.
|
||||
///
|
||||
/// At present, we support up to version 2.3 of the metadata specification.
|
||||
#[derive(Serialize, Deserialize, Debug, Clone)]
|
||||
#[serde(rename_all = "kebab-case")]
|
||||
pub struct Metadata23 {
|
||||
// Mandatory fields
|
||||
pub name: PackageName,
|
||||
pub version: Version,
|
||||
// Optional fields
|
||||
pub requires_dist: Vec<Requirement<VerbatimParsedUrl>>,
|
||||
pub requires_python: Option<VersionSpecifiers>,
|
||||
pub provides_extras: Vec<ExtraName>,
|
||||
}
|
||||
|
||||
/// <https://github.com/PyO3/python-pkginfo-rs/blob/d719988323a0cfea86d4737116d7917f30e819e2/src/error.rs>
|
||||
///
|
||||
/// The error type
|
||||
#[derive(Error, Debug)]
|
||||
pub enum MetadataError {
|
||||
#[error(transparent)]
|
||||
MailParse(#[from] MailParseError),
|
||||
#[error("Invalid `pyproject.toml`")]
|
||||
InvalidPyprojectTomlSyntax(#[source] toml_edit::TomlError),
|
||||
#[error("`pyproject.toml` is using the `[project]` table, but the required `project.name` field is not set.")]
|
||||
InvalidPyprojectTomlMissingName(#[source] toml_edit::de::Error),
|
||||
#[error(transparent)]
|
||||
InvalidPyprojectTomlSchema(toml_edit::de::Error),
|
||||
#[error("metadata field {0} not found")]
|
||||
FieldNotFound(&'static str),
|
||||
#[error("invalid version: {0}")]
|
||||
Pep440VersionError(VersionParseError),
|
||||
#[error(transparent)]
|
||||
Pep440Error(#[from] VersionSpecifiersParseError),
|
||||
#[error(transparent)]
|
||||
Pep508Error(#[from] Box<Pep508Error<VerbatimParsedUrl>>),
|
||||
#[error(transparent)]
|
||||
InvalidName(#[from] InvalidNameError),
|
||||
#[error("Invalid `Metadata-Version` field: {0}")]
|
||||
InvalidMetadataVersion(String),
|
||||
#[error("Reading metadata from `PKG-INFO` requires Metadata 2.2 or later (found: {0})")]
|
||||
UnsupportedMetadataVersion(String),
|
||||
#[error("The following field was marked as dynamic: {0}")]
|
||||
DynamicField(&'static str),
|
||||
#[error("The project uses Poetry's syntax to declare its dependencies, despite including a `project` table in `pyproject.toml`")]
|
||||
PoetrySyntax,
|
||||
#[error("Failed to read `requires.txt` contents")]
|
||||
RequiresTxtContents(#[from] std::io::Error),
|
||||
}
|
||||
|
||||
impl From<Pep508Error<VerbatimParsedUrl>> for MetadataError {
|
||||
fn from(error: Pep508Error<VerbatimParsedUrl>) -> Self {
|
||||
Self::Pep508Error(Box::new(error))
|
||||
}
|
||||
}
|
||||
|
||||
/// From <https://github.com/PyO3/python-pkginfo-rs/blob/d719988323a0cfea86d4737116d7917f30e819e2/src/metadata.rs#LL78C2-L91C26>
|
||||
impl Metadata23 {
|
||||
/// Parse the [`Metadata23`] from a `METADATA` file, as included in a built distribution (wheel).
|
||||
pub fn parse_metadata(content: &[u8]) -> Result<Self, MetadataError> {
|
||||
let headers = Headers::parse(content)?;
|
||||
|
||||
let name = PackageName::new(
|
||||
headers
|
||||
.get_first_value("Name")
|
||||
.ok_or(MetadataError::FieldNotFound("Name"))?,
|
||||
)?;
|
||||
let version = Version::from_str(
|
||||
&headers
|
||||
.get_first_value("Version")
|
||||
.ok_or(MetadataError::FieldNotFound("Version"))?,
|
||||
)
|
||||
.map_err(MetadataError::Pep440VersionError)?;
|
||||
let requires_dist = headers
|
||||
.get_all_values("Requires-Dist")
|
||||
.map(|requires_dist| LenientRequirement::from_str(&requires_dist))
|
||||
.map_ok(Requirement::from)
|
||||
.collect::<Result<Vec<_>, _>>()?;
|
||||
let requires_python = headers
|
||||
.get_first_value("Requires-Python")
|
||||
.map(|requires_python| LenientVersionSpecifiers::from_str(&requires_python))
|
||||
.transpose()?
|
||||
.map(VersionSpecifiers::from);
|
||||
let provides_extras = headers
|
||||
.get_all_values("Provides-Extra")
|
||||
.filter_map(|provides_extra| match ExtraName::new(provides_extra) {
|
||||
Ok(extra_name) => Some(extra_name),
|
||||
Err(err) => {
|
||||
warn!("Ignoring invalid extra: {err}");
|
||||
None
|
||||
}
|
||||
})
|
||||
.collect::<Vec<_>>();
|
||||
|
||||
Ok(Self {
|
||||
name,
|
||||
version,
|
||||
requires_dist,
|
||||
requires_python,
|
||||
provides_extras,
|
||||
})
|
||||
}
|
||||
|
||||
/// Read the [`Metadata23`] from a source distribution's `PKG-INFO` file, if it uses Metadata 2.2
|
||||
/// or later _and_ none of the required fields (`Requires-Python`, `Requires-Dist`, and
|
||||
/// `Provides-Extra`) are marked as dynamic.
|
||||
pub fn parse_pkg_info(content: &[u8]) -> Result<Self, MetadataError> {
|
||||
let headers = Headers::parse(content)?;
|
||||
|
||||
// To rely on a source distribution's `PKG-INFO` file, the `Metadata-Version` field must be
|
||||
// present and set to a value of at least `2.2`.
|
||||
let metadata_version = headers
|
||||
.get_first_value("Metadata-Version")
|
||||
.ok_or(MetadataError::FieldNotFound("Metadata-Version"))?;
|
||||
|
||||
// Parse the version into (major, minor).
|
||||
let (major, minor) = parse_version(&metadata_version)?;
|
||||
if (major, minor) < (2, 2) || (major, minor) >= (3, 0) {
|
||||
return Err(MetadataError::UnsupportedMetadataVersion(metadata_version));
|
||||
}
|
||||
|
||||
// If any of the fields we need are marked as dynamic, we can't use the `PKG-INFO` file.
|
||||
let dynamic = headers.get_all_values("Dynamic").collect::<Vec<_>>();
|
||||
for field in dynamic {
|
||||
match field.as_str() {
|
||||
"Requires-Python" => return Err(MetadataError::DynamicField("Requires-Python")),
|
||||
"Requires-Dist" => return Err(MetadataError::DynamicField("Requires-Dist")),
|
||||
"Provides-Extra" => return Err(MetadataError::DynamicField("Provides-Extra")),
|
||||
_ => (),
|
||||
}
|
||||
}
|
||||
|
||||
// The `Name` and `Version` fields are required, and can't be dynamic.
|
||||
let name = PackageName::new(
|
||||
headers
|
||||
.get_first_value("Name")
|
||||
.ok_or(MetadataError::FieldNotFound("Name"))?,
|
||||
)?;
|
||||
let version = Version::from_str(
|
||||
&headers
|
||||
.get_first_value("Version")
|
||||
.ok_or(MetadataError::FieldNotFound("Version"))?,
|
||||
)
|
||||
.map_err(MetadataError::Pep440VersionError)?;
|
||||
|
||||
// The remaining fields are required to be present.
|
||||
let requires_dist = headers
|
||||
.get_all_values("Requires-Dist")
|
||||
.map(|requires_dist| LenientRequirement::from_str(&requires_dist))
|
||||
.map_ok(Requirement::from)
|
||||
.collect::<Result<Vec<_>, _>>()?;
|
||||
let requires_python = headers
|
||||
.get_first_value("Requires-Python")
|
||||
.map(|requires_python| LenientVersionSpecifiers::from_str(&requires_python))
|
||||
.transpose()?
|
||||
.map(VersionSpecifiers::from);
|
||||
let provides_extras = headers
|
||||
.get_all_values("Provides-Extra")
|
||||
.filter_map(|provides_extra| match ExtraName::new(provides_extra) {
|
||||
Ok(extra_name) => Some(extra_name),
|
||||
Err(err) => {
|
||||
warn!("Ignoring invalid extra: {err}");
|
||||
None
|
||||
}
|
||||
})
|
||||
.collect::<Vec<_>>();
|
||||
|
||||
Ok(Self {
|
||||
name,
|
||||
version,
|
||||
requires_dist,
|
||||
requires_python,
|
||||
provides_extras,
|
||||
})
|
||||
}
|
||||
|
||||
/// Extract the metadata from a `pyproject.toml` file, as specified in PEP 621.
|
||||
pub fn parse_pyproject_toml(contents: &str) -> Result<Self, MetadataError> {
|
||||
let pyproject_toml = PyProjectToml::from_toml(contents)?;
|
||||
|
||||
let project = pyproject_toml
|
||||
.project
|
||||
.ok_or(MetadataError::FieldNotFound("project"))?;
|
||||
|
||||
// If any of the fields we need were declared as dynamic, we can't use the `pyproject.toml` file.
|
||||
let dynamic = project.dynamic.unwrap_or_default();
|
||||
for field in dynamic {
|
||||
match field.as_str() {
|
||||
"dependencies" => return Err(MetadataError::DynamicField("dependencies")),
|
||||
"optional-dependencies" => {
|
||||
return Err(MetadataError::DynamicField("optional-dependencies"))
|
||||
}
|
||||
"requires-python" => return Err(MetadataError::DynamicField("requires-python")),
|
||||
"version" => return Err(MetadataError::DynamicField("version")),
|
||||
_ => (),
|
||||
}
|
||||
}
|
||||
|
||||
// If dependencies are declared with Poetry, and `project.dependencies` is omitted, treat
|
||||
// the dependencies as dynamic. The inclusion of a `project` table without defining
|
||||
// `project.dependencies` is almost certainly an error.
|
||||
if project.dependencies.is_none()
|
||||
&& pyproject_toml.tool.and_then(|tool| tool.poetry).is_some()
|
||||
{
|
||||
return Err(MetadataError::PoetrySyntax);
|
||||
}
|
||||
|
||||
let name = project.name;
|
||||
let version = project
|
||||
.version
|
||||
.ok_or(MetadataError::FieldNotFound("version"))?;
|
||||
|
||||
// Parse the Python version requirements.
|
||||
let requires_python = project
|
||||
.requires_python
|
||||
.map(|requires_python| {
|
||||
LenientVersionSpecifiers::from_str(&requires_python).map(VersionSpecifiers::from)
|
||||
})
|
||||
.transpose()?;
|
||||
|
||||
// Extract the requirements.
|
||||
let mut requires_dist = project
|
||||
.dependencies
|
||||
.unwrap_or_default()
|
||||
.into_iter()
|
||||
.map(|requires_dist| LenientRequirement::from_str(&requires_dist))
|
||||
.map_ok(Requirement::from)
|
||||
.collect::<Result<Vec<_>, _>>()?;
|
||||
|
||||
// Extract the optional dependencies.
|
||||
let mut provides_extras: Vec<ExtraName> = Vec::new();
|
||||
for (extra, requirements) in project.optional_dependencies.unwrap_or_default() {
|
||||
requires_dist.extend(
|
||||
requirements
|
||||
.into_iter()
|
||||
.map(|requires_dist| LenientRequirement::from_str(&requires_dist))
|
||||
.map_ok(Requirement::from)
|
||||
.map_ok(|requirement| requirement.with_extra_marker(&extra))
|
||||
.collect::<Result<Vec<_>, _>>()?,
|
||||
);
|
||||
provides_extras.push(extra);
|
||||
}
|
||||
|
||||
Ok(Self {
|
||||
name,
|
||||
version,
|
||||
requires_dist,
|
||||
requires_python,
|
||||
provides_extras,
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
/// A `pyproject.toml` as specified in PEP 517.
|
||||
#[derive(Deserialize, Debug)]
|
||||
#[serde(rename_all = "kebab-case")]
|
||||
struct PyProjectToml {
|
||||
project: Option<Project>,
|
||||
tool: Option<Tool>,
|
||||
}
|
||||
|
||||
impl PyProjectToml {
|
||||
fn from_toml(toml: &str) -> Result<Self, MetadataError> {
|
||||
let pyproject_toml: toml_edit::ImDocument<_> = toml_edit::ImDocument::from_str(toml)
|
||||
.map_err(MetadataError::InvalidPyprojectTomlSyntax)?;
|
||||
let pyproject_toml: Self = PyProjectToml::deserialize(pyproject_toml.into_deserializer())
|
||||
.map_err(|err| {
|
||||
// TODO(konsti): A typed error would be nicer, this can break on toml upgrades.
|
||||
if err.message().contains("missing field `name`") {
|
||||
MetadataError::InvalidPyprojectTomlMissingName(err)
|
||||
} else {
|
||||
MetadataError::InvalidPyprojectTomlSchema(err)
|
||||
}
|
||||
})?;
|
||||
Ok(pyproject_toml)
|
||||
}
|
||||
}
|
||||
|
||||
/// PEP 621 project metadata.
|
||||
///
|
||||
/// This is a subset of the full metadata specification, and only includes the fields that are
|
||||
/// relevant for dependency resolution.
|
||||
///
|
||||
/// See <https://packaging.python.org/en/latest/specifications/pyproject-toml>.
|
||||
#[derive(Deserialize, Debug)]
|
||||
#[serde(rename_all = "kebab-case")]
|
||||
struct Project {
|
||||
/// The name of the project
|
||||
name: PackageName,
|
||||
/// The version of the project as supported by PEP 440
|
||||
version: Option<Version>,
|
||||
/// The Python version requirements of the project
|
||||
requires_python: Option<String>,
|
||||
/// Project dependencies
|
||||
dependencies: Option<Vec<String>>,
|
||||
/// Optional dependencies
|
||||
optional_dependencies: Option<IndexMap<ExtraName, Vec<String>>>,
|
||||
/// Specifies which fields listed by PEP 621 were intentionally unspecified
|
||||
/// so another tool can/will provide such metadata dynamically.
|
||||
dynamic: Option<Vec<String>>,
|
||||
}
|
||||
|
||||
#[derive(Deserialize, Debug)]
|
||||
#[serde(rename_all = "kebab-case")]
|
||||
struct Tool {
|
||||
poetry: Option<ToolPoetry>,
|
||||
}
|
||||
|
||||
#[derive(Deserialize, Debug)]
|
||||
#[serde(rename_all = "kebab-case")]
|
||||
#[allow(clippy::empty_structs_with_brackets)]
|
||||
struct ToolPoetry {}
|
||||
|
||||
/// Python Package Metadata 1.0 and later as specified in
|
||||
/// <https://peps.python.org/pep-0241/>.
|
||||
///
|
||||
/// This is a subset of the full metadata specification, and only includes the
|
||||
/// fields that have been consistent across all versions of the specification.
|
||||
#[derive(Deserialize, Debug, Clone)]
|
||||
#[serde(rename_all = "kebab-case")]
|
||||
pub struct Metadata10 {
|
||||
pub name: PackageName,
|
||||
pub version: String,
|
||||
}
|
||||
|
||||
impl Metadata10 {
|
||||
/// Parse the [`Metadata10`] from a `PKG-INFO` file, as included in a source distribution.
|
||||
pub fn parse_pkg_info(content: &[u8]) -> Result<Self, MetadataError> {
|
||||
let headers = Headers::parse(content)?;
|
||||
let name = PackageName::new(
|
||||
headers
|
||||
.get_first_value("Name")
|
||||
.ok_or(MetadataError::FieldNotFound("Name"))?,
|
||||
)?;
|
||||
let version = headers
|
||||
.get_first_value("Version")
|
||||
.ok_or(MetadataError::FieldNotFound("Version"))?;
|
||||
Ok(Self { name, version })
|
||||
}
|
||||
}
|
||||
|
||||
/// Python Package Metadata 1.2 and later as specified in
|
||||
/// <https://peps.python.org/pep-0345/>.
|
||||
///
|
||||
/// This is a subset of the full metadata specification, and only includes the
|
||||
/// fields that have been consistent across all versions of the specification later than 1.2.
|
||||
#[derive(Deserialize, Debug, Clone)]
|
||||
#[serde(rename_all = "kebab-case")]
|
||||
pub struct Metadata12 {
|
||||
pub name: PackageName,
|
||||
pub version: Version,
|
||||
pub requires_python: Option<VersionSpecifiers>,
|
||||
}
|
||||
|
||||
impl Metadata12 {
|
||||
/// Parse the [`Metadata12`] from a `.dist-info` `METADATA` file, as included in a built
|
||||
/// distribution.
|
||||
pub fn parse_metadata(content: &[u8]) -> Result<Self, MetadataError> {
|
||||
let headers = Headers::parse(content)?;
|
||||
|
||||
// To rely on a source distribution's `PKG-INFO` file, the `Metadata-Version` field must be
|
||||
// present and set to a value of at least `2.2`.
|
||||
let metadata_version = headers
|
||||
.get_first_value("Metadata-Version")
|
||||
.ok_or(MetadataError::FieldNotFound("Metadata-Version"))?;
|
||||
|
||||
// Parse the version into (major, minor).
|
||||
let (major, minor) = parse_version(&metadata_version)?;
|
||||
|
||||
// At time of writing:
|
||||
// > Version of the file format; legal values are “1.0”, “1.1”, “1.2”, “2.1”, “2.2”, and “2.3”.
|
||||
if (major, minor) < (1, 0) || (major, minor) >= (3, 0) {
|
||||
return Err(MetadataError::InvalidMetadataVersion(metadata_version));
|
||||
}
|
||||
|
||||
let name = PackageName::new(
|
||||
headers
|
||||
.get_first_value("Name")
|
||||
.ok_or(MetadataError::FieldNotFound("Name"))?,
|
||||
)?;
|
||||
let version = Version::from_str(
|
||||
&headers
|
||||
.get_first_value("Version")
|
||||
.ok_or(MetadataError::FieldNotFound("Version"))?,
|
||||
)
|
||||
.map_err(MetadataError::Pep440VersionError)?;
|
||||
let requires_python = headers
|
||||
.get_first_value("Requires-Python")
|
||||
.map(|requires_python| LenientVersionSpecifiers::from_str(&requires_python))
|
||||
.transpose()?
|
||||
.map(VersionSpecifiers::from);
|
||||
|
||||
Ok(Self {
|
||||
name,
|
||||
version,
|
||||
requires_python,
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
/// Parse a `Metadata-Version` field into a (major, minor) tuple.
|
||||
fn parse_version(metadata_version: &str) -> Result<(u8, u8), MetadataError> {
|
||||
let (major, minor) =
|
||||
metadata_version
|
||||
.split_once('.')
|
||||
.ok_or(MetadataError::InvalidMetadataVersion(
|
||||
metadata_version.to_string(),
|
||||
))?;
|
||||
let major = major
|
||||
.parse::<u8>()
|
||||
.map_err(|_| MetadataError::InvalidMetadataVersion(metadata_version.to_string()))?;
|
||||
let minor = minor
|
||||
.parse::<u8>()
|
||||
.map_err(|_| MetadataError::InvalidMetadataVersion(metadata_version.to_string()))?;
|
||||
Ok((major, minor))
|
||||
}
|
||||
|
||||
/// Python Package Metadata 2.3 as specified in
|
||||
/// <https://packaging.python.org/specifications/core-metadata/>.
|
||||
///
|
||||
/// This is a subset of [`Metadata23`]; specifically, it omits the `version` and `requires-python`
|
||||
/// fields, which aren't necessary when extracting the requirements of a package without installing
|
||||
/// the package itself.
|
||||
#[derive(Serialize, Deserialize, Debug, Clone)]
|
||||
#[serde(rename_all = "kebab-case")]
|
||||
pub struct RequiresDist {
|
||||
pub name: PackageName,
|
||||
pub requires_dist: Vec<Requirement<VerbatimParsedUrl>>,
|
||||
pub provides_extras: Vec<ExtraName>,
|
||||
}
|
||||
|
||||
impl RequiresDist {
|
||||
/// Extract the [`RequiresDist`] from a `pyproject.toml` file, as specified in PEP 621.
|
||||
pub fn parse_pyproject_toml(contents: &str) -> Result<Self, MetadataError> {
|
||||
let pyproject_toml = PyProjectToml::from_toml(contents)?;
|
||||
|
||||
let project = pyproject_toml
|
||||
.project
|
||||
.ok_or(MetadataError::FieldNotFound("project"))?;
|
||||
|
||||
// If any of the fields we need were declared as dynamic, we can't use the `pyproject.toml`
|
||||
// file.
|
||||
let dynamic = project.dynamic.unwrap_or_default();
|
||||
for field in dynamic {
|
||||
match field.as_str() {
|
||||
"dependencies" => return Err(MetadataError::DynamicField("dependencies")),
|
||||
"optional-dependencies" => {
|
||||
return Err(MetadataError::DynamicField("optional-dependencies"))
|
||||
}
|
||||
_ => (),
|
||||
}
|
||||
}
|
||||
|
||||
// If dependencies are declared with Poetry, and `project.dependencies` is omitted, treat
|
||||
// the dependencies as dynamic. The inclusion of a `project` table without defining
|
||||
// `project.dependencies` is almost certainly an error.
|
||||
if project.dependencies.is_none()
|
||||
&& pyproject_toml.tool.and_then(|tool| tool.poetry).is_some()
|
||||
{
|
||||
return Err(MetadataError::PoetrySyntax);
|
||||
}
|
||||
|
||||
let name = project.name;
|
||||
|
||||
// Extract the requirements.
|
||||
let mut requires_dist = project
|
||||
.dependencies
|
||||
.unwrap_or_default()
|
||||
.into_iter()
|
||||
.map(|requires_dist| LenientRequirement::from_str(&requires_dist))
|
||||
.map_ok(Requirement::from)
|
||||
.collect::<Result<Vec<_>, _>>()?;
|
||||
|
||||
// Extract the optional dependencies.
|
||||
let mut provides_extras: Vec<ExtraName> = Vec::new();
|
||||
for (extra, requirements) in project.optional_dependencies.unwrap_or_default() {
|
||||
requires_dist.extend(
|
||||
requirements
|
||||
.into_iter()
|
||||
.map(|requires_dist| LenientRequirement::from_str(&requires_dist))
|
||||
.map_ok(Requirement::from)
|
||||
.map_ok(|requirement| requirement.with_extra_marker(&extra))
|
||||
.collect::<Result<Vec<_>, _>>()?,
|
||||
);
|
||||
provides_extras.push(extra);
|
||||
}
|
||||
|
||||
Ok(Self {
|
||||
name,
|
||||
requires_dist,
|
||||
provides_extras,
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
/// `requires.txt` metadata as defined in <https://setuptools.pypa.io/en/latest/deprecated/python_eggs.html#dependency-metadata>.
|
||||
///
|
||||
/// This is a subset of the full metadata specification, and only includes the fields that are
|
||||
/// included in the legacy `requires.txt` file.
|
||||
#[derive(Deserialize, Debug, Clone)]
|
||||
#[serde(rename_all = "kebab-case")]
|
||||
pub struct RequiresTxt {
|
||||
pub requires_dist: Vec<Requirement<VerbatimParsedUrl>>,
|
||||
pub provides_extras: Vec<ExtraName>,
|
||||
}
|
||||
|
||||
impl RequiresTxt {
|
||||
/// Parse the [`RequiresTxt`] from a `requires.txt` file, as included in an `egg-info`.
|
||||
///
|
||||
/// See: <https://setuptools.pypa.io/en/latest/deprecated/python_eggs.html#dependency-metadata>
|
||||
pub fn parse(content: &[u8]) -> Result<Self, MetadataError> {
|
||||
let mut requires_dist = vec![];
|
||||
let mut provides_extras = vec![];
|
||||
let mut current_marker = MarkerTree::default();
|
||||
|
||||
for line in content.lines() {
|
||||
let line = line.map_err(MetadataError::RequiresTxtContents)?;
|
||||
|
||||
let line = line.trim();
|
||||
if line.is_empty() {
|
||||
continue;
|
||||
}
|
||||
|
||||
// When encountering a new section, parse the extra and marker from the header, e.g.,
|
||||
// `[:sys_platform == "win32"]` or `[dev]`.
|
||||
if line.starts_with('[') {
|
||||
let line = line.trim_start_matches('[').trim_end_matches(']');
|
||||
|
||||
// Split into extra and marker, both of which can be empty.
|
||||
let (extra, marker) = {
|
||||
let (extra, marker) = match line.split_once(':') {
|
||||
Some((extra, marker)) => (Some(extra), Some(marker)),
|
||||
None => (Some(line), None),
|
||||
};
|
||||
let extra = extra.filter(|extra| !extra.is_empty());
|
||||
let marker = marker.filter(|marker| !marker.is_empty());
|
||||
(extra, marker)
|
||||
};
|
||||
|
||||
// Parse the extra.
|
||||
let extra = if let Some(extra) = extra {
|
||||
if let Ok(extra) = ExtraName::from_str(extra) {
|
||||
provides_extras.push(extra.clone());
|
||||
Some(MarkerValueExtra::Extra(extra))
|
||||
} else {
|
||||
Some(MarkerValueExtra::Arbitrary(extra.to_string()))
|
||||
}
|
||||
} else {
|
||||
None
|
||||
};
|
||||
|
||||
// Parse the marker.
|
||||
let marker = marker.map(MarkerTree::parse_str).transpose()?;
|
||||
|
||||
// Create the marker tree.
|
||||
match (extra, marker) {
|
||||
(Some(extra), Some(mut marker)) => {
|
||||
marker.and(MarkerTree::expression(MarkerExpression::Extra {
|
||||
operator: ExtraOperator::Equal,
|
||||
name: extra,
|
||||
}));
|
||||
current_marker = marker;
|
||||
}
|
||||
(Some(extra), None) => {
|
||||
current_marker = MarkerTree::expression(MarkerExpression::Extra {
|
||||
operator: ExtraOperator::Equal,
|
||||
name: extra,
|
||||
});
|
||||
}
|
||||
(None, Some(marker)) => {
|
||||
current_marker = marker;
|
||||
}
|
||||
(None, None) => {
|
||||
current_marker = MarkerTree::default();
|
||||
}
|
||||
}
|
||||
|
||||
continue;
|
||||
}
|
||||
|
||||
// Parse the requirement.
|
||||
let requirement =
|
||||
Requirement::<VerbatimParsedUrl>::from(LenientRequirement::from_str(line)?);
|
||||
|
||||
// Add the markers and extra, if necessary.
|
||||
requires_dist.push(Requirement {
|
||||
marker: current_marker.clone(),
|
||||
..requirement
|
||||
});
|
||||
}
|
||||
|
||||
Ok(Self {
|
||||
requires_dist,
|
||||
provides_extras,
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
/// The headers of a distribution metadata file.
|
||||
#[derive(Debug)]
|
||||
struct Headers<'a>(Vec<mailparse::MailHeader<'a>>);
|
||||
|
||||
impl<'a> Headers<'a> {
|
||||
/// Parse the headers from the given metadata file content.
|
||||
fn parse(content: &'a [u8]) -> Result<Self, MailParseError> {
|
||||
let (headers, _) = mailparse::parse_headers(content)?;
|
||||
Ok(Self(headers))
|
||||
}
|
||||
|
||||
/// Return the first value associated with the header with the given name.
|
||||
fn get_first_value(&self, name: &str) -> Option<String> {
|
||||
self.0.get_first_header(name).and_then(|header| {
|
||||
let value = header.get_value();
|
||||
if value == "UNKNOWN" {
|
||||
None
|
||||
} else {
|
||||
Some(value)
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
/// Return all values associated with the header with the given name.
|
||||
fn get_all_values(&self, name: &str) -> impl Iterator<Item = String> {
|
||||
self.0
|
||||
.get_all_values(name)
|
||||
.into_iter()
|
||||
.filter(|value| value != "UNKNOWN")
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use std::str::FromStr;
|
||||
|
||||
use pep440_rs::Version;
|
||||
use uv_normalize::PackageName;
|
||||
|
||||
use crate::{MetadataError, RequiresTxt};
|
||||
|
||||
use super::Metadata23;
|
||||
|
||||
#[test]
|
||||
fn test_parse_metadata() {
|
||||
let s = "Metadata-Version: 1.0";
|
||||
let meta = Metadata23::parse_metadata(s.as_bytes());
|
||||
assert!(matches!(meta, Err(MetadataError::FieldNotFound("Name"))));
|
||||
|
||||
let s = "Metadata-Version: 1.0\nName: asdf";
|
||||
let meta = Metadata23::parse_metadata(s.as_bytes());
|
||||
assert!(matches!(meta, Err(MetadataError::FieldNotFound("Version"))));
|
||||
|
||||
let s = "Metadata-Version: 1.0\nName: asdf\nVersion: 1.0";
|
||||
let meta = Metadata23::parse_metadata(s.as_bytes()).unwrap();
|
||||
assert_eq!(meta.name, PackageName::from_str("asdf").unwrap());
|
||||
assert_eq!(meta.version, Version::new([1, 0]));
|
||||
|
||||
let s = "Metadata-Version: 1.0\nName: asdf\nVersion: 1.0\nAuthor: 中文\n\n一个 Python 包";
|
||||
let meta = Metadata23::parse_metadata(s.as_bytes()).unwrap();
|
||||
assert_eq!(meta.name, PackageName::from_str("asdf").unwrap());
|
||||
assert_eq!(meta.version, Version::new([1, 0]));
|
||||
|
||||
let s = "Metadata-Version: 1.0\nName: =?utf-8?q?foobar?=\nVersion: 1.0";
|
||||
let meta = Metadata23::parse_metadata(s.as_bytes()).unwrap();
|
||||
assert_eq!(meta.name, PackageName::from_str("foobar").unwrap());
|
||||
assert_eq!(meta.version, Version::new([1, 0]));
|
||||
|
||||
let s = "Metadata-Version: 1.0\nName: =?utf-8?q?=C3=A4_space?= <x@y.org>\nVersion: 1.0";
|
||||
let meta = Metadata23::parse_metadata(s.as_bytes());
|
||||
assert!(matches!(meta, Err(MetadataError::InvalidName(_))));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_parse_pkg_info() {
|
||||
let s = "Metadata-Version: 2.1";
|
||||
let meta = Metadata23::parse_pkg_info(s.as_bytes());
|
||||
assert!(matches!(
|
||||
meta,
|
||||
Err(MetadataError::UnsupportedMetadataVersion(_))
|
||||
));
|
||||
|
||||
let s = "Metadata-Version: 2.2\nName: asdf";
|
||||
let meta = Metadata23::parse_pkg_info(s.as_bytes());
|
||||
assert!(matches!(meta, Err(MetadataError::FieldNotFound("Version"))));
|
||||
|
||||
let s = "Metadata-Version: 2.3\nName: asdf";
|
||||
let meta = Metadata23::parse_pkg_info(s.as_bytes());
|
||||
assert!(matches!(meta, Err(MetadataError::FieldNotFound("Version"))));
|
||||
|
||||
let s = "Metadata-Version: 2.3\nName: asdf\nVersion: 1.0";
|
||||
let meta = Metadata23::parse_pkg_info(s.as_bytes()).unwrap();
|
||||
assert_eq!(meta.name, PackageName::from_str("asdf").unwrap());
|
||||
assert_eq!(meta.version, Version::new([1, 0]));
|
||||
|
||||
let s = "Metadata-Version: 2.3\nName: asdf\nVersion: 1.0\nDynamic: Requires-Dist";
|
||||
let meta = Metadata23::parse_pkg_info(s.as_bytes()).unwrap_err();
|
||||
assert!(matches!(meta, MetadataError::DynamicField("Requires-Dist")));
|
||||
|
||||
let s = "Metadata-Version: 2.3\nName: asdf\nVersion: 1.0\nRequires-Dist: foo";
|
||||
let meta = Metadata23::parse_pkg_info(s.as_bytes()).unwrap();
|
||||
assert_eq!(meta.name, PackageName::from_str("asdf").unwrap());
|
||||
assert_eq!(meta.version, Version::new([1, 0]));
|
||||
assert_eq!(meta.requires_dist, vec!["foo".parse().unwrap()]);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_parse_pyproject_toml() {
|
||||
let s = r#"
|
||||
[project]
|
||||
name = "asdf"
|
||||
"#;
|
||||
let meta = Metadata23::parse_pyproject_toml(s);
|
||||
assert!(matches!(meta, Err(MetadataError::FieldNotFound("version"))));
|
||||
|
||||
let s = r#"
|
||||
[project]
|
||||
name = "asdf"
|
||||
dynamic = ["version"]
|
||||
"#;
|
||||
let meta = Metadata23::parse_pyproject_toml(s);
|
||||
assert!(matches!(meta, Err(MetadataError::DynamicField("version"))));
|
||||
|
||||
let s = r#"
|
||||
[project]
|
||||
name = "asdf"
|
||||
version = "1.0"
|
||||
"#;
|
||||
let meta = Metadata23::parse_pyproject_toml(s).unwrap();
|
||||
assert_eq!(meta.name, PackageName::from_str("asdf").unwrap());
|
||||
assert_eq!(meta.version, Version::new([1, 0]));
|
||||
assert!(meta.requires_python.is_none());
|
||||
assert!(meta.requires_dist.is_empty());
|
||||
assert!(meta.provides_extras.is_empty());
|
||||
|
||||
let s = r#"
|
||||
[project]
|
||||
name = "asdf"
|
||||
version = "1.0"
|
||||
requires-python = ">=3.6"
|
||||
"#;
|
||||
let meta = Metadata23::parse_pyproject_toml(s).unwrap();
|
||||
assert_eq!(meta.name, PackageName::from_str("asdf").unwrap());
|
||||
assert_eq!(meta.version, Version::new([1, 0]));
|
||||
assert_eq!(meta.requires_python, Some(">=3.6".parse().unwrap()));
|
||||
assert!(meta.requires_dist.is_empty());
|
||||
assert!(meta.provides_extras.is_empty());
|
||||
|
||||
let s = r#"
|
||||
[project]
|
||||
name = "asdf"
|
||||
version = "1.0"
|
||||
requires-python = ">=3.6"
|
||||
dependencies = ["foo"]
|
||||
"#;
|
||||
let meta = Metadata23::parse_pyproject_toml(s).unwrap();
|
||||
assert_eq!(meta.name, PackageName::from_str("asdf").unwrap());
|
||||
assert_eq!(meta.version, Version::new([1, 0]));
|
||||
assert_eq!(meta.requires_python, Some(">=3.6".parse().unwrap()));
|
||||
assert_eq!(meta.requires_dist, vec!["foo".parse().unwrap()]);
|
||||
assert!(meta.provides_extras.is_empty());
|
||||
|
||||
let s = r#"
|
||||
[project]
|
||||
name = "asdf"
|
||||
version = "1.0"
|
||||
requires-python = ">=3.6"
|
||||
dependencies = ["foo"]
|
||||
|
||||
[project.optional-dependencies]
|
||||
dotenv = ["bar"]
|
||||
"#;
|
||||
let meta = Metadata23::parse_pyproject_toml(s).unwrap();
|
||||
assert_eq!(meta.name, PackageName::from_str("asdf").unwrap());
|
||||
assert_eq!(meta.version, Version::new([1, 0]));
|
||||
assert_eq!(meta.requires_python, Some(">=3.6".parse().unwrap()));
|
||||
assert_eq!(
|
||||
meta.requires_dist,
|
||||
vec![
|
||||
"foo".parse().unwrap(),
|
||||
"bar; extra == \"dotenv\"".parse().unwrap()
|
||||
]
|
||||
);
|
||||
assert_eq!(meta.provides_extras, vec!["dotenv".parse().unwrap()]);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_requires_txt() {
|
||||
let s = r"
|
||||
Werkzeug>=0.14
|
||||
Jinja2>=2.10
|
||||
|
||||
[dev]
|
||||
pytest>=3
|
||||
sphinx
|
||||
|
||||
[dotenv]
|
||||
python-dotenv
|
||||
";
|
||||
let meta = RequiresTxt::parse(s.as_bytes()).unwrap();
|
||||
assert_eq!(
|
||||
meta.requires_dist,
|
||||
vec![
|
||||
"Werkzeug>=0.14".parse().unwrap(),
|
||||
"Jinja2>=2.10".parse().unwrap(),
|
||||
"pytest>=3; extra == \"dev\"".parse().unwrap(),
|
||||
"sphinx; extra == \"dev\"".parse().unwrap(),
|
||||
"python-dotenv; extra == \"dotenv\"".parse().unwrap(),
|
||||
]
|
||||
);
|
||||
|
||||
let s = r"
|
||||
Werkzeug>=0.14
|
||||
|
||||
[dev:]
|
||||
Jinja2>=2.10
|
||||
|
||||
[:sys_platform == 'win32']
|
||||
pytest>=3
|
||||
|
||||
[]
|
||||
sphinx
|
||||
|
||||
[dotenv:sys_platform == 'darwin']
|
||||
python-dotenv
|
||||
";
|
||||
let meta = RequiresTxt::parse(s.as_bytes()).unwrap();
|
||||
assert_eq!(
|
||||
meta.requires_dist,
|
||||
vec![
|
||||
"Werkzeug>=0.14".parse().unwrap(),
|
||||
"Jinja2>=2.10 ; extra == \"dev\"".parse().unwrap(),
|
||||
"pytest>=3; sys_platform == 'win32'".parse().unwrap(),
|
||||
"sphinx".parse().unwrap(),
|
||||
"python-dotenv; sys_platform == 'darwin' and extra == \"dotenv\""
|
||||
.parse()
|
||||
.unwrap(),
|
||||
]
|
||||
);
|
||||
}
|
||||
}
|
||||
31
crates/pypi-types/src/metadata/metadata10.rs
Normal file
31
crates/pypi-types/src/metadata/metadata10.rs
Normal file
|
|
@ -0,0 +1,31 @@
|
|||
use crate::metadata::Headers;
|
||||
use crate::MetadataError;
|
||||
use serde::Deserialize;
|
||||
use uv_normalize::PackageName;
|
||||
|
||||
/// A subset of the full core metadata specification, including only the
|
||||
/// fields that have been consistent across all versions of the specification.
|
||||
///
|
||||
/// Core Metadata 1.0 is specified in <https://peps.python.org/pep-0241/>.
|
||||
#[derive(Deserialize, Debug, Clone)]
|
||||
#[serde(rename_all = "kebab-case")]
|
||||
pub struct Metadata10 {
|
||||
pub name: PackageName,
|
||||
pub version: String,
|
||||
}
|
||||
|
||||
impl Metadata10 {
|
||||
/// Parse the [`Metadata10`] from a `PKG-INFO` file, as included in a source distribution.
|
||||
pub fn parse_pkg_info(content: &[u8]) -> Result<Self, MetadataError> {
|
||||
let headers = Headers::parse(content)?;
|
||||
let name = PackageName::new(
|
||||
headers
|
||||
.get_first_value("Name")
|
||||
.ok_or(MetadataError::FieldNotFound("Name"))?,
|
||||
)?;
|
||||
let version = headers
|
||||
.get_first_value("Version")
|
||||
.ok_or(MetadataError::FieldNotFound("Version"))?;
|
||||
Ok(Self { name, version })
|
||||
}
|
||||
}
|
||||
64
crates/pypi-types/src/metadata/metadata12.rs
Normal file
64
crates/pypi-types/src/metadata/metadata12.rs
Normal file
|
|
@ -0,0 +1,64 @@
|
|||
use crate::metadata::{parse_version, Headers};
|
||||
use crate::{LenientVersionSpecifiers, MetadataError};
|
||||
use pep440_rs::{Version, VersionSpecifiers};
|
||||
use serde::Deserialize;
|
||||
use std::str::FromStr;
|
||||
use uv_normalize::PackageName;
|
||||
|
||||
/// A subset of the full cure metadata specification, only including the
|
||||
/// fields that have been consistent across all versions of the specification later than 1.2.
|
||||
///
|
||||
/// Python Package Metadata 1.2 is specified in <https://peps.python.org/pep-0345/>.
|
||||
#[derive(Deserialize, Debug, Clone)]
|
||||
#[serde(rename_all = "kebab-case")]
|
||||
pub struct Metadata12 {
|
||||
pub name: PackageName,
|
||||
pub version: Version,
|
||||
pub requires_python: Option<VersionSpecifiers>,
|
||||
}
|
||||
|
||||
impl Metadata12 {
|
||||
/// Parse the [`Metadata12`] from a `.dist-info/METADATA` file, as included in a built
|
||||
/// distribution.
|
||||
pub fn parse_metadata(content: &[u8]) -> Result<Self, MetadataError> {
|
||||
let headers = Headers::parse(content)?;
|
||||
|
||||
// To rely on a source distribution's `PKG-INFO` file, the `Metadata-Version` field must be
|
||||
// present and set to a value of at least `2.2`.
|
||||
let metadata_version = headers
|
||||
.get_first_value("Metadata-Version")
|
||||
.ok_or(MetadataError::FieldNotFound("Metadata-Version"))?;
|
||||
|
||||
// Parse the version into (major, minor).
|
||||
let (major, minor) = parse_version(&metadata_version)?;
|
||||
|
||||
// At time of writing:
|
||||
// > Version of the file format; legal values are “1.0”, “1.1”, “1.2”, “2.1”, “2.2”, and “2.3”.
|
||||
if (major, minor) < (1, 0) || (major, minor) >= (3, 0) {
|
||||
return Err(MetadataError::InvalidMetadataVersion(metadata_version));
|
||||
}
|
||||
|
||||
let name = PackageName::new(
|
||||
headers
|
||||
.get_first_value("Name")
|
||||
.ok_or(MetadataError::FieldNotFound("Name"))?,
|
||||
)?;
|
||||
let version = Version::from_str(
|
||||
&headers
|
||||
.get_first_value("Version")
|
||||
.ok_or(MetadataError::FieldNotFound("Version"))?,
|
||||
)
|
||||
.map_err(MetadataError::Pep440VersionError)?;
|
||||
let requires_python = headers
|
||||
.get_first_value("Requires-Python")
|
||||
.map(|requires_python| LenientVersionSpecifiers::from_str(&requires_python))
|
||||
.transpose()?
|
||||
.map(VersionSpecifiers::from);
|
||||
|
||||
Ok(Self {
|
||||
name,
|
||||
version,
|
||||
requires_python,
|
||||
})
|
||||
}
|
||||
}
|
||||
229
crates/pypi-types/src/metadata/metadata_resolver.rs
Normal file
229
crates/pypi-types/src/metadata/metadata_resolver.rs
Normal file
|
|
@ -0,0 +1,229 @@
|
|||
//! Derived from `pypi_types_crate`.
|
||||
|
||||
use std::str::FromStr;
|
||||
|
||||
use itertools::Itertools;
|
||||
use serde::{Deserialize, Serialize};
|
||||
use tracing::warn;
|
||||
|
||||
use pep440_rs::{Version, VersionSpecifiers};
|
||||
use pep508_rs::Requirement;
|
||||
use uv_normalize::{ExtraName, PackageName};
|
||||
|
||||
use crate::lenient_requirement::LenientRequirement;
|
||||
use crate::metadata::pyproject_toml::parse_pyproject_toml;
|
||||
use crate::metadata::Headers;
|
||||
use crate::{metadata, LenientVersionSpecifiers, MetadataError, VerbatimParsedUrl};
|
||||
|
||||
/// A subset of the full core metadata specification, including only the
|
||||
/// fields that are relevant to dependency resolution.
|
||||
///
|
||||
/// Core Metadata 2.3 is specified in <https://packaging.python.org/specifications/core-metadata/>.
|
||||
#[derive(Serialize, Deserialize, Debug, Clone)]
|
||||
#[serde(rename_all = "kebab-case")]
|
||||
pub struct MetadataResolver {
|
||||
// Mandatory fields
|
||||
pub name: PackageName,
|
||||
pub version: Version,
|
||||
// Optional fields
|
||||
pub requires_dist: Vec<Requirement<VerbatimParsedUrl>>,
|
||||
pub requires_python: Option<VersionSpecifiers>,
|
||||
pub provides_extras: Vec<ExtraName>,
|
||||
}
|
||||
|
||||
/// From <https://github.com/PyO3/python-pkginfo-rs/blob/d719988323a0cfea86d4737116d7917f30e819e2/src/metadata.rs#LL78C2-L91C26>
|
||||
impl MetadataResolver {
|
||||
/// Parse the [`MetadataResolver`] from a `METADATA` file, as included in a built distribution (wheel).
|
||||
pub fn parse_metadata(content: &[u8]) -> Result<Self, MetadataError> {
|
||||
let headers = Headers::parse(content)?;
|
||||
|
||||
let name = PackageName::new(
|
||||
headers
|
||||
.get_first_value("Name")
|
||||
.ok_or(MetadataError::FieldNotFound("Name"))?,
|
||||
)?;
|
||||
let version = Version::from_str(
|
||||
&headers
|
||||
.get_first_value("Version")
|
||||
.ok_or(MetadataError::FieldNotFound("Version"))?,
|
||||
)
|
||||
.map_err(MetadataError::Pep440VersionError)?;
|
||||
let requires_dist = headers
|
||||
.get_all_values("Requires-Dist")
|
||||
.map(|requires_dist| LenientRequirement::from_str(&requires_dist))
|
||||
.map_ok(Requirement::from)
|
||||
.collect::<Result<Vec<_>, _>>()?;
|
||||
let requires_python = headers
|
||||
.get_first_value("Requires-Python")
|
||||
.map(|requires_python| LenientVersionSpecifiers::from_str(&requires_python))
|
||||
.transpose()?
|
||||
.map(VersionSpecifiers::from);
|
||||
let provides_extras = headers
|
||||
.get_all_values("Provides-Extra")
|
||||
.filter_map(|provides_extra| match ExtraName::new(provides_extra) {
|
||||
Ok(extra_name) => Some(extra_name),
|
||||
Err(err) => {
|
||||
warn!("Ignoring invalid extra: {err}");
|
||||
None
|
||||
}
|
||||
})
|
||||
.collect::<Vec<_>>();
|
||||
|
||||
Ok(Self {
|
||||
name,
|
||||
version,
|
||||
requires_dist,
|
||||
requires_python,
|
||||
provides_extras,
|
||||
})
|
||||
}
|
||||
|
||||
/// Read the [`MetadataResolver`] from a source distribution's `PKG-INFO` file, if it uses Metadata 2.2
|
||||
/// or later _and_ none of the required fields (`Requires-Python`, `Requires-Dist`, and
|
||||
/// `Provides-Extra`) are marked as dynamic.
|
||||
pub fn parse_pkg_info(content: &[u8]) -> Result<Self, MetadataError> {
|
||||
let headers = Headers::parse(content)?;
|
||||
|
||||
// To rely on a source distribution's `PKG-INFO` file, the `Metadata-Version` field must be
|
||||
// present and set to a value of at least `2.2`.
|
||||
let metadata_version = headers
|
||||
.get_first_value("Metadata-Version")
|
||||
.ok_or(MetadataError::FieldNotFound("Metadata-Version"))?;
|
||||
|
||||
// Parse the version into (major, minor).
|
||||
let (major, minor) = metadata::parse_version(&metadata_version)?;
|
||||
if (major, minor) < (2, 2) || (major, minor) >= (3, 0) {
|
||||
return Err(MetadataError::UnsupportedMetadataVersion(metadata_version));
|
||||
}
|
||||
|
||||
// If any of the fields we need are marked as dynamic, we can't use the `PKG-INFO` file.
|
||||
let dynamic = headers.get_all_values("Dynamic").collect::<Vec<_>>();
|
||||
for field in dynamic {
|
||||
match field.as_str() {
|
||||
"Requires-Python" => return Err(MetadataError::DynamicField("Requires-Python")),
|
||||
"Requires-Dist" => return Err(MetadataError::DynamicField("Requires-Dist")),
|
||||
"Provides-Extra" => return Err(MetadataError::DynamicField("Provides-Extra")),
|
||||
_ => (),
|
||||
}
|
||||
}
|
||||
|
||||
// The `Name` and `Version` fields are required, and can't be dynamic.
|
||||
let name = PackageName::new(
|
||||
headers
|
||||
.get_first_value("Name")
|
||||
.ok_or(MetadataError::FieldNotFound("Name"))?,
|
||||
)?;
|
||||
let version = Version::from_str(
|
||||
&headers
|
||||
.get_first_value("Version")
|
||||
.ok_or(MetadataError::FieldNotFound("Version"))?,
|
||||
)
|
||||
.map_err(MetadataError::Pep440VersionError)?;
|
||||
|
||||
// The remaining fields are required to be present.
|
||||
let requires_dist = headers
|
||||
.get_all_values("Requires-Dist")
|
||||
.map(|requires_dist| LenientRequirement::from_str(&requires_dist))
|
||||
.map_ok(Requirement::from)
|
||||
.collect::<Result<Vec<_>, _>>()?;
|
||||
let requires_python = headers
|
||||
.get_first_value("Requires-Python")
|
||||
.map(|requires_python| LenientVersionSpecifiers::from_str(&requires_python))
|
||||
.transpose()?
|
||||
.map(VersionSpecifiers::from);
|
||||
let provides_extras = headers
|
||||
.get_all_values("Provides-Extra")
|
||||
.filter_map(|provides_extra| match ExtraName::new(provides_extra) {
|
||||
Ok(extra_name) => Some(extra_name),
|
||||
Err(err) => {
|
||||
warn!("Ignoring invalid extra: {err}");
|
||||
None
|
||||
}
|
||||
})
|
||||
.collect::<Vec<_>>();
|
||||
|
||||
Ok(Self {
|
||||
name,
|
||||
version,
|
||||
requires_dist,
|
||||
requires_python,
|
||||
provides_extras,
|
||||
})
|
||||
}
|
||||
|
||||
pub fn parse_pyproject_toml(toml: &str) -> Result<Self, MetadataError> {
|
||||
parse_pyproject_toml(toml)
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use crate::MetadataError;
|
||||
use pep440_rs::Version;
|
||||
use std::str::FromStr;
|
||||
use uv_normalize::PackageName;
|
||||
|
||||
#[test]
|
||||
fn test_parse_metadata() {
|
||||
let s = "Metadata-Version: 1.0";
|
||||
let meta = MetadataResolver::parse_metadata(s.as_bytes());
|
||||
assert!(matches!(meta, Err(MetadataError::FieldNotFound("Name"))));
|
||||
|
||||
let s = "Metadata-Version: 1.0\nName: asdf";
|
||||
let meta = MetadataResolver::parse_metadata(s.as_bytes());
|
||||
assert!(matches!(meta, Err(MetadataError::FieldNotFound("Version"))));
|
||||
|
||||
let s = "Metadata-Version: 1.0\nName: asdf\nVersion: 1.0";
|
||||
let meta = MetadataResolver::parse_metadata(s.as_bytes()).unwrap();
|
||||
assert_eq!(meta.name, PackageName::from_str("asdf").unwrap());
|
||||
assert_eq!(meta.version, Version::new([1, 0]));
|
||||
|
||||
let s = "Metadata-Version: 1.0\nName: asdf\nVersion: 1.0\nAuthor: 中文\n\n一个 Python 包";
|
||||
let meta = MetadataResolver::parse_metadata(s.as_bytes()).unwrap();
|
||||
assert_eq!(meta.name, PackageName::from_str("asdf").unwrap());
|
||||
assert_eq!(meta.version, Version::new([1, 0]));
|
||||
|
||||
let s = "Metadata-Version: 1.0\nName: =?utf-8?q?foobar?=\nVersion: 1.0";
|
||||
let meta = MetadataResolver::parse_metadata(s.as_bytes()).unwrap();
|
||||
assert_eq!(meta.name, PackageName::from_str("foobar").unwrap());
|
||||
assert_eq!(meta.version, Version::new([1, 0]));
|
||||
|
||||
let s = "Metadata-Version: 1.0\nName: =?utf-8?q?=C3=A4_space?= <x@y.org>\nVersion: 1.0";
|
||||
let meta = MetadataResolver::parse_metadata(s.as_bytes());
|
||||
assert!(matches!(meta, Err(MetadataError::InvalidName(_))));
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_parse_pkg_info() {
|
||||
let s = "Metadata-Version: 2.1";
|
||||
let meta = MetadataResolver::parse_pkg_info(s.as_bytes());
|
||||
assert!(matches!(
|
||||
meta,
|
||||
Err(MetadataError::UnsupportedMetadataVersion(_))
|
||||
));
|
||||
|
||||
let s = "Metadata-Version: 2.2\nName: asdf";
|
||||
let meta = MetadataResolver::parse_pkg_info(s.as_bytes());
|
||||
assert!(matches!(meta, Err(MetadataError::FieldNotFound("Version"))));
|
||||
|
||||
let s = "Metadata-Version: 2.3\nName: asdf";
|
||||
let meta = MetadataResolver::parse_pkg_info(s.as_bytes());
|
||||
assert!(matches!(meta, Err(MetadataError::FieldNotFound("Version"))));
|
||||
|
||||
let s = "Metadata-Version: 2.3\nName: asdf\nVersion: 1.0";
|
||||
let meta = MetadataResolver::parse_pkg_info(s.as_bytes()).unwrap();
|
||||
assert_eq!(meta.name, PackageName::from_str("asdf").unwrap());
|
||||
assert_eq!(meta.version, Version::new([1, 0]));
|
||||
|
||||
let s = "Metadata-Version: 2.3\nName: asdf\nVersion: 1.0\nDynamic: Requires-Dist";
|
||||
let meta = MetadataResolver::parse_pkg_info(s.as_bytes()).unwrap_err();
|
||||
assert!(matches!(meta, MetadataError::DynamicField("Requires-Dist")));
|
||||
|
||||
let s = "Metadata-Version: 2.3\nName: asdf\nVersion: 1.0\nRequires-Dist: foo";
|
||||
let meta = MetadataResolver::parse_pkg_info(s.as_bytes()).unwrap();
|
||||
assert_eq!(meta.name, PackageName::from_str("asdf").unwrap());
|
||||
assert_eq!(meta.version, Version::new([1, 0]));
|
||||
assert_eq!(meta.requires_dist, vec!["foo".parse().unwrap()]);
|
||||
}
|
||||
}
|
||||
113
crates/pypi-types/src/metadata/mod.rs
Normal file
113
crates/pypi-types/src/metadata/mod.rs
Normal file
|
|
@ -0,0 +1,113 @@
|
|||
mod metadata10;
|
||||
mod metadata12;
|
||||
mod metadata_resolver;
|
||||
mod pyproject_toml;
|
||||
mod requires_txt;
|
||||
|
||||
use crate::VerbatimParsedUrl;
|
||||
use mailparse::{MailHeaderMap, MailParseError};
|
||||
use pep440_rs::{VersionParseError, VersionSpecifiersParseError};
|
||||
use pep508_rs::Pep508Error;
|
||||
use std::str::Utf8Error;
|
||||
use thiserror::Error;
|
||||
use uv_normalize::InvalidNameError;
|
||||
|
||||
pub use metadata10::Metadata10;
|
||||
pub use metadata12::Metadata12;
|
||||
pub use metadata_resolver::MetadataResolver;
|
||||
pub use pyproject_toml::RequiresDist;
|
||||
pub use requires_txt::RequiresTxt;
|
||||
|
||||
/// <https://github.com/PyO3/python-pkginfo-rs/blob/d719988323a0cfea86d4737116d7917f30e819e2/src/error.rs>
|
||||
///
|
||||
/// The error type
|
||||
#[derive(Error, Debug)]
|
||||
pub enum MetadataError {
|
||||
#[error(transparent)]
|
||||
MailParse(#[from] MailParseError),
|
||||
#[error("Invalid `pyproject.toml`")]
|
||||
InvalidPyprojectTomlSyntax(#[source] toml_edit::TomlError),
|
||||
#[error("`pyproject.toml` is using the `[project]` table, but the required `project.name` field is not set.")]
|
||||
InvalidPyprojectTomlMissingName(#[source] toml_edit::de::Error),
|
||||
#[error(transparent)]
|
||||
InvalidPyprojectTomlSchema(toml_edit::de::Error),
|
||||
#[error("Metadata field {0} not found")]
|
||||
FieldNotFound(&'static str),
|
||||
#[error("Invalid version: {0}")]
|
||||
Pep440VersionError(VersionParseError),
|
||||
#[error(transparent)]
|
||||
Pep440Error(#[from] VersionSpecifiersParseError),
|
||||
#[error(transparent)]
|
||||
Pep508Error(#[from] Box<Pep508Error<VerbatimParsedUrl>>),
|
||||
#[error(transparent)]
|
||||
InvalidName(#[from] InvalidNameError),
|
||||
#[error("Invalid `Metadata-Version` field: {0}")]
|
||||
InvalidMetadataVersion(String),
|
||||
#[error("Reading metadata from `PKG-INFO` requires Metadata 2.2 or later (found: {0})")]
|
||||
UnsupportedMetadataVersion(String),
|
||||
#[error("The following field was marked as dynamic: {0}")]
|
||||
DynamicField(&'static str),
|
||||
#[error("The project uses Poetry's syntax to declare its dependencies, despite including a `project` table in `pyproject.toml`")]
|
||||
PoetrySyntax,
|
||||
#[error("Failed to read `requires.txt` contents")]
|
||||
RequiresTxtContents(#[from] std::io::Error),
|
||||
#[error("The description is not valid utf-8")]
|
||||
DescriptionEncoding(#[source] Utf8Error),
|
||||
}
|
||||
|
||||
impl From<Pep508Error<VerbatimParsedUrl>> for MetadataError {
|
||||
fn from(error: Pep508Error<VerbatimParsedUrl>) -> Self {
|
||||
Self::Pep508Error(Box::new(error))
|
||||
}
|
||||
}
|
||||
|
||||
/// The headers of a distribution metadata file.
|
||||
#[derive(Debug)]
|
||||
struct Headers<'a> {
|
||||
headers: Vec<mailparse::MailHeader<'a>>,
|
||||
}
|
||||
|
||||
impl<'a> Headers<'a> {
|
||||
/// Parse the headers from the given metadata file content.
|
||||
fn parse(content: &'a [u8]) -> Result<Self, MailParseError> {
|
||||
let (headers, _) = mailparse::parse_headers(content)?;
|
||||
Ok(Self { headers })
|
||||
}
|
||||
|
||||
/// Return the first value associated with the header with the given name.
|
||||
fn get_first_value(&self, name: &str) -> Option<String> {
|
||||
self.headers.get_first_header(name).and_then(|header| {
|
||||
let value = header.get_value();
|
||||
if value == "UNKNOWN" {
|
||||
None
|
||||
} else {
|
||||
Some(value)
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
/// Return all values associated with the header with the given name.
|
||||
fn get_all_values(&self, name: &str) -> impl Iterator<Item = String> {
|
||||
self.headers
|
||||
.get_all_values(name)
|
||||
.into_iter()
|
||||
.filter(|value| value != "UNKNOWN")
|
||||
}
|
||||
}
|
||||
|
||||
/// Parse a `Metadata-Version` field into a (major, minor) tuple.
|
||||
fn parse_version(metadata_version: &str) -> Result<(u8, u8), MetadataError> {
|
||||
let (major, minor) =
|
||||
metadata_version
|
||||
.split_once('.')
|
||||
.ok_or(MetadataError::InvalidMetadataVersion(
|
||||
metadata_version.to_string(),
|
||||
))?;
|
||||
let major = major
|
||||
.parse::<u8>()
|
||||
.map_err(|_| MetadataError::InvalidMetadataVersion(metadata_version.to_string()))?;
|
||||
let minor = minor
|
||||
.parse::<u8>()
|
||||
.map_err(|_| MetadataError::InvalidMetadataVersion(metadata_version.to_string()))?;
|
||||
Ok((major, minor))
|
||||
}
|
||||
314
crates/pypi-types/src/metadata/pyproject_toml.rs
Normal file
314
crates/pypi-types/src/metadata/pyproject_toml.rs
Normal file
|
|
@ -0,0 +1,314 @@
|
|||
use crate::{
|
||||
LenientRequirement, LenientVersionSpecifiers, MetadataError, MetadataResolver,
|
||||
VerbatimParsedUrl,
|
||||
};
|
||||
use indexmap::IndexMap;
|
||||
use itertools::Itertools;
|
||||
use pep440_rs::{Version, VersionSpecifiers};
|
||||
use pep508_rs::Requirement;
|
||||
use serde::de::IntoDeserializer;
|
||||
use serde::{Deserialize, Serialize};
|
||||
use std::str::FromStr;
|
||||
use uv_normalize::{ExtraName, PackageName};
|
||||
|
||||
/// Extract the metadata from a `pyproject.toml` file, as specified in PEP 621.
|
||||
pub(crate) fn parse_pyproject_toml(contents: &str) -> Result<MetadataResolver, MetadataError> {
|
||||
let pyproject_toml = PyProjectToml::from_toml(contents)?;
|
||||
|
||||
let project = pyproject_toml
|
||||
.project
|
||||
.ok_or(MetadataError::FieldNotFound("project"))?;
|
||||
|
||||
// If any of the fields we need were declared as dynamic, we can't use the `pyproject.toml` file.
|
||||
let dynamic = project.dynamic.unwrap_or_default();
|
||||
for field in dynamic {
|
||||
match field.as_str() {
|
||||
"dependencies" => return Err(MetadataError::DynamicField("dependencies")),
|
||||
"optional-dependencies" => {
|
||||
return Err(MetadataError::DynamicField("optional-dependencies"))
|
||||
}
|
||||
"requires-python" => return Err(MetadataError::DynamicField("requires-python")),
|
||||
"version" => return Err(MetadataError::DynamicField("version")),
|
||||
_ => (),
|
||||
}
|
||||
}
|
||||
|
||||
// If dependencies are declared with Poetry, and `project.dependencies` is omitted, treat
|
||||
// the dependencies as dynamic. The inclusion of a `project` table without defining
|
||||
// `project.dependencies` is almost certainly an error.
|
||||
if project.dependencies.is_none() && pyproject_toml.tool.and_then(|tool| tool.poetry).is_some()
|
||||
{
|
||||
return Err(MetadataError::PoetrySyntax);
|
||||
}
|
||||
|
||||
let name = project.name;
|
||||
let version = project
|
||||
.version
|
||||
.ok_or(MetadataError::FieldNotFound("version"))?;
|
||||
|
||||
// Parse the Python version requirements.
|
||||
let requires_python = project
|
||||
.requires_python
|
||||
.map(|requires_python| {
|
||||
LenientVersionSpecifiers::from_str(&requires_python).map(VersionSpecifiers::from)
|
||||
})
|
||||
.transpose()?;
|
||||
|
||||
// Extract the requirements.
|
||||
let mut requires_dist = project
|
||||
.dependencies
|
||||
.unwrap_or_default()
|
||||
.into_iter()
|
||||
.map(|requires_dist| LenientRequirement::from_str(&requires_dist))
|
||||
.map_ok(Requirement::from)
|
||||
.collect::<Result<Vec<_>, _>>()?;
|
||||
|
||||
// Extract the optional dependencies.
|
||||
let mut provides_extras: Vec<ExtraName> = Vec::new();
|
||||
for (extra, requirements) in project.optional_dependencies.unwrap_or_default() {
|
||||
requires_dist.extend(
|
||||
requirements
|
||||
.into_iter()
|
||||
.map(|requires_dist| LenientRequirement::from_str(&requires_dist))
|
||||
.map_ok(Requirement::from)
|
||||
.map_ok(|requirement| requirement.with_extra_marker(&extra))
|
||||
.collect::<Result<Vec<_>, _>>()?,
|
||||
);
|
||||
provides_extras.push(extra);
|
||||
}
|
||||
|
||||
Ok(MetadataResolver {
|
||||
name,
|
||||
version,
|
||||
requires_dist,
|
||||
requires_python,
|
||||
provides_extras,
|
||||
})
|
||||
}
|
||||
|
||||
/// A `pyproject.toml` as specified in PEP 517.
|
||||
#[derive(Deserialize, Debug)]
|
||||
#[serde(rename_all = "kebab-case")]
|
||||
struct PyProjectToml {
|
||||
project: Option<Project>,
|
||||
tool: Option<Tool>,
|
||||
}
|
||||
|
||||
impl PyProjectToml {
|
||||
pub(crate) fn from_toml(toml: &str) -> Result<Self, MetadataError> {
|
||||
let pyproject_toml: toml_edit::ImDocument<_> = toml_edit::ImDocument::from_str(toml)
|
||||
.map_err(MetadataError::InvalidPyprojectTomlSyntax)?;
|
||||
let pyproject_toml: Self = PyProjectToml::deserialize(pyproject_toml.into_deserializer())
|
||||
.map_err(|err| {
|
||||
// TODO(konsti): A typed error would be nicer, this can break on toml upgrades.
|
||||
if err.message().contains("missing field `name`") {
|
||||
MetadataError::InvalidPyprojectTomlMissingName(err)
|
||||
} else {
|
||||
MetadataError::InvalidPyprojectTomlSchema(err)
|
||||
}
|
||||
})?;
|
||||
Ok(pyproject_toml)
|
||||
}
|
||||
}
|
||||
|
||||
/// PEP 621 project metadata.
|
||||
///
|
||||
/// This is a subset of the full metadata specification, and only includes the fields that are
|
||||
/// relevant for dependency resolution.
|
||||
///
|
||||
/// See <https://packaging.python.org/en/latest/specifications/pyproject-toml>.
|
||||
#[derive(Deserialize, Debug)]
|
||||
#[serde(rename_all = "kebab-case")]
|
||||
struct Project {
|
||||
/// The name of the project
|
||||
name: PackageName,
|
||||
/// The version of the project as supported by PEP 440
|
||||
version: Option<Version>,
|
||||
/// The Python version requirements of the project
|
||||
requires_python: Option<String>,
|
||||
/// Project dependencies
|
||||
dependencies: Option<Vec<String>>,
|
||||
/// Optional dependencies
|
||||
optional_dependencies: Option<IndexMap<ExtraName, Vec<String>>>,
|
||||
/// Specifies which fields listed by PEP 621 were intentionally unspecified
|
||||
/// so another tool can/will provide such metadata dynamically.
|
||||
dynamic: Option<Vec<String>>,
|
||||
}
|
||||
|
||||
#[derive(Deserialize, Debug)]
|
||||
#[serde(rename_all = "kebab-case")]
|
||||
struct Tool {
|
||||
poetry: Option<ToolPoetry>,
|
||||
}
|
||||
|
||||
#[derive(Deserialize, Debug)]
|
||||
#[serde(rename_all = "kebab-case")]
|
||||
#[allow(clippy::empty_structs_with_brackets)]
|
||||
struct ToolPoetry {}
|
||||
|
||||
/// Python Package Metadata 2.3 as specified in
|
||||
/// <https://packaging.python.org/specifications/core-metadata/>.
|
||||
///
|
||||
/// This is a subset of [`MetadataResolver`]; specifically, it omits the `version` and `requires-python`
|
||||
/// fields, which aren't necessary when extracting the requirements of a package without installing
|
||||
/// the package itself.
|
||||
#[derive(Serialize, Deserialize, Debug, Clone)]
|
||||
#[serde(rename_all = "kebab-case")]
|
||||
pub struct RequiresDist {
|
||||
pub name: PackageName,
|
||||
pub requires_dist: Vec<Requirement<VerbatimParsedUrl>>,
|
||||
pub provides_extras: Vec<ExtraName>,
|
||||
}
|
||||
|
||||
impl RequiresDist {
|
||||
/// Extract the [`RequiresDist`] from a `pyproject.toml` file, as specified in PEP 621.
|
||||
pub fn parse_pyproject_toml(contents: &str) -> Result<Self, MetadataError> {
|
||||
let pyproject_toml = PyProjectToml::from_toml(contents)?;
|
||||
|
||||
let project = pyproject_toml
|
||||
.project
|
||||
.ok_or(MetadataError::FieldNotFound("project"))?;
|
||||
|
||||
// If any of the fields we need were declared as dynamic, we can't use the `pyproject.toml`
|
||||
// file.
|
||||
let dynamic = project.dynamic.unwrap_or_default();
|
||||
for field in dynamic {
|
||||
match field.as_str() {
|
||||
"dependencies" => return Err(MetadataError::DynamicField("dependencies")),
|
||||
"optional-dependencies" => {
|
||||
return Err(MetadataError::DynamicField("optional-dependencies"))
|
||||
}
|
||||
_ => (),
|
||||
}
|
||||
}
|
||||
|
||||
// If dependencies are declared with Poetry, and `project.dependencies` is omitted, treat
|
||||
// the dependencies as dynamic. The inclusion of a `project` table without defining
|
||||
// `project.dependencies` is almost certainly an error.
|
||||
if project.dependencies.is_none()
|
||||
&& pyproject_toml.tool.and_then(|tool| tool.poetry).is_some()
|
||||
{
|
||||
return Err(MetadataError::PoetrySyntax);
|
||||
}
|
||||
|
||||
let name = project.name;
|
||||
|
||||
// Extract the requirements.
|
||||
let mut requires_dist = project
|
||||
.dependencies
|
||||
.unwrap_or_default()
|
||||
.into_iter()
|
||||
.map(|requires_dist| LenientRequirement::from_str(&requires_dist))
|
||||
.map_ok(Requirement::from)
|
||||
.collect::<Result<Vec<_>, _>>()?;
|
||||
|
||||
// Extract the optional dependencies.
|
||||
let mut provides_extras: Vec<ExtraName> = Vec::new();
|
||||
for (extra, requirements) in project.optional_dependencies.unwrap_or_default() {
|
||||
requires_dist.extend(
|
||||
requirements
|
||||
.into_iter()
|
||||
.map(|requires_dist| LenientRequirement::from_str(&requires_dist))
|
||||
.map_ok(Requirement::from)
|
||||
.map_ok(|requirement| requirement.with_extra_marker(&extra))
|
||||
.collect::<Result<Vec<_>, _>>()?,
|
||||
);
|
||||
provides_extras.push(extra);
|
||||
}
|
||||
|
||||
Ok(Self {
|
||||
name,
|
||||
requires_dist,
|
||||
provides_extras,
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use crate::metadata::pyproject_toml::parse_pyproject_toml;
|
||||
use crate::MetadataError;
|
||||
use pep440_rs::Version;
|
||||
use std::str::FromStr;
|
||||
use uv_normalize::PackageName;
|
||||
|
||||
#[test]
|
||||
fn test_parse_pyproject_toml() {
|
||||
let s = r#"
|
||||
[project]
|
||||
name = "asdf"
|
||||
"#;
|
||||
let meta = parse_pyproject_toml(s);
|
||||
assert!(matches!(meta, Err(MetadataError::FieldNotFound("version"))));
|
||||
|
||||
let s = r#"
|
||||
[project]
|
||||
name = "asdf"
|
||||
dynamic = ["version"]
|
||||
"#;
|
||||
let meta = parse_pyproject_toml(s);
|
||||
assert!(matches!(meta, Err(MetadataError::DynamicField("version"))));
|
||||
|
||||
let s = r#"
|
||||
[project]
|
||||
name = "asdf"
|
||||
version = "1.0"
|
||||
"#;
|
||||
let meta = parse_pyproject_toml(s).unwrap();
|
||||
assert_eq!(meta.name, PackageName::from_str("asdf").unwrap());
|
||||
assert_eq!(meta.version, Version::new([1, 0]));
|
||||
assert!(meta.requires_python.is_none());
|
||||
assert!(meta.requires_dist.is_empty());
|
||||
assert!(meta.provides_extras.is_empty());
|
||||
|
||||
let s = r#"
|
||||
[project]
|
||||
name = "asdf"
|
||||
version = "1.0"
|
||||
requires-python = ">=3.6"
|
||||
"#;
|
||||
let meta = parse_pyproject_toml(s).unwrap();
|
||||
assert_eq!(meta.name, PackageName::from_str("asdf").unwrap());
|
||||
assert_eq!(meta.version, Version::new([1, 0]));
|
||||
assert_eq!(meta.requires_python, Some(">=3.6".parse().unwrap()));
|
||||
assert!(meta.requires_dist.is_empty());
|
||||
assert!(meta.provides_extras.is_empty());
|
||||
|
||||
let s = r#"
|
||||
[project]
|
||||
name = "asdf"
|
||||
version = "1.0"
|
||||
requires-python = ">=3.6"
|
||||
dependencies = ["foo"]
|
||||
"#;
|
||||
let meta = parse_pyproject_toml(s).unwrap();
|
||||
assert_eq!(meta.name, PackageName::from_str("asdf").unwrap());
|
||||
assert_eq!(meta.version, Version::new([1, 0]));
|
||||
assert_eq!(meta.requires_python, Some(">=3.6".parse().unwrap()));
|
||||
assert_eq!(meta.requires_dist, vec!["foo".parse().unwrap()]);
|
||||
assert!(meta.provides_extras.is_empty());
|
||||
|
||||
let s = r#"
|
||||
[project]
|
||||
name = "asdf"
|
||||
version = "1.0"
|
||||
requires-python = ">=3.6"
|
||||
dependencies = ["foo"]
|
||||
|
||||
[project.optional-dependencies]
|
||||
dotenv = ["bar"]
|
||||
"#;
|
||||
let meta = parse_pyproject_toml(s).unwrap();
|
||||
assert_eq!(meta.name, PackageName::from_str("asdf").unwrap());
|
||||
assert_eq!(meta.version, Version::new([1, 0]));
|
||||
assert_eq!(meta.requires_python, Some(">=3.6".parse().unwrap()));
|
||||
assert_eq!(
|
||||
meta.requires_dist,
|
||||
vec![
|
||||
"foo".parse().unwrap(),
|
||||
"bar; extra == \"dotenv\"".parse().unwrap()
|
||||
]
|
||||
);
|
||||
assert_eq!(meta.provides_extras, vec!["dotenv".parse().unwrap()]);
|
||||
}
|
||||
}
|
||||
170
crates/pypi-types/src/metadata/requires_txt.rs
Normal file
170
crates/pypi-types/src/metadata/requires_txt.rs
Normal file
|
|
@ -0,0 +1,170 @@
|
|||
use crate::{LenientRequirement, MetadataError, VerbatimParsedUrl};
|
||||
use pep508_rs::marker::MarkerValueExtra;
|
||||
use pep508_rs::{ExtraOperator, MarkerExpression, MarkerTree, Requirement};
|
||||
use serde::Deserialize;
|
||||
use std::io::BufRead;
|
||||
use std::str::FromStr;
|
||||
use uv_normalize::ExtraName;
|
||||
|
||||
/// `requires.txt` metadata as defined in <https://setuptools.pypa.io/en/latest/deprecated/python_eggs.html#dependency-metadata>.
|
||||
///
|
||||
/// This is a subset of the full metadata specification, and only includes the fields that are
|
||||
/// included in the legacy `requires.txt` file.
|
||||
#[derive(Deserialize, Debug, Clone)]
|
||||
#[serde(rename_all = "kebab-case")]
|
||||
pub struct RequiresTxt {
|
||||
pub requires_dist: Vec<Requirement<VerbatimParsedUrl>>,
|
||||
pub provides_extras: Vec<ExtraName>,
|
||||
}
|
||||
|
||||
impl RequiresTxt {
|
||||
/// Parse the [`RequiresTxt`] from a `requires.txt` file, as included in an `egg-info`.
|
||||
///
|
||||
/// See: <https://setuptools.pypa.io/en/latest/deprecated/python_eggs.html#dependency-metadata>
|
||||
pub fn parse(content: &[u8]) -> Result<Self, MetadataError> {
|
||||
let mut requires_dist = vec![];
|
||||
let mut provides_extras = vec![];
|
||||
let mut current_marker = MarkerTree::default();
|
||||
|
||||
for line in content.lines() {
|
||||
let line = line.map_err(MetadataError::RequiresTxtContents)?;
|
||||
|
||||
let line = line.trim();
|
||||
if line.is_empty() {
|
||||
continue;
|
||||
}
|
||||
|
||||
// When encountering a new section, parse the extra and marker from the header, e.g.,
|
||||
// `[:sys_platform == "win32"]` or `[dev]`.
|
||||
if line.starts_with('[') {
|
||||
let line = line.trim_start_matches('[').trim_end_matches(']');
|
||||
|
||||
// Split into extra and marker, both of which can be empty.
|
||||
let (extra, marker) = {
|
||||
let (extra, marker) = match line.split_once(':') {
|
||||
Some((extra, marker)) => (Some(extra), Some(marker)),
|
||||
None => (Some(line), None),
|
||||
};
|
||||
let extra = extra.filter(|extra| !extra.is_empty());
|
||||
let marker = marker.filter(|marker| !marker.is_empty());
|
||||
(extra, marker)
|
||||
};
|
||||
|
||||
// Parse the extra.
|
||||
let extra = if let Some(extra) = extra {
|
||||
if let Ok(extra) = ExtraName::from_str(extra) {
|
||||
provides_extras.push(extra.clone());
|
||||
Some(MarkerValueExtra::Extra(extra))
|
||||
} else {
|
||||
Some(MarkerValueExtra::Arbitrary(extra.to_string()))
|
||||
}
|
||||
} else {
|
||||
None
|
||||
};
|
||||
|
||||
// Parse the marker.
|
||||
let marker = marker.map(MarkerTree::parse_str).transpose()?;
|
||||
|
||||
// Create the marker tree.
|
||||
match (extra, marker) {
|
||||
(Some(extra), Some(mut marker)) => {
|
||||
marker.and(MarkerTree::expression(MarkerExpression::Extra {
|
||||
operator: ExtraOperator::Equal,
|
||||
name: extra,
|
||||
}));
|
||||
current_marker = marker;
|
||||
}
|
||||
(Some(extra), None) => {
|
||||
current_marker = MarkerTree::expression(MarkerExpression::Extra {
|
||||
operator: ExtraOperator::Equal,
|
||||
name: extra,
|
||||
});
|
||||
}
|
||||
(None, Some(marker)) => {
|
||||
current_marker = marker;
|
||||
}
|
||||
(None, None) => {
|
||||
current_marker = MarkerTree::default();
|
||||
}
|
||||
}
|
||||
|
||||
continue;
|
||||
}
|
||||
|
||||
// Parse the requirement.
|
||||
let requirement =
|
||||
Requirement::<VerbatimParsedUrl>::from(LenientRequirement::from_str(line)?);
|
||||
|
||||
// Add the markers and extra, if necessary.
|
||||
requires_dist.push(Requirement {
|
||||
marker: current_marker.clone(),
|
||||
..requirement
|
||||
});
|
||||
}
|
||||
|
||||
Ok(Self {
|
||||
requires_dist,
|
||||
provides_extras,
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
|
||||
#[test]
|
||||
fn test_requires_txt() {
|
||||
let s = r"
|
||||
Werkzeug>=0.14
|
||||
Jinja2>=2.10
|
||||
|
||||
[dev]
|
||||
pytest>=3
|
||||
sphinx
|
||||
|
||||
[dotenv]
|
||||
python-dotenv
|
||||
";
|
||||
let meta = RequiresTxt::parse(s.as_bytes()).unwrap();
|
||||
assert_eq!(
|
||||
meta.requires_dist,
|
||||
vec![
|
||||
"Werkzeug>=0.14".parse().unwrap(),
|
||||
"Jinja2>=2.10".parse().unwrap(),
|
||||
"pytest>=3; extra == \"dev\"".parse().unwrap(),
|
||||
"sphinx; extra == \"dev\"".parse().unwrap(),
|
||||
"python-dotenv; extra == \"dotenv\"".parse().unwrap(),
|
||||
]
|
||||
);
|
||||
|
||||
let s = r"
|
||||
Werkzeug>=0.14
|
||||
|
||||
[dev:]
|
||||
Jinja2>=2.10
|
||||
|
||||
[:sys_platform == 'win32']
|
||||
pytest>=3
|
||||
|
||||
[]
|
||||
sphinx
|
||||
|
||||
[dotenv:sys_platform == 'darwin']
|
||||
python-dotenv
|
||||
";
|
||||
let meta = RequiresTxt::parse(s.as_bytes()).unwrap();
|
||||
assert_eq!(
|
||||
meta.requires_dist,
|
||||
vec![
|
||||
"Werkzeug>=0.14".parse().unwrap(),
|
||||
"Jinja2>=2.10 ; extra == \"dev\"".parse().unwrap(),
|
||||
"pytest>=3; sys_platform == 'win32'".parse().unwrap(),
|
||||
"sphinx".parse().unwrap(),
|
||||
"python-dotenv; sys_platform == 'darwin' and extra == \"dotenv\""
|
||||
.parse()
|
||||
.unwrap(),
|
||||
]
|
||||
);
|
||||
}
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue