Mailman 3 April 2021 - docs

The time.sleep() Function Is Broken In Python 3.
by SERVER 09 Apr '21

09 Apr '21

I'm Reporting This Because I Can't Use The time.sleep() Function In Python 3. Can You Fix The Doc? It Says For Me To Use The time.sleep() Function, But Won't Work. Can You REALLY Fix The Doc?

2 1

[issue43778] [Doc] Doc/tools/extensions/glossary_search.py fails with FileNotFoundError if the _static/ directory doesn't exist
by STINNER Victor 08 Apr '21

08 Apr '21

New submission from STINNER Victor <vstinner(a)python.org>: Doc/tools/extensions/glossary_search.py failed multiple times on my doc PR: https://github.com/python/cpython/pull/25283 The fail is not deterministic (random error, timing issue?), it depends if the directory was already created by something else or not. Error on the Docs PR job of the Azure Pipeline: -------------- 2021-04-08T17:55:57.7774293Z writing output... [ 98%] whatsnew/3.5 2021-04-08T17:55:58.0531588Z writing output... [ 98%] whatsnew/3.6 2021-04-08T17:55:58.3085384Z writing output... [ 99%] whatsnew/3.7 2021-04-08T17:55:58.5638166Z writing output... [ 99%] whatsnew/3.8 2021-04-08T17:55:59.3385073Z writing output... [ 99%] whatsnew/3.9 2021-04-08T17:55:59.5205350Z writing output... [ 99%] whatsnew/changelog 2021-04-08T17:56:02.4282200Z writing output... [100%] whatsnew/index 2021-04-08T17:56:03.1454692Z 2021-04-08T17:56:03.1463636Z Writing glossary.json 2021-04-08T17:56:03.1466614Z 2021-04-08T17:56:03.1467473Z Exception occurred: 2021-04-08T17:56:03.3286028Z File "/home/vsts/work/1/s/Doc/tools/extensions/glossary_search.py", line 49, in on_build_finish 2021-04-08T17:56:03.3287379Z with open(path.join(app.outdir, '_static', 'glossary.json'), 'w') as f: 2021-04-08T17:56:03.3288351Z FileNotFoundError: [Errno 2] No such file or directory: '/home/vsts/work/1/s/Doc/build/html/_static/glossary.json' 2021-04-08T17:56:03.3294489Z The full traceback has been saved in /tmp/sphinx-err-1c8jemiu.log, if you want to report the issue to the developers. 2021-04-08T17:56:03.3295501Z Please also report this if it was a user error, so that a better error message can be provided next time. 2021-04-08T17:56:03.3296536Z A bug report can be filed in the tracker at <https://github.com/sphinx-doc/sphinx/issues>. Thanks! -------------- https://dev.azure.com/Python/cpython/_build/results?buildId=78035&view=resu… Error on Travis CI: -------------- PATH=./venv/bin:$PATH sphinx-build -b html -d build/doctrees -q -W -j4 -W . build/html Extension error: Handler <function on_build_finish at 0x7f6ed4c6abf8> for event 'build-finished' threw an exception (exception: [Errno 2] No such file or directory: '/home/travis/build/python/cpython/Doc/build/html/_static/glossary.json') Makefile:49: recipe for target 'build' failed -------------- https://travis-ci.com/github/python/cpython/jobs/497108477 Attached PR fix the extension: create the directory if it doesn't exists. ---------- assignee: docs@python components: Documentation messages: 390552 nosy: docs@python, vstinner priority: normal severity: normal status: open title: [Doc] Doc/tools/extensions/glossary_search.py fails with FileNotFoundError if the _static/ directory doesn't exist versions: Python 3.10 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue43778> _______________________________________

1 3

[issue43540] importlib: Document how to replace load_module() in What's New in Python 3.10
by STINNER Victor 08 Apr '21

08 Apr '21

