Mailman 3 June 2018 - docs

[issue27910] Doc/library/traceback.rst — references to tuples should be replaced with new FrameSummary object
by Tomas Orsava Aug. 2, 2018

Aug. 2, 2018

New submission from Tomas Orsava: In the documentation for the `traceback` module, the definitions of functions `extract_tb` [0], `format_list` [1] and classmethod `from_list` [2] mention the old style (4-)tuples that these functions used to return or accept. Since Python 3.5, however, they return or accept a FrameSummary object instead of the 4-tuple, or a StackSummary object instead of a list of 4-tuples. I'm including a patch that fixes these definitions to make them reflect the new reality. [0] https://docs.python.org/3.6/library/traceback.html#traceback.extract_tb [1] https://docs.python.org/3.6/library/traceback.html#traceback.format_list [2] https://docs.python.org/3.6/library/traceback.html#traceback.StackSummary.f… ---------- assignee: docs@python components: Documentation files: traceback-doc.patch keywords: patch messages: 274010 nosy: docs@python, torsava priority: normal severity: normal status: open title: Doc/library/traceback.rst — references to tuples should be replaced with new FrameSummary object versions: Python 3.5, Python 3.6 Added file: http://bugs.python.org/file44293/traceback-doc.patch _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue27910> _______________________________________

7 16

[issue30984] traceback.print_exc return value documentation
by Jelle Zijlstra Aug. 2, 2018

Aug. 2, 2018

New submission from Jelle Zijlstra: The documentation for traceback.format_tb says "Return a list of “pre-processed” stack trace entries extracted from the traceback object tb. It is useful for alternate formatting of stack traces. The optional limit argument has the same meaning as for print_tb(). A “pre-processed” stack trace entry is a 4-tuple (filename, line number, function name, text) representing the information that is usually printed for a stack trace." However, as of 3.5 it actually returns a StackSummary object, which is a subclass of list and contains FrameSummary objects. FrameSummary objects are not tuples. The documentation is accurate for 3.4 and earlier. I'm surprised this change was made because it seems like a compatibility break, but it's too late to do something about that now. The documentation should be changed to correct the return value and add a "versionchanged: 3.5" note. ---------- assignee: docs@python components: Documentation messages: 298807 nosy: Jelle Zijlstra, docs@python priority: normal severity: normal status: open title: traceback.print_exc return value documentation versions: Python 3.6, Python 3.7 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue30984> _______________________________________

2 1

[issue27671] FAQ: len() is still function for good reason.
by INADA Naoki July 31, 2018

July 31, 2018

New submission from INADA Naoki: https://docs.python.org/3/faq/design.html#why-does-python-use-methods-for-s… > The major reason is history. ... > but it’s a part of Python, and it’s too late to make such fundamental changes now. The functions have to remain to avoid massive code breakage. People seeing this answer may think "it's bad design, but remains for historical reason." But there is more positive reason why len is still function. http://effbot.org/pyfaq/why-does-python-use-methods-for-some-functionality-… ---------- assignee: docs@python components: Documentation messages: 271881 nosy: docs@python, methane priority: normal severity: normal status: open title: FAQ: len() is still function for good reason. _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue27671> _______________________________________

4 12

[issue33666] os.errno gone AWOL
by Miro Hrončok July 29, 2018

July 29, 2018

New submission from Miro Hrončok <miro(a)hroncok.cz>: In 3.7.0b4 I see the following traceback: >>> import os >>> os.errno Traceback (most recent call last): File "<stdin>", line 1, in <module> AttributeError: module 'os' has no attribute 'errno' This was not the case for Python 3.6: >>> import os >>> os.errno <module 'errno' (built-in)> os.errno might not have been documented, however there are projects out there that use it: https://github.com/intel/bmap-tools/issues/34 https://bugzilla.redhat.com/show_bug.cgi?id=1583196 So I suggest the removal of os.errno is something worth documenting at https://docs.python.org/3.7/whatsnew/3.7.html The root of the change is in https://github.com/python/cpython/pull/1269/files#diff-405b29928f2a3ae216e4… ---------- assignee: docs@python components: Documentation, Library (Lib) messages: 317847 nosy: docs@python, hroncok priority: normal severity: normal status: open title: os.errno gone AWOL type: behavior versions: Python 3.7, Python 3.8 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue33666> _______________________________________

6 22

[issue29710] Incorrect representation caveat on bitwise operation docs
by Nick Coghlan July 28, 2018

July 28, 2018

