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::{GreeksData, PortfolioGreeks, 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::<GreeksData>();
45        ensure_custom_data_registered::<PortfolioGreeks>();
46        ensure_custom_data_registered::<YieldCurve>();
47
48        m.add_function(wrap_pyfunction!(
49            crate::python::arrow::get_arrow_schema_map,
50            m
51        )?)?;
52        m.add_function(wrap_pyfunction!(
53            crate::python::arrow::get_arrow_schema_bytes,
54            m
55        )?)?;
56        m.add_function(wrap_pyfunction!(
57            crate::python::arrow::pyobjects_to_arrow_record_batch_bytes,
58            m
59        )?)?;
60        m.add_function(wrap_pyfunction!(
61            crate::python::arrow::py_book_deltas_to_arrow_record_batch_bytes,
62            m
63        )?)?;
64        m.add_function(wrap_pyfunction!(
65            crate::python::arrow::py_book_depths_to_arrow_record_batch_bytes,
66            m
67        )?)?;
68        m.add_function(wrap_pyfunction!(
69            crate::python::arrow::py_quotes_to_arrow_record_batch_bytes,
70            m
71        )?)?;
72        m.add_function(wrap_pyfunction!(
73            crate::python::arrow::py_trades_to_arrow_record_batch_bytes,
74            m
75        )?)?;
76        m.add_function(wrap_pyfunction!(
77            crate::python::arrow::py_bars_to_arrow_record_batch_bytes,
78            m
79        )?)?;
80        m.add_function(wrap_pyfunction!(
81            crate::python::arrow::py_mark_prices_to_arrow_record_batch_bytes,
82            m
83        )?)?;
84        m.add_function(wrap_pyfunction!(
85            crate::python::arrow::py_index_prices_to_arrow_record_batch_bytes,
86            m
87        )?)?;
88        m.add_function(wrap_pyfunction!(
89            crate::python::arrow::py_instrument_status_to_arrow_record_batch_bytes,
90            m
91        )?)?;
92        m.add_function(wrap_pyfunction!(
93            crate::python::arrow::py_option_greeks_to_arrow_record_batch_bytes,
94            m
95        )?)?;
96        m.add_function(wrap_pyfunction!(
97            crate::python::arrow::py_option_greeks_from_arrow_record_batch_bytes,
98            m
99        )?)?;
100        m.add_function(wrap_pyfunction!(
101            crate::python::arrow::py_instrument_status_from_arrow_record_batch_bytes,
102            m
103        )?)?;
104        m.add_function(wrap_pyfunction!(
105            crate::python::arrow::py_instrument_closes_to_arrow_record_batch_bytes,
106            m
107        )?)?;
108    }
109
110    Ok(())
111}