Struct DistributionDatabase 

pub struct DistributionDatabase<'a, Context: BuildContext> { /* private fields */ }

A cached high-level interface to convert distributions (a requirement resolved to a location) to a wheel or wheel metadata.

For wheel metadata, this happens by either fetching the metadata from the remote wheel or by building the source distribution. For wheel files, either the wheel is downloaded or a source distribution is downloaded, built and the new wheel gets returned.

All kinds of wheel sources (index, URL, path) and source distribution source (index, URL, path, Git) are supported.

This struct also has the task of acquiring locks around source dist builds in general and git operation especially, as well as respecting concurrency limits.

Implementations

impl<'a, Context: BuildContext> DistributionDatabase<'a, Context>

pub fn new( client: &'a RegistryClient, build_context: &'a Context, downloads_semaphore: Arc<Semaphore>, ) -> Self

pub fn with_first_party_packages( self, first_party_packages: &'a FirstPartyPackages, ) -> Self

Allow metadata builds for the given first-party workspace source trees.

pub fn is_first_party(&self, name: &PackageName, path: &Path) -> bool

Return whether the name and path identify an eligible workspace member.

pub fn with_recorder(self, recorder: Option<ResolutionRecorder>) -> Self

Record which static metadata entries are consulted while resolving runtime dependencies.

pub fn record_metadata(&self, dist: &Dist)

Record a metadata lookup before reading an in-memory cache.

pub fn dependency_metadata( &self, name: &PackageName, version: Option<&Version>, ) -> Option<ResolutionMetadata>

Look up user-provided metadata, recording misses as well as matches.

pub fn with_build_stack(self, build_stack: &'a BuildStack) -> Self

Set the build stack to use for the DistributionDatabase.

pub fn with_reporter(self, reporter: Arc<dyn Reporter>) -> Self

Set the Reporter to use for the DistributionDatabase.

pub async fn get_or_build_wheel( &self, dist: &Dist, tags: &Tags, hashes: ArchiveHashPolicy<'_>, ) -> Result<LocalWheel, Error>

Either fetch the wheel or fetch and build the source distribution

Returns a wheel that’s compliant with the given platform tags.

Applicable hash checks are enforced before newly fetched archives are published to the cache. Callers must enforce their hash policy when reusing cached wheels.

pub async fn get_installed_metadata( &self, dist: &InstalledDist, ) -> Result<ArchiveMetadata, Error>

Either fetch the only wheel metadata (directly from the index or with range requests) or fetch and build the source distribution.

While hashes will be generated in some cases, hash-checking is only enforced for source distributions, and should be enforced by the caller for wheels.

pub async fn get_or_build_wheel_metadata( &self, dist: &Dist, hashes: MetadataHashPolicy<'_>, ) -> Result<ArchiveMetadata, Error>

Retrieve distribution metadata and any hashes requested for resolution.

Source archive hashes are validated before executing build backends; wheel archive hash validation is deferred to installation.

pub async fn build_wheel_metadata( &self, source: &BuildableSource<'_>, hashes: MetadataHashPolicy<'_>, ) -> Result<ArchiveMetadata, Error>

Build the wheel metadata for a source distribution, or fetch it from the cache if possible.

Requested hashes are validated before executing a build backend. User-provided metadata can avoid downloading or validating the source archive.

pub async fn requires_dist( &self, path: &Path, pyproject_toml: &PyProjectToml, ) -> Result<Option<RequiresDist>, Error>

Return the RequiresDist from a pyproject.toml, if it can be statically extracted.

pub fn client(&self) -> &ManagedClient<'a>

Return the [ManagedClient] used by this resolver.