Is "setuptools_scm >= 2.0.0, <3" still required for the buildsystem?

[timkoers]

I'm having troubles installing vunit, since setuptools_scm >= 2.0.0 but smaller than 3 is required to install VUnit.
I've been working around this by providing the --no-build-isolation flag to pip when installing, but lately that has been causing some issues too.

setuptools_scm is currently at around version 9.x.x, so if you could re-evaluate if this dependency is even necessary that'd be great

[yourfate]

Somehow our CI stopped being able to install VUnit in the last like 3 days. Is this related? Is there a workaround?

[Trooper-X]

Somehow our CI stopped being able to install VUnit in the last like 3 days. Is this related? Is there a workaround?

Have you tried the --no-build-isolation like timkoers suggested?
That works for me.

[yourfate]

Have you tried the --no-build-isolation like timkoers suggested? That works for me.

That seems to work. Requires us to change CI scripts tho. Can this be resolved vunit-side too?

[javValverde]

I would also love this to be solved in VUnit, and even better if a pypi release is made afterwards

[yourfate]

Have you tried the --no-build-isolation like timkoers suggested? That works for me.

That seems to work. Requires us to change CI scripts tho. Can this be resolved vunit-side too?

New problem: this workaround only works with python 3.12, not with python 3.10.

Edit: solved by installing the wheel package as well.

[LarsAsplund]

The setup of VUnit is old and will be updated for v5.0.0. However, I'm not sure what exactly is causing your problems. Can you post your error messages? If the problem is isolated, I can make a pre-release of 5.0.0 that fixes the problem and then you can use it by running pip install with --pre.

[Trooper-X]

Using a Debian Trixie docker:

root@54752a857740:/# python3 -m venv derp
root@54752a857740:/# cd derp
root@54752a857740:/derp# source bin/activate
(derp) root@54752a857740:/derp# pip install vunit-hdl
Collecting vunit-hdl
  Downloading vunit_hdl-4.7.0.tar.gz (665 kB)
     ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 665.5/665.5 kB 16.8 MB/s eta 0:00:00
  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
  ╰─> [82 lines of output]
      /tmp/pip-build-env-40s6u1p4/overlay/lib/python3.11/site-packages/setuptools/dist.py:765: SetuptoolsDeprecationWarning: License classifiers are deprecated.
      !!
      
              ********************************************************************************
              Please consider removing the following classifiers in favor of a SPDX license expression:
      
              License :: OSI Approved :: Mozilla Public License 2.0 (MPL 2.0)
      
              See https://packaging.python.org/en/latest/guides/writing-pyproject-toml/#license for details.
              ********************************************************************************
      
      !!
        self._finalize_license_expression()
      running egg_info
      writing vunit_hdl.egg-info/PKG-INFO
      writing dependency_links to vunit_hdl.egg-info/dependency_links.txt
      writing requirements to vunit_hdl.egg-info/requires.txt
      writing top-level names to vunit_hdl.egg-info/top_level.txt
      Traceback (most recent call last):
        File "/derp/lib/python3.11/site-packages/pip/_vendor/pyproject_hooks/_in_process/_in_process.py", line 353, in <module>
          main()
        File "/derp/lib/python3.11/site-packages/pip/_vendor/pyproject_hooks/_in_process/_in_process.py", line 335, in main
          json_out['return_val'] = hook(**hook_input['kwargs'])
                                   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
        File "/derp/lib/python3.11/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-40s6u1p4/overlay/lib/python3.11/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-40s6u1p4/overlay/lib/python3.11/site-packages/setuptools/build_meta.py", line 301, in _get_build_requires
          self.run_setup()
        File "/tmp/pip-build-env-40s6u1p4/overlay/lib/python3.11/site-packages/setuptools/build_meta.py", line 317, in run_setup
          exec(code, locals())
        File "<string>", line 43, in <module>
        File "/tmp/pip-build-env-40s6u1p4/overlay/lib/python3.11/site-packages/setuptools/__init__.py", line 117, in setup
          return distutils.core.setup(**attrs)  # type: ignore[return-value]
                 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
        File "/tmp/pip-build-env-40s6u1p4/overlay/lib/python3.11/site-packages/setuptools/_distutils/core.py", line 186, in setup
          return run_commands(dist)
                 ^^^^^^^^^^^^^^^^^^
        File "/tmp/pip-build-env-40s6u1p4/overlay/lib/python3.11/site-packages/setuptools/_distutils/core.py", line 202, in run_commands
          dist.run_commands()
        File "/tmp/pip-build-env-40s6u1p4/overlay/lib/python3.11/site-packages/setuptools/_distutils/dist.py", line 1000, in run_commands
          self.run_command(cmd)
        File "/tmp/pip-build-env-40s6u1p4/overlay/lib/python3.11/site-packages/setuptools/dist.py", line 1107, in run_command
          super().run_command(command)
        File "/tmp/pip-build-env-40s6u1p4/overlay/lib/python3.11/site-packages/setuptools/_distutils/dist.py", line 1019, in run_command
          cmd_obj.run()
        File "/tmp/pip-build-env-40s6u1p4/overlay/lib/python3.11/site-packages/setuptools/command/egg_info.py", line 312, in run
          self.find_sources()
        File "/tmp/pip-build-env-40s6u1p4/overlay/lib/python3.11/site-packages/setuptools/command/egg_info.py", line 320, in find_sources
          mm.run()
        File "/tmp/pip-build-env-40s6u1p4/overlay/lib/python3.11/site-packages/setuptools/command/egg_info.py", line 542, in run
          self.add_defaults()
        File "/tmp/pip-build-env-40s6u1p4/overlay/lib/python3.11/site-packages/setuptools/command/egg_info.py", line 583, in add_defaults
          rcfiles = list(walk_revctrl())
                    ^^^^^^^^^^^^^^^^^^^^
        File "/tmp/pip-build-env-40s6u1p4/overlay/lib/python3.11/site-packages/setuptools/command/sdist.py", line 23, in walk_revctrl
          yield from ep.load()(dirname)
                     ^^^^^^^^^
        File "/usr/lib/python3.11/importlib/metadata/__init__.py", line 202, in load
          module = import_module(match.group('module'))
                   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
        File "/usr/lib/python3.11/importlib/__init__.py", line 126, in import_module
          return _bootstrap._gcd_import(name[level:], package, level)
                 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
        File "<frozen importlib._bootstrap>", line 1206, in _gcd_import
        File "<frozen importlib._bootstrap>", line 1178, in _find_and_load
        File "<frozen importlib._bootstrap>", line 1128, in _find_and_load_unlocked
        File "<frozen importlib._bootstrap>", line 241, in _call_with_frames_removed
        File "<frozen importlib._bootstrap>", line 1206, in _gcd_import
        File "<frozen importlib._bootstrap>", line 1178, in _find_and_load
        File "<frozen importlib._bootstrap>", line 1149, in _find_and_load_unlocked
        File "<frozen importlib._bootstrap>", line 690, in _load_unlocked
        File "<frozen importlib._bootstrap_external>", line 940, in exec_module
        File "<frozen importlib._bootstrap>", line 241, in _call_with_frames_removed
        File "/tmp/pip-build-env-40s6u1p4/overlay/lib/python3.11/site-packages/setuptools_scm/__init__.py", line 10, in <module>
          from .version import format_version, meta, ScmVersion
        File "/tmp/pip-build-env-40s6u1p4/overlay/lib/python3.11/site-packages/setuptools_scm/version.py", line 9, in <module>
          from pkg_resources import iter_entry_points
      ModuleNotFoundError: No module named 'pkg_resources'
      [end of output]
  
  note: This error originates from a subprocess, and is likely not a problem with 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.

