nautilus_analysis/python/statistics/
expectancy.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
16use std::collections::BTreeMap;
17
18#[allow(unused_imports)] // Used in template pattern for returns conversion
19use nautilus_core::UnixNanos;
20use pyo3::prelude::*;
21
22use crate::{statistic::PortfolioStatistic, statistics::expectancy::Expectancy};
23
24#[pymethods]
25#[pyo3_stub_gen::derive::gen_stub_pymethods]
26impl Expectancy {
27    #[new]
28    fn py_new() -> Self {
29        Self {}
30    }
31
32    fn __repr__(&self) -> String {
33        self.to_string()
34    }
35
36    #[getter]
37    #[pyo3(name = "name")]
38    fn py_name(&self) -> String {
39        self.name()
40    }
41
42    #[pyo3(name = "calculate_from_realized_pnls")]
43    #[expect(clippy::needless_pass_by_value)]
44    fn py_calculate_from_realized_pnls(&mut self, realized_pnls: Vec<f64>) -> Option<f64> {
45        self.calculate_from_realized_pnls(&realized_pnls)
46    }
47
48    #[pyo3(name = "calculate_from_returns")]
49    #[allow(unused_variables)] // Pattern preserved for consistency across statistics
50    fn py_calculate_from_returns(&mut self, _returns: BTreeMap<u64, f64>) -> Option<f64> {
51        None
52    }
53
54    #[pyo3(name = "calculate_from_positions")]
55    fn py_calculate_from_positions(&mut self, _positions: Vec<Py<PyAny>>) -> Option<f64> {
56        None
57    }
58}
nautilus_analysis/python/statistics/expectancy.rs

nautilus_analysis/python/statistics/
expectancy.rs
