Mailman 3 March 2015 - docs

[issue23432] Duplicate content in SystemExit documentation
by Berker Peksag March 10, 2015

March 10, 2015

New submission from Berker Peksag: >From https://docs.python.org/3/library/exceptions.html#SystemExit Also, this exception derives directly from BaseException and not Exception, since it is not technically an error. and The exception inherits from BaseException instead of Exception so that it is not accidentally caught by code that catches Exception. This allows the exception to properly propagate up and cause the interpreter to exit. Here is a patch to remove the duplicate content and document the code attribute properly. ---------- assignee: docs@python components: Documentation files: systemexit.diff keywords: patch messages: 235684 nosy: berker.peksag, docs@python priority: normal severity: normal stage: patch review status: open title: Duplicate content in SystemExit documentation versions: Python 3.4, Python 3.5 Added file: http://bugs.python.org/file38082/systemexit.diff _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue23432> _______________________________________

3 7

Omission of namespace parameter to etree.findall(..) etc.
by Sergeev Evgeni March 10, 2015

March 10, 2015

On this page: https://docs.python.org/2/library/xml.etree.elementtree.html#xml.etree.Elem… See the discussion here: http://stackoverflow.com/a/14853417/1143274 These extra arguments should really be documented, as they are quite important for painless parsing where namespaces are involved. Regards, Evgeni P.S. I met this issue because I couldn't find the tag within . It turned out that I have to delve into XML namespaces, and the most straightforward approach to write readable code turned out to be via the undocumented etree_instance.findall('svg:g', nss) calls, where nss is a dictionary of namespaces like {'svg': 'http://www.w3.org/2000/svg'}. By the way, it would be nice for it to support something like {'': 'http://www.w3.org/2000/svg'} to indicate the default namespace... P.S.S. I was about to submit a report to the bugtracker, but it turned out that my email address would have been visible to all logged-in users. Obviously, this is accessible to robots who can get a Google OpenID and log in automatically. Therefore, I'm sending this report from my spamfest email account. The point is: this arrangement scares off spam-averse users like me from submitting bug reports.

1 0

[issue23613] searchindex.js is annoying
by Antoine Pitrou March 9, 2015

March 9, 2015

New submission from Antoine Pitrou: Since I get hit by this at least once a week, I thought I'd finally report a bug. The Doc/build/html/searchindex.js file is extremely annoying when grepping through the source tree (and especially when grepping in the docs), because it's very likely to match your search *and* it seems made of a huge single line of text, meaning the grep output now fills your terminal with junk. ---------- assignee: docs@python components: Documentation messages: 237557 nosy: docs@python, pitrou priority: normal severity: normal status: open title: searchindex.js is annoying type: behavior versions: Python 3.4, Python 3.5 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue23613> _______________________________________

6 10

Question
by Angela Grima March 9, 2015

March 9, 2015

Hello, \ I am a beginner at Python and I am trying to write a program that allows me to read in a list of decimal numerals, assign a grade to each one, and write each one with the corresponding grade. Unfortunately, it Python thinks that each score is a string but does not allow me to convert it to a floating point. I have tried different statements using Python but I am still stuck. Attached are a copy of the program, data being used. Below is the printed output. Microsoft Windows [Version 6.1.7601] Copyright (c) 2009 Microsoft Corporation. All rights reserved. C:\Users\Ange\Documents\Computer Science\Python Class>docbright.py Score Grade Traceback (most recent call last): File "C:\Users\Ange\Documents\Computer Science\Python Class\docbright.py", lin e 18, in <module> x = float(x) + .005 ValueError: could not convert string to float:ss> Your help is appreciated. Angela Grima

1 2

[issue23617] Incorrect plural "includes" on Python Standard Library front page
by Kentrell Johnson March 9, 2015

March 9, 2015

New submission from Kentrell Johnson: "The Python installers for the Windows platform usually includes" should be "The Python installers for the Windows platform usually include" ---------- assignee: docs@python components: Documentation messages: 237598 nosy: docs@python, kentrell.johnson priority: normal severity: normal status: open title: Incorrect plural "includes" on Python Standard Library front page type: enhancement versions: Python 2.7, Python 3.4 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue23617> _______________________________________

