ENH: add tobytes and stop using tostring in documentation #4257
Conversation
|
this also restores compatibility with older PIL versions of fromarray which expect a tobytes function in python3 due to a wrong source conversion. |
|
Deprecation is not a good idea, for the reason you already mentioned. |
|
Which PIL versions by the way? Only Pillow and maybe the very last PIL version should be relevant these days. |
|
removed the deprecation warning. any PIL older than 2.1 should be affected, I hit it with 1.1.7 in ubuntu 13.10. |
|
1.1.7 should be the lowest version that people still use, so will help some users. |
| @@ -5382,10 +5383,20 @@ def tolist(self, fill_value=None): | |||
| #........................ | |||
| def tostring(self, fill_value=None, order='C'): | |||
| """ | |||
| This function is deprecated. Use tobytes() if support for older numpy | |||
There was a problem hiding this comment.
Can we call it something else than deprecated? That still sounds like something that will be removed at some point, which is not what should happen. Something like "This function has inconsistent behavior on Python 3.x; it's recommended to use tobytes instead if numpy 1.9 is the lowest version your code has to support".
|
removed the use of the word deprecated |
| @@ -9384,7 +9384,7 @@ self | |||
| \emph default | |||
| . | |||
| \series bold | |||
| tostring | |||
| tobytes | |||
There was a problem hiding this comment.
Down below there is "Return the bytes of this array in a Python string." that should be updated also.
|
Oops, looks like I commented in your repository version... |
tostring returns bytes which are not equal to string, so provide a tobytes function alias. tostring does not emit a deprecation warning yet so rdepends do not need to check two names to support older versions of numpy without warnings.
|
LGTM, thanks. |
ENH: add tobytes and stop using tostring in documentation
tostring returns bytes which are not equal to string, so provide a
tobytes function alias and deprecate tostring.
PyArray_ToString is not yet deprected in this PR, but should probably also be in favor of a more descriptive name.
I'm not sure if we should really deprecate tostring, it would force rdepends to add checks for both names if they want to support older versions without warnings.
We might also want an equivalent frombytes that does not accept strings for symmetry, but currently fromstring seems works for bytes and strings as it can also read formated strings instead of only raw bytes.