datafusion_python/expr/
unnest.rs

1// Licensed to the Apache Software Foundation (ASF) under one
2// or more contributor license agreements.  See the NOTICE file
3// distributed with this work for additional information
4// regarding copyright ownership.  The ASF licenses this file
5// to you under the Apache License, Version 2.0 (the
6// "License"); you may not use this file except in compliance
7// with the License.  You may obtain a copy of the License at
8//
9//   http://www.apache.org/licenses/LICENSE-2.0
10//
11// Unless required by applicable law or agreed to in writing,
12// software distributed under the License is distributed on an
13// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14// KIND, either express or implied.  See the License for the
15// specific language governing permissions and limitations
16// under the License.
17
18use std::fmt::{self, Display, Formatter};
19
20use datafusion::logical_expr::logical_plan::Unnest;
21use pyo3::prelude::*;
22use pyo3::IntoPyObjectExt;
23
24use crate::common::df_schema::PyDFSchema;
25use crate::expr::logical_node::LogicalNode;
26use crate::sql::logical::PyLogicalPlan;
27
28#[pyclass(frozen, name = "Unnest", module = "datafusion.expr", subclass)]
29#[derive(Clone)]
30pub struct PyUnnest {
31    unnest_: Unnest,
32}
33
34impl From<Unnest> for PyUnnest {
35    fn from(unnest_: Unnest) -> PyUnnest {
36        PyUnnest { unnest_ }
37    }
38}
39
40impl From<PyUnnest> for Unnest {
41    fn from(unnest_: PyUnnest) -> Self {
42        unnest_.unnest_
43    }
44}
45
46impl Display for PyUnnest {
47    fn fmt(&self, f: &mut Formatter) -> fmt::Result {
48        write!(
49            f,
50            "Unnest
51            Inputs: {:?}
52            Schema: {:?}",
53            &self.unnest_.input, &self.unnest_.schema,
54        )
55    }
56}
57
58#[pymethods]
59impl PyUnnest {
60    /// Retrieves the input `LogicalPlan` to this `Unnest` node
61    fn input(&self) -> PyResult<Vec<PyLogicalPlan>> {
62        Ok(Self::inputs(self))
63    }
64
65    /// Resulting Schema for this `Unnest` node instance
66    fn schema(&self) -> PyResult<PyDFSchema> {
67        Ok(self.unnest_.schema.as_ref().clone().into())
68    }
69
70    fn __repr__(&self) -> PyResult<String> {
71        Ok(format!("Unnest({self})"))
72    }
73
74    fn __name__(&self) -> PyResult<String> {
75        Ok("Unnest".to_string())
76    }
77}
78
79impl LogicalNode for PyUnnest {
80    fn inputs(&self) -> Vec<PyLogicalPlan> {
81        vec![PyLogicalPlan::from((*self.unnest_.input).clone())]
82    }
83
84    fn to_variant<'py>(&self, py: Python<'py>) -> PyResult<Bound<'py, PyAny>> {
85        self.clone().into_bound_py_any(py)
86    }
87}