Hashes Class Reference

Inheritance diagram for Hashes:

Public Member Functions
None	__init__ (self, Optional[Dict[str, List[str]]] hashes=None)
"Hashes"	__and__ (self, "Hashes" other)
int	digest_count (self)
bool	is_hash_allowed (self, str hash_name, str hex_digest)
None	check_against_chunks (self, Iterable[bytes] chunks)
None	check_against_file (self, BinaryIO file)
None	check_against_path (self, str path)
bool	has_one_of (self, Dict[str, str] hashes)
bool	__bool__ (self)
bool	__eq__ (self, object other)
int	__hash__ (self)

Protected Member Functions
"NoReturn"	_raise (self, Dict[str, "_Hash"] gots)

Protected Attributes
	_allowed

Detailed Description

A wrapper that builds multiple hashes at once and checks them against
known-good values

Definition at line 25 of file hashes.py.

Constructor & Destructor Documentation

__init__()

None __init__	(		self,
		Optional[Dict[str, List[str]]]	hashes = None
	)

:param hashes: A dict of algorithm names pointing to lists of allowed
    hex digests

Reimplemented in MissingHashes.

Definition at line 31 of file hashes.py.

    def __init__(self, hashes: Optional[Dict[str, List[str]]] = None) -> None:
        """
        :param hashes: A dict of algorithm names pointing to lists of allowed
            hex digests
        """
        allowed = {}
        if hashes is not None:
            for alg, keys in hashes.items():
                # Make sure values are always sorted (to ease equality checks)
                allowed[alg] = sorted(keys)
        self._allowed = allowed
 

References i.

Referenced by Protocol.__init_subclass__().

Here is the caller graph for this function:

Member Function Documentation

__and__()

"Hashes" __and__	(		self,
		"Hashes"	other
	)

Definition at line 43 of file hashes.py.

    def __and__(self, other: "Hashes") -> "Hashes":
        if not isinstance(other, Hashes):
            return NotImplemented
 
        # If either of the Hashes object is entirely empty (i.e. no hash
        # specified at all), all hashes from the other object are allowed.
        if not other:
            return self
        if not self:
            return other
 
        # Otherwise only hashes that present in both objects are allowed.
        new = {}
        for alg, values in other._allowed.items():
            if alg not in self._allowed:
                continue
            new[alg] = [v for v in values if v in self._allowed[alg]]
        return Hashes(new)
 

References Hashes._allowed, and i.

__bool__()

bool __bool__

(

self

)

Return whether I know any known-good hashes.

Definition at line 115 of file hashes.py.

    def __bool__(self) -> bool:
        """Return whether I know any known-good hashes."""
        return bool(self._allowed)
 

References Hashes._allowed.

__eq__()

bool __eq__	(		self,
		object	other
	)

Definition at line 119 of file hashes.py.

    def __eq__(self, other: object) -> bool:
        if not isinstance(other, Hashes):
            return NotImplemented
        return self._allowed == other._allowed
 

References Hashes._allowed, and i.

Referenced by Version.__ge__(), Version.__gt__(), Version.__le__(), Version.__ne__(), Matcher.__ne__(), Timestamp.__ne__(), and HTTPHeaderDict.__ne__().

Here is the caller graph for this function:

__hash__()

int __hash__

(

self

)

Definition at line 124 of file hashes.py.

    def __hash__(self) -> int:
        return hash(
            ",".join(
                sorted(
                    ":".join((alg, digest))
                    for alg, digest_list in self._allowed.items()
                    for digest in digest_list
                )
            )
        )
 
 

References Hashes._allowed.

Referenced by Style.__eq__(), and Style.__ne__().

Here is the caller graph for this function:

_raise()

"NoReturn" _raise (   self, Dict[str, "_Hash"]  gots  )

protected

Reimplemented in MissingHashes.

Definition at line 93 of file hashes.py.

    def _raise(self, gots: Dict[str, "_Hash"]) -> "NoReturn":
        raise HashMismatch(self._allowed, gots)
 

References Hashes._allowed.

Referenced by Hashes.check_against_chunks().

Here is the caller graph for this function:

check_against_chunks()

None check_against_chunks	(		self,
		Iterable[bytes]	chunks
	)

Check good hashes against ones built from iterable of chunks of
data.

Raise HashMismatch if none match.

Definition at line 70 of file hashes.py.

    def check_against_chunks(self, chunks: Iterable[bytes]) -> None:
        """Check good hashes against ones built from iterable of chunks of
        data.
 
        Raise HashMismatch if none match.
 
        """
        gots = {}
        for hash_name in self._allowed.keys():
            try:
                gots[hash_name] = hashlib.new(hash_name)
            except (ValueError, TypeError):
                raise InstallationError(f"Unknown hash name: {hash_name}")
 
        for chunk in chunks:
            for hash in gots.values():
                hash.update(chunk)
 
        for hash_name, got in gots.items():
            if got.hexdigest() in self._allowed[hash_name]:
                return
        self._raise(gots)
 

References Hashes._allowed, Hashes._raise(), MissingHashes._raise(), and i.

Referenced by Hashes.check_against_file().

Here is the call graph for this function:

Here is the caller graph for this function:

check_against_file()

None check_against_file	(		self,
		BinaryIO	file
	)

Check good hashes against a file-like object

Raise HashMismatch if none match.

Definition at line 96 of file hashes.py.

    def check_against_file(self, file: BinaryIO) -> None:
        """Check good hashes against a file-like object
 
        Raise HashMismatch if none match.
 
        """
        return self.check_against_chunks(read_chunks(file))
 

References Hashes.check_against_chunks().

Referenced by Hashes.check_against_path().

Here is the call graph for this function:

Here is the caller graph for this function:

check_against_path()

None check_against_path	(		self,
		str	path
	)

Definition at line 104 of file hashes.py.

    def check_against_path(self, path: str) -> None:
        with open(path, "rb") as file:
            return self.check_against_file(file)
 

References Hashes.check_against_file().

Here is the call graph for this function:

digest_count()

int digest_count

(

self

)

Definition at line 63 of file hashes.py.

    def digest_count(self) -> int:
        return sum(len(digests) for digests in self._allowed.values())
 

References Hashes._allowed, and i.

has_one_of()

bool has_one_of	(		self,
		Dict[str, str]	hashes
	)

Return whether any of the given hashes are allowed.

Definition at line 108 of file hashes.py.

    def has_one_of(self, hashes: Dict[str, str]) -> bool:
        """Return whether any of the given hashes are allowed."""
        for hash_name, hex_digest in hashes.items():
            if self.is_hash_allowed(hash_name, hex_digest):
                return True
        return False
 

References i, LinkHash.is_hash_allowed(), Link.is_hash_allowed(), and Hashes.is_hash_allowed().

Here is the call graph for this function:

is_hash_allowed()

bool is_hash_allowed	(		self,
		str	hash_name,
		str	hex_digest
	)

Return whether the given hex digest is allowed.

Definition at line 66 of file hashes.py.

    def is_hash_allowed(self, hash_name: str, hex_digest: str) -> bool:
        """Return whether the given hex digest is allowed."""
        return hex_digest in self._allowed.get(hash_name, [])
 

References Hashes._allowed.

Referenced by Hashes.has_one_of().

Here is the caller graph for this function:

Field Documentation

_allowed

_allowed

protected

Definition at line 41 of file hashes.py.

Referenced by Hashes.__and__(), Hashes.__bool__(), Hashes.__eq__(), Hashes.__hash__(), Hashes._raise(), Hashes.check_against_chunks(), Hashes.digest_count(), and Hashes.is_hash_allowed().

---

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/utils/hashes.py