Mailman 3 January 2017 - docs

[issue29330] __slots__ needs documentation
by Raymond Hettinger 20 Jan '17

20 Jan '17

Changes by Raymond Hettinger <raymond.hettinger(a)gmail.com>: ---------- assignee: docs@python -> rhettinger _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue29330> _______________________________________

1 0

[issue29330] __slots__ needs documentation
by Eryk Sun 20 Jan '17

20 Jan '17

Eryk Sun added the comment: Are you suggesting that the Helper class in Lib/pydoc.py should index [sub-]topics by special names such as "__slots__"? Currently you can see the __slots__ documentation via the topics "ATTRIBUTEMETHODS" and "SPECIALMETHODS". The list of topics can be printed via help('topics'). Also when you exit out of help('__') it refers you to the SPECIALMETHODS topic. ---------- nosy: +eryksun _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue29330> _______________________________________

1 0

[issue29330] __slots__ needs documentation
by Martin Panter 20 Jan '17

20 Jan '17

Martin Panter added the comment: Have you seen <https://docs.python.org/2.7/reference/datamodel.html#slots>? There is also <https://docs.python.org/2.7/glossary.html#term-slots>. ---------- assignee: -> docs@python components: +Documentation nosy: +docs@python, martin.panter _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue29330> _______________________________________

2 1

[issue29329] Incorrect documentation for custom `hex()` support on Python 2
by Serhiy Storchaka 20 Jan '17

20 Jan '17

Changes by Serhiy Storchaka <storchaka+cpython(a)gmail.com>: ---------- assignee: -> docs@python components: +Documentation keywords: +easy nosy: +docs@python stage: -> needs patch versions: +Python 2.7 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue29329> _______________________________________

1 0

Wrapped titles have no anchor (e.g. email.message_from_binary_file)
by Rob Wu 20 Jan '17

20 Jan '17

