Mailman 3 September 2018 - docs

Bugs in Python 3.7 documentation.
by Никита Люшненко Sept. 12, 2018

Sept. 12, 2018

https://docs.python.org/3/reference/datamodel.html#metaclass-example - "uses an collections.OrderedDict to remember" when it is better to use "uses a collections.OrderedDict to remember" https://docs.python.org/3/reference/executionmodel.html#exceptions "Exceptions are a means" - Is it correct to use "a" here? "means" means a lot of them. "a" means one. "In either case, it prints a stack backtrace" - most of the time in Python documentation term "traceback" is used instead of "backtrace".… [View More]

1 0

[issue25041] document AF_PACKET socket address format
by Tim Tisdall Sept. 12, 2018

Sept. 12, 2018

New submission from Tim Tisdall: As mentioned in #24984, I'm making another issue to document the address format for AF_PACKET. In this case there's already documentation in Modules/socketmodule.c that says: - an AF_PACKET socket address is a tuple containing a string specifying the ethernet interface and an integer specifying the Ethernet protocol number to be received. For example: ("eth0",0x1234). Optional 3rd,4th,5th elements in the tuple specify packet-type and ha-type/addr. … [View More]

9 16

[issue26502] traceback.extract_tb breaks compatibility by returning FrameSummary
by Petr Viktorin Sept. 11, 2018

Sept. 11, 2018

New submission from Petr Viktorin: According to the docs [0], traceback.extract_tb should return 4-tuples (filename, line number, function name, text). [0] https://docs.python.org/3/library/traceback.html#traceback.extract_tb Instead, since Python 3.5, it returns FrameSummary objects, which are not tuples, nor tuple subclasses, nor even sequences. (This broke some code in the wild that called len() on FrameSummary.) Issue 25111 pointed out another tuple incompatibility, which was fixed. … [View More]

4 8

[issue33883] doc Mention mypy, pytype and PyAnnotate in FAQ
by Andrés Delfino Sept. 11, 2018

Sept. 11, 2018

New submission from Andrés Delfino <adelfino(a)gmail.com>: As far as I know, mypy and pytype are more advanced that any of the other tools mentioned in the FAQ for static analysis, however we are not touching them. PR adds mentions. ---------- assignee: docs@python components: Documentation messages: 319798 nosy: adelfino, docs@python priority: normal severity: normal status: open title: doc Mention mypy, pytype and PyAnnotate in FAQ type: enhancement versions: Python 2.7, Python 3.6, … [View More]

3 5

[issue33032] Mention implicit cache in struct.Struct docs
by Nick Coghlan Sept. 11, 2018

Sept. 11, 2018

New submission from Nick Coghlan <ncoghlan(a)gmail.com>: The struct.Struct docs claim that creating and re-using a Struct object will be noticeably faster than calling the module level methods repeatedly with the same format string, as it will avoid parsing the format string multiple times: https://docs.python.org/3/library/struct.html#struct.Struct This claim is questionable, as struct has used an internal Struct cache since at least 2.5, so if you're using less than 100 different … [View More]

4 7

Can you support Chinese for document
by qiny＠conzhu.com Sept. 11, 2018

Sept. 11, 2018

Can you support Chinese? You are losing millions developer!!!

2 1

[issue32027] argparse allow_abbrev option also controls short flag combinations
by Jörn Hees Sept. 11, 2018

Sept. 11, 2018

New submission from Jörn Hees <nrej9TyO(a)joernhees.de>: The allow_abbrev option (default True) currently is documented like this (https://docs.python.org/3/library/argparse.html#allow-abbrev): > Normally, when you pass an argument list to the parse_args() method of an ArgumentParser, it recognizes abbreviations of long options. However, it also controls combinations of short options and especially the combination of flags (store_const) like `-a -b` as `-ab`. Example snippet for … [View More]

3 3

secrets.compare_digest still ranks poorly for "python constant time string comparison"
by Kevin Burke Sept. 10, 2018

Sept. 10, 2018

Hi, I'm not sure of exactly the way to fix this, but I needed to use constant time string comparison today, and all of the top results on Google for this problem still point to third party libraries. Perhaps a targeted effort could generate more links to https://docs.python.org/3/library/secrets.html, and publicly available sources and third party libraries could have their README's point to this library as well. Kevin -- Kevin Burke phone: 925.271.7005 | kev.inburke.com

1 0

[issue34619] Typo in docs.python.jp
by kuri8ive Sept. 10, 2018

Sept. 10, 2018

New submission from kuri8ive <1yen.com(a)gmail.com>: Typo in https://docs.python.jp/3/tutorial/index.html "Python Web サイト(htts://www.python.org)" should be "Python Web サイト(https://www.python.org) " ---------- assignee: docs@python components: Documentation messages: 324906 nosy: docs@python, kuri8ive priority: normal severity: normal status: open title: Typo in docs.python.jp type: enhancement _______________________________________ Python tracker <report(a)bugs.python.org> <https://bugs.python.org/issue34619> _______________________________________

3 2

[issue34525] smtplib's authobject return value wrongly documented
by Sebastian Rittau Sept. 10, 2018

Sept. 10, 2018

New submission from Sebastian Rittau <srittau(a)rittau.biz>: smtplib's authobject() callback is supposed to return bytes, according to both the documentation at https://docs.python.org/3/library/smtplib.html as well as the docstring of SMTP.auth(). This does neither match the implementation of auth(), which immediately calls encode() on the return value, nor that of the auth_cram_md5() et al, which return str. ---------- assignee: docs@python components: Documentation messages: 324209 … [View More]

3 6