datafusion_python/
lib.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
18#[cfg(feature = "mimalloc")]
19use mimalloc::MiMalloc;
20use pyo3::prelude::*;
21
22// Re-export Apache Arrow DataFusion dependencies
23pub use datafusion;
24pub use datafusion::common as datafusion_common;
25pub use datafusion::logical_expr as datafusion_expr;
26pub use datafusion::optimizer;
27pub use datafusion::sql as datafusion_sql;
28
29#[cfg(feature = "substrait")]
30pub use datafusion_substrait;
31
32#[allow(clippy::borrow_deref_ref)]
33pub mod catalog;
34pub mod common;
35
36#[allow(clippy::borrow_deref_ref)]
37mod config;
38#[allow(clippy::borrow_deref_ref)]
39pub mod context;
40#[allow(clippy::borrow_deref_ref)]
41pub mod dataframe;
42mod dataset;
43mod dataset_exec;
44pub mod errors;
45#[allow(clippy::borrow_deref_ref)]
46pub mod expr;
47#[allow(clippy::borrow_deref_ref)]
48mod functions;
49pub mod physical_plan;
50mod pyarrow_filter_expression;
51pub mod pyarrow_util;
52mod record_batch;
53pub mod sql;
54pub mod store;
55pub mod unparser;
56
57#[cfg(feature = "substrait")]
58pub mod substrait;
59#[allow(clippy::borrow_deref_ref)]
60mod udaf;
61#[allow(clippy::borrow_deref_ref)]
62mod udf;
63pub mod udtf;
64mod udwf;
65pub mod utils;
66
67#[cfg(feature = "mimalloc")]
68#[global_allocator]
69static GLOBAL: MiMalloc = MiMalloc;
70
71// Used to define Tokio Runtime as a Python module attribute
72pub(crate) struct TokioRuntime(tokio::runtime::Runtime);
73
74/// Low-level DataFusion internal package.
75///
76/// The higher-level public API is defined in pure python files under the
77/// datafusion directory.
78#[pymodule]
79fn _internal(py: Python, m: Bound<'_, PyModule>) -> PyResult<()> {
80    // Register the python classes
81    m.add_class::<catalog::PyCatalog>()?;
82    m.add_class::<catalog::PyDatabase>()?;
83    m.add_class::<catalog::PyTable>()?;
84    m.add_class::<context::PyRuntimeEnvBuilder>()?;
85    m.add_class::<context::PySessionConfig>()?;
86    m.add_class::<context::PySessionContext>()?;
87    m.add_class::<context::PySQLOptions>()?;
88    m.add_class::<dataframe::PyDataFrame>()?;
89    m.add_class::<udf::PyScalarUDF>()?;
90    m.add_class::<udaf::PyAggregateUDF>()?;
91    m.add_class::<udwf::PyWindowUDF>()?;
92    m.add_class::<udtf::PyTableFunction>()?;
93    m.add_class::<config::PyConfig>()?;
94    m.add_class::<sql::logical::PyLogicalPlan>()?;
95    m.add_class::<physical_plan::PyExecutionPlan>()?;
96    m.add_class::<record_batch::PyRecordBatch>()?;
97    m.add_class::<record_batch::PyRecordBatchStream>()?;
98
99    // Register `common` as a submodule. Matching `datafusion-common` https://docs.rs/datafusion-common/latest/datafusion_common/
100    let common = PyModule::new(py, "common")?;
101    common::init_module(&common)?;
102    m.add_submodule(&common)?;
103
104    // Register `expr` as a submodule. Matching `datafusion-expr` https://docs.rs/datafusion-expr/latest/datafusion_expr/
105    let expr = PyModule::new(py, "expr")?;
106    expr::init_module(&expr)?;
107    m.add_submodule(&expr)?;
108
109    let unparser = PyModule::new(py, "unparser")?;
110    unparser::init_module(&unparser)?;
111    m.add_submodule(&unparser)?;
112
113    // Register the functions as a submodule
114    let funcs = PyModule::new(py, "functions")?;
115    functions::init_module(&funcs)?;
116    m.add_submodule(&funcs)?;
117
118    let store = PyModule::new(py, "object_store")?;
119    store::init_module(&store)?;
120    m.add_submodule(&store)?;
121
122    // Register substrait as a submodule
123    #[cfg(feature = "substrait")]
124    setup_substrait_module(py, &m)?;
125
126    Ok(())
127}
128
129#[cfg(feature = "substrait")]
130fn setup_substrait_module(py: Python, m: &Bound<'_, PyModule>) -> PyResult<()> {
131    let substrait = PyModule::new(py, "substrait")?;
132    substrait::init_module(&substrait)?;
133    m.add_submodule(&substrait)?;
134    Ok(())
135}
datafusion_python/lib.rs

datafusion_python/
lib.rs
