opentracing not installable anymore with latest setuptools

[xrmx]

It looks like setuptools stopped supporting the description-file attribute that is used in opentracing python setup.cfg:

 py312-test-opentelemetry-opentracing-shim: install_deps> python -I -m pip install -r /home/runner/work/opentelemetry-python/opentelemetry-python/shim/opentelemetry-opentracing-shim/test-requirements.txt
  error: subprocess-exited-with-error
  
  × Getting requirements to build wheel did not run successfully.
  │ exit code: 1
  ╰─> [34 lines of output]
      Traceback (most recent call last):
        File "/home/runner/work/opentelemetry-python/opentelemetry-python/.tox/py312-test-opentelemetry-opentracing-shim/lib/python3.12/site-packages/pip/_vendor/pyproject_hooks/_in_process/_in_process.py", line 389, in <module>
          main()
        File "/home/runner/work/opentelemetry-python/opentelemetry-python/.tox/py312-test-opentelemetry-opentracing-shim/lib/python3.12/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/runner/work/opentelemetry-python/opentelemetry-python/.tox/py312-test-opentelemetry-opentracing-shim/lib/python3.12/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-c5p3pdk4/overlay/lib/python3.12/site-packages/setuptools/build_meta.py", line 334, in get_requires_for_build_wheel
          return self._get_build_requires(config_settings, requirements=[])
                 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
        File "/tmp/pip-build-env-c5p3pdk4/overlay/lib/python3.12/site-packages/setuptools/build_meta.py", line 304, in _get_build_requires
          self.run_setup()
        File "/tmp/pip-build-env-c5p3pdk4/overlay/lib/python3.12/site-packages/setuptools/build_meta.py", line 522, in run_setup
          super().run_setup(setup_script=setup_script)
        File "/tmp/pip-build-env-c5p3pdk4/overlay/lib/python3.12/site-packages/setuptools/build_meta.py", line 320, in run_setup
          exec(code, locals())
        File "<string>", line 4, in <module>
        File "/tmp/pip-build-env-c5p3pdk4/overlay/lib/python3.12/site-packages/setuptools/__init__.py", line 116, in setup
          _install_setup_requires(attrs)
        File "/tmp/pip-build-env-c5p3pdk4/overlay/lib/python3.12/site-packages/setuptools/__init__.py", line 87, in _install_setup_requires
          dist.parse_config_files(ignore_option_errors=True)
        File "/home/runner/work/opentelemetry-python/opentelemetry-python/.tox/py312-test-opentelemetry-opentracing-shim/lib/python3.12/site-packages/_virtualenv.py", line 22, in parse_config_files
          result = old_parse_config_files(self, *args, **kwargs)
                   ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
        File "/tmp/pip-build-env-c5p3pdk4/overlay/lib/python3.12/site-packages/setuptools/dist.py", line 730, in parse_config_files
          self._parse_config_files(filenames=inifiles)
        File "/tmp/pip-build-env-c5p3pdk4/overlay/lib/python3.12/site-packages/setuptools/dist.py", line 599, in _parse_config_files
          opt = self._enforce_underscore(opt, section)
                ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
        File "/tmp/pip-build-env-c5p3pdk4/overlay/lib/python3.12/site-packages/setuptools/dist.py", line 629, in _enforce_underscore
          raise InvalidConfigError(
      setuptools.errors.InvalidConfigError: Invalid dash-separated key 'description-file' in 'metadata' (setup.cfg), please use the underscore name 'description_file' instead.
      [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.

[mikelane]

This is causing build failures for my team.

[emdneto]

@mikelane opentracing package is being affected because of pypa/setuptools#4910

[mikelane]

Presumably, opentracing is not compatible with the new version of setuptools, right? If so, then it does seem like an opentracing bug. If there's a better issue board for this than opentelemetry-python, I'm happy to comment there.

[emdneto]

@mikelane I think opentracing package isn't maintained anymore. I prefer to wait for pypa/setuptools#4911. If it takes too long we can do the workaround. I think they will yank the version

[mikelane]

Oof. In the meantime, our CI is dead in the water until we figure out a workaround.

[emdneto]

@mikelane it seems they fixed in the new version 78.0.2