datafusion_python/expr/
alias.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::expr::Alias;
21use pyo3::prelude::*;
22
23use crate::expr::PyExpr;
24
25#[pyclass(frozen, name = "Alias", module = "datafusion.expr", subclass)]
26#[derive(Clone)]
27pub struct PyAlias {
28    alias: Alias,
29}
30
31impl From<Alias> for PyAlias {
32    fn from(alias: Alias) -> Self {
33        Self { alias }
34    }
35}
36
37impl From<PyAlias> for Alias {
38    fn from(py_alias: PyAlias) -> Self {
39        py_alias.alias
40    }
41}
42
43impl Display for PyAlias {
44    fn fmt(&self, f: &mut Formatter) -> fmt::Result {
45        write!(
46            f,
47            "Alias
48            \nExpr: `{:?}`
49            \nAlias Name: `{}`",
50            &self.alias.expr, &self.alias.name
51        )
52    }
53}
54
55#[pymethods]
56impl PyAlias {
57    /// Retrieve the "name" of the alias
58    fn alias(&self) -> PyResult<String> {
59        Ok(self.alias.name.clone())
60    }
61
62    fn expr(&self) -> PyResult<PyExpr> {
63        Ok((*self.alias.expr.clone()).into())
64    }
65
66    /// Get a String representation of this column
67    fn __repr__(&self) -> String {
68        format!("{self}")
69    }
70}