Skip to content

bpo-24024: update str.__doc__ to show default encoding explicitly #257

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 4 commits into from
Closed

bpo-24024: update str.__doc__ to show default encoding explicitly #257

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c1c235f
bpo-24024 update str.__doc__ to show default encoding explicitly
plusminushalf Feb 23, 2017
df2fce9
Code review changes
plusminushalf Apr 2, 2017
6011f9f
Removing extra function signatures
plusminushalf Apr 6, 2017
d860f4b
Code review changes
plusminushalf Apr 10, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 2 additions & 5 deletions Objects/unicodeobject.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15119,16 +15119,13 @@ unicode_subtype_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
}

PyDoc_STRVAR(unicode_doc,
"str(object='') -> str\n\
str(bytes_or_buffer[, encoding[, errors]]) -> str\n\
"str(object='', encoding='utf-8', errors='strict') -> str\n\
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is a problem with this. This signature means that str('', 'utf-8', 'strict') is equivalent to str(). But calling str with string argument and encoding is an error. The signature of str can't be expressed in such form, this is a cause why the str constructor still is not converted to Argument Clinic.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don’t think that merging the two lines is correct.

\n\
Create a new string object from the given object. If encoding or\n\
errors is specified, then the object must expose a data buffer\n\
that will be decoded using the given encoding and error handler.\n\
Otherwise, returns the result of object.__str__() (if defined)\n\
or repr(object).\n\
encoding defaults to sys.getdefaultencoding().\n\
errors defaults to 'strict'.");
or repr(object).");

static PyObject *unicode_iter(PyObject *seq);

Expand Down