xorbits.pandas.DataFrame.tz_convert#

DataFrame.tz_convert(tz, axis: Axis = 0, level=None, copy: bool_t | None = None) → Self#

Convert tz-aware axis to target time zone.

Parameters

  • tz (str or tzinfo object or None) – Target time zone. Passing None will convert to UTC and remove the timezone information.

  • axis ({0 or 'index', 1 or 'columns'}, default 0) – The axis to convert

  • level (int, str, default None) – If axis is a MultiIndex, convert a specific level. Otherwise must be None.

  • copy (bool, default True) – Also make a copy of the underlying data.

Returns

Object with time zone converted axis.

Return type

Series/DataFrame

Raises

TypeError – If the axis is tz-naive.

Examples

Change to another time zone:

>>> s = pd.Series(  
...     [1],
...     index=pd.DatetimeIndex(['2018-09-15 01:30:00+02:00']),
... )
>>> s.tz_convert('Asia/Shanghai')  
2018-09-15 07:30:00+08:00    1
dtype: int64

Pass None to convert to UTC and get a tz-naive index:

>>> s = pd.Series([1],  
...     index=pd.DatetimeIndex(['2018-09-15 01:30:00+02:00']))
>>> s.tz_convert(None)  
2018-09-14 23:30:00    1
dtype: int64

Warning

This method has not been implemented yet. Xorbits will try to execute it with pandas.

This docstring was copied from pandas.core.frame.DataFrame.