Mailman 3 August 2013 - docs

[issue18827] mistake in the timedelta.total_seconds docstring
by Alexander Schier Aug. 24, 2013

Aug. 24, 2013

New submission from Alexander Schier: > Return the total number of seconds contained in the duration. Equivalent to (td.microseconds + (td.seconds + td.days * 24 * 3600) * 10**6) / 10**6 computed with true division enabled. Should be > Return the total number of seconds contained in the duration. Equivalent to (td.microseconds / 10**6 + (td.seconds + td.days * 24 * 3600) * 10**6) computed with true division enabled. At least i hope, the bug is only in the docs and not in the function ;). ---------- assignee: docs@python components: Documentation messages: 196100 nosy: allo, docs@python priority: normal severity: normal status: open title: mistake in the timedelta.total_seconds docstring type: behavior versions: Python 2.7 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue18827> _______________________________________

2 2

[issue14191] argparse doesn't allow optionals within positionals
by Martin Panter Aug. 24, 2013

Aug. 24, 2013

Martin Panter added the comment: It sounds like this bug might cover Issue 15112, which is only concerned with options between different positional parameters. ---------- nosy: +vadmium _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue14191> _______________________________________

1 0

[issue15125] argparse: positional arguments containing - in name not handled well
by Martin Panter Aug. 24, 2013

Aug. 24, 2013

Changes by Martin Panter <vadmium+py(a)gmail.com>: ---------- nosy: +vadmium _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue15125> _______________________________________

1 0

[issue18757] Fix internal references for concurrent modules
by Serhiy Storchaka Aug. 23, 2013

Aug. 23, 2013

New submission from Serhiy Storchaka: Here is a patch which fixes internal references in the documentation of concurrent modules: threading, multiprocessing, concurrent.futures, subprocess, queue, and select. ---------- assignee: docs@python components: Documentation messages: 195378 nosy: bquinlan, docs@python, jnoller, pitrou, rhettinger, sbt, serhiy.storchaka priority: normal severity: normal stage: patch review status: open title: Fix internal references for concurrent modules versions: Python 2.7, Python 3.3, Python 3.4 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue18757> _______________________________________

3 6

Fix more typos in .py files (issue 18803)
by ezio.melotti＠gmail.com Aug. 23, 2013

Aug. 23, 2013

http://bugs.python.org/review/18803/diff/9027/Lib/inspect.py File Lib/inspect.py (right): http://bugs.python.org/review/18803/diff/9027/Lib/inspect.py#newcode50 Lib/inspect.py:50: # back to hard-coding so the dependency is optional Apparently the "hardcoding" spelling is accepted too (and I prefer it). http://bugs.python.org/review/18803/

1 0

[issue18796] Wrong documentation of show_code function from dis module
by Vajrasky Kok Aug. 23, 2013

Aug. 23, 2013

New submission from Vajrasky Kok: $ ./python Python 3.4.0a1+ (default:afb1b4797419, Aug 21 2013, 09:54:46) [GCC 4.7.2] on linux Type "help", "copyright", "credits" or "license" for more information. >>> import dis >>> import sys >>> def spam(x): ... return x * 2 ... >>> dis.show_code(spam, file=sys.stderr) Name: spam Filename: <stdin> Argument count: 1 Kw-only arguments: 0 Number of locals: 1 Stack size: 2 Flags: OPTIMIZED, NEWLOCALS, NOFREE Constants: 0: None 1: 2 Variable names: 0: x >>> output = open('/tmp/output.txt', 'w') >>> dis.show_code(spam, file=output) >>> output.close() >>> dis.show_code.__doc__ 'Print details of methods, functions, or code to stdout.' Attached the patch to fix the documentation. ---------- assignee: docs@python components: Documentation files: fix_doc_show_code.patch keywords: patch messages: 195742 nosy: docs@python, vajrasky priority: normal severity: normal status: open title: Wrong documentation of show_code function from dis module versions: Python 3.4 Added file: http://bugs.python.org/file31392/fix_doc_show_code.patch _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue18796> _______________________________________

3 2

[issue18713] Clearly document the use of PYTHONIOENCODING to set surrogateescape
by Serhiy Storchaka Aug. 23, 2013

