HashMismatch Class Reference

Inheritance diagram for HashMismatch:

Collaboration diagram for HashMismatch:

Public Member Functions
None	__init__ (self, Dict[str, List[str]] allowed, Dict[str, "_Hash"] gots)
str	body (self)
Public Member Functions inherited from HashError
str	__str__ (self)

Data Fields
	allowed
	gots
Data Fields inherited from HashError
	req

Static Public Attributes
int	order = 4
tuple	head
Static Public Attributes inherited from HashError
Optional	req = None
str	head = ""
int	order = -1

Protected Member Functions
str	_hash_comparison (self)
Protected Member Functions inherited from HashError
str	_requirement_name (self)

Detailed Description

Distribution file hash values don't match.

:ivar package_name: The name of the package that triggered the hash
    mismatch. Feel free to write to this after the exception is raise to
    improve its error message.

Definition at line 568 of file exceptions.py.

Constructor & Destructor Documentation

__init__()

None __init__	(		self,
		Dict[str, List[str]]	allowed,
		Dict[str, "_Hash"]	gots
	)

:param allowed: A dict of algorithm names pointing to lists of allowed
    hex digests
:param gots: A dict of algorithm names pointing to hashes we
    actually got from the files under suspicion

Definition at line 586 of file exceptions.py.

    def __init__(self, allowed: Dict[str, List[str]], gots: Dict[str, "_Hash"]) -> None:
        """
        :param allowed: A dict of algorithm names pointing to lists of allowed
            hex digests
        :param gots: A dict of algorithm names pointing to hashes we
            actually got from the files under suspicion
        """
        self.allowed = allowed
        self.gots = gots
 

Referenced by Protocol.__init_subclass__().

Here is the caller graph for this function:

Member Function Documentation

_hash_comparison()

str _hash_comparison (   self )

protected

Return a comparison of actual and expected hash values.

Example::

       Expected sha256 abcdeabcdeabcdeabcdeabcdeabcdeabcdeabcdeabcde
                    or 123451234512345123451234512345123451234512345
            Got        bcdefbcdefbcdefbcdefbcdefbcdefbcdefbcdefbcdef

Definition at line 599 of file exceptions.py.

    def _hash_comparison(self) -> str:
        """
        Return a comparison of actual and expected hash values.
 
        Example::
 
               Expected sha256 abcdeabcdeabcdeabcdeabcdeabcdeabcdeabcdeabcde
                            or 123451234512345123451234512345123451234512345
                    Got        bcdefbcdefbcdefbcdefbcdefbcdefbcdefbcdefbcdef
 
        """
 
        def hash_then_or(hash_name: str) -> "chain[str]":
            # For now, all the decent hashes have 6-char names, so we can get
            # away with hard-coding space literals.
            return chain([hash_name], repeat("    or"))
 
        lines: List[str] = []
        for hash_name, expecteds in self.allowed.items():
            prefix = hash_then_or(hash_name)
            lines.extend(
                ("        Expected {} {}".format(next(prefix), e)) for e in expecteds
            )
            lines.append(
                "             Got        {}\n".format(self.gots[hash_name].hexdigest())
            )
        return "\n".join(lines)
 
 

body()

str body

(

self

)

Return a summary of me for display under the heading.

This default implementation simply prints a description of the
triggering requirement.

:param req: The InstallRequirement that provoked this error, with
    its link already populated by the resolver's _populate_link().

Reimplemented from HashError.

Definition at line 596 of file exceptions.py.

    def body(self) -> str:
        return "    {}:\n{}".format(self._requirement_name(), self._hash_comparison())
 

Referenced by PreparedRequest.copy(), PreparedRequest.prepare_auth(), and PreparedRequest.prepare_body().

Here is the caller graph for this function:

Field Documentation

allowed

allowed

Definition at line 593 of file exceptions.py.

gots

gots

Definition at line 594 of file exceptions.py.

head

tuple head

static

Initial value:

=  (
        "THESE PACKAGES DO NOT MATCH THE HASHES FROM THE REQUIREMENTS "
        "FILE. If you have updated the package versions, please update "
        "the hashes. Otherwise, examine the package contents carefully; "
        "someone may have tampered with them."
    )

Definition at line 579 of file exceptions.py.

order

int order = 4

static

Definition at line 578 of file exceptions.py.

---

The documentation for this class was generated from the following file:

• /home/liwuen/projects_dev/pqc-engineering-ssec-23/venv/lib/python3.12/site-packages/pip/_internal/exceptions.py