Mailman 3 March 2017 - docs

[issue29813] PyTuple_GetSlice documentation incorrect
by Michael Seifert 16 Mar '17

16 Mar '17

New submission from Michael Seifert: The PyTuple_GetSlice documentation says it "Take a slice of the tuple pointed to by p from low to high and return it as a new tuple." [0] However in case the start is <= 0 and the stop is >= tuplesize it doesn't return the promised "new tuple", it just returns the tuplepointer after incrementing it's refcount [1]. The behaviour is fine (it gave me a bit of a headache though), however could a note/warning/sentence be included in the docs mentioning that special case? [0] https://docs.python.org/3/c-api/tuple.html#c.PyTuple_GetSlice [1] https://github.com/python/cpython/blob/master/Objects/tupleobject.c#L414 ---------- assignee: docs@python components: Documentation messages: 289632 nosy: MSeifert, docs@python priority: normal severity: normal status: open title: PyTuple_GetSlice documentation incorrect type: behavior _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue29813> _______________________________________

3 6

Misleading wording in Python HOWTOs
by Slava Novak 15 Mar '17

15 Mar '17

Hi, Misleading wording: https://docs.python.org/2/howto/logging.html#logging-advanced-tutorial Section ->Basic Logging Tutorial->When to use logging-> ... The default level is WARNING, which means that only events of this *level and above* will be tracked, unless the logging package is configured to do otherwise. ... But based on the table before this sting: Level When it’s used DEBUG Detailed information, typically of interest only when diagnosing problems. INFO Confirmation that things are working as expected. WARNING An indication that something unexpected happened, or indicative of some problem in the near future (e.g. ‘disk space low’). The software is still working as expected. ERROR Due to a more serious problem, the software has not been able to perform some function. CRITICAL A serious error, indicating that the program itself may be unable to continue running. So according to statement, all above which are blue will be logged. Which is not true. With WARNING level it will log: WARNING, ERROR, CRITICAL. As show in *A simple example* section in https://docs.python.org/2/howto/logging.html#logging-advanced-tutorial Does this make sense? Or I didn't read it properly? Sincerely, -Slava

1 0

[issue29807] ArgParse page in library reference rewrite
by Steve Carter 14 Mar '17

14 Mar '17

New submission from Steve Carter: Originally raise as https://github.com/python/pythondotorg/issues/1059 Although it's a reference page, it is clouded by too many examples and too little reference material. Moreover, the examples are not real-world applications of argument parsing. I propose removing the "process some integers" example, replacing it with something more typically gnu style, e.g., myapp.py [--quiet] [--log-level _n_] [--title=STR] {get | put} [FSPEC [, FSPEC...]]. This shows the user how to to many of the common command-line tasks. [I'm tentatively offering to do this, but I haven't yet found the content I need to revise.] ---------- assignee: docs@python components: Documentation messages: 289569 nosy: docs@python, sweavo priority: normal severity: normal status: open title: ArgParse page in library reference rewrite versions: Python 2.7 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue29807> _______________________________________

2 1

argparse doc introduction is inappropriately targeted (issue 26602)
by vadmium+py＠gmail.com 14 Mar '17

14 Mar '17

https://bugs.python.org/review/26602/diff/16809/Doc/library/argparse.rst File Doc/library/argparse.rst (right): https://bugs.python.org/review/26602/diff/16809/Doc/library/argparse.rst#ne… Doc/library/argparse.rst:31: The following code is a Python program that takes a String and outputs the String doesn’t need to be capitalized I don’t think https://bugs.python.org/review/26602/diff/16809/Doc/library/argparse.rst#ne… Doc/library/argparse.rst:37: parser.add_argument("message", help='Type in any message') I find starting parameter descriptions with lower case is more consistent with the default description for “--help”: positional arguments: message Type in any message optional arguments: -h, --help show this help message and exit https://bugs.python.org/review/26602/diff/16809/Doc/library/argparse.rst#ne… Doc/library/argparse.rst:40: print args.message[:1] You seem to be replacing a Python 3 example with Python 2 syntax. https://bugs.python.org/review/26602/diff/16809/Doc/library/argparse.rst#ne… Doc/library/argparse.rst:52: message type in any message Spacing seems off. Also casing of “Type” is different to in the code. https://bugs.python.org/review/26602/diff/16809/Doc/library/argparse.rst#ne… Doc/library/argparse.rst:103: >>> parser.add_argument('message', help='an integer for the accumulator') Looks like this is unfinished, a cross between the old and new examples :) https://bugs.python.org/review/26602/

1 0

[issue29806] Requesting version info with lowercase -v or -vv causes an import crash
by Anne Moroney 14 Mar '17

14 Mar '17

