Struct BuildDispatch 

pub struct BuildDispatch<'a> { /* private fields */ }

The main implementation of BuildContext, used by the CLI, see BuildContext documentation.

Implementations

impl<'a> BuildDispatch<'a>

pub fn new( client: &'a RegistryClient, cache: &'a Cache, constraints: &'a Constraints, interpreter: &'a Interpreter, index_locations: &'a IndexLocations, flat_index: &'a FlatIndex, dependency_metadata: &'a DependencyMetadata, shared_state: SharedState, index_strategy: IndexStrategy, config_settings: &'a ConfigSettings, config_settings_package: &'a PackageConfigSettings, build_isolation: BuildIsolation<'a>, extra_build_requires: &'a ExtraBuildRequires, extra_build_variables: &'a ExtraBuildVariables, link_mode: LinkMode, build_options: &'a BuildOptions, hasher: &'a HashStrategy, exclude_newer: ExcludeNewer, sources: NoSources, workspace_cache: WorkspaceCache, concurrency: Concurrency, preview: Preview, ) -> Self

pub fn with_build_extra_env_vars<I, K, V>( self, sdist_build_env_variables: I, ) -> Self

where I: IntoIterator<Item = (K, V)>, K: AsRef<OsStr>, V: AsRef<OsStr>,

Set the environment variables to be used when building a source distribution.

Trait Implementations

impl BuildContext for BuildDispatch<'_>

type SourceDistBuilder = SourceBuild

async fn interpreter(&self) -> &Interpreter

Return a reference to the interpreter.

fn cache(&self) -> &Cache

Return a reference to the cache.

fn git(&self) -> &GitResolver

Return a reference to the Git resolver.

fn build_arena(&self) -> &BuildArena<SourceBuild>

Return a reference to the build arena.

fn capabilities(&self) -> &IndexCapabilities

Return a reference to the discovered registry capabilities.

fn dependency_metadata(&self) -> &DependencyMetadata

Return a reference to any pre-defined static metadata.

fn build_options(&self) -> &BuildOptions

Whether source distribution building or pre-built wheels is disabled.

fn build_isolation(&self) -> BuildIsolation<'_>

The isolation mode used for building source distributions.

fn config_settings(&self) -> &ConfigSettings

The ConfigSettings used to build distributions.

fn config_settings_package(&self) -> &PackageConfigSettings

The ConfigSettings used to build a specific package.

fn sources(&self) -> &NoSources

Whether to incorporate tool.uv.sources when resolving requirements.

fn locations(&self) -> &IndexLocations

The index locations being searched.

fn workspace_cache(&self) -> &WorkspaceCache

Workspace discovery caching.

fn extra_build_requires(&self) -> &ExtraBuildRequires

Get the extra build requirements.

fn extra_build_variables(&self) -> &ExtraBuildVariables

Get the extra build variables.

async fn resolve<'data>( &'data self, requirements: &'data [Requirement], build_stack: &'data BuildStack, ) -> Result<Resolution, BuildDispatchError>

Resolve the given requirements into a ready-to-install set of package versions.

async fn install<'data>( &'data self, resolution: &'data Resolution, venv: &'data PythonEnvironment, build_stack: &'data BuildStack, ) -> Result<Vec<CachedDist>, BuildDispatchError>

Install the given set of package versions into the virtual environment. The environment must use the same base Python as BuildContext::interpreter

async fn setup_build<'data>( &'data self, source: &'data Path, subdirectory: Option<&'data Path>, install_path: &'data Path, version_id: Option<&'data str>, dist: Option<&'data SourceDist>, sources: &'data NoSources, build_kind: BuildKind, build_output: BuildOutput, build_stack: BuildStack, ) -> Result<SourceBuild, Error>

Set up a source distribution build by installing the required dependencies. A wrapper for uv_build::SourceBuild::setup.

async fn direct_build<'data>( &'data self, source: &'data Path, subdirectory: Option<&'data Path>, output_dir: &'data Path, sources: NoSources, build_kind: BuildKind, version_id: Option<&'data str>, ) -> Result<Option<DistFilename>, BuildDispatchError>

Build by calling directly into the uv build backend without PEP 517, if possible.