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
26#[cfg(feature = "arrow")]
27use nautilus_model::data::greeks::YieldCurve;
28use pyo3::prelude::*;
29
30#[cfg(feature = "arrow")]
31use crate::arrow::custom::ensure_custom_data_registered;
32
33/// Exposed through `nautilus_trader.serialization`.
34///
35/// # Errors
36///
37/// Returns an error if registering any module components fails.
38// Allow unused `m` when no feature-gated content registers on the module
39#[allow(deprecated, unused_variables)]
40#[pymodule]
41pub fn serialization(_: Python<'_>, m: &Bound<'_, PyModule>) -> PyResult<()> {
42    #[cfg(feature = "arrow")]
43    {
44        ensure_custom_data_registered::<YieldCurve>();
45
46        m.add_function(wrap_pyfunction!(
47            crate::python::arrow::get_arrow_schema_map,
48            m
49        )?)?;
50        m.add_function(wrap_pyfunction!(
51            crate::python::arrow::get_arrow_schema_bytes,
52            m
53        )?)?;
54        m.add_function(wrap_pyfunction!(
55            crate::python::arrow::pyobjects_to_arrow_record_batch_bytes,
56            m
57        )?)?;
58        m.add_function(wrap_pyfunction!(
59            crate::python::arrow::py_book_deltas_to_arrow_record_batch_bytes,
60            m
61        )?)?;
62        m.add_function(wrap_pyfunction!(
63            crate::python::arrow::py_book_depths_to_arrow_record_batch_bytes,
64            m
65        )?)?;
66        m.add_function(wrap_pyfunction!(
67            crate::python::arrow::py_quotes_to_arrow_record_batch_bytes,
68            m
69        )?)?;
70        m.add_function(wrap_pyfunction!(
71            crate::python::arrow::py_trades_to_arrow_record_batch_bytes,
72            m
73        )?)?;
74        m.add_function(wrap_pyfunction!(
75            crate::python::arrow::py_bars_to_arrow_record_batch_bytes,
76            m
77        )?)?;
78        m.add_function(wrap_pyfunction!(
79            crate::python::arrow::py_mark_prices_to_arrow_record_batch_bytes,
80            m
81        )?)?;
82        m.add_function(wrap_pyfunction!(
83            crate::python::arrow::py_index_prices_to_arrow_record_batch_bytes,
84            m
85        )?)?;
86        m.add_function(wrap_pyfunction!(
87            crate::python::arrow::py_instrument_status_to_arrow_record_batch_bytes,
88            m
89        )?)?;
90        m.add_function(wrap_pyfunction!(
91            crate::python::arrow::py_option_greeks_to_arrow_record_batch_bytes,
92            m
93        )?)?;
94        m.add_function(wrap_pyfunction!(
95            crate::python::arrow::py_option_greeks_from_arrow_record_batch_bytes,
96            m
97        )?)?;
98        m.add_function(wrap_pyfunction!(
99            crate::python::arrow::py_instrument_status_from_arrow_record_batch_bytes,
100            m
101        )?)?;
102        m.add_function(wrap_pyfunction!(
103            crate::python::arrow::py_instrument_closes_to_arrow_record_batch_bytes,
104            m
105        )?)?;
106    }
107
108    Ok(())
109}