Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

feat: add Series dt.tz and dt.unit properties #303

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jan 8, 2024
Merged

feat: add Series dt.tz and dt.unit properties #303

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5e9cf5b
feat: add Series dt.tz and dt.unit properties
TrevorBergeron Jan 4, 2024
cca5453
remove redundant pandas version checks from tests
TrevorBergeron Jan 5, 2024
7762e75
Merge branch 'main' into dt
TrevorBergeron Jan 5, 2024
6252e15
Merge branch 'main' into dt
TrevorBergeron Jan 8, 2024
0bc46b1
Merge branch 'main' into dt
TrevorBergeron Jan 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 29 additions & 8 deletions 37 bigframes/operations/datetimes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@

from __future__ import annotations

import datetime as dt
from typing import Optional

from bigframes.core import log_adapter
import bigframes.operations as ops
import bigframes.operations.base
Expand All @@ -27,6 +30,7 @@ class DatetimeMethods(
):
__doc__ = vendordt.DatetimeProperties.__doc__

# Date accessors
@property
def day(self) -> series.Series:
return self._apply_unary_op(ops.day_op)
Expand All @@ -40,17 +44,26 @@ def date(self) -> series.Series:
return self._apply_unary_op(ops.date_op)

@property
def hour(self) -> series.Series:
return self._apply_unary_op(ops.hour_op)
def quarter(self) -> series.Series:
return self._apply_unary_op(ops.quarter_op)

@property
def minute(self) -> series.Series:
return self._apply_unary_op(ops.minute_op)
def year(self) -> series.Series:
return self._apply_unary_op(ops.year_op)

@property
def month(self) -> series.Series:
return self._apply_unary_op(ops.month_op)

# Time accessors
@property
def hour(self) -> series.Series:
return self._apply_unary_op(ops.hour_op)

@property
def minute(self) -> series.Series:
return self._apply_unary_op(ops.minute_op)

@property
def second(self) -> series.Series:
return self._apply_unary_op(ops.second_op)
Expand All @@ -60,9 +73,17 @@ def time(self) -> series.Series:
return self._apply_unary_op(ops.time_op)

@property
def quarter(self) -> series.Series:
return self._apply_unary_op(ops.quarter_op)
def tz(self) -> Optional[dt.timezone]:
# Assumption: pyarrow dtype
tz_string = self._dtype.pyarrow_dtype.tz
if tz_string == "UTC":
return dt.timezone.utc
elif tz_string is None:
return None
else:
raise ValueError(f"Unexpected timezone {tz_string}")

@property
def year(self) -> series.Series:
return self._apply_unary_op(ops.year_op)
def unit(self) -> str:
# Assumption: pyarrow dtype
return self._dtype.pyarrow_dtype.unit
95 changes: 59 additions & 36 deletions 95 tests/system/small/operations/test_datetimes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,18 +16,22 @@
import pytest

import bigframes.series
from tests.system.utils import assert_series_equal
from tests.system.utils import assert_series_equal, skip_legacy_pandas

DATETIME_COL_NAMES = [("datetime_col",), ("timestamp_col",)]
DATE_COLUMNS = [
("datetime_col",),
("timestamp_col",),
("date_col",),
]


@pytest.mark.parametrize(
("col_name",),
DATETIME_COL_NAMES,
DATE_COLUMNS,
)
def test_day(scalars_dfs, col_name):
if pd.__version__.startswith("1."):
pytest.skip("Pyarrow datetime objects not support in pandas 1.x.")
@skip_legacy_pandas
def test_dt_day(scalars_dfs, col_name):
scalars_df, scalars_pandas_df = scalars_dfs
bf_series: bigframes.series.Series = scalars_df[col_name]
bf_result = bf_series.dt.day.to_pandas()
Expand All @@ -43,9 +47,8 @@ def test_day(scalars_dfs, col_name):
("col_name",),
DATETIME_COL_NAMES,
)
def test_date(scalars_dfs, col_name):
if pd.__version__.startswith("1."):
pytest.skip("Pyarrow datetime objects not support in pandas 1.x.")
@skip_legacy_pandas
def test_dt_date(scalars_dfs, col_name):
scalars_df, scalars_pandas_df = scalars_dfs
bf_series: bigframes.series.Series = scalars_df[col_name]
bf_result = bf_series.dt.date.to_pandas()
Expand All @@ -59,11 +62,10 @@ def test_date(scalars_dfs, col_name):

@pytest.mark.parametrize(
("col_name",),
DATETIME_COL_NAMES,
DATE_COLUMNS,
)
def test_dayofweek(scalars_dfs, col_name):
if pd.__version__.startswith("1."):
pytest.skip("Pyarrow datetime objects not support in pandas 1.x.")
@skip_legacy_pandas
def test_dt_dayofweek(scalars_dfs, col_name):
scalars_df, scalars_pandas_df = scalars_dfs
bf_series: bigframes.series.Series = scalars_df[col_name]
bf_result = bf_series.dt.dayofweek.to_pandas()
Expand All @@ -76,9 +78,8 @@ def test_dayofweek(scalars_dfs, col_name):
("col_name",),
DATETIME_COL_NAMES,
)
def test_hour(scalars_dfs, col_name):
if pd.__version__.startswith("1."):
pytest.skip("Pyarrow datetime objects not support in pandas 1.x.")
@skip_legacy_pandas
def test_dt_hour(scalars_dfs, col_name):
scalars_df, scalars_pandas_df = scalars_dfs
bf_series: bigframes.series.Series = scalars_df[col_name]
bf_result = bf_series.dt.hour.to_pandas()
Expand All @@ -94,9 +95,8 @@ def test_hour(scalars_dfs, col_name):
("col_name",),
DATETIME_COL_NAMES,
)
def test_minute(scalars_dfs, col_name):
if pd.__version__.startswith("1."):
pytest.skip("Pyarrow datetime objects not support in pandas 1.x.")
@skip_legacy_pandas
def test_dt_minute(scalars_dfs, col_name):
scalars_df, scalars_pandas_df = scalars_dfs
bf_series: bigframes.series.Series = scalars_df[col_name]
bf_result = bf_series.dt.minute.to_pandas()
Expand All @@ -110,11 +110,10 @@ def test_minute(scalars_dfs, col_name):

