pandas.Timestamp#
- class pandas.Timestamp(ts_input=<object object>, freq=None, tz=None, unit=None, year=None, month=None, day=None, hour=None, minute=None, second=None, microsecond=None, nanosecond=None, tzinfo=None, *, fold=None)#
Pandas replacement for python datetime.datetime object.
Timestamp is the pandas equivalent of python’s Datetime and is interchangeable with it in most cases. It’s the type used for the entries that make up a DatetimeIndex, and other timeseries oriented data structures in pandas.
- Parameters
- ts_inputdatetime-like, str, int, float
Value to be converted to Timestamp.
- freqstr, DateOffset
Offset which Timestamp will have.
- tzstr, pytz.timezone, dateutil.tz.tzfile or None
Time zone for time which Timestamp will have.
- unitstr
Unit used for conversion if ts_input is of type int or float. The valid values are ‘D’, ‘h’, ‘m’, ‘s’, ‘ms’, ‘us’, and ‘ns’. For example, ‘s’ means seconds and ‘ms’ means milliseconds.
- year, month, dayint
- hour, minute, second, microsecondint, optional, default 0
- nanosecondint, optional, default 0
- tzinfodatetime.tzinfo, optional, default None
- fold{0, 1}, default None, keyword-only
Due to daylight saving time, one wall clock time can occur twice when shifting from summer to winter time; fold describes whether the datetime-like corresponds to the first (0) or the second time (1) the wall clock hits the ambiguous time.
New in version 1.1.0.
Notes
There are essentially three calling conventions for the constructor. The primary form accepts four parameters. They can be passed by position or keyword.
The other two forms mimic the parameters from
datetime.datetime. They can be passed by either position or keyword, but not both mixed together.Examples
Using the primary calling convention:
This converts a datetime-like string
>>> pd.Timestamp('2017-01-01T12') Timestamp('2017-01-01 12:00:00')
This converts a float representing a Unix epoch in units of seconds
>>> pd.Timestamp(1513393355.5, unit='s') Timestamp('2017-12-16 03:02:35.500000')
This converts an int representing a Unix-epoch in units of seconds and for a particular timezone
>>> pd.Timestamp(1513393355, unit='s', tz='US/Pacific') Timestamp('2017-12-15 19:02:35-0800', tz='US/Pacific')
Using the other two forms that mimic the API for
datetime.datetime:>>> pd.Timestamp(2017, 1, 1, 12) Timestamp('2017-01-01 12:00:00')
>>> pd.Timestamp(year=2017, month=1, day=1, hour=12) Timestamp('2017-01-01 12:00:00')
Attributes
Return numpy datetime64 format in nanoseconds.
Return day of the week.
Return the day of the year.
Return day of the week.
Return the day of the year.
Return the number of days in the month.
Return the number of days in the month.
Return the total number of days in the month.
Return True if year is a leap year.
Return True if date is last day of month.
Return True if date is first day of month.
Return True if date is last day of the quarter.
Return True if date is first day of the quarter.
Return True if date is last day of the year.
Return True if date is first day of the year.
Return the quarter of the year.
Alias for tzinfo.
Return the week number of the year.
Return the week number of the year.
day
fold
freq
hour
microsecond
minute
month
nanosecond
second
tzinfo
value
year
Methods
astimezone(tz)Convert timezone-aware Timestamp to another time zone.
ceil(freq[, ambiguous, nonexistent])Return a new Timestamp ceiled to this resolution.
combine(date, time)Combine date, time into datetime with same date and time fields.
Return ctime() style string.
Return date object with same year, month and day.
Return the day name of the Timestamp with specified locale.
Return self.tzinfo.dst(self).
floor(freq[, ambiguous, nonexistent])Return a new Timestamp floored to this resolution.
int, int, int -> Construct a date from the ISO year, week number and weekday.
string -> datetime from datetime.isoformat() output
fromordinal(ordinal[, freq, tz])Passed an ordinal, translate and convert to a ts.
fromtimestamp(ts)Transform timestamp[, tz] to tz's local time from POSIX timestamp.
Return a 3-tuple containing ISO year, week number, and weekday.
Return the time formatted according to ISO 8610.
Return the day of the week represented by the date.
Return the month name of the Timestamp with specified locale.
Normalize Timestamp to midnight, preserving tz information.
now([tz])Return new Timestamp object representing current time local to tz.
replace([year, month, day, hour, minute, ...])Implements datetime.replace, handles nanoseconds.
round(freq[, ambiguous, nonexistent])Round the Timestamp to the specified resolution.
strftime(format)Return a string representing the given POSIX timestamp controlled by an explicit format string.
strptime(string, format)Function is not implemented.
Return time object with same time but with tzinfo=None.
Return POSIX timestamp as float.
Return time tuple, compatible with time.localtime().
Return time object with same time and tzinfo.
Return a numpy.datetime64 object with 'ns' precision.
Convert TimeStamp to a Julian Date.
Convert the Timestamp to a NumPy datetime64.
Return an period of which this timestamp is an observation.
Convert a Timestamp object to a native Python datetime object.
today(cls[, tz])Return the current time in the local timezone.
Return proleptic Gregorian ordinal.
tz_convert(tz)Convert timezone-aware Timestamp to another time zone.
tz_localize(tz[, ambiguous, nonexistent])Convert naive Timestamp to local time zone, or remove timezone from timezone-aware Timestamp.
Return self.tzinfo.tzname(self).
utcfromtimestamp(ts)Construct a naive UTC datetime from a POSIX timestamp.
utcnow()Return a new Timestamp representing UTC day and time.
Return self.tzinfo.utcoffset(self).
Return UTC time tuple, compatible with time.localtime().
weekday()Return the day of the week represented by the date.