Pandas DataFrame: tz_localize() function

Last update on August 19 2022 21:50:51 (UTC/GMT +8 hours)

DataFrame - tz_localize() function

The tz_localize() function is used to localize tz-naive index of a Series or DataFrame to target time zone.

This operation localizes the Index. To localize the values in a timezone-naive Series, use Series.dt.tz_localize().

Syntax:

DataFrame.tz_localize(self, tz, axis=0, level=None, copy=True, ambiguous='raise', nonexistent='raise')

Parameters:

Name	Description	Type / Default Value	Required / Optional
tz		string or pytz.timezone object	Required
axis	the axis to localize		Required
level	If axis ia a MultiIndex, localize a specific level. Otherwise must be None	int, str Default Value: None	Required
copy	Also make a copy of the underlying data	boolean Default Value: True	Required
ambiguous	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 ambiguous parameter dictates how ambiguous times should be handled. ‘infer’ will attempt to infer fall dst-transition hours based on order bool-ndarray where True signifies a DST time, False designates a non-DST time (note that this flag is only applicable for ambiguous times) ‘NaT’ will return NaT where there are ambiguous times ‘raise’ will raise an AmbiguousTimeError if there are ambiguous times	‘infer’, bool-ndarray, ‘NaT’, Default Value: ‘raise’	Required
nonexistent	A nonexistent time does not exist in a particular timezone where clocks moved forward due to DST. Valid values are: ‘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	str Default Value: ‘raise’	Required

Returns: Series or DataFrame
Same type as the input.

Raises: TypeError
If the TimeSeries is tz-aware and tz is not None.

Example:

Download the Pandas DataFrame Notebooks from here.

Previous: DataFrame - resample() function
Next: DataFrame.plot.area() function