Skip to content

sphinx Python package broken due to setuptools deprecation enforcement #13451

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
iorsh opened this issue Mar 24, 2025 · 1 comment
Closed

sphinx Python package broken due to setuptools deprecation enforcement #13451

iorsh opened this issue Mar 24, 2025 · 1 comment

Comments

@iorsh
Copy link

iorsh commented Mar 24, 2025

Describe the bug

Please see pypa/setuptools#4870

Sphinx package installation is broken now (e.g. in FontForge CI):

Collecting sphinx
  Downloading sphinx-8.2.3-py3-none-any.whl.metadata (7.0 kB)
Collecting typing
  Downloading typing-3.7.4.3.tar.gz (78 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
  
  [31 lines of output]
  Traceback (most recent call last):
    File "D:/a/fontforge/fontforge/repo/build/sphinx-venv/lib/python3.12/site-packages/pip/_vendor/pyproject_hooks/_in_process/_in_process.py", line 353, in <module>
      main()
    File "D:/a/fontforge/fontforge/repo/build/sphinx-venv/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 "D:/a/fontforge/fontforge/repo/build/sphinx-venv/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 "D:/a/_temp/msys64/tmp/pip-build-env-sy5csid3/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 "D:/a/_temp/msys64/tmp/pip-build-env-sy5csid3/overlay/lib/python3.12/site-packages/setuptools/build_meta.py", line 304, in _get_build_requires
      self.run_setup()
    File "D:/a/_temp/msys64/tmp/pip-build-env-sy5csid3/overlay/lib/python3.12/site-packages/setuptools/build_meta.py", line 522, in run_setup
      super().run_setup(setup_script=setup_script)
    File "D:/a/_temp/msys64/tmp/pip-build-env-sy5csid3/overlay/lib/python3.12/site-packages/setuptools/build_meta.py", line 320, in run_setup
      exec(code, locals())
    File "<string>", line 57, in <module>
    File "D:/a/_temp/msys64/tmp/pip-build-env-sy5csid3/overlay/lib/python3.12/site-packages/setuptools/__init__.py", line 116, in setup
      _install_setup_requires(attrs)
    File "D:/a/_temp/msys64/tmp/pip-build-env-sy5csid3/overlay/lib/python3.12/site-packages/setuptools/__init__.py", line 87, in _install_setup_requires
      dist.parse_config_files(ignore_option_errors=True)
    File "D:/a/_temp/msys64/tmp/pip-build-env-sy5csid3/overlay/lib/python3.12/site-packages/setuptools/dist.py", line 730, in parse_config_files
      self._parse_config_files(filenames=inifiles)
    File "D:/a/_temp/msys64/tmp/pip-build-env-sy5csid3/overlay/lib/python3.12/site-packages/setuptools/dist.py", line 599, in _parse_config_files
      opt = self._enforce_underscore(opt, section)
            ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    File "D:/a/_temp/msys64/tmp/pip-build-env-sy5csid3/overlay/lib/python3.12/site-packages/setuptools/dist.py", line 629, in _enforce_underscore
      raise InvalidConfigError(
  setuptools.errors.InvalidConfigError: Invalid dash-separated key 'license-file' in 'metadata' (setup.cfg), please use the underscore name 'license_file' instead.
  [end of output]
  
  note: This error originates from a subprocess, and is likely not a problem with pip.

How to Reproduce

Try to install sphinx Python package with setuptools 78.0.1

Environment Information

No info, can't be installed.

Sphinx extensions

Additional context

No response

@iorsh iorsh added the type:bug label Mar 24, 2025
@AA-Turner
Copy link
Member

Sphinx does not use setuptools, and has not done so for three years. The log you uploaded appears to show a failure building the typing PyPI package, which should not be needed -- it is a built in standard library module in all supported versions of Python.

A

@AA-Turner AA-Turner closed this as not planned Won't fix, can't repro, duplicate, stale Mar 24, 2025
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Apr 22, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants