Skip to content
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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor(api)!: make as_timestamp and as_interval positional-only #10790

Merged
merged 2 commits into from
Feb 6, 2025
Merged

refactor(api)!: make as_timestamp and as_interval positional-only #10790

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
178dd77
refactor(api)!: change `as_timestamp` `unit` argument to be positiona…
cpcloud Feb 5, 2025
2b46aa6
refactor(api)!: change `as_interval` `unit` argument to be positional…
cpcloud Feb 5, 2025
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
2 changes: 1 addition & 1 deletion ibis/backends/bigquery/tests/unit/test_compiler.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,7 @@ def test_hashbytes(case, how, dtype, snapshot):
),
)
def test_integer_to_timestamp(case, unit, snapshot):
expr = ibis.literal(case, type=dt.int64).as_timestamp(unit=unit).name("tmp")
expr = ibis.literal(case, type=dt.int64).as_timestamp(unit).name("tmp")
snapshot.assert_match(to_sql(expr), "out.sql")


Expand Down
2 changes: 1 addition & 1 deletion ibis/backends/druid/tests/conftest.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ def functional_alltypes(self) -> ir.Table:
# tool that calls itself a time series database or "good for
# working with time series", that lacks a first-class timestamp
# type.
timestamp_col=t.timestamp_col.as_timestamp(unit="ms"),
timestamp_col=t.timestamp_col.as_timestamp("ms"),
)

@property
Expand Down
2 changes: 1 addition & 1 deletion ibis/backends/flink/tests/test_compiler.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ def test_count_star(simple_table, assert_sql):
],
)
def test_timestamp_from_unix(simple_table, unit, assert_sql):
expr = simple_table.d.as_timestamp(unit=unit)
expr = simple_table.d.as_timestamp(unit)
assert_sql(expr)


Expand Down
4 changes: 2 additions & 2 deletions ibis/backends/tests/test_temporal.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -556,7 +556,7 @@ def test_date_truncate(backend, alltypes, df, unit):
def test_integer_to_interval_timestamp(
backend, con, alltypes, df, unit, displacement_type
):
interval = alltypes.int_col.as_interval(unit=unit)
interval = alltypes.int_col.as_interval(unit)
expr = (alltypes.timestamp_col + interval).name("tmp")

def convert_to_offset(offset, displacement_type=displacement_type):
Expand Down Expand Up @@ -629,7 +629,7 @@ def convert_to_offset(offset, displacement_type=displacement_type):
@pytest.mark.notimpl(["datafusion", "druid"], raises=com.OperationNotDefinedError)
@pytest.mark.notimpl(["exasol"], raises=com.OperationNotDefinedError)
def test_integer_to_interval_date(backend, con, alltypes, df, unit):
interval = alltypes.int_col.as_interval(unit=unit)
interval = alltypes.int_col.as_interval(unit)
month = alltypes.date_string_col[:2]
day = alltypes.date_string_col[3:5]
year = alltypes.date_string_col[6:8]
Expand Down
24 changes: 10 additions & 14 deletions ibis/expr/types/numeric.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1420,10 +1420,7 @@ def approx_quantile(

@public
class IntegerValue(NumericValue):
def as_timestamp(
self,
unit: Literal["s", "ms", "us"],
) -> ir.TimestampValue:
def as_timestamp(self, unit: Literal["s", "ms", "us"], /) -> ir.TimestampValue:
"""Convert an integral UNIX timestamp to a timestamp expression.

Parameters
Expand All @@ -1440,11 +1437,7 @@ def as_timestamp(
--------
>>> import ibis
>>> ibis.options.interactive = True
>>> t = ibis.memtable(
... {
... "int_col": [0, 1730501716, 2147483647],
... }
... )
>>> t = ibis.memtable({"int_col": [0, 1730501716, 2147483647]})
>>> t.int_col.as_timestamp("s")
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ TimestampFromUNIX(int_col, SECOND) ┃
Expand All @@ -1461,6 +1454,7 @@ def as_timestamp(
def as_interval(
self,
unit: Literal["Y", "M", "W", "D", "h", "m", "s", "ms", "us", "ns"] = "s",
/,
) -> ir.IntervalValue:
"""Convert an integer to an interval.

Expand Down Expand Up @@ -1513,19 +1507,21 @@ def as_interval(
"""
return ops.IntervalFromInteger(self, unit).to_expr()

@deprecated(as_of="10.0", removed_in="11.0", instead="use as_timestamp() instead")
@deprecated(
as_of="10.0", removed_in="11.0", instead="use as_timestamp(unit) instead"
)
def to_timestamp(
self,
unit: Literal["s", "ms", "us"] = "s",
self, unit: Literal["s", "ms", "us"] = "s", /
) -> ir.TimestampValue:
return self.as_timestamp(unit=unit)
return self.as_timestamp(unit)

@deprecated(as_of="10.0", removed_in="11.0", instead="use as_interval() instead")
def to_interval(
self,
unit: Literal["Y", "M", "W", "D", "h", "m", "s", "ms", "us", "ns"] = "s",
/,
) -> ir.IntervalValue:
return self.as_interval(unit=unit)
return self.as_interval(unit)

def convert_base(
self,
Expand Down
26 changes: 13 additions & 13 deletions ibis/tests/expr/test_temporal.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -641,10 +641,10 @@ def test_integer_to_interval(column, unit, table):
@pytest.mark.parametrize(
"operands",
[
lambda t, u: (api.interval(3, unit=u), api.interval(2, unit=u)),
lambda t, u: (api.interval(3, unit=u), api.interval(3, unit=u)),
lambda t, u: (t.c.as_interval(unit=u), api.interval(2, unit=u)),
lambda t, u: (t.c.as_interval(unit=u), t.d.as_interval(unit=u)),
lambda _, u: (api.interval(3, unit=u), api.interval(2, unit=u)),
lambda _, u: (api.interval(3, unit=u), api.interval(3, unit=u)),
lambda t, u: (t.c.as_interval(u), api.interval(2, unit=u)),
lambda t, u: (t.c.as_interval(u), t.d.as_interval(u)),
],
)
@pytest.mark.parametrize(
Expand Down Expand Up @@ -688,15 +688,15 @@ def test_interval_comparisons(unit, operands, operator, table):
@pytest.mark.parametrize(
"interval",
[
lambda t: api.interval(years=4),
lambda t: api.interval(quarters=4),
lambda t: api.interval(months=3),
lambda t: api.interval(weeks=2),
lambda t: api.interval(days=1),
lambda t: t.c.as_interval(unit="Y"),
lambda t: t.c.as_interval(unit="M"),
lambda t: t.c.as_interval(unit="W"),
lambda t: t.c.as_interval(unit="D"),
lambda _: api.interval(years=4),
lambda _: api.interval(quarters=4),
lambda _: api.interval(months=3),
lambda _: api.interval(weeks=2),
lambda _: api.interval(days=1),
lambda t: t.c.as_interval("Y"),
lambda t: t.c.as_interval("M"),
lambda t: t.c.as_interval("W"),
lambda t: t.c.as_interval("D"),
],
ids=[
"years",
Expand Down
Loading