Skip to main content

nautilus_execution/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
18pub mod config;
19pub mod fee;
20pub mod fill;
21pub mod latency;
22
23use pyo3::prelude::*;
24
25/// Exposed through `nautilus_trader.execution`.
26///
27/// # Errors
28///
29/// Returns an error if registering any module components fails.
30#[pymodule]
31pub fn execution(_: Python<'_>, m: &Bound<'_, PyModule>) -> PyResult<()> {
32    m.add_class::<crate::engine::config::ExecutionEngineConfig>()?;
33    m.add_class::<crate::order_emulator::config::OrderEmulatorConfig>()?;
34    m.add_class::<crate::matching_engine::config::OrderPriorityResetPolicy>()?;
35    m.add_class::<fee::PyFeeModel>()?;
36    m.add_class::<crate::models::fee::FixedFeeModel>()?;
37    m.add_class::<crate::models::fee::MakerTakerFeeModel>()?;
38    m.add_class::<crate::models::fee::PerContractFeeModel>()?;
39    m.add_class::<crate::models::fee::ProbabilityPriceFeeModel>()?;
40    m.add_class::<crate::models::fee::CappedOptionFeeModel>()?;
41    m.add_class::<crate::models::fee::TieredNotionalOptionFeeModel>()?;
42    m.add_class::<fill::PyFillModel>()?;
43    m.add_class::<crate::models::fill::DefaultFillModel>()?;
44    m.add_class::<crate::models::fill::BestPriceFillModel>()?;
45    m.add_class::<crate::models::fill::OneTickSlippageFillModel>()?;
46    m.add_class::<crate::models::fill::ProbabilisticFillModel>()?;
47    m.add_class::<crate::models::fill::TwoTierFillModel>()?;
48    m.add_class::<crate::models::fill::ThreeTierFillModel>()?;
49    m.add_class::<crate::models::fill::LimitOrderPartialFillModel>()?;
50    m.add_class::<crate::models::fill::SizeAwareFillModel>()?;
51    m.add_class::<crate::models::fill::CompetitionAwareFillModel>()?;
52    m.add_class::<crate::models::fill::VolumeSensitiveFillModel>()?;
53    m.add_class::<crate::models::fill::MarketHoursFillModel>()?;
54    m.add_class::<latency::PyLatencyModel>()?;
55    m.add_class::<crate::models::latency::StaticLatencyModel>()?;
56    Ok(())
57}
58
59#[cfg(test)]
60mod tests {
61    use pyo3::{prelude::*, types::PyModule};
62    use rstest::rstest;
63
64    use super::execution;
65    use crate::matching_engine::config::OrderPriorityResetPolicy;
66
67    #[rstest]
68    #[case("PRICE_CHANGE", OrderPriorityResetPolicy::PriceChange)]
69    #[case(
70        "PRICE_OR_QUANTITY_INCREASE",
71        OrderPriorityResetPolicy::PriceOrQuantityIncrease
72    )]
73    #[case("ANY_MODIFY", OrderPriorityResetPolicy::AnyModify)]
74    fn test_order_priority_reset_policy_python_export(
75        #[case] name: &str,
76        #[case] expected: OrderPriorityResetPolicy,
77    ) {
78        Python::initialize();
79        Python::attach(|py| {
80            let module = PyModule::new(py, "execution").unwrap();
81            execution(py, &module).unwrap();
82            let policy = module.getattr("OrderPriorityResetPolicy").unwrap();
83            let member = policy.getattr(name).unwrap();
84            assert_eq!(
85                policy
86                    .getattr("__module__")
87                    .unwrap()
88                    .extract::<String>()
89                    .unwrap(),
90                "nautilus_trader.execution"
91            );
92            assert_eq!(
93                member.extract::<OrderPriorityResetPolicy>().unwrap(),
94                expected
95            );
96            assert!(member.eq(expected as isize).unwrap());
97            assert_eq!(member.hash().unwrap(), expected as isize);
98        });
99    }
100}