[docs] [issue34895] Mark optional stdlib modules in documentation

[Marcus]

Marcus <of4tvziy at online.de> added the comment:

My concern is that certain missing build-time dependencies do not stop the build but trigger an easy to miss message at the end of the build stage (only). Also the end user doesn't get to see this. At the same time these modules are sort of expected to be part of a complete Python distribution.

Two issues I see with this: 1. By omission, the distributor might inadvertently create an incomplete distribution. 2. The enduser, running a script (possibly created elsewhere) receives a standard “ModuleNotFoundError” and is left in the dark about its origin as the documentation seems to confirm that the affected module ought to be available.

$ grep -F missing.append setup.py
             missing.append('spwd')
             missing.append('readline')
             missing.append('_ssl')
             missing.append('_hashlib')
             missing.append('_sqlite3')
                 missing.append('_dbm')
             missing.append('_gdbm')
             missing.append('nis')
             missing.append('_curses')
             missing.append('_curses_panel')
                     missing.append('zlib')
                 missing.append('zlib')
             missing.append('zlib')
             missing.append('_bz2')
             missing.append('_lzma')
             missing.append('_elementtree')
             missing.append('ossaudiodev')
             missing.append('_tkinter')
             missing.append('_uuid')

All modules in the above list are potentially affected, although some (ossaudiodev, nis) might be considered platform specific. Arguably availablility some of these modules could be perhaps turned into build-time requirements with opt-out mechanics.

In any case a hint to the end user debugging such issues would be rather helpful and a big timesaver (see initial report).

----------

_______________________________________
Python tracker <report at bugs.python.org>
<https://bugs.python.org/issue34895>
_______________________________________