@@ -78,21 +78,26 @@ def _new_DatetimeIndex(cls, d):
78
78
)
79
79
class DatetimeIndex (DatetimeTimedeltaMixin ):
80
80
"""
81
- Immutable ndarray of datetime64 data, represented internally as int64, and
82
- which can be boxed to Timestamp objects that are subclasses of datetime and
83
- carry metadata such as frequency information.
81
+ Immutable ndarray-like of datetime64 data.
82
+
83
+ Represented internally as int64, and which can be boxed to Timestamp objects
84
+ that are subclasses of datetime and carry metadata.
84
85
85
86
Parameters
86
87
----------
87
88
data : array-like (1-dimensional), optional
88
89
Optional datetime-like data to construct index with.
89
- copy : bool
90
- Make a copy of input ndarray.
91
90
freq : str or pandas offset object, optional
92
91
One of pandas date offset strings or corresponding objects. The string
93
92
'infer' can be passed in order to set the frequency of the index as the
94
93
inferred frequency upon creation.
95
- tz : pytz.timezone or dateutil.tz.tzfile
94
+ tz : pytz.timezone or dateutil.tz.tzfile or datetime.tzinfo or str
95
+ Set the Timezone of the data.
96
+ normalize : bool, default False
97
+ Normalize start/end dates to midnight before generating date range.
98
+ closed : {'left', 'right'}, optional
99
+ Set whether to include `start` and `end` that are on the
100
+ boundary. The default includes boundary points on either end.
96
101
ambiguous : 'infer', bool-ndarray, 'NaT', default 'raise'
97
102
When clocks moved backward due to DST, ambiguous times may arise.
98
103
For example in Central European Time (UTC+01), when going from 03:00
@@ -107,12 +112,16 @@ class DatetimeIndex(DatetimeTimedeltaMixin):
107
112
times)
108
113
- 'NaT' will return NaT where there are ambiguous times
109
114
- 'raise' will raise an AmbiguousTimeError if there are ambiguous times.
110
- name : object
111
- Name to be stored in the index.
112
115
dayfirst : bool, default False
113
116
If True, parse dates in `data` with the day first order.
114
117
yearfirst : bool, default False
115
118
If True parse dates in `data` with the year first order.
119
+ dtype : numpy.dtype or DatetimeTZDtype or str, default None
120
+ Note that the only NumPy dtype allowed is ‘datetime64[ns]’.
121
+ copy : bool, default False
122
+ Make a copy of input ndarray.
123
+ name : label, default None
124
+ Name to be stored in the index.
116
125
117
126
Attributes
118
127
----------
0 commit comments