Struct ResolverInstallerSchema 

pub struct ResolverInstallerSchema {

    pub index: Option<Vec<Index>>,
    pub index_url: Option<PipIndex>,
    pub extra_index_url: Option<Vec<PipExtraIndex>>,
    pub no_index: Option<bool>,
    pub find_links: Option<Vec<PipFindLinks>>,
    pub index_strategy: Option<IndexStrategy>,
    pub keyring_provider: Option<KeyringProviderType>,
    pub resolution: Option<ResolutionMode>,
    pub prerelease: Option<PrereleaseMode>,
    pub fork_strategy: Option<ForkStrategy>,
    pub dependency_metadata: Option<Vec<StaticMetadata>>,
    pub config_settings: Option<ConfigSettings>,
    pub config_settings_package: Option<PackageConfigSettings>,
    pub no_build_isolation: Option<bool>,
    pub no_build_isolation_package: Option<Vec<PackageName>>,
    pub extra_build_dependencies: Option<ExtraBuildDependencies>,
    pub extra_build_variables: Option<ExtraBuildVariables>,
    pub exclude_newer: Option<ExcludeNewerValue>,
    pub exclude_newer_package: Option<ExcludeNewerPackage>,
    pub link_mode: Option<LinkMode>,
    pub compile_bytecode: Option<bool>,
    pub no_sources: Option<bool>,
    pub upgrade: Option<bool>,
    pub upgrade_package: Option<Vec<Requirement<VerbatimParsedUrl>>>,
    pub reinstall: Option<bool>,
    pub reinstall_package: Option<Vec<PackageName>>,
    pub no_build: Option<bool>,
    pub no_build_package: Option<Vec<PackageName>>,
    pub no_binary: Option<bool>,
    pub no_binary_package: Option<Vec<PackageName>>,
    pub torch_backend: Option<TorchMode>,
}

The JSON schema for the [tool.uv] section of a pyproject.toml file.

Fields

index: Option<Vec<Index>>

The package indexes to use when resolving dependencies.

Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

Indexes are considered in the order in which they’re defined, such that the first-defined index has the highest priority. Further, the indexes provided by this setting are given higher priority than any indexes specified via index_url or extra_index_url. uv will only consider the first index that contains a given package, unless an alternative index strategy is specified.

If an index is marked as explicit = true, it will be used exclusively for those dependencies that select it explicitly via [tool.uv.sources], as in:

[[tool.uv.index]]
name = "pytorch"
url = "https://download.pytorch.org/whl/cu121"
explicit = true

[tool.uv.sources]
torch = { index = "pytorch" }

If an index is marked as default = true, it will be moved to the end of the prioritized list, such that it is given the lowest priority when resolving packages. Additionally, marking an index as default will disable the PyPI default index.

index_url: Option<PipIndex>