3 2

Re: [docs] Python 3 crc32 documentation clarifications (issue 22341)
by vadmium+py＠gmail.com March 9, 2015

March 9, 2015

Reviewers: storchaka, https://bugs.python.org/review/22341/diff/13462/Doc/library/binascii.rst File Doc/library/binascii.rst (right): https://bugs.python.org/review/22341/diff/13462/Doc/library/binascii.rst#ne… Doc/library/binascii.rst:125: the given *crc*. The default initial value is zero. The algorithm On 2015/02/28 13:02:25, storchaka wrote: > May be just write the signature as crc32(data, crc=0) and drop the sentence > about the default value? I hesitate to do this because all these functions do not accept keyword arguments, and writing crc32(.., crc=0) implies (at least to me) that it may be a keyword argument. The square brackets imply positional-only parameters in my mind. Is there any style guide or precedence on how to do this better (e.g. devguide)? I couldn’t find anything obvious. Please review this at https://bugs.python.org/review/22341/ Affected files: Doc/library/binascii.rst Doc/library/zlib.rst # HG changeset patch # Parent 3de678cd184d943f53e9bc0e74feefaa07cc7f55 Issue #22341: Drop Python 2 workaround and document CRC initial value diff -r 3de678cd184d -r 8a48ec8372c2 Doc/library/binascii.rst --- a/Doc/library/binascii.rst Thu Dec 18 23:47:55 2014 +0100 +++ b/Doc/library/binascii.rst Fri Dec 19 05:02:33 2014 +0000 @@ -121,24 +121,18 @@ .. function:: crc32(data[, crc]) - Compute CRC-32, the 32-bit checksum of data, starting with an initial crc. This + Compute CRC-32, the 32-bit checksum of *data*, starting with + the given *crc*. The default initial value is zero. The algorithm is consistent with the ZIP file checksum. Since the algorithm is designed for use as a checksum algorithm, it is not suitable for use as a general hash algorithm. Use as follows:: print(binascii.crc32(b"hello world")) # Or, in two pieces: - crc = binascii.crc32(b"hello") - crc = binascii.crc32(b" world", crc) & 0xffffffff + crc = binascii.crc32(b"hello", 0) + crc = binascii.crc32(b" world", crc) print('crc32 = {:#010x}'.format(crc)) -.. note:: - To generate the same numeric value across all Python versions and - platforms use crc32(data) & 0xffffffff. If you are only using - the checksum in packed binary format this is not necessary as the - return value is the correct 32bit binary representation - regardless of sign. - .. function:: b2a_hex(data) hexlify(data) diff -r 3de678cd184d -r 8a48ec8372c2 Doc/library/zlib.rst --- a/Doc/library/zlib.rst Thu Dec 18 23:47:55 2014 +0100 +++ b/Doc/library/zlib.rst Fri Dec 19 05:02:33 2014 +0000 @@ -30,10 +30,11 @@ .. function:: adler32(data[, value]) - Computes a Adler-32 checksum of *data*. (An Adler-32 checksum is almost as - reliable as a CRC32 but can be computed much more quickly.) If *value* is - present, it is used as the starting value of the checksum; otherwise, a fixed - default value is used. This allows computing a running checksum over the + Computes an Adler-32 checksum of *data*. (An Adler-32 checksum is + almost as reliable as a CRC32 but can be computed much more quickly.) + If *value* is present, it is used as the starting value of + the checksum; otherwise, a default value of 1 is used. + This allows computing a running checksum over the concatenation of several inputs. The algorithm is not cryptographically strong, and should not be used for authentication or digital signatures. Since the algorithm is designed for use as a checksum algorithm, it is not suitable @@ -41,13 +42,6 @@ Always returns an unsigned 32-bit integer. -.. note:: - To generate the same numeric value across all Python versions and - platforms use adler32(data) & 0xffffffff. If you are only using - the checksum in packed binary format this is not necessary as the - return value is the correct 32bit binary representation - regardless of sign. - .. function:: compress(data[, level]) @@ -98,8 +92,9 @@ single: checksum; Cyclic Redundancy Check Computes a CRC (Cyclic Redundancy Check) checksum of *data*. If *value* is - present, it is used as the starting value of the checksum; otherwise, a fixed - default value is used. This allows computing a running checksum over the + present, it is used as the starting value of the checksum; otherwise, a + default value of zero is used. + This allows computing a running checksum over the concatenation of several inputs. The algorithm is not cryptographically strong, and should not be used for authentication or digital signatures. Since the algorithm is designed for use as a checksum algorithm, it is not suitable @@ -107,14 +102,6 @@ Always returns an unsigned 32-bit integer. - .. note:: - - To generate the same numeric value across all Python versions and - platforms, use ``crc32(data) & 0xffffffff``. If you are only using - the checksum in packed binary format this is not necessary as the - return value is the correct 32-bit binary representation - regardless of sign. - .. function:: decompress(data[, wbits[, bufsize]])

