diff options
| author | Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com> | 2018-09-10 11:13:13 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-09-10 11:13:13 -0700 |
| commit | 011141f312f11b35ac163d9d52fe48e4bb61a814 (patch) | |
| tree | e04341e715304ffb21a7b6bbf7743b6bc939bd97 | |
| parent | 4d5d219a7ae1351e6f6e7c1c9845a499927d1219 (diff) | |
| download | cpython-git-011141f312f11b35ac163d9d52fe48e4bb61a814.tar.gz | |
closes bpo-34525: Fix smtplib's authobject() documentation (GH-8965)
(cherry picked from commit 78deb7f33227972987722bc3fed5bcb45fae869e)
Co-authored-by: Sebastian Rittau <srittau@rittau.org>
| -rw-r--r-- | Doc/library/smtplib.rst | 4 | ||||
| -rwxr-xr-x | Lib/smtplib.py | 2 |
2 files changed, 3 insertions, 3 deletions
diff --git a/Doc/library/smtplib.rst b/Doc/library/smtplib.rst index 805217252a..6fb0934218 100644 --- a/Doc/library/smtplib.rst +++ b/Doc/library/smtplib.rst @@ -346,7 +346,7 @@ An :class:`SMTP` instance has the following methods: If optional keyword argument *initial_response_ok* is true, ``authobject()`` will be called first with no argument. It can return the - :rfc:`4954` "initial response" bytes which will be encoded and sent with + :rfc:`4954` "initial response" ASCII ``str`` which will be encoded and sent with the ``AUTH`` command as below. If the ``authobject()`` does not support an initial response (e.g. because it requires a challenge), it should return ``None`` when called with ``challenge=None``. If *initial_response_ok* is @@ -355,7 +355,7 @@ An :class:`SMTP` instance has the following methods: If the initial response check returns ``None``, or if *initial_response_ok* is false, ``authobject()`` will be called to process the server's challenge response; the *challenge* argument it is passed will be a ``bytes``. It - should return ``bytes`` *data* that will be base64 encoded and sent to the + should return ASCII ``str`` *data* that will be base64 encoded and sent to the server. The ``SMTP`` class provides ``authobjects`` for the ``CRAM-MD5``, ``PLAIN``, diff --git a/Lib/smtplib.py b/Lib/smtplib.py index 048c6bfb06..5e1bc0b198 100755 --- a/Lib/smtplib.py +++ b/Lib/smtplib.py @@ -615,7 +615,7 @@ class SMTP: It will be called to process the server's challenge response; the challenge argument it is passed will be a bytes. It should return - bytes data that will be base64 encoded and sent to the server. + an ASCII string that will be base64 encoded and sent to the server. Keyword arguments: - initial_response_ok: Allow sending the RFC 4954 initial-response |