python / python/cpython

The docstring of `str()` should show the default values for object, encoding and errors and should say `bytes-like object`

Open
#137,112 6 comments 0 reactions 1 assignee View on GitHub

@terryjreedy is already working on this.

Since Jul 26, 2025.

docs interpreter-core triaged
Dominant language
Python
Stars
77.2k
Forks
35.9k
PR merge metrics
PR metrics pending

Description

The docstring of str() doesn't show the default values for object, encoding and errors and does say bytes_or_buffer as shown below:

print(help(str))
# class str(object)
#  |  str(object='') -> str
#  |  str(bytes_or_buffer[, encoding[, errors]]) -> str

So, the docstring of str() should show the default values for object, encoding and errors and should say bytes-like object as shown below:

print(help(str))
# class str(object)
#  |  str(object='') -> str
#  |  str(object=b'', encoding='utf-8', errors='strict') -> str # Here
#  |  str(bytes-like object[, encoding[, errors]]) -> str
          # Here
Linked PRs
  • gh-142650

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.