Skip to content
Navigation Menu
{{ message }}
forked from apache/datafusion-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathwindow.rs
More file actions
295 lines (265 loc) · 9.93 KB
/
Copy pathwindow.rs
File metadata and controls
295 lines (265 loc) · 9.93 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership. The ASF licenses this file
// to you under the Apache License, Version 2.0 (the
// "License"); you may not use this file except in compliance
// with the License. You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing,
// software distributed under the License is distributed on an
// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
// KIND, either express or implied. See the License for the
// specific language governing permissions and limitations
// under the License.
use datafusion::common::{DataFusionError, ScalarValue};
use datafusion::logical_expr::expr::WindowFunction;
use datafusion::logical_expr::{Expr, Window, WindowFrame, WindowFrameBound, WindowFrameUnits};
use pyo3::{prelude::*, IntoPyObjectExt};
use std::fmt::{self, Display, Formatter};
use crate::common::data_type::PyScalarValue;
use crate::common::df_schema::PyDFSchema;
use crate::errors::{py_type_err, PyDataFusionResult};
use crate::expr::logical_node::LogicalNode;
use crate::expr::sort_expr::{py_sort_expr_list, PySortExpr};
use crate::expr::PyExpr;
use crate::sql::logical::PyLogicalPlan;
use super::py_expr_list;
use crate::errors::py_datafusion_err;
#[pyclass(name = "WindowExpr", module = "datafusion.expr", subclass)]
#[derive(Clone)]
pub struct PyWindowExpr {
window: Window,
}
#[pyclass(name = "WindowFrame", module = "datafusion.expr", subclass)]
#[derive(Clone)]
pub struct PyWindowFrame {
window_frame: WindowFrame,
}
impl From<PyWindowFrame> for WindowFrame {
fn from(window_frame: PyWindowFrame) -> Self {
window_frame.window_frame
}
}
impl From<WindowFrame> for PyWindowFrame {
fn from(window_frame: WindowFrame) -> PyWindowFrame {
PyWindowFrame { window_frame }
}
}
#[pyclass(name = "WindowFrameBound", module = "datafusion.expr", subclass)]
#[derive(Clone)]
pub struct PyWindowFrameBound {
frame_bound: WindowFrameBound,
}
impl From<PyWindowExpr> for Window {
fn from(window: PyWindowExpr) -> Window {
window.window
}
}
impl From<Window> for PyWindowExpr {
fn from(window: Window) -> PyWindowExpr {
PyWindowExpr { window }
}
}
impl From<WindowFrameBound> for PyWindowFrameBound {
fn from(frame_bound: WindowFrameBound) -> Self {
PyWindowFrameBound { frame_bound }
}
}
impl Display for PyWindowExpr {
fn fmt(&self, f: &mut Formatter) -> fmt::Result {
write!(
f,
"Over\n
Window Expr: {:?}
Schema: {:?}",
&self.window.window_expr, &self.window.schema
)
}
}
impl Display for PyWindowFrame {
fn fmt(&self, f: &mut Formatter) -> std::fmt::Result {
write!(
f,
"OVER ({} BETWEEN {} AND {})",
self.window_frame.units, self.window_frame.start_bound, self.window_frame.end_bound
)
}
}
#[pymethods]
impl PyWindowExpr {
/// Returns the schema of the Window
pub fn schema(&self) -> PyResult<PyDFSchema> {
Ok(self.window.schema.as_ref().clone().into())
}
/// Returns window expressions
pub fn get_window_expr(&self) -> PyResult<Vec<PyExpr>> {
py_expr_list(&self.window.window_expr)
}
/// Returns order by columns in a window function expression
pub fn get_sort_exprs(&self, expr: PyExpr) -> PyResult<Vec<PySortExpr>> {
match expr.expr.unalias() {
Expr::WindowFunction(WindowFunction { order_by, .. }) => py_sort_expr_list(&order_by),
other => Err(not_window_function_err(other)),
}
}
/// Return partition by columns in a window function expression
pub fn get_partition_exprs(&self, expr: PyExpr) -> PyResult<Vec<PyExpr>> {
match expr.expr.unalias() {
Expr::WindowFunction(WindowFunction { partition_by, .. }) => {
py_expr_list(&partition_by)
}
other => Err(not_window_function_err(other)),
}
}
/// Return input args for window function
pub fn get_args(&self, expr: PyExpr) -> PyResult<Vec<PyExpr>> {
match expr.expr.unalias() {
Expr::WindowFunction(WindowFunction { args, .. }) => py_expr_list(&args),
other => Err(not_window_function_err(other)),
}
}
/// Return window function name
pub fn window_func_name(&self, expr: PyExpr) -> PyResult<String> {
match expr.expr.unalias() {
Expr::WindowFunction(WindowFunction { fun, .. }) => Ok(fun.to_string()),
other => Err(not_window_function_err(other)),
}
}
/// Returns a Pywindow frame for a given window function expression
pub fn get_frame(&self, expr: PyExpr) -> Option<PyWindowFrame> {
match expr.expr.unalias() {
Expr::WindowFunction(WindowFunction { window_frame, .. }) => Some(window_frame.into()),
_ => None,
}
}
}
fn not_window_function_err(expr: Expr) -> PyErr {
py_type_err(format!(
"Provided {} Expr {:?} is not a WindowFunction type",
expr.variant_name(),
expr
))
}
#[pymethods]
impl PyWindowFrame {
#[new]
#[pyo3(signature=(unit, start_bound, end_bound))]
pub fn new(
unit: &str,
start_bound: Option<PyScalarValue>,
end_bound: Option<PyScalarValue>,
) -> PyResult<Self> {
let units = unit.to_ascii_lowercase();
let units = match units.as_str() {
"rows" => WindowFrameUnits::Rows,
"range" => WindowFrameUnits::Range,
"groups" => WindowFrameUnits::Groups,
_ => {
return Err(py_datafusion_err(DataFusionError::NotImplemented(format!(
"{:?}",
units,
))));
}
};
let start_bound = match start_bound {
Some(start_bound) => WindowFrameBound::Preceding(start_bound.0),
None => match units {
WindowFrameUnits::Range => WindowFrameBound::Preceding(ScalarValue::UInt64(None)),
WindowFrameUnits::Rows => WindowFrameBound::Preceding(ScalarValue::UInt64(None)),
WindowFrameUnits::Groups => {
return Err(py_datafusion_err(DataFusionError::NotImplemented(format!(
"{:?}",
units,
))));
}
},
};
let end_bound = match end_bound {
Some(end_bound) => WindowFrameBound::Following(end_bound.0),
None => match units {
WindowFrameUnits::Rows => WindowFrameBound::Following(ScalarValue::UInt64(None)),
WindowFrameUnits::Range => WindowFrameBound::Following(ScalarValue::UInt64(None)),
WindowFrameUnits::Groups => {
return Err(py_datafusion_err(DataFusionError::NotImplemented(format!(
"{:?}",
units,
))));
}
},
};
Ok(PyWindowFrame {
window_frame: WindowFrame::new_bounds(units, start_bound, end_bound),
})
}
/// Returns the window frame units for the bounds
pub fn get_frame_units(&self) -> PyResult<String> {
Ok(self.window_frame.units.to_string())
}
/// Returns starting bound
pub fn get_lower_bound(&self) -> PyResult<PyWindowFrameBound> {
Ok(self.window_frame.start_bound.clone().into())
}
/// Returns end bound
pub fn get_upper_bound(&self) -> PyResult<PyWindowFrameBound> {
Ok(self.window_frame.end_bound.clone().into())
}
/// Get a String representation of this window frame
fn __repr__(&self) -> String {
format!("{}", self)
}
}
#[pymethods]
impl PyWindowFrameBound {
/// Returns if the frame bound is current row
pub fn is_current_row(&self) -> bool {
matches!(self.frame_bound, WindowFrameBound::CurrentRow)
}
/// Returns if the frame bound is preceding
pub fn is_preceding(&self) -> bool {
matches!(self.frame_bound, WindowFrameBound::Preceding(_))
}
/// Returns if the frame bound is following
pub fn is_following(&self) -> bool {
matches!(self.frame_bound, WindowFrameBound::Following(_))
}
/// Returns the offset of the window frame
pub fn get_offset(&self) -> PyDataFusionResult<Option<u64>> {
match &self.frame_bound {
WindowFrameBound::Preceding(val) | WindowFrameBound::Following(val) => match val {
x if x.is_null() => Ok(None),
ScalarValue::UInt64(v) => Ok(*v),
// The cast below is only safe because window bounds cannot be negative
ScalarValue::Int64(v) => Ok(v.map(|n| n as u64)),
ScalarValue::Utf8(Some(s)) => match s.parse::<u64>() {
Ok(s) => Ok(Some(s)),
Err(_e) => Err(DataFusionError::Plan(format!(
"Unable to parse u64 from Utf8 value '{s}'"
))
.into()),
},
ref x => {
Err(DataFusionError::Plan(format!("Unexpected window frame bound: {x}")).into())
}
},
WindowFrameBound::CurrentRow => Ok(None),
}
}
/// Returns if the frame bound is unbounded
pub fn is_unbounded(&self) -> PyResult<bool> {
match &self.frame_bound {
WindowFrameBound::Preceding(v) | WindowFrameBound::Following(v) => Ok(v.is_null()),
WindowFrameBound::CurrentRow => Ok(false),
}
}
}
impl LogicalNode for PyWindowExpr {
fn inputs(&self) -> Vec<PyLogicalPlan> {
vec![self.window.input.as_ref().clone().into()]
}
fn to_variant<'py>(&self, py: Python<'py>) -> PyResult<Bound<'py, PyAny>> {
self.clone().into_bound_py_any(py)
}
}
You can’t perform that action at this time.