https://github.com/python/cpython/commit/d2d415b9761a539c37ea4f950df4e9aab0eca6ed commit: d2d415b9761a539c37ea4f950df4e9aab0eca6ed branch: main author: Savage Mechanic <[email protected]> committer: serhiy-storchaka <[email protected]> date: 2026-07-05T13:16:54Z summary:
gh-149930: Clarify imaplib response helper types (GH-149963) Co-authored-by: savagemechanic <[email protected]> files: M Doc/library/imaplib.rst diff --git a/Doc/library/imaplib.rst b/Doc/library/imaplib.rst index dbf4560ab5e53b..c58c957d03c1d8 100644 --- a/Doc/library/imaplib.rst +++ b/Doc/library/imaplib.rst @@ -127,11 +127,11 @@ The second subclass allows for connections created by a child process: The following utility functions are defined: -.. function:: Internaldate2tuple(datestr) +.. function:: Internaldate2tuple(resp) - Parse an IMAP4 ``INTERNALDATE`` string and return corresponding local - time. The return value is a :class:`time.struct_time` tuple or - ``None`` if the string has wrong format. + Parse a :term:`bytes-like object` containing an IMAP4 ``INTERNALDATE`` + response and return the corresponding local time. The return value is a + :class:`time.struct_time` tuple or ``None`` if the input has wrong format. .. function:: Int2AP(num) @@ -139,9 +139,11 @@ The following utility functions are defined: [``A`` .. ``P``]. -.. function:: ParseFlags(flagstr) +.. function:: ParseFlags(resp) - Converts an IMAP4 ``FLAGS`` response to a tuple of individual flags. + Converts a :term:`bytes-like object` containing an IMAP4 ``FLAGS`` response + to a tuple of individual flags as :class:`bytes`. The return value is an + empty tuple if the input has wrong format. .. function:: Time2Internaldate(date_time) _______________________________________________ Python-checkins mailing list -- [email protected] To unsubscribe send an email to [email protected] https://mail.python.org/mailman3//lists/python-checkins.python.org Member address: [email protected]