A colleague of mine strongly suggested to upgrade the build system, as this currently tooling looks quite out-dated and is probably the source of this problem.

[watsonjj]

I believe this is connected to a new release of setuptools (v82.0.0), which removed pkg-resources, and which CIs are likely pulling today. The problem can be bypassed by setting an upper limit on setuptools version in the build-system of vunit's pyproject.toml:

[build-system]
requires = [
    "setuptools >= 35.0.2, <82.0.0",
    "setuptools_scm >= 2.0.0, <3"
]

[felixn]

I'm also affected, same error as Trooper-X

The issue is caused by the upper limit on setuptools_scm <3, while setuptools is unconstrained.
setuptools v82 deprecated pkg_resources
Removing the upper limit on setuptools_scm fixes the issue.

VUnit builds fine with the latest versions of both setuptools and setuptools_scm:
#1159

I think a v4.7.1 hotfix would be best!

[Markus-Wagner]

I can confirm the same error message with a ubuntu docker container:

• Ubuntu is based on jammy
• Python version 3.12
• Used vunit-hdl version 4.7.0

[timkoers]

Have you tried the --no-build-isolation like timkoers suggested? That works for me.

That seems to work. Requires us to change CI scripts tho. Can this be resolved vunit-side too?

New problem: this workaround only works with python 3.12, not with python 3.10.

Edit: solved by installing the wheel package as well.

I tried this and at first it seemed to continue (with --no-build-isolation), but in the end it failed with a Error: invalid command ‘bdist_wheel’ error. No pointers to where this command is executed.

[yourfate]

I tried this and at first it seemed to continue (with --no-build-isolation), but in the end it failed with a Error: invalid command ‘bdist_wheel’ error. No pointers to where this command is executed.

You have to install the wheel package too:

pip install setuptools wheel
pip install --no-build-isolation vunit-hdl

[Markus-Wagner]

I'd also like to support a v4.7.1, as it is the latest released version. Assuming this is the way to go, I can think of 2 different approaches:

1. Fix 4.7.0 and 5.0.0 the same way

[build-system]
requires = [
    "setuptools >= 35.0.2",
    "setuptools_scm >= 2.0.0"    # maybe increase the version to where it does not require pkg_resources any more, this would be >=v7.0.0
]

This would be more future proof, but I don't know if it breaks something else in some elses dependencies

2. Different fixes for 4.7.0 and 5.0.0

Remove the upper limit for v5.0.0 (as used in the example above). I guess we do not need to take care regarding compatibility with other outdated python packages, which require old setuptools_scm versions

But restrict the upper limit of setuptools for v.4.7.0, hence we know it is still compatible with older stuptools_scm

[build-system]
requires = [
    "setuptools >= 35.0.2, <82.0.0",
    "setuptools_scm >= 2.0.0, <3"
]

[timkoers]

I tried this and at first it seemed to continue (with --no-build-isolation), but in the end it failed with a Error: invalid command ‘bdist_wheel’ error. No pointers to where this command is executed.

You have to install the wheel package too:

pip install setuptools wheel
pip install --no-build-isolation vunit-hdl

Even with the wheel package installed, this error appears

[LarsAsplund]

For a hotfix release, we would have to be a bit defensive as we don't want to break any existing installations. Currently, we support Python 3.8+ and I don't think the latest setuptools do. OTOH, 3.10 is the oldest version that hasn't been obsoleted so we need to bump that as well. At least for v5.0.0.