New submission from STINNER Victor <vstinner(a)python.org>: The load_module() method of importlib loaders is deprecated which cause test failures in multiple projects. It is not easy to guess how to replace it. Examples: * pkg_resources fix adding create_module() and exec_module() methods: https://github.com/pypa/setuptools/commit/6ad2fb0b78d11e22672f56ef9d65d13eb… * pkg_resources fix replacing importlib.load_module() function call (not loader methods) with importlib.import_module(): https://github.com/pypa/setuptools/commit/a54d9e6b30c6da0542698144d2ff149ae… Cython uses this code: if sys.version_info[:2] < (3, 3): import imp def load_dynamic(name, module_path): return imp.load_dynamic(name, module_path) else: from importlib.machinery import ExtensionFileLoader def load_dynamic(name, module_path): return ExtensionFileLoader(name, module_path).load_module() Fixed Cython code: if sys.version_info < (3, 5): import imp def load_dynamic(name, module_path): return imp.load_dynamic(name, module_path) else: import importlib.util as _importlib_util def load_dynamic(name, module_path): spec = _importlib_util.spec_from_file_location(name, module_path) module = _importlib_util.module_from_spec(spec) # sys.modules[name] = module spec.loader.exec_module(module) return module ---------- assignee: docs@python components: Documentation, Library (Lib) messages: 389007 nosy: brett.cannon, docs@python, vstinner priority: normal severity: normal status: open title: importlib: Document how to replace load_module() in What's New in Python 3.10 versions: Python 3.10 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue43540> _______________________________________

4 6

[issue43737] Documentation of modulo operator should document behaviour clearly when second operator is negative
by Raymond Hettinger 08 Apr '21

08 Apr '21

Raymond Hettinger <raymond.hettinger(a)gmail.com> added the comment: I agree with Steven that minor fact should not be given more weight. It has a specification in the Reference and it own FAQ entry. IMO it doesn't belong in tutorial because having a negative modulus is rare and because burying the use in details makes the tutorial harder to read. The intent of the tutorial is to have a structured, example driven, overview of the language. It necessarily omits uncommon cases and detailed specifications. Thanks for the suggestion, but I am going to close this one as Steven suggested. ---------- resolution: -> not a bug stage: patch review -> resolved status: open -> closed _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue43737> _______________________________________

1 0

[issue43737] Documentation of modulo operator should document behaviour clearly when second operator is negative
by Anthony Flury 08 Apr '21

08 Apr '21

Change by Anthony Flury <anthony.flury(a)btinternet.com>: ---------- assignee: -> docs@python components: +Documentation nosy: +docs@python _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue43737> _______________________________________

1 0

[issue43087] ctypes documentation error
by Terry J. Reedy 08 Apr '21

08 Apr '21

Change by Terry J. Reedy <tjreedy(a)udel.edu>: ---------- resolution: -> fixed stage: patch review -> resolved status: open -> closed _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue43087> _______________________________________

1 0

[issue43087] ctypes documentation error
by Terry J. Reedy 08 Apr '21

08 Apr '21

Terry J. Reedy <tjreedy(a)udel.edu> added the comment: New changeset 754dc353565eeb4a43a912417cc5b66959458f1b by Miss Islington (bot) in branch '3.8': [3.8] bpo-43087: Fix error in ctypes "Incomplete Types" doc (GH-24404) https://github.com/python/cpython/commit/754dc353565eeb4a43a912417cc5b66959… ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue43087> _______________________________________

1 0

[issue43087] ctypes documentation error
by Terry J. Reedy 08 Apr '21

08 Apr '21

Terry J. Reedy <tjreedy(a)udel.edu> added the comment: New changeset 5490b49fa6646c9f48869955c12cf6af9fc3f2a4 by Miss Islington (bot) in branch '3.9': [3.9] bpo-43087: Fix error in ctypes "Incomplete Types" doc (GH-24404) https://github.com/python/cpython/commit/5490b49fa6646c9f48869955c12cf6af9f… ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue43087> _______________________________________

1 0

[issue43340] json.load() can raise UnicodeDecodeError, but this is not documented
by Raymond Hettinger 08 Apr '21

08 Apr '21

Change by Raymond Hettinger <raymond.hettinger(a)gmail.com>: ---------- assignee: rhettinger -> _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue43340> _______________________________________

1 0

[issue42999] `pathlib.Path.link_to()` documentation is misleading
by Barney Gale 07 Apr '21

07 Apr '21

New submission from Barney Gale <barney.gale(a)gmail.com>: Compare the documentation of `symlink_to()` and `link_to()`: .. method:: Path.symlink_to(target, target_is_directory=False) Make this path a symbolic link to *target*. .. method:: Path.link_to(target) Create a hard link pointing to a path named *target*. In fact, `link_to()` does something like: Make *target* a hard link to this path. Which is unexpected given the naming and inconsistency with `symlink_to()`, but it's the way the current implementation works, and so the documentation should reflect that. Adding a replacement `hardlink_to()` function is covered here in bpo-39950. ---------- assignee: docs@python components: Documentation messages: 385474 nosy: barneygale, docs@python priority: normal severity: normal status: open title: `pathlib.Path.link_to()` documentation is misleading type: behavior _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue42999> _______________________________________

3 9