pip._vendor.resolvelib.reporters.BaseReporter Class Reference

Inheritance diagram for pip._vendor.resolvelib.reporters.BaseReporter:

Collaboration diagram for pip._vendor.resolvelib.reporters.BaseReporter:

Public Member Functions
	starting (self)
	starting_round (self, index)
	ending_round (self, index, state)
	ending (self, state)
	adding_requirement (self, requirement, parent)
	resolving_conflicts (self, causes)
	rejecting_candidate (self, criterion, candidate)
	pinning (self, candidate)

Detailed Description

Delegate class to provider progress reporting for the resolver.

Member Function Documentation

adding_requirement()

pip._vendor.resolvelib.reporters.BaseReporter.adding_requirement	(		self,
			requirement,
			parent
	)

Called when adding a new requirement into the resolve criteria.

:param requirement: The additional requirement to be applied to filter
    the available candidaites.
:param parent: The candidate that requires ``requirement`` as a
    dependency, or None if ``requirement`` is one of the root
    requirements passed in from ``Resolver.resolve()``.

Reimplemented in pip._internal.resolution.resolvelib.reporter.PipDebuggingReporter.

ending()

pip._vendor.resolvelib.reporters.BaseReporter.ending	(		self,
			state
	)

Called before the resolution ends successfully.

Reimplemented in pip._internal.resolution.resolvelib.reporter.PipDebuggingReporter.

ending_round()

pip._vendor.resolvelib.reporters.BaseReporter.ending_round	(		self,
			index,
			state
	)

Called before each round of resolution ends.

This is NOT called if the resolution ends at this round. Use `ending`
if you want to report finalization. The index is zero-based.

Reimplemented in pip._internal.resolution.resolvelib.reporter.PipDebuggingReporter.

pinning()

pip._vendor.resolvelib.reporters.BaseReporter.pinning	(		self,
			candidate
	)

Called when adding a candidate to the potential solution.

Reimplemented in pip._internal.resolution.resolvelib.reporter.PipDebuggingReporter.

rejecting_candidate()

pip._vendor.resolvelib.reporters.BaseReporter.rejecting_candidate	(		self,
			criterion,
			candidate
	)

Called when rejecting a candidate during backtracking.

Reimplemented in pip._internal.resolution.resolvelib.reporter.PipReporter, and pip._internal.resolution.resolvelib.reporter.PipDebuggingReporter.

resolving_conflicts()

pip._vendor.resolvelib.reporters.BaseReporter.resolving_conflicts	(		self,
			causes
	)

Called when starting to attempt requirement conflict resolution.

:param causes: The information on the collision that caused the backtracking.

starting()

pip._vendor.resolvelib.reporters.BaseReporter.starting

(

self

)

Called before the resolution actually starts.

Reimplemented in pip._internal.resolution.resolvelib.reporter.PipDebuggingReporter.

starting_round()

pip._vendor.resolvelib.reporters.BaseReporter.starting_round	(		self,
			index
	)

Called before each round of resolution starts.

The index is zero-based.

Reimplemented in pip._internal.resolution.resolvelib.reporter.PipDebuggingReporter.

---

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

• docs/help/help-venv/lib/python3.12/site-packages/pip/_vendor/resolvelib/reporters.py