Summary

Add per-build dependencies and normalized exclusions.

Review Request #15044 — Created May 12, 2026 and submitted May 17, 2026, 9:34 a.m.

Information

Owner

chipx86

Repository

buildthings

Branch

master

Bugs

Depends On

Reviewers

Groups

beanbag-misc

People

Description

During the development of buildthings, one of the goals was to allow

editable builds to exclude certain dependencies. This was removed

accidentally during the move to build isolation dependency control.
This change brings that functionality back and improves it.
All build types can now specify their own lists of dependencies, which

default to the standard dependencies set. They can also specify their

own exclusions.
Exclusions, both on dependencies and isolations, are now normalized.

The name in an exclusion can now match against a name with a version

specifier in the dependencies list. Names are also canonicalized, so

they don't have to be an exact match.
Unit tests covering the dependency options for build isolation, package

metadata, and builds have been added, along with the underlying methods

used for normalizing and filtering dependencies. These tests have been

moved into buildthings/tests/ so that we can reliably import test

modules for utilities.

Testing Done

Built packages in Review Board using both dependencies and exclusions.
Checked the resulting lists.

Installed in editable mode and verified it also used the right
dependencies and exclusions.

All unit tests pass.

Commits

Summary	ID
Add per-build dependencies and normalized exclusions. During the development of buildthings, one of the goals was to allow editable builds to exclude certain dependencies. This was removed accidentally during the move to build isolation dependency control. This change brings that functionality back and improves it. All build types can now specify their own lists of dependencies, which default to the standard dependencies set. They can also specify their own exclusions. Exclusions, both on dependencies and isolations, are now normalized. The name in an exclusion can now match against a name with a version specifier in the dependencies list. Names are also canonicalized, so they don't have to be an exact match. Unit tests covering the dependency options for build isolation, package metadata, and builds have been added, along with the underlying methods used for normalizing and filtering dependencies. These tests have been moved into `buildthings/tests/` so that we can reliably import test modules for utilities.	191e79ad4df7f1211d2a0adb42765f0c28283e63

Summary

Add per-build dependencies and normalized exclusions.

During the development of buildthings, one of the goals was to allow editable builds to exclude certain dependencies. This was removed accidentally during the move to build isolation dependency control. This change brings that functionality back and improves it. All build types can now specify their own lists of dependencies, which default to the standard dependencies set. They can also specify their own exclusions. Exclusions, both on dependencies and isolations, are now normalized. The name in an exclusion can now match against a name with a version specifier in the dependencies list. Names are also canonicalized, so they don't have to be an exact match. Unit tests covering the dependency options for build isolation, package metadata, and builds have been added, along with the underlying methods used for normalizing and filtering dependencies. These tests have been moved into `buildthings/tests/` so that we can reliably import test modules for utilities.

191e79ad4df7f1211d2a0adb42765f0c28283e63

Issues

Description	From	Last Updated
It seems like these shouldn't have isolation in them.	david	May 14, 2026, 8:26 a.m.
You added a whole big section for .exclude-deps, but .dependencies only gets this. Can we make a section for this …	david	May 14, 2026, 9:14 p.m.
Don't we need to be applying exclusions here? It seems like we're correctly excluding dependencies inside the isolated environment, but …	david	May 14, 2026, 8:34 a.m.
Same here.	david	May 14, 2026, 8:45 a.m.
Same here.	david	May 14, 2026, 8:45 a.m.
It might be nice to validate that these are lists (in the way that _load_dependencies does).	david	May 14, 2026, 8:53 a.m.
It might be surprising that package[extras] wouldn't match an exclusion of package. Can we at least note in here that …	david	May 14, 2026, 8:53 a.m.
This can be *package_deps_config['dependencies']	david	May 14, 2026, 8:38 p.m.
typo: arguments -> argument	david	May 14, 2026, 8:39 p.m.
We're not validating the type in this branch. Can we make a small helper to do the validation bit that …	david	May 14, 2026, 8:45 p.m.
Need to add "Returns:" to this docstring now.	david	May 14, 2026, 8:46 p.m.
PEP685 says that extras names should be normalized using the same rules as project names, so this should probably be: …	david	May 14, 2026, 8:46 p.m.
I think when we're in greenfield packages where we're truly using pytest-style tests, we should use real python docstrings with …	david	May 14, 2026, 9:14 p.m.
Leftover debug code.	david	May 14, 2026, 8:47 p.m.

flake8 passed.

JSHint passed.

README.rst (Diff revision 1)

