pandas 1.4.2
ParametersRaisesReturns

Parameters

tz : str, pytz.timezone, dateutil.tz.tzfile or None

Time zone for time which Timestamp will be converted to. None will remove timezone holding local time.

ambiguous : bool, 'NaT', default 'raise'

When clocks moved backward due to DST, ambiguous times may arise. For example in Central European Time (UTC+01), when going from 03:00 DST to 02:00 non-DST, 02:30:00 local time occurs both at 00:30:00 UTC and at 01:30:00 UTC. In such a situation, the :None:None:`ambiguous` parameter dictates how ambiguous times should be handled.

The behavior is as follows:

  • bool contains flags to determine if time is dst or not (note that this flag is only applicable for ambiguous fall dst dates).

  • 'NaT' will return NaT for an ambiguous time.

  • 'raise' will raise an AmbiguousTimeError for an ambiguous time.

nonexistent : 'shift_forward', 'shift_backward, 'NaT', timedelta, default 'raise'

A nonexistent time does not exist in a particular timezone where clocks moved forward due to DST.

The behavior is as follows:

  • 'shift_forward' will shift the nonexistent time forward to the closest existing time.

  • 'shift_backward' will shift the nonexistent time backward to the closest existing time.

  • 'NaT' will return NaT where there are nonexistent times.

  • timedelta objects will shift nonexistent times by the timedelta.

  • 'raise' will raise an NonExistentTimeError if there are nonexistent times.

Raises

TypeError

If the Timestamp is tz-aware and tz is not None.

Returns

localized : Timestamp

Convert naive Timestamp to local time zone, or remove timezone from timezone-aware Timestamp.

Examples

Create a naive timestamp object:

This example is valid syntax, but we were not able to check execution
>>> ts = pd.Timestamp('2020-03-14T15:32:52.192548651')
... ts
Timestamp('2020-03-14 15:32:52.192548651')

Add 'Europe/Stockholm' as timezone:

This example is valid syntax, but we were not able to check execution
>>> ts.tz_localize(tz='Europe/Stockholm')
Timestamp('2020-03-14 15:32:52.192548651+0100', tz='Europe/Stockholm')

Analogous for pd.NaT :

This example is valid syntax, but we were not able to check execution
>>> pd.NaT.tz_localize()
NaT
See :

Local connectivity graph

Hover to see nodes names; edges to Self not shown, Caped at 50 nodes.

Using a canvas is more power efficient and can get hundred of nodes ; but does not allow hyperlinks; , arrows or text (beyond on hover)

SVG is more flexible but power hungry; and does not scale well to 50 + nodes.

All aboves nodes referred to, (or are referred from) current nodes; Edges from Self to other have been omitted (or all nodes would be connected to the central node "self" which is not useful). Nodes are colored by the library they belong to, and scaled with the number of references pointing them

File: None#None
type: <class 'cython_function_or_method'>
Commit: