Mailman 3 November 2015 - docs

[issue12946] PyModule_GetDict() claims it can never fail, but it can
by Stefan Behnel 19 Aug '16

19 Aug '16

New submission from Stefan Behnel <scoder(a)users.sourceforge.net>: As is obvious from the code, PyModule_GetDict() can fail if being passed a non-module object, and when the (unlikely) dict creation at the end fails. The documentation of the C-API function should be fixed to reflect that, i.e. it should state that NULL is returned in the case of an error. PyObject * PyModule_GetDict(PyObject *m) { PyObject *d; if (!PyModule_Check(m)) { PyErr_BadInternalCall(); return NULL; } d = ((PyModuleObject *)m) -> md_dict; if (d == NULL) ((PyModuleObject *)m) -> md_dict = d = PyDict_New(); return d; } ---------- assignee: docs@python components: Documentation messages: 143764 nosy: docs@python, scoder priority: normal severity: normal status: open title: PyModule_GetDict() claims it can never fail, but it can type: behavior versions: Python 2.6, Python 2.7, Python 3.1, Python 3.2, Python 3.3 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue12946> _______________________________________

7 11

[issue24637] locals dictionary in PyRun_String
by Matthew Keeter 13 Aug '16

13 Aug '16

New submission from Matthew Keeter: The C API docs for PyRun_StringFlags, PyEval_EvalCodeEx, and PyEval_EvalCode say that globals and locals both must be dictionaries. However, digging into the source [1] shows that locals can be any object implementing the mapping protocol. Furthermore, the Python docs for eval and exec (which end up taking the same path) match the implementation, saying that locals can be any mapping object (which has been true since 2.4). The attached patch changes the C API docs to reflect the Python docs (and the actual implementation). No new tests are required, as test_general_eval [2] already checks that an arbitrary mapping object can be used as the locals variable in exec. [1] https://github.com/python/cpython/blob/master/Objects/frameobject.c#L628-L6… [2] https://github.com/python/cpython/blob/master/Lib/test/test_builtin.py#L473 ---------- assignee: docs@python components: Documentation files: locals.patch keywords: patch messages: 246761 nosy: Matthew Keeter, docs@python priority: normal severity: normal status: open title: locals dictionary in PyRun_String type: enhancement 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/file39929/locals.patch _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue24637> _______________________________________

4 4

[issue23322] parser module docs missing second example
by Devin Jeanpierre 08 Aug '16

08 Aug '16

New submission from Devin Jeanpierre: The port to reST missed the second example: https://docs.python.org/release/2.5/lib/node867.html This is still referred to in the docs, so it is not deliberate. For example, the token module docs say "The second example for the parser module shows how to use the symbol module": https://docs.python.org/3.5/library/token.html#module-token There is no second example, nor any use of the symbol module, in the docs: https://docs.python.org/3.5/library/parser.html ---------- assignee: docs@python components: Documentation messages: 234716 nosy: Devin Jeanpierre, docs@python priority: normal severity: normal status: open title: parser module docs missing second example versions: Python 2.7, Python 3.2, Python 3.3, Python 3.4, Python 3.5 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue23322> _______________________________________

5 7

[issue24278] Docs on Parsing arguments should say something about mem mgmt for formatters returning C strings
by Martin Blais 07 Aug '16

07 Aug '16

New submission from Martin Blais: Functions that parse arguments like PyArg_ParseTupleAndKeywords() have several formatters that fill in C strings, e.g. "s". In the C API doc: https://docs.python.org/3.5/c-api/arg.html#c.PyArg_ParseTupleAndKeywords There should be an explicit mention of whether this memory needs to be free (in this case: No) and if not, how this memory is managed (in this case: This refers to a buffer managed by the string object itself). Because of questions of encoding, it raises questions where this memory lies, and what its lifetime is (in this case: That of the owning string object from the caller). This deserves an explicit mention, even if brief. ---------- assignee: docs@python components: Documentation messages: 243987 nosy: blais, docs@python priority: normal severity: normal status: open title: Docs on Parsing arguments should say something about mem mgmt for formatters returning C strings _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue24278> _______________________________________

4 12

[issue24626] please sync cgi.parse document
by hiroaki itoh 06 Aug '16

06 Aug '16

New submission from hiroaki itoh: https://docs.python.org/2/library/cgi.html#cgi.parse (the file defaults to ``sys.stdin`` and environment defaults to ``os.environ``) https://docs.python.org/3/library/cgi.html#cgi.parse (the file defaults to ``sys.stdin``) maby this fix had applied only to python2 branch, so please update to py3 also. ---------- assignee: docs@python components: Documentation messages: 246680 nosy: docs@python, xwhhsprings priority: normal severity: normal status: open title: please sync cgi.parse document type: behavior versions: Python 3.4 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue24626> _______________________________________

2 2

[issue23542] Update PEP 476 for using urllib2.build_opener()
by Shakeel Mohamed 06 Aug '16

06 Aug '16

New submission from Shakeel Mohamed: In the "Opting Out" section of PEP 476, there's a workaround for disabling SSL cert verification. I think it would be worth updating the section to include the following workaround when using urllib2.build_opener(), like so: unverified_ssl_handler = urllib2.HTTPSHandler(context=ssl._create_unverified_context()) opener = urllib2.build_opener(unverified_ssl_handler) ---------- assignee: docs@python components: Documentation messages: 236835 nosy: Shakeel Mohamed, docs@python priority: normal severity: normal status: open title: Update PEP 476 for using urllib2.build_opener() versions: Python 2.7 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue23542> _______________________________________

2 3

[issue18548] In unittest doc change WidgetTestCase to SimpleWidgetTestCase in suite()
by py.user 06 Aug '16

06 Aug '16

New submission from py.user: http://docs.python.org/3/library/unittest.html#organizing-test-code """ def suite(): suite = unittest.TestSuite() suite.addTest(WidgetTestCase('test_default_size')) suite.addTest(WidgetTestCase('test_resize')) return suite """ ---------- assignee: docs@python components: Documentation files: issue.diff keywords: patch messages: 193667 nosy: docs@python, py.user priority: normal severity: normal status: open title: In unittest doc change WidgetTestCase to SimpleWidgetTestCase in suite() type: enhancement versions: Python 3.4 Added file: http://bugs.python.org/file31029/issue.diff _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue18548> _______________________________________

5 4

[issue15639] csv.Error description is incorrectly broad
by Xavier Morel 06 Aug '16

06 Aug '16

New submission from Xavier Morel: In both Python 2.7 and Python 3.x, csv.Error is documented as: Raised by any of the functions when an error is detected. As far as I can tell from using the module and looking at the code, this is completely incorrect. There is actually a single instance of csv.Error being used: the instantiation of csv.Dialect (which converts TypeError raised from _csv._Dialect() into csv.Error, a comment notes that this is "for compatibility with py 2.3"). And the only way to hit that code paths seems to be subclassing `Dialect` and putting incorrect values in the various attributes (providing them to `csv.reader` raises a TypeError). I believe the documentation to csv.Error should be changed to: 1. Mark it as effectively deprecated 2. Indicate that the only situation in which it it may be raised is when initializing a subclass of csv.Dialect ---------- assignee: docs@python components: Documentation messages: 168096 nosy: docs@python, xmorel priority: normal severity: normal status: open title: csv.Error description is incorrectly broad versions: Python 2.7, Python 3.3 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue15639> _______________________________________

2 2

[issue14594] document imp.load_dynamic()
by Stefan Behnel 06 Aug '16

06 Aug '16

New submission from Stefan Behnel <scoder(a)users.sourceforge.net>: The imp.load_dynamic() function is used by third party code (e.g. Cython's pyximport) but is not currently documented. http://docs.python.org/dev/library/imp.html The latest changes to the import mechanism suggest that it should better be documented to give a hint that users can rely on it. ---------- assignee: docs@python components: Documentation messages: 158412 nosy: docs@python, scoder priority: normal severity: normal status: open title: document imp.load_dynamic() type: behavior versions: Python 2.6, Python 2.7, Python 3.1, Python 3.2, Python 3.3 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue14594> _______________________________________

6 6

[issue24082] Obsolete note in argument parsing (c-api/arg.rst)
by Petr Viktorin 04 Aug '16

04 Aug '16

New submission from Petr Viktorin: A note in the docs for the "u" format unit saus NULs are not allowed, but the previous sentence says they aren't accepted. ---------- assignee: docs@python components: Documentation files: 0002-Remove-obsolete-note-in-argument-parsing-docs.patch keywords: patch messages: 242271 nosy: docs@python, encukou priority: normal severity: normal status: open title: Obsolete note in argument parsing (c-api/arg.rst) versions: Python 3.4 Added file: http://bugs.python.org/file39236/0002-Remove-obsolete-note-in-argument-pars… _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue24082> _______________________________________

5 5