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

// -------------------------------------------------------------------------------------------------
//  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::{indicator::Indicator, momentum::ichimoku::IchimokuCloud};

#[pymethods]
#[pyo3_stub_gen::derive::gen_stub_pymethods]
impl IchimokuCloud {
    /// Creates a new `IchimokuCloud` instance.
    ///
    /// The indicator becomes `initialized` after `senkou_period` bars,
    /// at which point `tenkan_sen` and `kijun_sen` are valid. The displaced
    /// outputs (`senkou_span_a`, `senkou_span_b`, `chikou_span`) require an
    /// additional `displacement` bars before they become non-zero.
    #[new]
    #[pyo3(signature = (tenkan_period=9, kijun_period=26, senkou_period=52, displacement=26))]
    #[must_use]
    pub fn py_new(
        tenkan_period: usize,
        kijun_period: usize,
        senkou_period: usize,
        displacement: usize,
    ) -> Self {
        Self::new(tenkan_period, kijun_period, senkou_period, displacement)
    }

    fn __repr__(&self) -> String {
        format!("{self}")
    }

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

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

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

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

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

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

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

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

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

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

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

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

    /// Updates the indicator with OHLC values.
    #[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();
    }
}