The documentation of email.message_from_binary_file (below message_from_bytes at https://docs.python.org/3/library/email.parser.html#email.message_from_bytes ) has no anchor. This is possibly caused by the fact that in the source, the method signature is split over two lines: https://hg.python.org/cpython/file/5b771c662c00/Doc/library/email.parser.rs… If acceptable, an easy fix is to edit the rst file and put the full method name on one line. Otherwise the doc generator should be modified to account for multi-line method signatures. Kind regards, Rob https://robwu.nl

1 0

[issue29315] \b requires raw strings or to be escaped. Update docs with that hint?
by Mike Lissner 19 Jan '17

19 Jan '17

New submission from Mike Lissner: I just ran into a funny corner case I imagine others are aware of. When you write "\b" in Python, it is a single character: "\x08". So if you try to write a regex like: words = '\b(.*)\b' That won't work. But using a raw string will: words = r'\b(.*)\b' As will escaping it in this horrible fashion: words = '\\b(.*)\\b' I believe this doesn't affect any of the other regex flags, so I wonder if it's worth adding something to the docs to warn about this. I just spent a bunch of time trying to figure out why it seemed like \b wasn't working. A little tip in the docs would have gone a LONG way. ---------- assignee: docs@python components: Documentation messages: 285751 nosy: Mike.Lissner, docs@python priority: normal severity: normal status: open title: \b requires raw strings or to be escaped. Update docs with that hint? type: enhancement versions: Python 2.7, Python 3.3, Python 3.4, Python 3.5, Python 3.6, Python 3.7 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue29315> _______________________________________

2 1

[issue29274] Change “tests cases” → “test cases”
by Martin Panter 19 Jan '17

19 Jan '17

New submission from Martin Panter: The “unittest” documentation has “tests cases” written a few times. This doesn’t seem right to me, but I thought I should get a second opinion in case I missed something. ---------- assignee: docs@python components: Documentation files: tests-cases.patch keywords: patch messages: 285468 nosy: docs@python, martin.panter priority: normal severity: normal stage: patch review status: open title: Change “tests cases” → “test cases” versions: Python 2.7, Python 3.5, Python 3.6, Python 3.7 Added file: http://bugs.python.org/file46288/tests-cases.patch _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue29274> _______________________________________

5 5

Please update dowloadable documentation
by JJ Lemire 18 Jan '17

18 Jan '17

Good morning, the full documentation ONLINE says: Welcome! This is the documentation for Python 3.6.0, last updated Jan 13, 2017. the full documentation OFFline says (dowloadable documentation) Welcome! This is the documentation for Python 3.6.0, last updated Jan 02, 2017. Please update Thanks -- Jacques

1 0

[issue29291] Misleading text in the documentation of re library for non-greedy match
by ipolcak 17 Jan '17

17 Jan '17

New submission from ipolcak: The text about non-greedy match in the documentation for re library is misleading. The docs for py2.7 (https://docs.python.org/2.7/library/re.html) and 3.6 (https://docs.python.org/3.6/library/re.html) says: "The '*', '+', and '?' qualifiers are all greedy; they match as much text as possible. Sometimes this behaviour isn’t desired; if the RE <.*> is matched against <a> b <c>, it will match the entire string, and not just <a>. Adding ? after the qualifier makes it perform the match in non-greedy or minimal fashion; as few characters as possible will be matched. Using the RE <.*?> will match only <a>." The docs for py3.4 (https://docs.python.org/3.4/library/re.html) offers a little bit different example: "The '*', '+', and '?' qualifiers are all greedy; they match as much text as possible. Sometimes this behaviour isn’t desired; if the RE <.*> is matched against '<H1>title</H1>', it will match the entire string, and not just '<H1>'. Adding '?' after the qualifier makes it perform the match in non-greedy or minimal fashion; as few characters as possible will be matched. Using .*? in the previous expression will match only '<H1>'." However, in reality if the non-greedy match is not successful, it might fallback to the greedy match, see: >>> import re >>> a = re.compile(r"<.*?><span>") >>> a.match("<a> b <c><span>") <_sre.SRE_Match object; span=(0, 15), match='<a> b <c><span>'> >>> a.search("<a> b <c><span>") <_sre.SRE_Match object; span=(0, 15), match='<a> b <c><span>'> So the '<.*?>' part of the regex matches '<a> b <c>' in this example. I propose to add to the documentation the following text: "However, note that even the non-greedy version can match additional text, for example consider the RE '(<.*>)<d>' to be matched against '<a> b <c><d>'. The match is successful and the unnamed group contains '<a> b <c>'." ---------- assignee: docs@python components: Documentation messages: 285619 nosy: docs@python, ipolcak priority: normal severity: normal status: open title: Misleading text in the documentation of re library for non-greedy match type: behavior versions: Python 2.7, Python 3.4, Python 3.6 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue29291> _______________________________________

4 3

python3.4 cookiejar can't get cookies
by 1067511899＠qq.com 17 Jan '17

17 Jan '17

Hi： sorry for my poor English first,I am a Chinese. when access http://hd.chinatax.gov.cn/guoshui/main.jsp the firefox can get cookie and you can find it by devtools,but cookiejar can't. the full description is posted :https://www.reddit.com/r/learnpython/comments/5o9olm/about_cookiesheaderssomething_already_drive_me_mad/?st=iy16b0iq&sh=a5a7e960,A and after I debug into the code,I find the problem : https://www.reddit.com/r/learnpython/comments/5ogqfi/a_bug_of_anaconda34or_… python read headers from web server successfully.but when to parse it to class email.message.Message(policy=compat32),a problem happens. if the headers contains something like: Cache-Control : No-cache, I mean there is blank(one or more) beside the ':',the feedparser.py lines:227 will go wrong. because lines:35_37: # RFC 2822 $3.6.8 Optional fields. ftext is %d33-57 / %d59-126, Any character # except controls, SP, and ":". headerRE = re.compile(r'^(From |[\041-\071\073-\176]*:|[\t ])') I read RFC 2822 $3.6.8,and yes,the headerRE has no mistake,but as you can see,the headers can be created by programmer,and blank beside ':' do happen,so my suggestion is : headerRE = re.compile(r'^(From |[\041-\071\073-\176]*\s*:\s*|[\t ])') this may not strict fulfile the RFC,but it acts exactly like other web browser,such firefox,etc. if meet some web site that not strict fulfile the RFC,no matter cookiejar or requests will not get the cookie right.but that not make sense,because web browser can. btw:I changed my feedparser.py,because I need scraw web site in my work. there are also another way to solve the problem,but I think that is really not pythonic. import http.cookiejar, urllib.request cj = http.cookiejar.CookieJar() opener = urllib.request.build_opener(urllib.request.HTTPCookieProcessor(cj)) r = opener.open("http://hd.chinatax.gov.cn/guoshui/main.jsp") pls=r.info().get_payload().split('\r\n') cookiels=[] for x in pls: if x.strip(): tmp=x.split(':') if tmp[0]=='Set-Cookie': cookiels.append(tmp[1]) print(tmp) cookie='.'.join(cookiels) print(cookie) Thanks. yours . Mengwei lee 1067511899(a)qq.com

1 0