HashError Class Reference

Inheritance diagram for HashError:

Collaboration diagram for HashError:

Public Member Functions
str	body (self)
str	__str__ (self)

Data Fields
	req

Static Public Attributes
Optional	req = None
str	head = ""
int	order = -1

Protected Member Functions
str	_requirement_name (self)

Detailed Description

A failure to verify a package against known-good hashes

:cvar order: An int sorting hash exception classes by difficulty of
    recovery (lower being harder), so the user doesn't bother fretting
    about unpinned packages when he has deeper issues, like VCS
    dependencies, to deal with. Also keeps error reports in a
    deterministic order.
:cvar head: A section heading for display above potentially many
    exceptions of this kind
:ivar req: The InstallRequirement that triggered this error. This is
    pasted on after the exception is instantiated, because it's not
    typically available earlier.

Definition at line 447 of file exceptions.py.

Member Function Documentation

__str__()

str __str__

(

self

)

Definition at line 480 of file exceptions.py.

    def __str__(self) -> str:
        return f"{self.head}\n{self.body()}"
 

_requirement_name()

str _requirement_name (   self )

protected

Return a description of the requirement that triggered me.

This default implementation returns long description of the req, with
line numbers

Definition at line 483 of file exceptions.py.

    def _requirement_name(self) -> str:
        """Return a description of the requirement that triggered me.
 
        This default implementation returns long description of the req, with
        line numbers
 
        """
        return str(self.req) if self.req else "unknown package"
 
 

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 in HashMissing, and HashMismatch.

Definition at line 468 of file exceptions.py.

    def body(self) -> str:
        """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().
 
        """
        return f"    {self._requirement_name()}"
 

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

Here is the caller graph for this function:

Field Documentation

head

str head = ""

static

Definition at line 465 of file exceptions.py.

order

int order = -1

static

Definition at line 466 of file exceptions.py.

req [1/2]

Optional req = None

static

Definition at line 464 of file exceptions.py.

Referenced by FrozenRequirement.__str__(), InstallRequirement.__str__(), SourceDistribution._get_build_requires_editable(), SourceDistribution._get_build_requires_wheel(), SourceDistribution._install_build_reqs(), SourceDistribution._prepare_build_backend(), SourceDistribution._raise_conflicts(), SourceDistribution._raise_missing_reqs(), InstallRequirement._set_requirement(), InstallRequirement.assert_source_matches_version(), InstallRequirement.check_if_exists(), InstallRequirement.ensure_build_location(), InstallRequirement.from_path(), InstalledDistribution.get_metadata_distribution(), SourceDistribution.get_metadata_distribution(), WheelDistribution.get_metadata_distribution(), InstallRequirement.name(), SourceDistribution.prepare_distribution_metadata(), InstallRequirement.specifier(), InstallRequirement.uninstall(), and InstallRequirement.warn_on_mismatching_name().

req [2/2]

req

Definition at line 490 of file exceptions.py.

Referenced by FrozenRequirement.__str__(), InstallRequirement.__str__(), SourceDistribution._get_build_requires_editable(), SourceDistribution._get_build_requires_wheel(), SourceDistribution._install_build_reqs(), SourceDistribution._prepare_build_backend(), SourceDistribution._raise_conflicts(), SourceDistribution._raise_missing_reqs(), InstallRequirement._set_requirement(), InstallRequirement.assert_source_matches_version(), InstallRequirement.check_if_exists(), InstallRequirement.ensure_build_location(), InstallRequirement.from_path(), InstalledDistribution.get_metadata_distribution(), SourceDistribution.get_metadata_distribution(), WheelDistribution.get_metadata_distribution(), InstallRequirement.name(), SourceDistribution.prepare_distribution_metadata(), InstallRequirement.specifier(), InstallRequirement.uninstall(), and InstallRequirement.warn_on_mismatching_name().

---

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