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(
24 from_py_object,
25 frozen,
26 name = "ScalarVariable",
27 module = "datafusion.expr",
28 subclass
29)]
30#[derive(Clone)]
31pub struct PyScalarVariable {
32 field: FieldRef,
33 variables: Vec<String>,
34}
35
36impl PyScalarVariable {
37 pub fn new(field: &FieldRef, variables: &[String]) -> Self {
38 Self {
39 field: field.to_owned(),
40 variables: variables.to_vec(),
41 }
42 }
43}
44
45#[pymethods]
46impl PyScalarVariable {
47 /// Get the data type
48 fn data_type(&self) -> PyResult<PyDataType> {
49 Ok(self.field.data_type().clone().into())
50 }
51
52 fn variables(&self) -> PyResult<Vec<String>> {
53 Ok(self.variables.clone())
54 }
55
56 fn __repr__(&self) -> PyResult<String> {
57 Ok(format!("{}{:?}", self.field.data_type(), self.variables))
58 }
59}