New submission from Nick Coghlan: The docs on bitwise operations at https://docs.python.org/3/library/stdtypes.html#bitwise-operations-on-integ… include the caveated sentence: Negative numbers are treated as their 2’s complement value (this assumes that there are enough bits so that no overflow occurs during the operation). This sentence isn't correct now that integers are always arbitrary length. The bitwise inversion will never overflow, and is instead calculated as "-(n+1)" rather than literally flipping bits in the representation: https://docs.python.org/3/reference/expressions.html#unary-arithmetic-and-b… ---------- assignee: docs@python components: Documentation messages: 288890 nosy: docs@python, ncoghlan priority: normal severity: normal stage: needs patch status: open title: Incorrect representation caveat on bitwise operation docs type: enhancement versions: Python 3.5, Python 3.6, Python 3.7 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue29710> _______________________________________

7 35

[issue24356] venv documentation incorrect / misleading
by Graham Oliver July 28, 2018

July 28, 2018

New submission from Graham Oliver: See my question here https://groups.google.com/forum/#!topic/comp.lang.python/BUmyc_hzAsA In particular Carl Meyer's response https://groups.google.com/d/msg/comp.lang.python/BUmyc_hzAsA/-cT-N-g_LL4J I am not sure what is possible with venv but I would suggest that the statement 'allowing creation of environments with various Python versions' needs to be clarified and / or altered. Thanks Graham ---------- assignee: docs@python components: Documentation messages: 244618 nosy: Graham.Oliver, docs@python priority: normal severity: normal status: open title: venv documentation incorrect / misleading versions: Python 3.3 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue24356> _______________________________________

8 15

[issue32769] Add 'annotations' to the glossary
by Stéphane Wirtel July 28, 2018

July 28, 2018

New submission from Stéphane Wirtel <stephane(a)wirtel.be>: There is a description of the annotation in the Glossary, but with 'function annotation' maybe we could rename 'function annotation' by 'annotation' ---------- nosy: +matrixise _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue32769> _______________________________________

8 39

[issue33921] Explain that '' can be used to bind to all interfaces for the AF_INET address family in the docs
by John Hagen July 28, 2018

July 28, 2018

New submission from John Hagen <johnthagen(a)gmail.com>: The socket documentation (https://docs.python.org/3/library/socket.html#socket-families) does not list '' as a way to bind to all interfaces for the AF_INET/AF_INET6 address family. This is answered on SO here: https://stackoverflow.com/a/8034146 but it took me a while to find it. Ideally if this was mentioned in the docs, that would be great. ---------- assignee: docs@python components: Documentation messages: 320125 nosy: John Hagen, docs@python priority: normal severity: normal status: open title: Explain that '' can be used to bind to all interfaces for the AF_INET address family in the docs type: enhancement versions: Python 3.5, Python 3.6, Python 3.7, Python 3.8 _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue33921> _______________________________________

7 10

[issue27717] sqlite documentation bug
by Eyal Mor July 27, 2018

July 27, 2018

New submission from Eyal Mor: In the SQlite module documentation there a code section showing how to securely use the sqlite.execute method. The problem with this code section is that just from a glance, without reading the paragraph before, or the comments in the section, users could use the insecure version. It would be better if only a secure example would be in the code section. https://docs.python.org/2/library/sqlite3.html Section: # Never do this -- insecure! symbol = 'RHAT' c.execute("SELECT * FROM stocks WHERE symbol = '%s'" % symbol) # Do this instead t = ('RHAT',) c.execute('SELECT * FROM stocks WHERE symbol=?', t) print c.fetchone() # Larger example that inserts many records at a time purchases = [('2006-03-28', 'BUY', 'IBM', 1000, 45.00), ('2006-04-05', 'BUY', 'MSFT', 1000, 72.00), ('2006-04-06', 'SELL', 'IBM', 500, 53.00), ] c.executemany('INSERT INTO stocks VALUES (?,?,?,?,?)', purchases) ---------- assignee: docs@python components: Documentation files: Screen Shot 2016-08-09 at 3.28.05 PM.png messages: 272238 nosy: Eyal Mor, docs@python priority: normal severity: normal status: open title: sqlite documentation bug type: security versions: Python 2.7, Python 3.2, Python 3.3, Python 3.4, Python 3.5, Python 3.6 Added file: http://bugs.python.org/file44056/Screen Shot 2016-08-09 at 3.28.05 PM.png _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue27717> _______________________________________

3 3

[issue12743] C API marshalling doc contains XXX
by JJeffries July 27, 2018

July 27, 2018

New submission from JJeffries <jamesjeffries1(a)gmail.com>: The Python C API manual page for data marshaling contains the following paragraph. XXX What about error detection? It appears that reading past the end of the file will always result in a negative numeric value (where that’s relevant), but it’s not clear that negative values won’t be handled properly when there’s no error. What’s the right way to tell? Should only non-negative values be written using these routines? I suggest that the XXX should be removed as it is unclear why it's there. Patch to follow in the next couple of days if others agree. ---------- assignee: docs@python components: Documentation messages: 141959 nosy: JJeffries, docs@python priority: normal severity: normal status: open title: C API marshalling doc contains XXX _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue12743> _______________________________________

7 13