The issue has been resolved. Show all issues

It seems like these shouldn't have isolation in them.

README.rst (Diff revision 1)

The issue has been dropped. Show all issues

You added a whole big section for .exclude-deps, but .dependencies only gets this. Can we make a section for this too?

chipx86

May 14, 2026, 11:14 a.m.

It's in the dependencies section, which has a lot of content. This is the override example for the dependencies. What should I add?

david

May 14, 2026, 9:56 p.m.

Just thinking it would be nice to have something like this, matching the exclude section:

tool.buildthings.<build_type>.dependencies
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. versionadded:: 1.1

A list of Python package dependencies for the given build type.

This will override the general dependencies specified in
``tool.buildthings.dependencies``.

**Example**

.. code-block:: toml

   [tool.buildthings.editable]
   dependencies = ["kgb"]

chipx86

May 14, 2026, 10 p.m.

exclude-deps has its own section there because, unlike with dependencies, this isn't an override for one in tool.buildthings. It's only found in the build type sections. This is following the same pattern used for all the docs here, which is to document where the setting is defined at the highest level and then to list where it can be overridden. For example, we have:

tool.buildthings.isolation.include-dev-deps
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

When ``true``, development dependencies (from
``tool.buildthings.dev-dependencies`` or ``dev-requirements.txt``) will be
installed into the isolated build environment.

This may be needed if you're using extra build steps.

**Overridden by:**

* ``tool.buildthings.isolation.editable.include-dev-deps``
* ``tool.buildthings.isolation.sdist.include-dev-deps``
* ``tool.buildthings.isolation.wheel.include-dev-deps``

buildthings/backend.py (Diff revision 1)

The issue has been resolved. Show all issues

Don't we need to be applying exclusions here? It seems like we're correctly excluding dependencies inside the isolated environment, but the resulting wheel file would have Requires-Dist with all dependencies in it.

buildthings/backend.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Same here.
```
buildthings/backend.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Same here.
```

buildthings/config.py (Diff revision 1)

The issue has been resolved. Show all issues

It might be nice to validate that these are lists (in the way that _load_dependencies does).

buildthings/requirements.py (Diff revision 1)

The issue has been resolved. Show all issues

It might be surprising that package[extras] wouldn't match an exclusion of package. Can we at least note in here that extras will be included in the returned name?

Change Summary:


Fixed up exclusions for all dependency lists.
Added a comprehensive test suite. This now lives in buildthings/tests/, since we need to be able to reliably import a utils module.
Fixed bad override keys in the dependencies docs.
Improved internal docs when it comes to [extras] support.

Description:

		During the development of buildthings, one of the goals was to allow
		editable builds to exclude certain dependencies. This was removed
		accidentally during the move to build isolation dependency control.

		This change brings that functionality back and improves it.

		All build types can now specify their own lists of dependencies, which
		default to the standard dependencies set. They can also specify their
		own exclusions.

		Exclusions, both on dependencies and isolations, are now normalized.
		The name in an exclusion can now match against a name with a version
		specifier in the dependencies list. Names are also canonicalized, so
		they don't have to be an exact match.
	+
	+	Unit tests covering the dependency options for build isolation, package
	+	metadata, and builds have been added, along with the underlying methods
	+	used for normalizing and filtering dependencies. These tests have been
	+	moved into `buildthings/tests/` so that we can reliably import test
	+	modules for utilities.

Testing Done:

		Built packages in Review Board using both dependencies and exclusions.
		Checked the resulting lists.

		Installed in editable mode and verified it also used the right
		dependencies and exclusions.
	+
	+	All unit tests pass.

Commits:

	Summary	ID
	Add per-build dependencies and normalized exclusions. During the development of buildthings, one of the goals was to allow editable builds to exclude certain dependencies. This was removed accidentally during the move to build isolation dependency control. This change brings that functionality back and improves it. All build types can now specify their own lists of dependencies, which default to the standard dependencies set. They can also specify their own exclusions. Exclusions, both on dependencies and isolations, are now normalized. The name in an exclusion can now match against a name with a version specifier in the dependencies list. Names are also canonicalized, so they don't have to be an exact match.	ad480abd541cb36506fb181b275094ba8e79f034
	Add per-build dependencies and normalized exclusions. During the development of buildthings, one of the goals was to allow editable builds to exclude certain dependencies. This was removed accidentally during the move to build isolation dependency control. This change brings that functionality back and improves it. All build types can now specify their own lists of dependencies, which default to the standard dependencies set. They can also specify their own exclusions. Exclusions, both on dependencies and isolations, are now normalized. The name in an exclusion can now match against a name with a version specifier in the dependencies list. Names are also canonicalized, so they don't have to be an exact match. Unit tests covering the dependency options for build isolation, package metadata, and builds have been added, along with the underlying methods used for normalizing and filtering dependencies. These tests have been moved into `buildthings/tests/` so that we can reliably import test modules for utilities.	690b984189cb89b5e03994c521fefbc2cb5a1306

