[issue11231] bytes() constructor is not correctly documented
New submission from STINNER Victor <victor.stinner@haypocalc.com>: There are 5 different usages of the bytes() constructor: 1) bytes(iterable_of_ints) -> bytes 2) bytes(string, encoding[, errors]) -> bytes 3) bytes(bytes_or_buffer) -> immutable copy of bytes_or_buffer 4) bytes(memory_view) -> bytes 5) bytes(int) <=> b'\0' * size The docstring describes the four first usages, the documentation only (3). http://docs.python.org/dev/library/functions.html#bytes Note: bytes(3) accepts 2 other arguments, but I don't think that they are used: bytes(3, 'unused encoding', 'unused errors'). ---------- assignee: docs@python components: Documentation messages: 128739 nosy: docs@python, haypo priority: normal severity: normal status: open title: bytes() constructor is not correctly documented versions: Python 3.1, Python 3.2, Python 3.3 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue11231> _______________________________________
Antoine Pitrou <pitrou@free.fr> added the comment:
3) bytes(bytes_or_buffer) -> immutable copy of bytes_or_buffer 4) bytes(memory_view) -> bytes
These are AFAIR the same. ---------- nosy: +pitrou _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue11231> _______________________________________
STINNER Victor <victor.stinner@haypocalc.com> added the comment:
These are AFAIR the same.
So the docstring should also maybe be updated too: $ python
help(bytes) Help on class bytes in module builtins:
class bytes(object) | bytes(iterable_of_ints) -> bytes | bytes(string, encoding[, errors]) -> bytes | bytes(bytes_or_buffer) -> immutable copy of bytes_or_buffer | bytes(memory_view) -> bytes | | Construct an immutable array of bytes from: | - an iterable yielding integers in range(256) | - a text string encoded using the specified encoding | - a bytes or a buffer object | - any object implementing the buffer API. | ... ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue11231> _______________________________________
Changes by Éric Araujo <merwok@netwok.org>: ---------- nosy: +eric.araujo _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue11231> _______________________________________
Terry J. Reedy <tjreedy@udel.edu> added the comment: You sort of left out bytes() == bytes(0) == b''. I did not know about case 5 -- not surprisingly ;-). ---------- nosy: +terry.reedy _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue11231> _______________________________________
STINNER Victor <victor.stinner@haypocalc.com> added the comment: Oooh, I missed the important sentence "Accordingly, constructor arguments are interpreted as for bytearray()." The 5 constructors are documented in bytearray doc: http://docs.python.org/dev/library/functions.html#bytearray ---------- resolution: -> works for me status: open -> closed _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue11231> _______________________________________
brendel <brice.berna@gmail.com> added the comment: Here is a patch for the docstring of bytes and bytesarray. ---------- nosy: +brendel Added file: http://bugs.python.org/file23989/patch _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue11231> _______________________________________
Changes by brendel <brice.berna@gmail.com>: Removed file: http://bugs.python.org/file23989/patch _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue11231> _______________________________________
Changes by brendel <brice.berna@gmail.com>: Added file: http://bugs.python.org/file23990/patch _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue11231> _______________________________________
Roundup Robot <devnull@psf.upfronthosting.co.za> added the comment: New changeset beac7d6c7be4 by Victor Stinner in branch '3.2': Issue #11231: Fix bytes and bytearray docstrings http://hg.python.org/cpython/rev/beac7d6c7be4 New changeset dc670add1e28 by Victor Stinner in branch 'default': Issue #11231: Fix bytes and bytearray docstrings http://hg.python.org/cpython/rev/dc670add1e28 ---------- nosy: +python-dev _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue11231> _______________________________________
participants (6)
-
Antoine Pitrou -
brendel
-
Roundup Robot
-
STINNER Victor
-
Terry J. Reedy
-
Éric Araujo