pbr: ModuleNotFoundError: No module named 'pkg_resources'

[freyes]

When building a charm using layer-basic fails because pbr<6.1.1 can't be built with setuptools>=82.0 due to the drop of pkg_resources, this can't be addressed by pinning setuptools, because pip will build pbr in an isolated environment.

:: Collecting pbr<6.1.1 (from -r /tmp/tmpt0pr1_kw/wheelhouse.txt (line 55))
:: Using cached pbr-6.1.0.tar.gz (124 kB)
:: Installing build dependencies: started
:: Installing build dependencies: finished with status 'done'
:: Getting requirements to build wheel: started
:: Getting requirements to build wheel: finished with status 'error'
:: error: subprocess-exited-with-error
::
:: × Getting requirements to build wheel did not run successfully.
:: │ exit code: 1
:: ╰─> [22 lines of output]
:: Traceback (most recent call last):
:: File "/tmp/tmp438b5rxl/lib/python3.12/site-packages/pip/_vendor/pyproject_hooks/_in_process/_in_process.py", line 353, in <module>
:: main()
:: File "/tmp/tmp438b5rxl/lib/python3.12/site-packages/pip/_vendor/pyproject_hooks/_in_process/_in_process.py", line 335, in main
:: json_out['return_val'] = hook(**hook_input['kwargs'])
:: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
:: File "/tmp/tmp438b5rxl/lib/python3.12/site-packages/pip/_vendor/pyproject_hooks/_in_process/_in_process.py", line 118, in get_requires_for_build_wheel
:: return hook(config_settings)
:: ^^^^^^^^^^^^^^^^^^^^^
:: File "/tmp/pip-build-env-avujfybc/overlay/lib/python3.12/site-packages/setuptools/build_meta.py", line 333, in get_requires_for_build_wheel
:: return self._get_build_requires(config_settings, requirements=[])
:: ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
:: File "/tmp/pip-build-env-avujfybc/overlay/lib/python3.12/site-packages/setuptools/build_meta.py", line 301, in _get_build_requires
:: self.run_setup()
:: File "/tmp/pip-build-env-avujfybc/overlay/lib/python3.12/site-packages/setuptools/build_meta.py", line 520, in run_setup
:: super().run_setup(setup_script=setup_script)
:: File "/tmp/pip-build-env-avujfybc/overlay/lib/python3.12/site-packages/setuptools/build_meta.py", line 317, in run_setup
:: exec(code, locals())
:: File "<string>", line 18, in <module>
:: File "/tmp/pip-download-kuycbmxk/pbr_44eca0dc1cc2429fb2c1ebcbee964869/pbr/util.py", line 75, in <module>
:: import pkg_resources
:: ModuleNotFoundError: No module named 'pkg_resources'
:: [end of output]

References:

• [BUG] Restore pkg_resources pypa/setuptools#5174
• Pinning pbr<6.1.1 so it continues to use setuptools #229

[freyes]

we would need to pass --no-build-isolation --no-use-pep517, although this is not something we do today and it can result in a much more different artifact, so probably this is not the right approach.

[freyes]

pkg_resources use was dropped from pbr

• https://review.opendev.org/c/openstack/pbr/+/964803
• https://review.opendev.org/c/openstack/pbr/+/960031

so we would need to use pbr>=7.0.2,

$ git tag --contains adbe935a4f3736f10f29a4021e4d65009b3bb8f2
7.0.2
7.0.3

But reintroduces the issue solved by the pinning

2025-02-11 21:18:09 WARNING unit.openstack-integrator/0.install logger.go:60 ERROR: Could not find a version that satisfies the requirement setuptools>=64.0.0 (from versions: 62.1.0)
2025-02-11 21:18:09 WARNING unit.openstack-integrator/0.install logger.go:60 ERROR: No matching distribution found for setuptools>=64.0.0

[freyes]

I'm thinking we could add support to a constraints file in charm-tools, this could be passed to the building environment using the environment variable PIP_CONSTRAINT, this is my terminal's output how that survives all the way into the building sandbox used by pip.

 ~ $ mkvirtualenv myvenv
created virtual environment CPython3.13.7.final.0-64 in 157ms
 creator CPython3Posix(dest=/home/freyes/.virtualenvs/myvenv, clear=False, no_vcs_ignore=False, global=False)
 seeder FromAppData(download=False, pip=bundle, via=copy, app_data_dir=/home/freyes/.local/share/virtualenv)
 added seed packages: pip==25.2
 activators BashActivator,CShellActivator,FishActivator,NushellActivator,PowerShellActivator,PythonActivator