Diff:

Revision 2 (+2980 -62)

Show changes

	README.rst
	buildthings/backend.py
	buildthings/config.py
	buildthings/requirements.py
	buildthings/tests/__init__.py
	buildthings/tests/test_backend.py
	buildthings/tests/test_config.py
	buildthings/tests/test_filter_dependencies.py
	3 more

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

buildthings/backend.py (Diff revision 2)
The issue has been resolved. Show all issues
```
This can be *package_deps_config['dependencies']
```
buildthings/config.py (Diff revision 2)
The issue has been resolved. Show all issues
```
typo: arguments -> argument
```

buildthings/config.py (Diff revision 2)

The issue has been dropped. Show all issues

We're not validating the type in this branch.

Can we make a small helper to do the validation bit that you added twice above so we can use it here too?

chipx86

May 14, 2026, 8:54 p.m.

Validation needs more work in general. I'd rather not get this change any more out of scope at this point in the release than it is. Let's punt for now on future cleanup.

buildthings/config.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Need to add "Returns:" to this docstring now.
```

buildthings/requirements.py (Diff revision 2)

The issue has been resolved. Show all issues

PEP685 says that extras names should be normalized using the same rules as project names, so this should probably be:

extras_str = ','.join(sorted(canonicalize_name(e) for e in extras))

buildthings/tests/test_backend.py (Diff revision 2)

The issue has been resolved. Show all issues

I think when we're in greenfield packages where we're truly using pytest-style tests, we should use real python docstrings with imperative mood and trailing periods.

So "Test get_requires_for_build_editable."

Same for the rest of the test cases.

chipx86

May 14, 2026, 8:54 p.m.

I don't love having two standards for how we write these, but fine. The conditions of a test usually need to wrap after the first line summary, so we're not going to get actual real docstring compliance for tests, just a version of it.

buildthings/tests/test_config.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Leftover debug code.
```

Change Summary:


Reworked unit test docstrings.
Fixed doc issues.
Normalized extras names.
Reused an already-fetched variable.
Removed debug code.

Commits:

	Summary	ID
	Add per-build dependencies and normalized exclusions. During the development of buildthings, one of the goals was to allow editable builds to exclude certain dependencies. This was removed accidentally during the move to build isolation dependency control. This change brings that functionality back and improves it. All build types can now specify their own lists of dependencies, which default to the standard dependencies set. They can also specify their own exclusions. Exclusions, both on dependencies and isolations, are now normalized. The name in an exclusion can now match against a name with a version specifier in the dependencies list. Names are also canonicalized, so they don't have to be an exact match. Unit tests covering the dependency options for build isolation, package metadata, and builds have been added, along with the underlying methods used for normalizing and filtering dependencies. These tests have been moved into `buildthings/tests/` so that we can reliably import test modules for utilities.	690b984189cb89b5e03994c521fefbc2cb5a1306
	Add per-build dependencies and normalized exclusions. During the development of buildthings, one of the goals was to allow editable builds to exclude certain dependencies. This was removed accidentally during the move to build isolation dependency control. This change brings that functionality back and improves it. All build types can now specify their own lists of dependencies, which default to the standard dependencies set. They can also specify their own exclusions. Exclusions, both on dependencies and isolations, are now normalized. The name in an exclusion can now match against a name with a version specifier in the dependencies list. Names are also canonicalized, so they don't have to be an exact match. Unit tests covering the dependency options for build isolation, package metadata, and builds have been added, along with the underlying methods used for normalizing and filtering dependencies. These tests have been moved into `buildthings/tests/` so that we can reliably import test modules for utilities.	191e79ad4df7f1211d2a0adb42765f0c28283e63

Diff:

Revision 3 (+3288 -62)

Show changes

	README.rst
	buildthings/backend.py
	buildthings/config.py
	buildthings/requirements.py
	buildthings/tests/__init__.py
	buildthings/tests/test_backend.py
	buildthings/tests/test_config.py
	buildthings/tests/test_filter_dependencies.py
	3 more

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to master (733889a)