22285099215

Committed 22 Feb 2026 08:52PM UTC coverage: 75.854% (-17.1%) from 92.936%

Build # 22285099215

Build Type

Pull #23121

github

Committed by

web-flow

Commit Message

Merge c7299df9c into ba8359840

Pull Request Pull Request #23121: fix issue with optional fields in dependency validator

Run Details

28 of 29 new or added lines in 2 files covered. (96.55%)

11174 existing lines in 400 files now uncovered.

53694 of 70786 relevant lines covered (75.85%)

1.88 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

71.43

/src/python/pants/util/pip_requirement.py

# Copyright 2021 Pants project contributors (see CONTRIBUTORS.md).
# Licensed under the Apache License, Version 2.0 (see LICENSE).

from __future__ import annotations

import logging
import urllib.parse

from packaging.requirements import InvalidRequirement, Requirement
from packaging.specifiers import SpecifierSet

logger = logging.getLogger(__name__)


class PipRequirement:
    """A Pip-style requirement."""

    @classmethod
    def parse(cls, line: str, description_of_origin: str = "") -> PipRequirement:
        try:
            return cls(Requirement(line))
        except InvalidRequirement as e:
            scheme, netloc, path, query, fragment = urllib.parse.urlsplit(line, scheme="file")
            if fragment:
                # Try converting a pip VCS-style requirement into a PEP-440 one that can be
                # parsed as a Requirement. E.g.,
                # git+https://github.com/django/django.git@stable/2.1.x#egg=Django
                # into
                # Django@ git+https://github.com/django/django.git@stable/2.1.x#egg=Django

                # Note: In pip VCS urls the fragment is a query-style string.
                fragment_params = urllib.parse.parse_qs(fragment)
                egg = fragment_params.get("egg")
                if egg:
                    # parse_qs() ignores params with empty values by default, so we're guaranteed
                    # that there is at least one value in this list.
                    project = egg[0]
                    # We recompose the URL to force the default file:// scheme to be explicit.
                    full_url = urllib.parse.urlunsplit((scheme, netloc, path, query, fragment))
                    pep_440_req_str = f"{project}@ {full_url}"
                    try:
                        return cls(Requirement(pep_440_req_str))
                    except InvalidRequirement:
                        # If parsing the converted URL fails for some reason, it's probably less
                        # confusing to the user if we raise the original error instead of one for
                        # a synthetic requirement string they don't directly know about.
                        pass
            origin_str = f" in {description_of_origin}" if description_of_origin else ""
            raise ValueError(f"Invalid requirement '{line}'{origin_str}: {e}")

    def __init__(self, req: Requirement):
        self._req = req

    def as_packaging_requirement(self) -> Requirement:
        return self._req

    @property
    def name(self) -> str:
        return self._req.name

    @property
    def specifier_set(self) -> SpecifierSet:
        return self._req.specifier

    @property
    def url(self):
        return self._req.url

    def __hash__(self):
        return hash(self._req)

    def __eq__(self, other):
        # Semantic equality requires parsing the specifier (since order in it doesn't matter).
        if not isinstance(other, self.__class__):
            return False
        return self._req == other._req

    def __repr__(self) -> str:
        return f"{self.__class__.__name__}({self._req})"

    def __str__(self):
        return str(self._req)

1	# Copyright 2021 Pants project contributors (see CONTRIBUTORS.md).
2	# Licensed under the Apache License, Version 2.0 (see LICENSE).
3
4	from __future__ import annotations	4✔
5
6	import logging	4✔
7	import urllib.parse	4✔
8
9	from packaging.requirements import InvalidRequirement, Requirement	4✔
10	from packaging.specifiers import SpecifierSet	4✔
11
12	logger = logging.getLogger(__name__)	4✔
13
14
15	class PipRequirement:	4✔
16	"""A Pip-style requirement."""
17
18	@classmethod	4✔
19	def parse(cls, line: str, description_of_origin: str = "") -> PipRequirement:	4✔
20	try:	4✔
21	return cls(Requirement(line))	4✔
22	except InvalidRequirement as e:	1✔
23	scheme, netloc, path, query, fragment = urllib.parse.urlsplit(line, scheme="file")	1✔
24	if fragment:	1✔
25	# Try converting a pip VCS-style requirement into a PEP-440 one that can be
26	# parsed as a Requirement. E.g.,
27	# git+https://github.com/django/django.git@stable/2.1.x#egg=Django
28	# into
29	# Django@ git+https://github.com/django/django.git@stable/2.1.x#egg=Django
30
31	# Note: In pip VCS urls the fragment is a query-style string.
UNCOV 32	fragment_params = urllib.parse.parse_qs(fragment)	×
UNCOV 33	egg = fragment_params.get("egg")	×
UNCOV 34	if egg:	×
35	# parse_qs() ignores params with empty values by default, so we're guaranteed
36	# that there is at least one value in this list.
UNCOV 37	project = egg[0]	×
38	# We recompose the URL to force the default file:// scheme to be explicit.
UNCOV 39	full_url = urllib.parse.urlunsplit((scheme, netloc, path, query, fragment))	×
UNCOV 40	pep_440_req_str = f"{project}@ {full_url}"	×
UNCOV 41	try:	×
UNCOV 42	return cls(Requirement(pep_440_req_str))	×
43	except InvalidRequirement:	×
44	# If parsing the converted URL fails for some reason, it's probably less
45	# confusing to the user if we raise the original error instead of one for
46	# a synthetic requirement string they don't directly know about.
47	pass	×
48	origin_str = f" in {description_of_origin}" if description_of_origin else ""	1✔
49	raise ValueError(f"Invalid requirement '{line}'{origin_str}: {e}")	1✔
50
51	def __init__(self, req: Requirement):	4✔
52	self._req = req	4✔
53
54	def as_packaging_requirement(self) -> Requirement:	4✔
55	return self._req	×
56
57	@property	4✔
58	def name(self) -> str:	4✔
59	return self._req.name	4✔
60
61	@property	4✔
62	def specifier_set(self) -> SpecifierSet:	4✔
UNCOV 63	return self._req.specifier	×
64
65	@property	4✔
66	def url(self):	4✔
UNCOV 67	return self._req.url	×
68
69	def __hash__(self):	4✔
70	return hash(self._req)	4✔
71
72	def __eq__(self, other):	4✔
73	# Semantic equality requires parsing the specifier (since order in it doesn't matter).
74	if not isinstance(other, self.__class__):	2✔
75	return False	×
76	return self._req == other._req	2✔
77
78	def __repr__(self) -> str:	4✔
79	return f"{self.__class__.__name__}({self._req})"	1✔
80
81	def __str__(self):	4✔
82	return str(self._req)	3✔

pantsbuild / pants / 22285099215

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous