Issue 11231: bytes() constructor is not correctly documented (original) (raw)

Created on 2011-02-17 16:46 by vstinner, last changed 2022-04-11 14:57 by admin. This issue is now closed.

| Messages (7) | | | | | | | | | | | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | ---------------------------- | | ------------------------------------------- | --------------------------------------------- | ---------------------------------------------------- | ---------------------------- | ----------------------------------------- | --- | | msg128739 - (view) | Author: STINNER Victor (vstinner) * | Date: 2011-02-17 16:46 | | | | | | | | | | 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'). | | | | | | | | | | | | msg128740 - (view) | Author: Antoine Pitrou (pitrou) * | Date: 2011-02-17 16:52 | | | | | | | | | | > 3) bytes(bytes_or_buffer) -> immutable copy of bytes_or_buffer > 4) bytes(memory_view) -> bytes These are AFAIR the same. | | | | | | | | | | | | msg128741 - (view) | Author: STINNER Victor (vstinner) * | Date: 2011-02-17 16:55 | | | | | | | | | | > 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. | ... | | msg128811 - (view) | Author: Terry J. Reedy (terry.reedy) * | Date: 2011-02-18 20:00 | | | | | | | | | | You sort of left out bytes() == bytes(0) == b''. I did not know about case 5 -- not surprisingly ;-). | | | | | | | | | | | | msg149670 - (view) | Author: STINNER Victor (vstinner) * | Date: 2011-12-17 15:29 | | | | | | | | | | 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 | | | | | | | | | | | | msg149679 - (view) | Author: (brendel) | Date: 2011-12-17 17:09 | | | | | | | | | | Here is a patch for the docstring of bytes and bytesarray. | | | | | | | | | | | | msg149712 - (view) | Author: Roundup Robot (python-dev) | Date: 2011-12-17 22:16 | | | | | | | | | | 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 | | | | | | | | | | |