virtualenvwrapper.user_scripts creating /home/freyes/.virtualenvs/myvenv/bin/predeactivate
virtualenvwrapper.user_scripts creating /home/freyes/.virtualenvs/myvenv/bin/postdeactivate
virtualenvwrapper.user_scripts creating /home/freyes/.virtualenvs/myvenv/bin/preactivate
virtualenvwrapper.user_scripts creating /home/freyes/.virtualenvs/myvenv/bin/postactivate
virtualenvwrapper.user_scripts creating /home/freyes/.virtualenvs/myvenv/bin/get_env_details
 ~ $ which pip
/home/freyes/.virtualenvs/myvenv/bin/pip
 /tmp $ pip wheel --no-binary :all: "pbr<6.1.1"
Looking in indexes: http://localhost:3141/root/pypi/+simple/
Collecting pbr<6.1.1
 Downloading http://localhost:3141/root/pypi/%2Bf/788/183e382e3d1d7/pbr-6.1.0.tar.gz (124 kB)
 Installing build dependencies ... done
 Getting requirements to build wheel ... error
 error: subprocess-exited-with-error
 
 × Getting requirements to build wheel did not run successfully.
 │ exit code: 1
 ╰─> [25 lines of output]
 Traceback (most recent call last):
 File "/home/freyes/.virtualenvs/myvenv/lib/python3.13/site-packages/pip/_vendor/pyproject_hooks/_in_process/_in_process.py", line 389, in <module>
 main()
 ~~~~^^
 File "/home/freyes/.virtualenvs/myvenv/lib/python3.13/site-packages/pip/_vendor/pyproject_hooks/_in_process/_in_process.py", line 373, in main
 json_out["return_val"] = hook(**hook_input["kwargs"])
 ~~~~^^^^^^^^^^^^^^^^^^^^^^^^
 File "/home/freyes/.virtualenvs/myvenv/lib/python3.13/site-packages/pip/_vendor/pyproject_hooks/_in_process/_in_process.py", line 143, in get_requires_for_build_wheel
 return hook(config_settings)
 File "/tmp/pip-build-env-0zz1bx3h/overlay/lib/python3.13/site-packages/setuptools/build_meta.py", line 333, in get_requires_for_build_wheel
 return self._get_build_requires(config_settings, requirements=[])
 ~~~~~~~~~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 File "/tmp/pip-build-env-0zz1bx3h/overlay/lib/python3.13/site-packages/setuptools/build_meta.py", line 301, in _get_build_requires
 self.run_setup()
 ~~~~~~~~~~~~~~^^
 File "/tmp/pip-build-env-0zz1bx3h/overlay/lib/python3.13/site-packages/setuptools/build_meta.py", line 520, in run_setup
 super().run_setup(setup_script=setup_script)
 ~~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^
 File "/tmp/pip-build-env-0zz1bx3h/overlay/lib/python3.13/site-packages/setuptools/build_meta.py", line 317, in run_setup
 exec(code, locals())
 ~~~~^^^^^^^^^^^^^^^^
 File "<string>", line 18, in <module>
 File "/tmp/pip-wheel-4f1yjjd0/pbr_4ba8557c742448ffac6c40a8627fda94/pbr/util.py", line 75, in <module>
 import pkg_resources
 ModuleNotFoundError: No module named 'pkg_resources'
 [end of output]
 
 note: This error originates from a subprocess, and is likely not a problem with pip.

[notice] A new release of pip is available: 25.2 -> 26.0.1
[notice] To update, run: pip install --upgrade pip
error: subprocess-exited-with-error

× Getting requirements to build wheel did not run successfully.
│ exit code: 1
╰─> See above for output.

note: This error originates from a subprocess, and is likely not a problem with pip.
 /tmp $ cat << EOF > constraints.txt
❯ setuptools<82.0
❯ EOF
 /tmp $ pip wheel -c ./constraints.txt --no-binary :all: "pbr<6.1.1"
