Skip to content

Commit

Permalink
add doc argument in special operators
Browse files Browse the repository at this point in the history
  • Loading branch information
finn-rudolph committed Dec 14, 2024
1 parent e1d57e3 commit c3c1121
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 11 deletions.
11 changes: 6 additions & 5 deletions src/pydiverse/transform/_internal/ops/ops/datetime.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,17 @@


class DatetimeExtract(Operator):
def __init__(self, name: str):
super().__init__(name, Signature(Datetime(), return_type=Int()))
def __init__(self, name: str, doc: str = ""):
super().__init__(name, Signature(Datetime(), return_type=Int()), doc=doc)


class DateExtract(Operator):
def __init__(self, name: str):
def __init__(self, name: str, doc: str = ""):
super().__init__(
name,
Signature(Date(), return_type=Int()),
Signature(Datetime(), return_type=Int()),
doc=doc,
)


Expand All @@ -41,8 +42,8 @@ def __init__(self, name: str):


class DurationToUnit(Operator):
def __init__(self, name: str):
super().__init__(name, Signature(Duration(), return_type=Int()))
def __init__(self, name: str, doc: str = ""):
super().__init__(name, Signature(Duration(), return_type=Int()), doc=doc)


dur_days = DurationToUnit("dur.days")
Expand Down
8 changes: 6 additions & 2 deletions src/pydiverse/transform/_internal/ops/ops/horizontal.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,13 @@


class Horizontal(Operator):
def __init__(self, name: str, *signatures: Signature):
def __init__(self, name: str, *signatures: Signature, doc: str = ""):
super().__init__(
name, *signatures, param_names=["arg", "args"], generate_expr_method=False
name,
*signatures,
param_names=["arg", "args"],
generate_expr_method=False,
doc=doc,
)


Expand Down
4 changes: 2 additions & 2 deletions src/pydiverse/transform/_internal/ops/ops/markers.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@


class Marker(Operator):
def __init__(self, name: str):
super().__init__(name, Signature(D, return_type=D))
def __init__(self, name: str, doc: str = ""):
super().__init__(name, Signature(D, return_type=D), doc=doc)


nulls_first = Marker("nulls_first")
Expand Down
4 changes: 2 additions & 2 deletions src/pydiverse/transform/_internal/ops/ops/string.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@


class StrUnary(Operator):
def __init__(self, name: str):
super().__init__(name, Signature(String(), return_type=String()))
def __init__(self, name: str, doc: str = ""):
super().__init__(name, Signature(String(), return_type=String()), doc=doc)


str_strip = StrUnary("str.strip")
Expand Down
2 changes: 2 additions & 0 deletions src/pydiverse/transform/_internal/ops/ops/window.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ def __init__(
param_names: list[str] | None = None,
default_values: list[Any] | None = None,
generate_expr_method=False,
doc: str = "",
):
super().__init__(
name,
Expand All @@ -24,6 +25,7 @@ def __init__(
param_names=param_names,
default_values=default_values,
generate_expr_method=generate_expr_method,
doc=doc,
)


Expand Down

0 comments on commit c3c1121

Please sign in to comment.