New submission from Anne Moroney: In trying to test the new feature in 3.6.0, $ python -VV # get more info than python -V or python --version I found several oddities. 1.On both Amazon Linux AMI Python 2.7.12 and also Anaconda Python 3.6.0, using lowercase v's causes a crash on some kind of import. 1a.AWS first lines are: [ec2-user@ip-172-31-2-101 ~]$ python -v # installing zipimport hook import zipimport # builtin # installed zipimport hook # /usr/lib64/python2.7/site.pyc matches /usr/lib64/python2.7/site.py import site # precompiled from /usr/lib64/python2.7/site.pyc 1b.Conda first lines are: (py36aws)me:tool-aws me$ python -v import _frozen_importlib # frozen import _imp # builtin import sys # builtin import '_warnings' # <class '_frozen_importlib.BuiltinImporter'> //etc 1c.In both cases, after lots of stuff, must quit python with quit() 2.Anaconda does not provide more information. Is that expected? (py36aws) $ python -VV Python 3.6.0 :: Continuum Analytics, Inc. (py36aws)$ python -V Python 3.6.0 :: Continuum Analytics, Inc. (py36aws)$ python --version Python 3.6.0 :: Continuum Analytics, Inc. ---------- assignee: docs@python components: Documentation messages: 289561 nosy: AnneTheAgile, docs@python priority: normal severity: normal status: open title: Requesting version info with lowercase -v or -vv causes an import crash type: crash versions: Python 2.7, Python 3.6 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue29806> _______________________________________

3 2

[issue29795] Clarify how to share multiprocessing primitives
by Max 13 Mar '17

13 Mar '17

New submission from Max: It seems both me and many other people (judging from SO questions) are confused about whether it's ok to write this: from multiprocessing import Process, Queue q = Queue() def f(): q.put([42, None, 'hello']) def main(): p = Process(target=f) p.start() print(q.get()) # prints "[42, None, 'hello']" p.join() if __name__ == '__main__': main() It's not ok (doesn't work on Windows presumably because somehow when it's pickled, the connection between global queues in the two processes is lost; works on Linux, because I guess fork keeps more information than pickle, so the connection is maintained). I thought it would be good to clarify in the docs that all the Queue() and Manager().* and other similar objects should be passed as parameters not just defined as globals. ---------- assignee: docs@python components: Documentation messages: 289454 nosy: docs@python, max priority: normal severity: normal status: open title: Clarify how to share multiprocessing primitives type: behavior versions: Python 3.6 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue29795> _______________________________________

2 5

[issue22576] ftplib documentation gives a wrong argument name for storbinary
by Derek Kurth 13 Mar '17

13 Mar '17

New submission from Derek Kurth: The Python 3 documentation for ftplib gives the storbinary method signature as: FTP.storbinary(cmd, file, blocksize=8192, callback=None, rest=None) However, the parameter named "file" is actually named "fp" in the code, so if you do something like this: ftp.storbinary(cmd="RETR something.txt", file=f) then you will get a TypeError: storbinary() got an unexpected keyword argument 'file'. I think the documentation should be updated to call that argument "fp" instead of "file." ---------- assignee: docs@python components: Documentation messages: 228773 nosy: Derek.Kurth, docs@python priority: normal severity: normal status: open title: ftplib documentation gives a wrong argument name for storbinary versions: Python 3.3 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue22576> _______________________________________

4 4

[issue29756] Improve documentation for list methods that compare items by equality
by Xiang Zhang 13 Mar '17

13 Mar '17

Changes by Xiang Zhang <angwerzx(a)126.com>: ---------- resolution: -> fixed stage: -> resolved status: open -> closed versions: +Python 3.7 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue29756> _______________________________________

1 0

[issue29756] Improve documentation for list methods that compare items by equality
by Alexander Todorov 13 Mar '17

13 Mar '17

Alexander Todorov added the comment: Hi folks, I have another very similar issue, it could be the same root cause. Let me know if it is. assert 3 == 3.0 will pass self.assertEqual(3, 3.0) - will pass this had the nasty side effect of my test suite not catching a problem with SUT. I have updated the test suite to validate the result type as well but want to know how to file this use-case. ---------- _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue29756> _______________________________________

2 1

[issue29722] heapq.merge docs don't handle reverse flag well
by Adam 11 Mar '17

11 Mar '17

New submission from Adam: The docs for heapq.merge are a little misleading. Iterables passed into heapq.merge with the reversed flag set to True must be sorted from largest to smallest to achieve the desired sorting effect, but the paragraph describing the function in the general case states that they should be sorted from smallest to largest. ---------- assignee: docs@python components: Documentation messages: 288997 nosy: adamniederer, docs@python priority: normal pull_requests: 388 severity: normal status: open title: heapq.merge docs don't handle reverse flag well type: behavior 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/issue29722> _______________________________________

3 4