Mirror
/
cpython
mirror of https://github.com/python/cpython
4
1
Fork 0
Code Issues Releases Wiki Activity

Patch #1731659: improve time.strptime docs.

This commit is contained in:
Georg Brandl 2007-07-12 09:06:41 +00:00
parent 7c3b50db66
commit c8011d649e
1 changed files with 17 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
Doc/lib/libtime.tex
View File

@ -309,15 +309,23 @@ The field width is normally 2 except for \code{\%j} where it is 3.
\begin{funcdesc}{strptime}{string\optional{, format}} \begin{funcdesc}{strptime}{string\optional{, format}}
Parse a string representing a time according to a format. The return Parse a string representing a time according to a format. The return
value is a \class{struct_time} as returned by \function{gmtime()} or value is a \class{struct_time} as returned by \function{gmtime()} or
\function{localtime()}. The \var{format} parameter uses the same \function{localtime()}.
directives as those used by \function{strftime()}; it defaults to
\code{"\%a \%b \%d \%H:\%M:\%S \%Y"} which matches the formatting The \var{format} parameter uses the same directives as those used by
returned by \function{ctime()}. If \var{string} cannot be parsed \function{strftime()}; it defaults to \code{"\%a \%b \%d \%H:\%M:\%S
according to \var{format}, \exception{ValueError} is raised. If the \%Y"} which matches the formatting returned by \function{ctime()}.
string to be parsed has excess data after parsing, If \var{string} cannot be parsed according to \var{format}, or if it
\exception{ValueError} is raised. The default values used to fill in has excess data after parsing, \exception{ValueError} is raised. The
any missing data when more accurate values cannot be inferred are default values used to fill in any missing data when more accurate
\code{(1900, 1, 1, 0, 0, 0, 0, 1, -1)} . values cannot be inferred are \code{(1900, 1, 1, 0, 0, 0, 0, 1, -1)}.
For example:
\begin{verbatim}
>>> import time
>>> time.strptime("30 Nov 00", "%d %b %y")
(2000, 11, 30, 0, 0, 0, 3, 335, -1)
\end{verbatim}
Support for the \code{\%Z} directive is based on the values contained in Support for the \code{\%Z} directive is based on the values contained in
\code{tzname} and whether \code{daylight} is true. Because of this, \code{tzname} and whether \code{daylight} is true. Because of this,