1 0

[issue23144] html.parser.HTMLParser: setting 'convert_charrefs = True' leads to dropped text
by Ezio Melotti March 8, 2015

March 8, 2015

Ezio Melotti added the comment: > A context manager here would seem a bit strange. I still haven't thought this through, but I can't see any problem with it right now. This would be similar to: from contextlib import closing with closing(MyHTMLParser()) as parser: parser.feed(html) and this already seems to work fine, including with OP's case. > If an exception is raised inside the context manager, > should close() be called (like for file objects), or not? The parser is guaranteed to never raise parsing-related errors during parsing, so this shouldn't be an issue. I will open a new issue after fixing this so we can keep discussing there. ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue23144> _______________________________________

1 0

[issue23144] html.parser.HTMLParser: setting 'convert_charrefs = True' leads to dropped text
by Martin Panter March 8, 2015

March 8, 2015

Martin Panter added the comment: A context manager here would seem a bit strange. Is there any precedent for using context managers with feed parsers? The two others that come to mind are ElementTree.XMLParser and email.parser.FeedParser. These two build an object while parsing, and close() returns that object, so a context manager would be unhelpful. If an exception is raised inside the context manager, should close() be called (like for file objects), or not? ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue23144> _______________________________________

1 0

[issue23556] Scope for raise without argument is different in Python 2 and 3
by Martin Panter March 8, 2015

March 8, 2015

Changes by Martin Panter <vadmium+py(a)gmail.com>: ---------- assignee: -> docs@python components: +Documentation nosy: +docs@python _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue23556> _______________________________________

1 0

[issue23144] html.parser.HTMLParser: setting 'convert_charrefs = True' leads to dropped text
by Ezio Melotti March 8, 2015

March 8, 2015

Ezio Melotti added the comment: > I still think it would be worthwhile adding close() calls to > the examples in the documentation (Doc/library/html.parser.rst). If I add context manager support to HTMLParser I can update the examples to use it, but otherwise I don't think it's worth changing them now. > BTW I haven’t tested this, and maybe it is not a concern, but even with > this patch it looks like the parser will buffer unlimited data and > output nothing until close() if each string it is fed ends with an > ampersand (and otherwise contains only plain text, no tags etc). This is true, but I don't think it's a realistic case. For this to be a problem you would need: 1) Someone feeding the parser with arbitrary chunks. Text files are usually fed to the parser whole, or line by line -- arbitrary chunks are uncommon. 2) A file that contains lot of entities. In most documents charrefs are not very common, and so the chances that a chunk will split one in the middle is low. Chances that several consecutive charrefs are split in the middle is even lower. 3) A file that is very big. Even if all the file is buffered until a call to close(), it shouldn't be a concern, since most files have relatively small size. It is true that this has a quadratic complexity, but I would expect the parsing to complete in a reasonable time for average sizes. ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue23144> _______________________________________

1 0