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.

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

Add Python wrapper for LogicalPlan::Sort #196

Merged
merged 1 commit into from
Feb 19, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 2 additions & 1 deletion datafusion/tests/test_imports.py
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@
Expr,
Projection,
TableScan,
Sort,
)


Expand All @@ -55,7 +56,7 @@ def test_class_module_is_datafusion():
]:
assert klass.__module__ == "datafusion"

for klass in [Expr, Projection, TableScan]:
for klass in [Expr, Projection, TableScan, Sort]:
assert klass.__module__ == "datafusion.expr"

for klass in [DFField, DFSchema]:
Expand Down
2 changes: 2 additions & 0 deletions src/expr.rs
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ use datafusion::scalar::ScalarValue;

pub mod logical_node;
pub mod projection;
pub mod sort;
pub mod table_scan;

/// A PyExpr that can be used on a DataFrame
Expand Down Expand Up @@ -143,5 +144,6 @@ pub(crate) fn init_module(m: &PyModule) -> PyResult<()> {
m.add_class::<PyExpr>()?;
m.add_class::<table_scan::PyTableScan>()?;
m.add_class::<projection::PyProjection>()?;
m.add_class::<sort::PySort>()?;
Ok(())
}
94 changes: 94 additions & 0 deletions src/expr/sort.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
// 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;
use datafusion_expr::logical_plan::Sort;
use pyo3::prelude::*;
use std::fmt::{self, Display, Formatter};

use crate::common::df_schema::PyDFSchema;
use crate::expr::logical_node::LogicalNode;
use crate::expr::PyExpr;
use crate::sql::logical::PyLogicalPlan;

#[pyclass(name = "Sort", module = "datafusion.expr", subclass)]
#[derive(Clone)]
pub struct PySort {
sort: Sort,
}

impl From<Sort> for PySort {
fn from(sort: Sort) -> PySort {
PySort { sort }
}
}

impl TryFrom<PySort> for Sort {
type Error = DataFusionError;

fn try_from(agg: PySort) -> Result<Self, Self::Error> {
Ok(agg.sort)
}
}

impl Display for PySort {
fn fmt(&self, f: &mut Formatter) -> fmt::Result {
write!(
f,
"Sort
\nExpr(s): {:?}
\nInput: {:?}
\nSchema: {:?}",
&self.sort.expr,
self.sort.input,
self.sort.input.schema()
)
}
}

#[pymethods]
impl PySort {
/// Retrieves the sort expressions for this `Sort`
fn sort_exprs(&self) -> PyResult<Vec<PyExpr>> {
Ok(self
.sort
.expr
.iter()
.map(|e| PyExpr::from(e.clone()))
.collect())
}

/// Retrieves the input `LogicalPlan` to this `Sort` node
fn input(&self) -> PyLogicalPlan {
PyLogicalPlan::from((*self.sort.input).clone())
}

/// Resulting Schema for this `Sort` node instance
fn schema(&self) -> PyDFSchema {
self.sort.input.schema().as_ref().clone().into()
}

fn __repr__(&self) -> PyResult<String> {
Ok(format!("Sort({})", self))
}
}

impl LogicalNode for PySort {
fn input(&self) -> Vec<PyLogicalPlan> {
vec![PyLogicalPlan::from((*self.sort.input).clone())]
}
}