Issue #10934: Fixed and expanded Internaldate2tuple() and
Time2Internaldate() documentation. Thanks Joe Peterson for the report and the original patch.
This commit is contained in:
parent
e47e093f70
commit
41a99bc20d
@ -85,9 +85,9 @@ The following utility functions are defined:
|
|||||||
|
|
||||||
.. function:: Internaldate2tuple(datestr)
|
.. function:: Internaldate2tuple(datestr)
|
||||||
|
|
||||||
Converts an IMAP4 INTERNALDATE string to Coordinated Universal Time. Returns a
|
Parse an IMAP4 ``INTERNALDATE`` string and return corresponding local
|
||||||
:mod:`time` module tuple.
|
time. The return value is a :class:`time.struct_time` tuple or
|
||||||
|
None if the string has wrong format.
|
||||||
|
|
||||||
.. function:: Int2AP(num)
|
.. function:: Int2AP(num)
|
||||||
|
|
||||||
@ -102,9 +102,13 @@ The following utility functions are defined:
|
|||||||
|
|
||||||
.. function:: Time2Internaldate(date_time)
|
.. function:: Time2Internaldate(date_time)
|
||||||
|
|
||||||
Converts a :mod:`time` module tuple to an IMAP4 ``INTERNALDATE`` representation.
|
Convert *date_time* to an IMAP4 ``INTERNALDATE`` representation. The
|
||||||
Returns a string in the form: ``"DD-Mmm-YYYY HH:MM:SS +HHMM"`` (including
|
return value is a string in the form: ``"DD-Mmm-YYYY HH:MM:SS
|
||||||
double-quotes).
|
+HHMM"`` (including double-quotes). The *date_time* argument can be a
|
||||||
|
number (int or float) represening seconds since epoch (as returned
|
||||||
|
by :func:`time.time`), a 9-tuple representing local time (as returned by
|
||||||
|
:func:`time.localtime`), or a double-quoted string. In the last case, it
|
||||||
|
is assumed to already be in the correct format.
|
||||||
|
|
||||||
Note that IMAP4 message numbers change as the mailbox changes; in particular,
|
Note that IMAP4 message numbers change as the mailbox changes; in particular,
|
||||||
after an ``EXPUNGE`` command performs deletions the remaining messages are
|
after an ``EXPUNGE`` command performs deletions the remaining messages are
|
||||||
|
@ -1312,9 +1312,10 @@ Mon2num = {'Jan': 1, 'Feb': 2, 'Mar': 3, 'Apr': 4, 'May': 5, 'Jun': 6,
|
|||||||
'Jul': 7, 'Aug': 8, 'Sep': 9, 'Oct': 10, 'Nov': 11, 'Dec': 12}
|
'Jul': 7, 'Aug': 8, 'Sep': 9, 'Oct': 10, 'Nov': 11, 'Dec': 12}
|
||||||
|
|
||||||
def Internaldate2tuple(resp):
|
def Internaldate2tuple(resp):
|
||||||
"""Convert IMAP4 INTERNALDATE to UT.
|
"""Parse an IMAP4 INTERNALDATE string.
|
||||||
|
|
||||||
Returns Python time module tuple.
|
Return corresponding local time. The return value is a
|
||||||
|
time.struct_time tuple or None if the string has wrong format.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
mo = InternalDate.match(resp)
|
mo = InternalDate.match(resp)
|
||||||
@ -1381,9 +1382,14 @@ def ParseFlags(resp):
|
|||||||
|
|
||||||
def Time2Internaldate(date_time):
|
def Time2Internaldate(date_time):
|
||||||
|
|
||||||
"""Convert 'date_time' to IMAP4 INTERNALDATE representation.
|
"""Convert date_time to IMAP4 INTERNALDATE representation.
|
||||||
|
|
||||||
Return string in form: '"DD-Mmm-YYYY HH:MM:SS +HHMM"'
|
Return string in form: '"DD-Mmm-YYYY HH:MM:SS +HHMM"'. The
|
||||||
|
date_time argument can be a number (int or float) represening
|
||||||
|
seconds since epoch (as returned by time.time()), a 9-tuple
|
||||||
|
representing local time (as returned by time.localtime()), or a
|
||||||
|
double-quoted string. In the last case, it is assumed to already
|
||||||
|
be in the correct format.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
if isinstance(date_time, (int, float)):
|
if isinstance(date_time, (int, float)):
|
||||||
|
Loading…
x
Reference in New Issue
Block a user