datafusion_python/expr/scalar_variable.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 arrow::datatypes::FieldRef;
19use pyo3::prelude::*;
20
21use crate::common::data_type::PyDataType;
22
23#[pyclass(frozen, name = "ScalarVariable", module = "datafusion.expr", subclass)]
24#[derive(Clone)]
25pub struct PyScalarVariable {
26 field: FieldRef,
27 variables: Vec<String>,
28}
29
30impl PyScalarVariable {
31 pub fn new(field: &FieldRef, variables: &[String]) -> Self {
32 Self {
33 field: field.to_owned(),
34 variables: variables.to_vec(),
35 }
36 }
37}
38
39#[pymethods]
40impl PyScalarVariable {
41 /// Get the data type
42 fn data_type(&self) -> PyResult<PyDataType> {
43 Ok(self.field.data_type().clone().into())
44 }
45
46 fn variables(&self) -> PyResult<Vec<String>> {
47 Ok(self.variables.clone())
48 }
49
50 fn __repr__(&self) -> PyResult<String> {
51 Ok(format!("{}{:?}", self.field.data_type(), self.variables))
52 }
53}