Mailman 3 November 2015 - docs

Re: [docs] enum docs outdated re attribute access (issue 25594)
by ethan＠stoneleaf.us Nov. 15, 2015

Nov. 15, 2015

http://bugs.python.org/review/25594/diff/15947/Doc/library/enum.rst File Doc/library/enum.rst (right): http://bugs.python.org/review/25594/diff/15947/Doc/library/enum.rst#newcode… Doc/library/enum.rst:733: Enum members are instances of an Enum class, and even though they are Good idea. http://bugs.python.org/review/25594/diff/15947/Doc/library/enum.rst#newcode… Doc/library/enum.rst:747: The :attr:`__members__` attribtute is only available on the class. Fixed. http://bugs.python.org/review/25594/

1 0

[issue25017] htmllib deprecated: Which library to use? Missing sane default in docs
by Thomas Guettler Nov. 14, 2015

Nov. 14, 2015

New submission from Thomas Guettler: At the top of the htmllib module: > Deprecated since version 2.6: The htmllib module has been removed in > Python 3. Source: https://docs.python.org/2/library/htmllib.html#module-htmllib Newcomers need more advice: Which library should be used? I know there are many html parsing libraries. But there should be a sane default for newcomers. Is there already an agreement of a sane default html parsing library? ---------- assignee: docs@python components: Documentation messages: 250088 nosy: docs@python, guettli priority: normal severity: normal status: open title: htmllib deprecated: Which library to use? Missing sane default in docs _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue25017> _______________________________________

7 19

enum docs outdated re attribute access (issue 25594)
by ghost.adh＠gmail.com Nov. 13, 2015

Nov. 13, 2015

Reviewers: , Message: One typo. https://bugs.python.org/review/25594/diff/15947/Doc/library/enum.rst File Doc/library/enum.rst (right): https://bugs.python.org/review/25594/diff/15947/Doc/library/enum.rst#newcod… Doc/library/enum.rst:733: Enum members are instances of an Enum class, and even though they are Not related to the issue, but perhaps one of the Enum could be linked with :class:`Enum`? https://bugs.python.org/review/25594/diff/15947/Doc/library/enum.rst#newcod… Doc/library/enum.rst:747: The :attr:`__members__` attribtute is only available on the class. Should read "attribute" Please review this at https://bugs.python.org/review/25594/ Affected files: Doc/library/enum.rst diff -r 828c9b920532 Doc/library/enum.rst --- a/Doc/library/enum.rst Fri Nov 13 15:18:26 2015 +0200 +++ b/Doc/library/enum.rst Fri Nov 13 10:17:02 2015 -0800 @@ -724,31 +724,34 @@ The most interesting thing about Enum me :class:`EnumMeta` creates them all while it is creating the :class:`Enum` class itself, and then puts a custom :meth:`__new__` in place to ensure that no new ones are ever instantiated by returning only the existing member instances. Finer Points ^^^^^^^^^^^^ Enum members are instances of an Enum class, and even though they are -accessible as `EnumClass.member`, they are not accessible directly from +accessible as `EnumClass.member`, they may not be accessible directly from the member:: - >>> Color.red - <Color.red: 1> - >>> Color.red.blue - Traceback (most recent call last): + >>> class FieldTypes(Enum): + ... name = 0 + ... value = 1 + ... size = 2 ... - AttributeError: 'Color' object has no attribute 'blue' + >>> FieldTypes.value.size + <FieldTypes.size: 2> + >>> FieldTypes.size.value + 2 -Likewise, the :attr:`__members__` is only available on the class. +The :attr:`__members__` attribtute is only available on the class. If you give your :class:`Enum` subclass extra methods, like the `Planet`_ class above, those methods will show up in a :func:`dir` of the member, but not of the class:: >>> dir(Planet) ['EARTH', 'JUPITER', 'MARS', 'MERCURY', 'NEPTUNE', 'SATURN', 'URANUS', 'VENUS', '__class__', '__doc__', '__members__', '__module__'] >>> dir(Planet.EARTH) ['__class__', '__doc__', '__module__', 'name', 'surface_gravity', 'value']

1 0

[issue25605] fcntl doc: document exceptions raised on error for ioctl() and flock()
by STINNER Victor Nov. 13, 2015

Nov. 13, 2015

New submission from STINNER Victor: Attached patch documents the exception raised when ioctl() or flock() functions fail. Note: flock() can also raises a ValueError if the second parameter (op) is unknown. If the patch is approved, I will write a similar patch for Python 3 (just replace IOError with OSError in Python 3 doc). Python 2 online doc: https://docs.python.org/2/library/fcntl.html Python 3 online doc: https://docs.python.org/dev/library/fcntl.html ---------- assignee: docs@python components: Documentation files: fcntl_doc.patch keywords: patch messages: 254524 nosy: docs@python, haypo priority: normal severity: normal status: open title: fcntl doc: document exceptions raised on error for ioctl() and flock() versions: Python 2.7 Added file: http://bugs.python.org/file41020/fcntl_doc.patch _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue25605> _______________________________________

3 3

[issue25586] socket.sendall broken when a socket has a timeout
by Jakub Stasiak Nov. 12, 2015

Nov. 12, 2015

New submission from Jakub Stasiak: It is my understanding that socket.sendall effectively calls the underlying socket.send's implementation in a retry loop, possibly multiple times. It is also my understanding that each one of those low level send calls can timeout on its own if a socket timeout is set. Considering the above I believe it's undesired to ever call socket.sendall with a socket that has a timeout set because if: 1. At least one send call succeeds 2. A send call after that times out then a socket timeout error will be raised and the information about the sent data will be lost. Granted, the documentation says that "On error, an exception is raised, and there is no way to determine how much data, if any, was successfully sent". I believe, however, that such API is very easy to misuse (I've seen it used with sockets with timeout set, because of small payload sizes and other circumstances it would appear to work fine most of the time and only fail every N hours or days). Possible improvements I see: 1. Explicitly mention interaction between socket's timeout and sendall's behavior in the documentation 2. Make sendall raise an error when the socket it's called with has a timeout set (I can see the backwards compatibility being a concern here but I can't think of any reason to remain compatible with behavior I believe to be broken anyway) 3. Both of the above I'm happy to procure an appropriate patch for any of the above. Please correct me if my understanding of this is off. ---------- assignee: docs@python components: Documentation, IO, Library (Lib) messages: 254357 nosy: docs@python, jstasiak priority: normal severity: normal status: open title: socket.sendall broken when a socket has a timeout type: behavior versions: Python 2.7, Python 3.2, Python 3.3, Python 3.4, Python 3.5, Python 3.6 _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue25586> _______________________________________

3 12

[issue16394] Reducing tee() memory footprint
by Serhiy Storchaka Nov. 12, 2015

Nov. 12, 2015

Serhiy Storchaka added the comment: Raymond, do you want to add a clarification to the documentation, or prefer just to close this issue? ---------- nosy: +serhiy.storchaka _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue16394> _______________________________________

1 0

[issue8426] multiprocessing.Queue fails to get() very large objects
by Serhiy Storchaka Nov. 12, 2015

Nov. 12, 2015

Serhiy Storchaka added the comment: I agree with Charles-François and think this issue should be closed. There is no a bug, and the behavior is documented. ---------- nosy: +serhiy.storchaka status: open -> pending _______________________________________ Python tracker <report(a)bugs.python.org> <http://bugs.python.org/issue8426> _______________________________________

1 0

Python 2 dis module docs
by Abraham, Hrvoje AVL/HR Nov. 12, 2015

Nov. 12, 2015

dis module https://docs.python.org/2/library/dis.html Documentation does not include BUILD_SET bytecode instruction, although it seems it is present in all Python 2 versions I experimented with. Maybe my reasoning is wrong (maybe BUILD_SET is not considered bytecode inst.), but also maybe there are some other instructions missing. It is present in Python 3 docs. minimal case: import dis def fun(): return {1,2,3,4,5} print dis.dis(fun) output: 49 0 LOAD_CONST 1 (1) 3 LOAD_CONST 2 (2) 6 LOAD_CONST 3 (3) 9 LOAD_CONST 4 (4) 12 LOAD_CONST 5 (5) 15 BUILD_SET 5 18 RETURN_VALUE None Best regards Hrvoje Abraham HRVOJE ABRAHAM Software Development Engineer Advanced Simulation Technologies / CDU hrvoje.abraham(a)avl.com<mailto:hrvoje.abraham@avl.com> T: +385 1 7775 000, F: +385 1 7775 123 M: +385 99 2380 737, Office: +385 1 7775 068 AVL-AST D.O.O. HR-10020 Zagreb, Strojarska 22 www .avl .com [cid:image001.png@01CF48D8.17AEEF30]<https://www.facebook.com/AVL.List> [cid:image002.png@01CF48D8.17AEEF30] <https://twitter.com/AVL_List> [cid:image003.png@01CF48D8.17AEEF30] <http://www.linkedin.com/company/avl> [cid:image004.png@01CF48D8.17AEEF30] <https://www.xing.com/companies/avllistgmbh> [cid:image005.png@01CF48D8.17AEEF30] <http://www.youtube.com/user/AVLList>

2 1

Typo error in Python 3.5 documentation
by Matthieu de La Roche Saint-André Nov. 12, 2015

Nov. 12, 2015

Hello, Quick email to notice about a typo error on the following documentation page : https://docs.python.org/3.5/tutorial/classes.html#method-objects On the last line of the example, a dot is missing between x and f : 9.3.4. Method Objects <https://docs.python.org/3.5/tutorial/classes.html#method-objects> Usually, a method is called right after it is bound: x.f() In the MyClass example, this will return the string 'hello world'. However, it is not necessary to call a method right away: x.f is a method object, and can be stored away and called at a later time. For example: xf = x.fwhile True: print(xf()) Thanks for the efforts on the documentations,

2 2

small typo in re module article
by animalize Nov. 12, 2015

Nov. 12, 2015

In this article: https://docs.python.org/3/library/re.html Search "neither" inside browser, it should followed by "nor". Need not to reply me:)

2 1