nautilus-indicators 0.56.0

Technical indicators for the Nautilus trading engine
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142

// -------------------------------------------------------------------------------------------------
//  Copyright (C) 2015-2026 Nautech Systems Pty Ltd. All rights reserved.
//  https://nautechsystems.io
//
//  Licensed under the GNU Lesser General Public License Version 3.0 (the "License");
//  You may not use this file except in compliance with the License.
//  You may obtain a copy of the License at https://www.gnu.org/licenses/lgpl-3.0.en.html
//
//  Unless required by applicable law or agreed to in writing, software
//  distributed under the License is distributed on an "AS IS" BASIS,
//  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
//  See the License for the specific language governing permissions and
//  limitations under the License.
// -------------------------------------------------------------------------------------------------

use nautilus_model::data::Bar;
use pyo3::prelude::*;

use crate::{
    average::MovingAverageType,
    indicator::Indicator,
    momentum::stochastics::{Stochastics, StochasticsDMethod},
};

#[pymethods]
#[pyo3_stub_gen::derive::gen_stub_pymethods]
impl Stochastics {
    /// Creates a new `Stochastics` instance with default parameters.
    ///
    /// This is the backward-compatible constructor that produces identical output
    /// to the original Nautilus implementation, setting the following to:
    /// - `slowing = 1` (no slowing applied to %K)
    /// - `ma_type = Exponential` (unused when slowing = 1 or with Ratio method)
    /// - `d_method = Ratio` (Nautilus native %D calculation)
    #[new]
    #[pyo3(signature = (period_k, period_d, slowing=None, ma_type=None, d_method=None))]
    #[must_use]
    pub fn py_new(
        period_k: usize,
        period_d: usize,
        slowing: Option<usize>,
        ma_type: Option<MovingAverageType>,
        d_method: Option<StochasticsDMethod>,
    ) -> Self {
        Self::new_with_params(
            period_k,
            period_d,
            slowing.unwrap_or(1),
            ma_type.unwrap_or(MovingAverageType::Exponential),
            d_method.unwrap_or(StochasticsDMethod::Ratio),
        )
    }

    fn __repr__(&self) -> String {
        format!(
            "Stochastics({},{},{},{:?},{:?})",
            self.period_k, self.period_d, self.slowing, self.ma_type, self.d_method
        )
    }

    #[getter]
    #[pyo3(name = "name")]
    fn py_name(&self) -> String {
        self.name()
    }

    #[getter]
    #[pyo3(name = "period_k")]
    const fn py_period_k(&self) -> usize {
        self.period_k
    }

    #[getter]
    #[pyo3(name = "period_d")]
    const fn py_period_d(&self) -> usize {
        self.period_d
    }

    #[getter]
    #[pyo3(name = "slowing")]
    const fn py_slowing(&self) -> usize {
        self.slowing
    }

    #[getter]
    #[pyo3(name = "ma_type")]
    const fn py_ma_type(&self) -> MovingAverageType {
        self.ma_type
    }

    #[getter]
    #[pyo3(name = "d_method")]
    const fn py_d_method(&self) -> StochasticsDMethod {
        self.d_method
    }

    #[getter]
    #[pyo3(name = "has_inputs")]
    fn py_has_inputs(&self) -> bool {
        self.has_inputs()
    }

    #[getter]
    #[pyo3(name = "value_k")]
    const fn py_value_k(&self) -> f64 {
        self.value_k
    }

    #[getter]
    #[pyo3(name = "value_d")]
    const fn py_value_d(&self) -> f64 {
        self.value_d
    }

    #[getter]
    #[pyo3(name = "initialized")]
    const fn py_initialized(&self) -> bool {
        self.initialized
    }

    /// Updates the indicator with raw price values.
    ///
    /// # Parameters
    ///
    /// - `high`: The high price for the period.
    /// - `low`: The low price for the period.
    /// - `close`: The close price for the period.
    #[pyo3(name = "update_raw")]
    fn py_update_raw(&mut self, high: f64, low: f64, close: f64) {
        self.update_raw(high, low, close);
    }

    #[pyo3(name = "handle_bar")]
    fn py_handle_bar(&mut self, bar: &Bar) {
        self.handle_bar(bar);
    }

    #[pyo3(name = "reset")]
    fn py_reset(&mut self) {
        self.reset();
    }
}