Skip to main content

nautilus_indicators/python/momentum/
bb.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 nautilus_core::python::to_pyvalue_err;
17use nautilus_model::data::{Bar, QuoteTick, TradeTick};
18use pyo3::prelude::*;
19
20use crate::{average::MovingAverageType, indicator::Indicator, momentum::bb::BollingerBands};
21
22#[pymethods]
23#[pyo3_stub_gen::derive::gen_stub_pymethods]
24impl BollingerBands {
25    /// Creates a new `BollingerBands` instance.
26    #[new]
27    #[pyo3(signature = (period, k, ma_type=None))]
28    #[must_use]
29    pub fn py_new(period: usize, k: f64, ma_type: Option<MovingAverageType>) -> Self {
30        Self::new(period, k, ma_type)
31    }
32
33    fn __repr__(&self) -> String {
34        format!("BollingerBands({})", self.period)
35    }
36
37    #[getter]
38    #[pyo3(name = "name")]
39    fn py_name(&self) -> String {
40        self.name()
41    }
42
43    #[getter]
44    #[pyo3(name = "period")]
45    const fn py_period(&self) -> usize {
46        self.period
47    }
48
49    #[getter]
50    #[pyo3(name = "has_inputs")]
51    fn py_has_inputs(&self) -> bool {
52        self.has_inputs()
53    }
54
55    #[getter]
56    #[pyo3(name = "k")]
57    const fn py_k(&self) -> f64 {
58        self.k
59    }
60
61    #[getter]
62    #[pyo3(name = "upper")]
63    const fn py_upper(&self) -> f64 {
64        self.upper
65    }
66
67    #[getter]
68    #[pyo3(name = "middle")]
69    const fn py_middle(&self) -> f64 {
70        self.middle
71    }
72
73    #[getter]
74    #[pyo3(name = "lower")]
75    const fn py_lower(&self) -> f64 {
76        self.lower
77    }
78
79    #[getter]
80    #[pyo3(name = "initialized")]
81    const fn py_initialized(&self) -> bool {
82        self.initialized
83    }
84
85    #[pyo3(name = "update_raw")]
86    fn py_update_raw(&mut self, high: f64, low: f64, close: f64) {
87        self.update_raw(high, low, close);
88    }
89
90    #[pyo3(name = "handle_quote_tick")]
91    fn py_handle_quote_tick(&mut self, quote: &QuoteTick) -> PyResult<()> {
92        self.handle_quote(quote).map_err(to_pyvalue_err)
93    }
94
95    #[pyo3(name = "handle_trade_tick")]
96    fn py_handle_trade_tick(&mut self, trade: &TradeTick) {
97        self.handle_trade(trade);
98    }
99
100    #[pyo3(name = "handle_bar")]
101    fn py_handle_bar(&mut self, bar: &Bar) {
102        self.handle_bar(bar);
103    }
104
105    #[pyo3(name = "reset")]
106    fn py_reset(&mut self) {
107        self.reset();
108    }
109}