[Python-checkins] r88116 - in python/branches/release27-maint: Doc/library/imaplib.rst Lib/imaplib.py
alexander.belopolsky
python-checkins at python.org
Wed Jan 19 22:48:20 CET 2011
Author: alexander.belopolsky
Date: Wed Jan 19 22:48:20 2011
New Revision: 88116
Log:
Merged revisions 88114 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/branches/py3k
........
r88114 | alexander.belopolsky | 2011-01-19 14:53:30 -0500 (Wed, 19 Jan 2011) | 5 lines
Issue #10934: Fixed and expanded Internaldate2tuple() and
Time2Internaldate() documentation. Thanks Joe Peterson for the report
and the original patch.
........
Modified:
python/branches/release27-maint/ (props changed)
python/branches/release27-maint/Doc/library/imaplib.rst
python/branches/release27-maint/Lib/imaplib.py
Modified: python/branches/release27-maint/Doc/library/imaplib.rst
==============================================================================
--- python/branches/release27-maint/Doc/library/imaplib.rst (original)
+++ python/branches/release27-maint/Doc/library/imaplib.rst Wed Jan 19 22:48:20 2011
@@ -84,9 +84,9 @@
.. function:: Internaldate2tuple(datestr)
- Converts an IMAP4 INTERNALDATE string to Coordinated Universal Time. Returns a
- :mod:`time` module tuple.
-
+ Parse an IMAP4 ``INTERNALDATE`` string and return corresponding local
+ time. The return value is a :class:`time.struct_time` instance or
+ None if the string has wrong format.
.. function:: Int2AP(num)
@@ -101,9 +101,13 @@
.. function:: Time2Internaldate(date_time)
- Converts a :mod:`time` module tuple to an IMAP4 ``INTERNALDATE`` representation.
- Returns a string in the form: ``"DD-Mmm-YYYY HH:MM:SS +HHMM"`` (including
- double-quotes).
+ Convert *date_time* to an IMAP4 ``INTERNALDATE`` representation. The
+ return value is a string in the form: ``"DD-Mmm-YYYY HH:MM:SS
+ +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,
after an ``EXPUNGE`` command performs deletions the remaining messages are
Modified: python/branches/release27-maint/Lib/imaplib.py
==============================================================================
--- python/branches/release27-maint/Lib/imaplib.py (original)
+++ python/branches/release27-maint/Lib/imaplib.py Wed Jan 19 22:48:20 2011
@@ -1321,9 +1321,10 @@
'Jul': 7, 'Aug': 8, 'Sep': 9, 'Oct': 10, 'Nov': 11, 'Dec': 12}
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 instance or None if the string has wrong format.
"""
mo = InternalDate.match(resp)
@@ -1390,9 +1391,14 @@
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)):
More information about the Python-checkins
mailing list