tk0miya
commented
3 years ago Reasonable. Now I posted #9826 to reduce the dependency to the distutils module. I hope it helps you.
After merging it, we still have 4 references in our code. We need to investigate their successor.
$ grep -r distutils sphinx tests setup.py | grep import
sphinx/setup_command.py:from distutils.cmd import Command
sphinx/setup_command.py:from distutils.errors import DistutilsExecError
tests/roots/test-setup/setup.py:from distutils.core import setup
setup.py:from distutils import log
leycec
pradyunsg
AA-Turner
nanonyme
Describe the bug
Python 3.10 officially deprecated the standard
distutilspackage after standardization of PEP 632 -- Deprecate distutils module. Python 3.12 is slated to entirely remove that package – and justifiably so. It's an ongoing dumpster fire that can't be put out soon enough. :fire:Sadly, Sphinx still widely imports from
distutils. GitHub shows at least twelve pending references. As a very temporary circumvention, globally replacingdistutilswithsetuptools._distutilsshould suffice to resolve this. Of course, that's also guaranteed to blow up. Like CPython,setuptoolsintends to disembowel and eventually removesetuptools._distutils. Ain't nobody got volunteer time to maintain cruft in perpetuity.Does This Really Matter Now?
Yup. I author @beartype, which doesn't necessarily play well with Sphinx's
autodocextension (as detailed here). I've kludged around that incompatibility on my end with ad-hoc and inexplicably dangerous heuristics that conditionally disable @beartype when we vaguely thinkautodocmight be active. Nobody actually knows whenautodocis active, of course. There's currently no public Sphinx API to externally detect that. Cue #9805.</ahem>Because that's dangerous, we exercise that with a non-trivial functional test programmatically running
sphinx-buildfrom within the activepytestprocess by calling thesphinx.cmd.build.main()entry point. Works great – under Python < 3.10, that is. Under Python ≥ 3.10, Sphinx emits deprecation warnings all over the place like a flailing water buffalo besieged by leeches. For safety, our test suite treats any warning as a test failure. Chaos ensues with extremepytesttracebacks resembling:To preserve our sanity, we're currently just ignoring that test under Python ≥ 3.10. We're not proud – but sometimes you just gotta get to sleep.
Thanks for all the Structured Docos
As always, thanks a well-documented ton for all the amazing volunteer work everyone does here. Sphinx rocks! May this issue find the final reST it so deserves. :wink:
How to Reproduce
Just look at the Sphinx codebase, maybe? Not sure what to say here. Badness is bad. The bitrot has gotta be removed – ideally sooner than later.
Expected behavior
...that Sphinx not import from
distutils. Work with me here, people.Your project
The problem is in Sphinx itself. Ain't no small project gonna help.
Screenshots
Let's be honest: nobody wants another screenshot of my puce monochrome CLI ViM setup. Nobody.
OS
Gentoo Linux, of course! O_o
Python version
3.10
Sphinx version
4.2.0
Sphinx extensions
Irrelevant.
Extra tools
Irrelevant.
Additional context
Irrelevant.