From ba40ef6f35bae75b1f2bcb159f3e9628f25a0b66 Mon Sep 17 00:00:00 2001 From: Savage Mechanic Date: Sun, 5 Jul 2026 14:16:54 +0100 Subject: [PATCH] gh-149930: Clarify imaplib response helper types (GH-149963) (cherry picked from commit d2d415b9761a539c37ea4f950df4e9aab0eca6ed) Co-authored-by: Savage Mechanic Co-authored-by: savagemechanic <20458938+savagemechanic@users.noreply.github.com> --- Doc/library/imaplib.rst | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/Doc/library/imaplib.rst b/Doc/library/imaplib.rst index efe8e6534e39c8..bcfef2116a80cb 100644 --- a/Doc/library/imaplib.rst +++ b/Doc/library/imaplib.rst @@ -134,11 +134,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) @@ -146,9 +146,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)