mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-09-10 10:47:34 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

Merged revisions 81756 via svnmerge from

Browse source 
svn+ssh://pythondev@svn.python.org/python/trunk

........
  r81756 | alexander.belopolsky | 2010-06-05 10:54:26 -0400 (Sat, 05 Jun 2010) | 1 line

  Issue #8899: time.struct_time now has class and atribute docstrings.
........
This commit is contained in:
Alexander Belopolsky 2010-06-05 15:04:51 +00:00
parent ac76074628
commit 69f3fd000d
3 changed files with 42 additions and 33 deletions
Download patch file Download diff file Expand all files Collapse all files

39
Doc/library/time.rst
View file

@ -81,30 +81,31 @@ An explanation of some terminology and conventions is in order.
:func:`gmtime`, :func:`localtime`, and :func:`strptime` also offer attribute :func:`gmtime`, :func:`localtime`, and :func:`strptime` also offer attribute
names for individual fields. names for individual fields.
+-------+------------------+------------------------------+ +-------+-------------------+---------------------------------+
| Index | Attribute | Values | | Index | Attribute | Values |
+=======+==================+==============================+ +=======+===================+=================================+
| 0 | :attr:`tm_year` | (for example, 1993) | | 0 | :attr:`tm_year` | (for example, 1993) |
+-------+------------------+------------------------------+ +-------+-------------------+---------------------------------+
| 1 | :attr:`tm_mon` | range [1,12] | | 1 | :attr:`tm_mon` | range [1, 12] |
+-------+------------------+------------------------------+ +-------+-------------------+---------------------------------+
| 2 | :attr:`tm_mday` | range [1,31] | | 2 | :attr:`tm_mday` | range [1, 31] |
+-------+------------------+------------------------------+ +-------+-------------------+---------------------------------+
| 3 | :attr:`tm_hour` | range [0,23] | | 3 | :attr:`tm_hour` | range [0, 23] |
+-------+------------------+------------------------------+ +-------+-------------------+---------------------------------+
| 4 | :attr:`tm_min` | range [0,59] | | 4 | :attr:`tm_min` | range [0, 59] |
+-------+------------------+------------------------------+ +-------+-------------------+---------------------------------+
| 5 | :attr:`tm_sec` | range [0,61]; see **(1)** in | | 5 | :attr:`tm_sec` | range [0, 61]; see **(1)** in |
| | | :func:`strftime` description | | | | :func:`strftime` description |
+-------+------------------+------------------------------+ +-------+-------------------+---------------------------------+
| 6 | :attr:`tm_wday` | range [0,6], Monday is 0 | | 6 | :attr:`tm_wday` | range [0, 6], Monday is 0 |
+-------+------------------+------------------------------+ +-------+-------------------+---------------------------------+
| 7 | :attr:`tm_yday` | range [1,366] | | 7 | :attr:`tm_yday` | range [1, 366] |
+-------+------------------+------------------------------+ +-------+-------------------+---------------------------------+
| 8 | :attr:`tm_isdst` | 0, 1 or -1; see below | | 8 | :attr:`tm_isdst` | 0, 1 or -1; see below |
+-------+------------------+------------------------------+ +-------+-------------------+---------------------------------+
Note that unlike the C structure, the month value is a range of 1-12, not 0-11. Note that unlike the C structure, the month value is a range of [1, 12],
not [0, 11].
A year value will be handled as described under "Year 2000 (Y2K) issues" above. A year value will be handled as described under "Year 2000 (Y2K) issues" above.
A ``-1`` argument as the daylight savings flag, passed to :func:`mktime` will A ``-1`` argument as the daylight savings flag, passed to :func:`mktime` will
usually result in the correct daylight savings state to be filled in. usually result in the correct daylight savings state to be filled in.

2
Misc/NEWS
View file

@ -398,6 +398,8 @@ C-API
Library Library
------- -------
- Issue #8899: time.struct_time now has class and atribute docstrings.
- Issue #6470: Drop UNC prefix in FixTk. - Issue #6470: Drop UNC prefix in FixTk.
- Issue #4768: base64 encoded email body parts were incorrectly stored as - Issue #4768: base64 encoded email body parts were incorrectly stored as

26
Modules/timemodule.c
View file

@ -208,21 +208,27 @@ Delay execution for a given number of seconds. The argument may be\n\
a floating point number for subsecond precision."); a floating point number for subsecond precision.");
static PyStructSequence_Field struct_time_type_fields[] = { static PyStructSequence_Field struct_time_type_fields[] = {
{"tm_year", NULL}, {"tm_year", "year, for example, 1993"},
{"tm_mon", NULL}, {"tm_mon", "month of year, range [1, 12]"},
{"tm_mday", NULL}, {"tm_mday", "day of month, range [1, 31]"},
{"tm_hour", NULL}, {"tm_hour", "hours, range [0, 23]"},
{"tm_min", NULL}, {"tm_min", "minutes, range [0, 59]"},
{"tm_sec", NULL}, {"tm_sec", "seconds, range [0, 61])"},
{"tm_wday", NULL}, {"tm_wday", "day of week, range [0, 6], Monday is 0"},
{"tm_yday", NULL}, {"tm_yday", "day of year, range [1, 366]"},
{"tm_isdst", NULL}, {"tm_isdst", "1 if summer time is in effect, 0 if not, and -1 if unknown"},
{0} {0}
}; };
static PyStructSequence_Desc struct_time_type_desc = { static PyStructSequence_Desc struct_time_type_desc = {
"time.struct_time", "time.struct_time",
NULL, "The time value as returned by gmtime(), localtime(), and strptime(), and\n"
" accepted by asctime(), mktime() and strftime(). May be considered as a\n"
" sequence of 9 integers.\n\n"
" Note that several fields' values are not the same as those defined by\n"
" the C language standard for struct tm. For example, the value of the\n"
" field tm_year is the actual year, not year - 1900. See individual\n"
" fields' descriptions for details.",
struct_time_type_fields, struct_time_type_fields,
9, 9,
}; };