Skip to content

Commit 5bc5b1a

Browse files
gh-149930: Clarify imaplib response helper types
1 parent acefff9 commit 5bc5b1a

1 file changed

Lines changed: 8 additions & 7 deletions

File tree

Doc/library/imaplib.rst

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -120,21 +120,23 @@ The second subclass allows for connections created by a child process:
120120
The following utility functions are defined:
121121

122122

123-
.. function:: Internaldate2tuple(datestr)
123+
.. function:: Internaldate2tuple(resp)
124124

125-
Parse an IMAP4 ``INTERNALDATE`` string and return corresponding local
126-
time. The return value is a :class:`time.struct_time` tuple or
127-
``None`` if the string has wrong format.
125+
Parse a :term:`bytes-like object` containing an IMAP4 ``INTERNALDATE``
126+
response and return the corresponding local time. The return value is a
127+
:class:`time.struct_time` tuple or ``None`` if the input has wrong format.
128128

129129
.. function:: Int2AP(num)
130130

131131
Converts an integer into a bytes representation using characters from the set
132132
[``A`` .. ``P``].
133133

134134

135-
.. function:: ParseFlags(flagstr)
135+
.. function:: ParseFlags(resp)
136136

137-
Converts an IMAP4 ``FLAGS`` response to a tuple of individual flags.
137+
Converts a :term:`bytes-like object` containing an IMAP4 ``FLAGS`` response
138+
to a tuple of individual flags as :class:`bytes`. The return value is an
139+
empty tuple if the input has wrong format.
138140

139141

140142
.. function:: Time2Internaldate(date_time)
@@ -729,4 +731,3 @@ retrieves and prints all messages::
729731
print('Message %s\n%s\n' % (num, data[0][1]))
730732
M.close()
731733
M.logout()
732-

0 commit comments

Comments
 (0)