Struct BuildBackendSettings 

pub struct BuildBackendSettings {
    pub module_root: PathBuf,
    pub module_name: Option<ModuleName>,
    pub source_include: Vec<String>,
    pub default_excludes: bool,
    pub source_exclude: Vec<String>,
    pub wheel_exclude: Vec<String>,
    pub namespace: bool,
    pub data: WheelDataIncludes,
}

Settings for the uv build backend (uv_build).

Note that those settings only apply when using the uv_build backend, other build backends (such as hatchling) have their own configuration.

All options that accept globs use the portable glob patterns from PEP 639.

Fields

module_root: PathBuf

The directory that contains the module directory.

Common values are src (src layout, the default) or an empty path (flat layout).

module_name: Option<ModuleName>

The name of the module directory inside module-root.

The default module name is the package name with dots and dashes replaced by underscores.

Package names need to be valid Python identifiers, and the directory needs to contain a __init__.py. An exception are stubs packages, whose name ends with -stubs, with the stem being the module name, and which contain a __init__.pyi file.

For namespace packages with a single module, the path can be dotted, e.g., foo.bar or foo-stubs.bar.

For namespace packages with multiple modules, the path can be a list, e.g., ["foo", "bar"]. We recommend using a single module per package, splitting multiple packages into a workspace.

Note that using this option runs the risk of creating two packages with different names but the same module names. Installing such packages together leads to unspecified behavior, often with corrupted files or directory trees.

source_include: Vec<String>

Glob expressions which files and directories to additionally include in the source distribution.

pyproject.toml and the contents of the module directory are always included.

default_excludes: bool

If set to false, the default excludes aren’t applied.

Default excludes: __pycache__, *.pyc, and *.pyo.

source_exclude: Vec<String>

Glob expressions which files and directories to exclude from the source distribution.

These exclusions are also applied to wheels to ensure that a wheel built from a source tree is consistent with a wheel built from a source distribution.

wheel_exclude: Vec<String>

Glob expressions which files and directories to exclude from the wheel.

namespace: bool

Build a namespace package.

Build a PEP 420 implicit namespace package, allowing more than one root __init__.py.

Use this option when the namespace package contains multiple root __init__.py, for namespace packages with a single root __init__.py use a dotted module-name instead.

To compare dotted module-name and namespace = true, the first example below can be expressed with module-name = "cloud.database": There is one root __init__.py database. In the second example, we have three roots (cloud.database, cloud.database_pro, billing.modules.database_pro), so namespace = true is required.

src
└── cloud
    └── database
        ├── __init__.py
        ├── query_builder
        │   └── __init__.py
        └── sql
            ├── parser.py
            └── __init__.py

src
├── cloud
│   ├── database
│   │   ├── __init__.py
│   │   ├── query_builder
│   │   │   └── __init__.py
│   │   └── sql
│   │       ├── __init__.py
│   │       └── parser.py
│   └── database_pro
│       ├── __init__.py
│       └── query_builder.py
└── billing
    └── modules
        └── database_pro
            ├── __init__.py
            └── sql.py

data: WheelDataIncludes

Data includes for wheels.

Each entry is a directory, whose contents are copied to the matching directory in the wheel in <name>-<version>.data/(purelib|platlib|headers|scripts|data). Upon installation, this data is moved to its target location, as defined by https://docs.python.org/3.12/library/sysconfig.html#installation-paths. Usually, small data files are included by placing them in the Python module instead of using data includes.

• scripts: Installed to the directory for executables, <venv>/bin on Unix or <venv>\Scripts on Windows. This directory is added to PATH when the virtual environment is activated or when using uv run, so this data type can be used to install additional binaries. Consider using project.scripts instead for Python entrypoints.

• data: Installed over the virtualenv environment root.

  Warning: This may override existing files!

• headers: Installed to the include directory. Compilers building Python packages with this package as build requirement use the include directory to find additional header files.

• purelib and platlib: Installed to the site-packages directory. It is not recommended to use these two options.

Trait Implementations

impl Clone for BuildBackendSettings

fn clone(&self) -> BuildBackendSettings

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BuildBackendSettings

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

Formats the value using the given formatter.

impl Default for BuildBackendSettings

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for BuildBackendSettings

where BuildBackendSettings: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl OptionsMetadata for BuildBackendSettings

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 BuildBackendSettings

fn eq(&self, other: &BuildBackendSettings) -> 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 Serialize for BuildBackendSettings

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for BuildBackendSettings

impl StructuralPartialEq for BuildBackendSettings