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, concurrent_downloads: usize, ) -> Self

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: HashPolicy<'_>, ) -> 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.

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_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: HashPolicy<'_>, ) -> 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 build_wheel_metadata( &self, source: &BuildableSource<'_>, hashes: HashPolicy<'_>, ) -> Result<ArchiveMetadata, Error>

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

The returned metadata is guaranteed to come from a distribution with a matching hash, and no build processes will be executed for distributions with mismatched hashes.

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.