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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
|
# pylint: disable=R0902
import importlib
import inspect
import sys
from pathlib import Path
from typing import Any, Dict, List, Optional, Type, Union
import pandas as pd
from openbb_terminal import OpenBBFigure, config_terminal, theme
from openbb_terminal.common.technical_analysis import ta_helpers
from openbb_terminal.core.config.paths import REPOSITORY_DIRECTORY
from openbb_terminal.core.plots.plotly_ta.base import PltTA
from openbb_terminal.core.plots.plotly_ta.data_classes import ChartIndicators
from openbb_terminal.core.session.current_system import get_current_system
from openbb_terminal.rich_config import console
PLUGINS_PATH = Path(__file__).parent / "plugins"
PLOTLY_TA: Optional["PlotlyTA"] = None
class PlotlyTA(PltTA):
"""Plotly Technical Analysis class
This class is a singleton. It is created and then reused, to assure
the plugins are only loaded once. This is done by overriding the __new__
method. The __init__ method is overridden to do nothing, except to clear
the internal data structures.
Attributes
----------
inchart_colors (List[str]):
List of colors for inchart indicators
show_volume (bool):
Whether to show the volume subplot
ma_mode (List[str]):
List of available moving average modes
inchart (List[str]):
List of available inchart indicators
subplots (List[str]):
List of available subplots
StaticMethods
-------------
plot(
df: pd.DataFrame,
indicators: ChartIndicators,
fig: Optional[OpenBBFigure] = None,
symbol: Optional[str] = "",
candles: bool = True,
volume: bool = True,
) -> OpenBBFigure:
Plots the chart with the given indicators
Examples
--------
>>> from openbb_terminal.sdk import openbb
>>> from openbb_terminal.core.plots.plotly_ta.ta_class import PlotlyTA
>>> df = openbb.stocks.load("SPY")
>>> indicators = dict(
>>> sma=dict(length=[20, 50, 100]),
>>> adx=dict(length=14),
>>> macd=dict(fast=12, slow=26, signal=9),
>>> rsi=dict(length=14),
>>> )
>>> fig = PlotlyTA.plot(df, indicators=indicators)
>>> fig.show()
If you want to plot the chart with the same indicators, you can
reuse the same instance of the class as follows:
>>> ta = PlotlyTA()
>>> fig = ta.plot(df, indicators=indicators)
>>> df2 = openbb.stocks.load("AAPL")
>>> fig2 = ta.plot(df2)
>>> fig.show()
>>> fig2.show()
"""
inchart_colors = theme.get_colors()
plugins: List[Type[PltTA]] = []
df_ta: pd.DataFrame = None
close_column: Optional[str] = "Close"
has_volume: bool = True
show_volume: bool = True
def __new__(cls, *args, **kwargs):
"""This method is overridden to create a singleton instance of the class."""
global PLOTLY_TA # pylint: disable=global-statement # noqa
if PLOTLY_TA is None:
# Creates the instance of the class and loads the plugins
# We set the global variable to the instance of the class so that
# the plugins are only loaded once
PLOTLY_TA = super().__new__(cls)
PLOTLY_TA._locate_plugins()
PLOTLY_TA.add_plugins(PLOTLY_TA.plugins)
cls.inchart_colors = theme.get_colors()
return PLOTLY_TA
def __init__(self, *args, **kwargs): # pylint: disable=unused-argument
"""This method is overridden to do nothing, except to clear the internal data structures."""
if not args and not kwargs:
self._clear_data()
else:
self.df_fib = None
super().__init__(*args, **kwargs)
@property
def ma_mode(self) -> List[str]:
return list(set(self.__ma_mode__))
@ma_mode.setter
def ma_mode(self, value: List[str]):
self.__ma_mode__ = value
@property
def inchart(self) -> List[str]:
return list(set(self.__inchart__))
@inchart.setter
def inchart(self, value: List[str]):
self.__inchart__ = value
@property
def subplots(self) -> List[str]:
return list(set(self.__subplots__))
@subplots.setter
def subplots(self, value: List[str]):
self.__subplots__ = value
# pylint: disable=R0913
def __plot__(
self,
df_stock: Union[pd.DataFrame, pd.Series],
indicators: Optional[Union[ChartIndicators, Dict[str, Dict[str, Any]]]] = None,
symbol: str = "",
candles: bool = True,
volume: bool = True,
fig: Optional[OpenBBFigure] = None,
volume_ticks_x: int = 7,
) -> OpenBBFigure:
"""This method should not be called directly. Use the PlotlyTA.plot() static method instead."""
if config_terminal.HOLD:
console.print(
"The previous command is not supported within hold on. Only the last command run"
"will be displayed when hold off is run."
)
if isinstance(df_stock, pd.Series):
df_stock = df_stock.to_frame()
if not isinstance(indicators, ChartIndicators):
indicators = ChartIndicators.from_dict(indicators or {})
self.indicators = indicators
self.intraday = df_stock.index[-2].time() != df_stock.index[-1].time()
self.df_stock = df_stock
self.close_column = ta_helpers.check_columns(self.df_stock)
self.params = self.indicators.get_params()
self.has_volume = "Volume" in self.df_stock.columns and bool(
self.df_stock["Volume"].sum() > 0
)
self.show_volume = volume and self.has_volume
return self.plot_fig(
fig=fig, symbol=symbol, candles=candles, volume_ticks_x=volume_ticks_x
)
@staticmethod
def plot(
df_stock: Union[pd.DataFrame, pd.Series],
indicators: Optional[Union[ChartIndicators, Dict[str, Dict[str, Any]]]] = None,
symbol: str = "",
candles: bool = True,
volume: bool = True,
fig: Optional[OpenBBFigure] = None,
volume_ticks_x: int = 7,
) -> OpenBBFigure:
"""Plot a chart with the given indicators.
Parameters
----------
df_stock : pd.DataFrame
Dataframe with stock data
indicators : Union[ChartIndicators, Dict[str, Dict[str, Any]]]
ChartIndicators object or dictionary with indicators and parameters to plot
Example:
dict(
sma=dict(length=[20, 50, 100]),
adx=dict(length=14),
macd=dict(fast=12, slow=26, signal=9),
rsi=dict(length=14),
)
symbol : str, optional
Symbol to plot, by default uses the dataframe.name attribute if available or ""
candles : bool, optional
Plot a candlestick chart, by default True (if False, plots a line chart)
volume : bool, optional
Plot volume, by default True
fig : OpenBBFigure, optional
Plotly figure to plot on, by default None
volume_ticks_x : int, optional
Number to multiply volume, by default 7
"""
if indicators is None and PLOTLY_TA is not None:
indicators = PLOTLY_TA.indicators
return Pl
|