bpo-24024: update str.__doc__ to show default encoding explicitly #257
Conversation
sys.getdefaultencoding() always returns 'utf-8' Reference: Objects/unicodeobject.c line number -> 4214 Also str() accepts bytes, bytearray or buffer-like objects as input hence changing it to object. As str returns .__str__() method defined inside object or repr(obj) otherwise.
>>> str.__doc__
'str(object=\'\') -> str\nstr(object, encoding="utf-8", errors="strict") -> str\n\nCreate a new string object from the given object. If encoding or\nerrors is specified, then the object must expose a data buffer\nthat will be decoded using the given encoding and error handler.\nOtherwise, returns the result of object.__str__() (if defined)\nor repr(object).\nencoding defaults to sys.getdefaultencoding().\nerrors defaults to \'strict\'.' |
Objects/unicodeobject.c
Outdated
| @@ -15120,7 +15120,7 @@ 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\ | |||
There was a problem hiding this comment.
Best to use single quotes to be consistent with the line above.
Since you add the defaults to the signature, I think you can remove them from the end of the text below.
1. Changing double quotes to single 2. Removing defaults information from the end since it is already defined in function signature
Objects/unicodeobject.c
Outdated
| @@ -15120,15 +15120,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\ | |||
There was a problem hiding this comment.
I'm not seeing why this needs two signatures now when str(object='', encoding='utf-8', errors='strict') would suffice.
There was a problem hiding this comment.
I don’t think that merging the two lines is correct.
Objects/unicodeobject.c
Outdated
| @@ -15119,8 +15119,7 @@ unicode_subtype_new(PyTypeObject *type, PyObject *args, PyObject *kwds) | |||
| } | |||
|
|
|||
| PyDoc_STRVAR(unicode_doc, | |||
| "str(object='') -> str\n\ | |||
| str(object, encoding='utf-8', errors='strict') -> str\n\ | |||
| "str(object, encoding='utf-8', errors='strict') -> str\n\ | |||
There was a problem hiding this comment.
Passing no arguments is also supported:
>>> str()
''There was a problem hiding this comment.
Indeed, object needs a default value, i.e object=''.
Codecov Report
@@ Coverage Diff @@
## master #257 +/- ##
==========================================
- Coverage 83.38% 82.37% -1.01%
==========================================
Files 1367 1428 +61
Lines 344811 351129 +6318
==========================================
+ Hits 287516 289255 +1739
- Misses 57295 61874 +4579Continue to review full report at Codecov.
|
| @@ -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\ | |||
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
I don’t think that merging the two lines is correct.
|
To try and help move older pull requests forward, we are going through and backfilling 'awaiting' labels on pull requests that are lacking the label. Based on the current reviews, the best we can tell in an automated fashion is that a core developer requested changes to be made to this pull request. If/when the requested changes have been made, please leave a comment that says, |
|
Closed because it make the docstring incorrect. |
Adapt patchcheck.py to the new name of the development branch.
… have features/fixes present in this library. Fixes python#257.
sys.getdefaultencoding() always returns 'utf-8'
Reference: Objects/unicodeobject.c line number -> 4214
Also str() accepts bytes, bytearray or buffer-like objects as input
hence changing it to object.
As str returns .__str__() method defined inside object or repr(obj)
otherwise.