BuildEnvironment: accumulate module changes to poke to all relevant modules

[becker33]

Fixes #32336

Currently, module changes from setup_dependent_package are applied only to the module of the package class, but not to any parent classes' modules between the package class module and spack.package_base.

In this PR, we create a custom class to accumulate module changes, and apply those changes to each class that requires it. This design allows us to code for a single module, while applying the changes to multiple modules as needed under the hood, without requiring the user to reason about package inheritance.

@tgamblin you'll probably want to look at this.

[becker33]

@spackbot fix style

[spackbot-app]

Let me see if I can fix that for you!

[spackbot-app]

I was able to run spack style --fix for you!

spack style --fix

==> Running style checks on spack
  selected: isort, mypy, black, flake8
==> Modified files
  lib/spack/spack/build_environment.py
==> Running isort checks
  isort checks were clean
==> Running mypy checks
Success: no issues found in 558 source files
  mypy checks were clean
==> Running black checks
reformatted lib/spack/spack/build_environment.py
All done! ✨ 🍰 ✨
1 file reformatted.
  black checks were clean
==> Running flake8 checks
  flake8 checks were clean
==> spack style checks were clean

Keep in mind that I cannot fix your flake8 or mypy errors, so if you have any you'll need to fix them and update the pull request. If I was able to push to your branch, if you make further changes you will need to pull from your updated branch before pushing again.

I've updated the branch with isort fixes.

[spackbot-app]

It looks like you had an issue with style checks! I can help with that if you ask me! Just say:

@spackbot fix style

... and I'll try to fix style and push a commit to your fork with the fix.

Alternatively, you can run:

$ spack style --fix

And then update the pull request here.

[spackbot-app]

It looks like you had an issue with style checks! I can help with that if you ask me! Just say:

@spackbot fix style

... and I'll try to fix style and push a commit to your fork with the fix.

Alternatively, you can run:

$ spack style --fix

And then update the pull request here.

[spackbot-app]

It looks like you had an issue with style checks! I can help with that if you ask me! Just say:

@spackbot fix style

... and I'll try to fix style and push a commit to your fork with the fix.

Alternatively, you can run:

$ spack style --fix

And then update the pull request here.

[becker33]

@spackbot fix style

[spackbot-app]

Let me see if I can fix that for you!

[spackbot-app]

I was able to run spack style --fix for you!

spack style --fix

==> Running style checks on spack
  selected: isort, mypy, black, flake8
==> Modified files
  lib/spack/spack/build_environment.py
  lib/spack/spack/test/build_environment.py
  var/spack/repos/builtin.mock/packages/cmake-client-inheritor/package.py
==> Running isort checks
Fixing /tmp/tmpxmage56q/spack/var/spack/repos/builtin.mock/packages/cmake-client-inheritor/package.py
  isort checks were clean
==> Running mypy checks
Success: no issues found in 558 source files
  mypy checks were clean
==> Running black checks
reformatted lib/spack/spack/test/build_environment.py
All done! ✨ 🍰 ✨
1 file reformatted, 2 files left unchanged.
  black checks were clean
==> Running flake8 checks
var/spack/repos/builtin.mock/packages/cmake-client-inheritor/package.py:6: [F401] 'os' imported but unused
  flake8 found errors

Keep in mind that I cannot fix your flake8 or mypy errors, so if you have any you'll need to fix them and update the pull request. If I was able to push to your branch, if you make further changes you will need to pull from your updated branch before pushing again.

I've updated the branch with isort fixes.

[becker33]

@spackbot fix style

[spackbot-app]

Let me see if I can fix that for you!

[spackbot-app]

I was able to run spack style --fix for you!

spack style --fix

==> Running style checks on spack
  selected: isort, mypy, black, flake8
==> Modified files
  lib/spack/spack/build_environment.py
  lib/spack/spack/test/build_environment.py
  var/spack/repos/builtin.mock/packages/cmake-client-inheritor/package.py
==> Running isort checks
Fixing /tmp/tmpseclb6dk/spack/var/spack/repos/builtin.mock/packages/cmake-client-inheritor/package.py
  isort checks were clean
==> Running mypy checks
Success: no issues found in 558 source files
  mypy checks were clean
==> Running black checks
All done! ✨ 🍰 ✨
3 files left unchanged.
  black checks were clean
==> Running flake8 checks
var/spack/repos/builtin.mock/packages/cmake-client-inheritor/package.py:6: [F401] 'spack.package.*' imported but unused
  flake8 found errors

Keep in mind that I cannot fix your flake8 or mypy errors, so if you have any you'll need to fix them and update the pull request. If I was able to push to your branch, if you make further changes you will need to pull from your updated branch before pushing again.

I've updated the branch with isort fixes.

[haampie]

This was a breaking change :(

It's now impossible to read properties from the parent module.

How are build deps like gmake / ninja supposed to get the parent module.make_jobs?

[alalazo]

I don't think many packages would be affected, but this potentially breaks previous semantics since we are not passing something that resembles the module. So if a package was accessing module properties, it won't find them in the Bunch(). Also, the PackageBase docstring is now misleading, since it says we are passing package.module as an argument.

EDIT: Sorry for the double posting, I should have refreshed the browser 😆