[issue15588] quopri: encodestring and decodestring handle bytes, not strings
New submission from patrick vrijlandt: quopri.py's functions encodestring and decodestring are documented to handle strings; and this is clearly suggested by their name. However, these functions accept and return bytes, not strings. This should be reflected in the documentation. Even better: deprecate these functions and introduce new ones with behaviour as suggested by their names: encode_string, encode_bytes etc. ---------- assignee: docs@python components: Documentation, Library (Lib) messages: 167672 nosy: docs@python, patrick.vrijlandt priority: normal severity: normal status: open title: quopri: encodestring and decodestring handle bytes, not strings type: behavior versions: Python 3.2 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue15588> _______________________________________
Changes by R. David Murray <rdmurray@bitdance.com>: ---------- components: +email nosy: +barry, r.david.murray versions: +Python 3.3, Python 3.4 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue15588> _______________________________________
Petri Lehtinen added the comment: The encode() and decode() functions also expect binary file objects. Attached a patch that changes documentation and docstrings. Removed the mentions of readline(), because read() is called on input instead, if the binascii module is available. Also removed the repeated descriptions of quotetabs and header in encodestring()'s docs. ---------- keywords: +needs review, patch nosy: +petri.lehtinen stage: -> patch review Added file: http://bugs.python.org/file26886/issue15588.patch _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue15588> _______________________________________
Mark Lawrence added the comment: Can we have a review on this fairly small patch please. ---------- nosy: +BreamoreBoy _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue15588> _______________________________________
R. David Murray added the comment: Please do review it, Mark. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue15588> _______________________________________
Mark Lawrence added the comment: Just one small query on the patch (more for my own benefit than anything else). In the rst file there's now no difference between the wording for the quotetabs positional argument to encode and the keyword argument to encodestring. Is there a rule (of thumb) that covers this situation? Other than that LGTM. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue15588> _______________________________________
R. David Murray added the comment: No, that's a good catch. For a keyword argument, we generally do mention the default value in the text, and it looks like we still should in that instance, especially since it *is* different that it is a keyword argument and not positional like the method to which the text is giving a back-reference. ---------- _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue15588> _______________________________________
Roundup Robot added the comment: New changeset b4130b2f7748 by Senthil Kumaran in branch 'default': merge from 3.4 http://hg.python.org/cpython/rev/b4130b2f7748 ---------- nosy: +python-dev _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue15588> _______________________________________
Senthil Kumaran added the comment: Thanks for the review, Mark. Addressed that and committed the changes in changeset 606a18938476 (3.4) changeset b4130b2f7748 (3.5) ---------- nosy: +orsenthil resolution: -> fixed stage: patch review -> resolved status: open -> closed versions: +Python 3.5 -Python 3.2, Python 3.3 _______________________________________ Python tracker <report@bugs.python.org> <http://bugs.python.org/issue15588> _______________________________________
participants (6)
-
Mark Lawrence -
patrick vrijlandt
-
Petri Lehtinen
-
R. David Murray
-
Roundup Robot
-
Senthil Kumaran