@pytest.mark.parametrize(
("col_name",),
DATETIME_COL_NAMES,
DATE_COLUMNS,
)
def test_month(scalars_dfs, col_name):
if pd.__version__.startswith("1."):
pytest.skip("Pyarrow datetime objects not support in pandas 1.x.")
@skip_legacy_pandas
def test_dt_month(scalars_dfs, col_name):
scalars_df, scalars_pandas_df = scalars_dfs
bf_series: bigframes.series.Series = scalars_df[col_name]
bf_result = bf_series.dt.month.to_pandas()
Expand All @@ -128,11 +127,10 @@ def test_month(scalars_dfs, col_name):

@pytest.mark.parametrize(
("col_name",),
DATETIME_COL_NAMES,
DATE_COLUMNS,
)
def test_quarter(scalars_dfs, col_name):
if pd.__version__.startswith("1."):
pytest.skip("Pyarrow datetime objects not support in pandas 1.x.")
@skip_legacy_pandas
def test_dt_quarter(scalars_dfs, col_name):
scalars_df, scalars_pandas_df = scalars_dfs
bf_series: bigframes.series.Series = scalars_df[col_name]
bf_result = bf_series.dt.quarter.to_pandas()
Expand All @@ -148,9 +146,8 @@ def test_quarter(scalars_dfs, col_name):
("col_name",),
DATETIME_COL_NAMES,
)
def test_second(scalars_dfs, col_name):
if pd.__version__.startswith("1."):
pytest.skip("Pyarrow datetime objects not support in pandas 1.x.")
@skip_legacy_pandas
def test_dt_second(scalars_dfs, col_name):
scalars_df, scalars_pandas_df = scalars_dfs
bf_series: bigframes.series.Series = scalars_df[col_name]
bf_result = bf_series.dt.second.to_pandas()
Expand All @@ -166,9 +163,8 @@ def test_second(scalars_dfs, col_name):
("col_name",),
DATETIME_COL_NAMES,
)
def test_time(scalars_dfs, col_name):
if pd.__version__.startswith("1."):
pytest.skip("Pyarrow datetime objects not support in pandas 1.x.")
@skip_legacy_pandas
def test_dt_time(scalars_dfs, col_name):
scalars_df, scalars_pandas_df = scalars_dfs
bf_series: bigframes.series.Series = scalars_df[col_name]
bf_result = bf_series.dt.time.to_pandas()
Expand All @@ -182,11 +178,10 @@ def test_time(scalars_dfs, col_name):

@pytest.mark.parametrize(
("col_name",),
DATETIME_COL_NAMES,
DATE_COLUMNS,
)
def test_year(scalars_dfs, col_name):
if pd.__version__.startswith("1."):
pytest.skip("Pyarrow datetime objects not support in pandas 1.x.")
@skip_legacy_pandas
def test_dt_year(scalars_dfs, col_name):
scalars_df, scalars_pandas_df = scalars_dfs
bf_series: bigframes.series.Series = scalars_df[col_name]
bf_result = bf_series.dt.year.to_pandas()
Expand All @@ -196,3 +191,31 @@ def test_year(scalars_dfs, col_name):
pd_result.astype(pd.Int64Dtype()),
bf_result,
)


@pytest.mark.parametrize(
("col_name",),
DATETIME_COL_NAMES,
)
@skip_legacy_pandas
def test_dt_tz(scalars_dfs, col_name):
scalars_df, scalars_pandas_df = scalars_dfs
bf_series: bigframes.series.Series = scalars_df[col_name]
bf_result = bf_series.dt.tz
pd_result = scalars_pandas_df[col_name].dt.tz

assert bf_result == pd_result


@pytest.mark.parametrize(
("col_name",),
DATETIME_COL_NAMES,
)
@skip_legacy_pandas
def test_dt_unit(scalars_dfs, col_name):
scalars_df, scalars_pandas_df = scalars_dfs
bf_series: bigframes.series.Series = scalars_df[col_name]
bf_result = bf_series.dt.unit
pd_result = scalars_pandas_df[col_name].dt.unit

assert bf_result == pd_result
19 changes: 19 additions & 0 deletions 19 third_party/bigframes_vendored/pandas/core/indexes/accessor.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,3 +94,22 @@ def year(self):
"""The year of the datetime."""

raise NotImplementedError(constants.ABSTRACT_METHOD_ERROR_MESSAGE)

@property
def tz(self):
"""Return the timezone.

Returns:
datetime.tzinfo, pytz.tzinfo.BaseTZInfo, dateutil.tz.tz.tzfile, or None
"""

raise NotImplementedError(constants.ABSTRACT_METHOD_ERROR_MESSAGE)

@property
def unit(self) -> str:
"""Returns the unit of time precision.

Returns:
Unit as string (eg. "us").
"""
raise NotImplementedError(constants.ABSTRACT_METHOD_ERROR_MESSAGE)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.