Aug. 23, 2013

Serhiy Storchaka added the comment: With new subject this issue looks as a duplicate of (or tightly related to) issue12832. ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue18713> _______________________________________

1 0

[issue18713] Clearly document the use of PYTHONIOENCODING to set surrogateescape
by Serhiy Storchaka Aug. 23, 2013

Aug. 23, 2013

Changes by Serhiy Storchaka <storchaka(a)gmail.com>: ---------- dependencies: +Empty PYTHONIOENCODING is not the same as nonexistent _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue18713> _______________________________________

1 0

[issue18713] Clearly document the use of PYTHONIOENCODING to set surrogateescape
by Nick Coghlan Aug. 23, 2013

Aug. 23, 2013

Nick Coghlan added the comment: Note: I created issue 18814 to cover some additional tools for working with surrogate escaped strings. For this issue, we currently have http://docs.python.org/3/howto/unicode.html, which aims to be a more comprehensive guide to understanding Unicode issues. I'm thinking we may want a "Debugging Unicode Errors" document, which defers to the existing howto guide for those that really want to understand Unicode, and instead focuses on quick fixes for resolving various problems that may present themselves. Application developers will likely want to read the longer guide, while the debugging document would be aimed at getting script writers past their immediate hurdle, without necessarily gaining a full understanding of Unicode. The would be for this page to become the top hit for "python surrogates not allowed", rather than the current top hit, which is a rejected bug report about it (http://bugs.python.org/issue13717). For example: ================================ What is the meaning of "UnicodeEncodeError: surrogates not allowed"? -------------------------------------------------------------------- Operating system metadata on POSIX based systems like Linux and Mac OS X may include improperly encoded text values. To cope with this, Python uses the "surrogateescape" error handler to store those arbitrary bytes inside a Unicode object. When converted back to bytes using the same encoding and error handler, the original byte sequence is reproduced exactly. This allows operations like opening a file based on a directory listing to work correctly, even when the metadata is not properly encoded according to the system settings. The "surrogates not allowed" error appears when a string from one of these operating system interfaces contains an embedded arbitrary byte sequence, but an attempt is made to encode it using the default "strict" error handler rather than the "surrogateescape" handler. This commonly occurs when printing improperly encoded operating system data to the console, or writing it to a file, database or other serialised interface. The ``PYTHONIOENCODING`` environment variable can be used to ensure operating system metadata can always be read via sys.stdin and written via sys.stdout. The following command will display the encoding Python will use by default to interact with the operating system:: $ python3 -c "import sys; print(sys.getfilesystemencoding())" utf-8 This can then be used to specify an appropriate setting for ``PYTHONIOENCODING``:: $ export PYTHONIOENCODING=utf-8:surrogateescape For other interfaces, there is no such general solution. If allowing the invalid byte sequence to propagate further is acceptable, then enabling the surrogateescape handler may be appropriate. Alternatively, it may be better to track these corrupted strings back to their point of origin, and either fix the underlying metadata, or else filter them out early on. ================================ If issue 18814 is implemented, then it could point to those tools. Similarly, issue 15216 could be referenced if that is implemented. ---------- assignee: -> docs@python components: +Documentation nosy: +docs@python title: Enable surrogateescape on stdin and stdout when appropriate -> Clearly document the use of PYTHONIOENCODING to set surrogateescape _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue18713> _______________________________________

1 0

[issue15233] atexit: guarantee order of execution of registered functions?
by Georg Brandl Aug. 21, 2013

Aug. 21, 2013

New submission from Georg Brandl <georg(a)python.org>: Currently, the atexit docs state "The order in which the functions are called is not defined" in the introduction and "all functions registered are called in last in, first out order" in the docs of the atexit() function. While the latter is correct, I don't think we should guarantee that behaviour by documenting it. Suggestions? ---------- assignee: docs@python components: Documentation messages: 164454 nosy: docs@python, georg.brandl, loewis, pitrou priority: normal severity: normal status: open title: atexit: guarantee order of execution of registered functions? versions: Python 2.7, Python 3.2, Python 3.3 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue15233> _______________________________________

8 23