Looking in indexes: http://localhost:3141/root/pypi/+simple/
Collecting pbr<6.1.1
 Downloading http://localhost:3141/root/pypi/%2Bf/788/183e382e3d1d7/pbr-6.1.0.tar.gz (124 kB)
 Installing build dependencies ... done
 Getting requirements to build wheel ... error
 error: subprocess-exited-with-error
 
 × Getting requirements to build wheel did not run successfully.
 │ exit code: 1
 ╰─> [25 lines of output]
 Traceback (most recent call last):
 File "/home/freyes/.virtualenvs/myvenv/lib/python3.13/site-packages/pip/_vendor/pyproject_hooks/_in_process/_in_process.py", line 389, in <module>
 main()
 ~~~~^^
 File "/home/freyes/.virtualenvs/myvenv/lib/python3.13/site-packages/pip/_vendor/pyproject_hooks/_in_process/_in_process.py", line 373, in main
 json_out["return_val"] = hook(**hook_input["kwargs"])
 ~~~~^^^^^^^^^^^^^^^^^^^^^^^^
 File "/home/freyes/.virtualenvs/myvenv/lib/python3.13/site-packages/pip/_vendor/pyproject_hooks/_in_process/_in_process.py", line 143, in get_requires_for_build_wheel
 return hook(config_settings)
 File "/tmp/pip-build-env-bxomsqj1/overlay/lib/python3.13/site-packages/setuptools/build_meta.py", line 333, in get_requires_for_build_wheel
 return self._get_build_requires(config_settings, requirements=[])
 ~~~~~~~~~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 File "/tmp/pip-build-env-bxomsqj1/overlay/lib/python3.13/site-packages/setuptools/build_meta.py", line 301, in _get_build_requires
 self.run_setup()
 ~~~~~~~~~~~~~~^^
 File "/tmp/pip-build-env-bxomsqj1/overlay/lib/python3.13/site-packages/setuptools/build_meta.py", line 520, in run_setup
 super().run_setup(setup_script=setup_script)
 ~~~~~~~~~~~~~~~~~^^^^^^^^^^^^^^^^^^^^^^^^^^^
 File "/tmp/pip-build-env-bxomsqj1/overlay/lib/python3.13/site-packages/setuptools/build_meta.py", line 317, in run_setup
 exec(code, locals())
 ~~~~^^^^^^^^^^^^^^^^
 File "<string>", line 18, in <module>
 File "/tmp/pip-wheel-zxrvrzi9/pbr_08506395ba1e4caf9118ebaff0502d13/pbr/util.py", line 75, in <module>
 import pkg_resources
 ModuleNotFoundError: No module named 'pkg_resources'
 [end of output]
 
 note: This error originates from a subprocess, and is likely not a problem with pip.

[notice] A new release of pip is available: 25.2 -> 26.0.1
[notice] To update, run: pip install --upgrade pip
error: subprocess-exited-with-error

× Getting requirements to build wheel did not run successfully.
│ exit code: 1
╰─> See above for output.

note: This error originates from a subprocess, and is likely not a problem with pip.
 /tmp $ PIP_CONSTRAINT=./constraint.txt pip wheel --no-binary :all: "pbr<6.1.1"

[notice] A new release of pip is available: 25.2 -> 26.0.1
[notice] To update, run: pip install --upgrade pip
ERROR: Could not open requirements file: [Errno 2] No such file or directory: './constraint.txt'
 /tmp $ PIP_CONSTRAINT=./constraints.txt pip wheel --no-binary :all: "pbr<6.1.1"
Looking in indexes: http://localhost:3141/root/pypi/+simple/
Collecting pbr<6.1.1
 Downloading http://localhost:3141/root/pypi/%2Bf/788/183e382e3d1d7/pbr-6.1.0.tar.gz (124 kB)
 Installing build dependencies ... done
 Getting requirements to build wheel ... done
 Preparing metadata (pyproject.toml) ... done
Building wheels for collected packages: pbr
 Building wheel for pbr (pyproject.toml) ... done
 Created wheel for pbr: filename=pbr-6.1.0-py2.py3-none-any.whl size=108608 sha256=f798173072dbe5af3c5dc126bc88fc8786a91cdfaaf622a1f21cbbef8ee64b79
 Stored in directory: /home/freyes/.cache/pip/wheels/28/20/44/f8709ce86fed72b656a641ba5d639926c78916ff73f20d6784
Successfully built pbr

[notice] A new release of pip is available: 25.2 -> 26.0.1
[notice] To update, run: pip install --upgrade pip

[freyes]

https://warthogs.atlassian.net/browse/OPEN-4063