Skip to main content

nautilus_serialization/python/
mod.rs

1// -------------------------------------------------------------------------------------------------
2//  Copyright (C) 2015-2026 Nautech Systems Pty Ltd. All rights reserved.
3//  https://nautechsystems.io
4//
5//  Licensed under the GNU Lesser General Public License Version 3.0 (the "License");
6//  You may not use this file except in compliance with the License.
7//  You may obtain a copy of the License at https://www.gnu.org/licenses/lgpl-3.0.en.html
8//
9//  Unless required by applicable law or agreed to in writing, software
10//  distributed under the License is distributed on an "AS IS" BASIS,
11//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12//  See the License for the specific language governing permissions and
13//  limitations under the License.
14// -------------------------------------------------------------------------------------------------
15
16//! Python bindings from [PyO3](https://pyo3.rs).
17
18#![allow(
19    clippy::missing_errors_doc,
20    reason = "errors documented on underlying Rust methods"
21)]
22
23#[cfg(feature = "arrow")]
24pub mod arrow;
25
26use pyo3::prelude::*;
27
28/// Loaded as `nautilus_pyo3.serialization`.
29///
30/// # Errors
31///
32/// Returns a `PyErr` if registering any module components fails.
33// Allow unused `m` when no feature-gated content registers on the module
34#[allow(unused_variables)]
35#[pymodule]
36pub fn serialization(_: Python<'_>, m: &Bound<'_, PyModule>) -> PyResult<()> {
37    #[cfg(feature = "arrow")]
38    {
39        m.add_function(wrap_pyfunction!(
40            crate::python::arrow::get_arrow_schema_map,
41            m
42        )?)?;
43        m.add_function(wrap_pyfunction!(
44            crate::python::arrow::pyobjects_to_arrow_record_batch_bytes,
45            m
46        )?)?;
47        m.add_function(wrap_pyfunction!(
48            crate::python::arrow::py_book_deltas_to_arrow_record_batch_bytes,
49            m
50        )?)?;
51        m.add_function(wrap_pyfunction!(
52            crate::python::arrow::py_book_depth10_to_arrow_record_batch_bytes,
53            m
54        )?)?;
55        m.add_function(wrap_pyfunction!(
56            crate::python::arrow::py_quotes_to_arrow_record_batch_bytes,
57            m
58        )?)?;
59        m.add_function(wrap_pyfunction!(
60            crate::python::arrow::py_trades_to_arrow_record_batch_bytes,
61            m
62        )?)?;
63        m.add_function(wrap_pyfunction!(
64            crate::python::arrow::py_bars_to_arrow_record_batch_bytes,
65            m
66        )?)?;
67        m.add_function(wrap_pyfunction!(
68            crate::python::arrow::py_mark_prices_to_arrow_record_batch_bytes,
69            m
70        )?)?;
71        m.add_function(wrap_pyfunction!(
72            crate::python::arrow::py_index_prices_to_arrow_record_batch_bytes,
73            m
74        )?)?;
75        m.add_function(wrap_pyfunction!(
76            crate::python::arrow::py_instrument_closes_to_arrow_record_batch_bytes,
77            m
78        )?)?;
79    }
80
81    Ok(())
82}