The URL of the Python package index (by default: https://pypi.org/simple).

Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

The index provided by this setting is given lower priority than any indexes specified via extra_index_url or index.

(Deprecated: use index instead.)

extra_index_url: Option<Vec<PipExtraIndex>>

Extra URLs of package indexes to use, in addition to --index-url.

Accepts either a repository compliant with PEP 503 (the simple repository API), or a local directory laid out in the same format.

All indexes provided via this flag take priority over the index specified by index_url or index with default = true. When multiple indexes are provided, earlier values take priority.

To control uv’s resolution strategy when multiple indexes are present, see index_strategy.

(Deprecated: use index instead.)

no_index: Option<bool>

Ignore all registry indexes (e.g., PyPI), instead relying on direct URL dependencies and those provided via --find-links.

find_links: Option<Vec<PipFindLinks>>

Locations to search for candidate distributions, in addition to those found in the registry indexes.

If a path, the target must be a directory that contains packages as wheel files (.whl) or source distributions (e.g., .tar.gz or .zip) at the top level.

If a URL, the page must contain a flat list of links to package files adhering to the formats described above.

index_strategy: Option<IndexStrategy>

The strategy to use when resolving against multiple index URLs.

By default, uv will stop at the first index on which a given package is available, and limit resolutions to those present on that first index (first-index). This prevents “dependency confusion” attacks, whereby an attacker can upload a malicious package under the same name to an alternate index.

keyring_provider: Option<KeyringProviderType>

Attempt to use keyring for authentication for index URLs.

At present, only --keyring-provider subprocess is supported, which configures uv to use the keyring CLI to handle authentication.

resolution: Option<ResolutionMode>

The strategy to use when selecting between the different compatible versions for a given package requirement.

By default, uv will use the latest compatible version of each package (highest).

prerelease: Option<PrereleaseMode>

The strategy to use when considering pre-release versions.

By default, uv will accept pre-releases for packages that only publish pre-releases, along with first-party requirements that contain an explicit pre-release marker in the declared specifiers (if-necessary-or-explicit).

fork_strategy: Option<ForkStrategy>

The strategy to use when selecting multiple versions of a given package across Python versions and platforms.

By default, uv will optimize for selecting the latest version of each package for each supported Python version (requires-python), while minimizing the number of selected versions across platforms.

Under fewest, uv will minimize the number of selected versions for each package, preferring older versions that are compatible with a wider range of supported Python versions or platforms.

dependency_metadata: Option<Vec<StaticMetadata>>

Pre-defined static metadata for dependencies of the project (direct or transitive). When provided, enables the resolver to use the specified metadata instead of querying the registry or building the relevant package from source.

Metadata should be provided in adherence with the Metadata 2.3 standard, though only the following fields are respected:

• name: The name of the package.
• (Optional) version: The version of the package. If omitted, the metadata will be applied to all versions of the package.
• (Optional) requires-dist: The dependencies of the package (e.g., werkzeug>=0.14).
• (Optional) requires-python: The Python version required by the package (e.g., >=3.10).
• (Optional) provides-extra: The extras provided by the package.

config_settings: Option<ConfigSettings>

Settings to pass to the PEP 517 build backend, specified as KEY=VALUE pairs.

config_settings_package: Option<PackageConfigSettings>

Settings to pass to the PEP 517 build backend for specific packages, specified as KEY=VALUE pairs.

Accepts a map from package names to string key-value pairs.

no_build_isolation: Option<bool>

Disable isolation when building source distributions.

Assumes that build dependencies specified by PEP 518 are already installed.

no_build_isolation_package: Option<Vec<PackageName>>

Disable isolation when building source distributions for a specific package.

Assumes that the packages’ build dependencies specified by PEP 518 are already installed.

extra_build_dependencies: Option<ExtraBuildDependencies>

Additional build dependencies for packages.

This allows extending the PEP 517 build environment for the project’s dependencies with additional packages. This is useful for packages that assume the presence of packages like pip, and do not declare them as build dependencies.

extra_build_variables: Option<ExtraBuildVariables>

Extra environment variables to set when building certain packages.

Environment variables will be added to the environment when building the specified packages.

exclude_newer: Option<ExcludeNewerValue>

Limit candidate packages to those that were uploaded prior to the given date.

Accepts RFC 3339 timestamps (e.g., 2006-12-02T02:07:43Z), a “friendly” duration (e.g., 24 hours, 1 week, 30 days), or an ISO 8601 duration (e.g., PT24H, P7D, P30D).

Durations do not respect semantics of the local time zone and are always resolved to a fixed number of seconds assuming that a day is 24 hours (e.g., DST transitions are ignored). Calendar units such as months and years are not allowed.

exclude_newer_package: Option<ExcludeNewerPackage>

Limit candidate packages for specific packages to those that were uploaded prior to the given date.

Accepts a dictionary format of PACKAGE = "DATE" pairs, where DATE is an RFC 3339 timestamp (e.g., 2006-12-02T02:07:43Z), a “friendly” duration (e.g., 24 hours, 1 week, 30 days), or a ISO 8601 duration (e.g., PT24H, P7D, P30D).

Durations do not respect semantics of the local time zone and are always resolved to a fixed number of seconds assuming that a day is 24 hours (e.g., DST transitions are ignored). Calendar units such as months and years are not allowed.

link_mode: Option<LinkMode>

The method to use when installing packages from the global cache.

Defaults to clone (also known as Copy-on-Write) on macOS, and hardlink on Linux and Windows.

WARNING: The use of symlink link mode is discouraged, as they create tight coupling between the cache and the target environment. For example, clearing the cache (uv cache clean) will break all installed packages by way of removing the underlying source files. Use symlinks with caution.

compile_bytecode: Option<bool>

Compile Python files to bytecode after installation.

By default, uv does not compile Python (.py) files to bytecode (__pycache__/*.pyc); instead, compilation is performed lazily the first time a module is imported. For use-cases in which start time is critical, such as CLI applications and Docker containers, this option can be enabled to trade longer installation times for faster start times.

When enabled, uv will process the entire site-packages directory (including packages that are not being modified by the current operation) for consistency. Like pip, it will also ignore errors.

no_sources: Option<bool>

Ignore the tool.uv.sources table when resolving dependencies. Used to lock against the standards-compliant, publishable package metadata, as opposed to using any local or Git sources.

upgrade: Option<bool>

Allow package upgrades, ignoring pinned versions in any existing output file.

upgrade_package: Option<Vec<Requirement<VerbatimParsedUrl>>>

Allow upgrades for a specific package, ignoring pinned versions in any existing output file.

Accepts both standalone package names (ruff) and version specifiers (ruff<0.5.0).

reinstall: Option<bool>

Reinstall all packages, regardless of whether they’re already installed. Implies refresh.

reinstall_package: Option<Vec<PackageName>>

Reinstall a specific package, regardless of whether it’s already installed. Implies refresh-package.

no_build: Option<bool>

Don’t build source distributions.

When enabled, resolving will not run arbitrary Python code. The cached wheels of already-built source distributions will be reused, but operations that require building distributions will exit with an error.

no_build_package: Option<Vec<PackageName>>

Don’t build source distributions for a specific package.

no_binary: Option<bool>

Don’t install pre-built wheels.

The given packages will be built and installed from source. The resolver will still use pre-built wheels to extract package metadata, if available.

no_binary_package: Option<Vec<PackageName>>

Don’t install pre-built wheels for a specific package.

torch_backend: Option<TorchMode>

The backend to use when fetching packages in the PyTorch ecosystem.

When set, uv will ignore the configured index URLs for packages in the PyTorch ecosystem, and will instead use the defined backend.

For example, when set to cpu, uv will use the CPU-only PyTorch index; when set to cu126, uv will use the PyTorch index for CUDA 12.6.

The auto mode will attempt to detect the appropriate PyTorch index based on the currently installed CUDA drivers.

This setting is only respected by uv pip commands.

This option is in preview and may change in any future release.

Implementations

impl ResolverInstallerSchema

pub fn relative_to(self, root_dir: &Path) -> Result<Self, IndexUrlError>

Resolve the ResolverInstallerSchema relative to the given root directory.

Trait Implementations

impl Clone for ResolverInstallerSchema

fn clone(&self) -> ResolverInstallerSchema

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Combine for ResolverInstallerSchema

fn combine(self, other: ResolverInstallerSchema) -> ResolverInstallerSchema

Combine two values, preferring the values in self.

impl Debug for ResolverInstallerSchema

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ResolverInstallerSchema

fn default() -> ResolverInstallerSchema

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ResolverInstallerSchema

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ResolverInstallerSchema> for InstallerOptions

fn from(value: ResolverInstallerSchema) -> Self

Converts to this type from the input type.

impl From<ResolverInstallerSchema> for ResolverInstallerOptions

fn from(value: ResolverInstallerSchema) -> Self

Converts to this type from the input type.

impl From<ResolverInstallerSchema> for ResolverOptions

fn from(value: ResolverInstallerSchema) -> Self

Converts to this type from the input type.

impl OptionsMetadata for ResolverInstallerSchema

fn record(visit: &mut dyn Visit)

Visits the options metadata of this object by calling visit for each option.

fn documentation() -> Option<&'static str>

fn metadata() -> OptionSet

where Self: Sized + 'static,

Returns the extracted metadata.

impl PartialEq for ResolverInstallerSchema

fn eq(&self, other: &ResolverInstallerSchema) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for ResolverInstallerSchema

impl StructuralPartialEq for ResolverInstallerSchema