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
|
"""Generates the sdk files from the trailmaps."""
import os
import re
import subprocess # nosec: B404
import sys
from pathlib import Path
from typing import Any, Dict, List, Optional, TextIO
from openbb_terminal.core.sdk.sdk_helpers import get_sdk_imports_text
from openbb_terminal.core.sdk.trailmap import Trailmap, get_trailmaps
from openbb_terminal.core.session.current_system import set_system_variable
from openbb_terminal.rich_config import console
set_system_variable("TEST_MODE", True)
set_system_variable("LOG_COLLECT", False)
REPO_ROOT = Path(__file__).parent.joinpath("openbb_terminal").resolve()
sub_names = {
"defi": "DeFi",
"disc": "Discovery",
"dd": "Due Diligence",
"onchain": "OnChain",
"ov": "Overview",
"keys": "Keys",
"forecast": "Forecasting",
"alt": "Alternative",
"crypto": "Cryptocurrency",
"ba": "Behavioral Analysis",
"ca": "Comparison Analysis",
"dps": "Darkpool Shorts",
"po": "Portfolio Optimization",
"qa": "Quantitative Analysis",
"screener": "Screener",
"ta": "Technical Analysis",
"th": "Trading Hours",
"fa": "Fundamental Analysis",
"Oss": "Open Source Software",
"funds": "Mutual Funds",
"gov": "Government",
"ins": "Insiders",
"nft": "NFT",
}
sdk_openbb_var = """
class SDKLogger:
def __init__(self) -> None:
self.__check_initialize_logging()
def __check_initialize_logging(self):
if not get_current_system().LOGGING_SUPPRESS:
self.__initialize_logging()
@staticmethod
def __initialize_logging() -> None:
# pylint: disable=C0415
from openbb_terminal.core.session.current_system import set_system_variable
from openbb_terminal.core.log.generation.settings_logger import log_all_settings
from openbb_terminal.loggers import setup_logging
set_system_variable("LOGGING_SUB_APP", "sdk")
setup_logging()
log_all_settings()
@staticmethod
def _try_to_login(sdk: "OpenBBSDK"):
if is_local() and is_auth_enabled():
try:
sdk.login(silent=True)
except Exception:
pass
openbb = OpenBBSDK()\r\r
"""
disable_lines = (
"# ######### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ######### #\r"
"# flake8: noqa\r# pylint: disable=C0301,R0902,R0903\r"
)
class BuildCategoryModelClasses:
"""Builds the command tree for the SDK."""
def __init__(self, trailmaps: List[Trailmap]) -> None:
self.trailmaps = trailmaps
self.categories: Dict[str, Any] = {}
self.import_modules: Dict[str, Any] = {}
self.root_modules: Dict[str, Any] = {}
self.import_cat_class = (
"from openbb_terminal.core.sdk.sdk_helpers import Category\r"
)
for tmap in self.trailmaps:
local = tmap.location_path
self.categories = self.add_todict(self.categories, local, tmap)
for folder in ["models", "controllers"]:
if not (REPO_ROOT / f"core/sdk/{folder}").exists():
(REPO_ROOT / f"core/sdk/{folder}").mkdir()
if not (REPO_ROOT / f"core/sdk/{folder}/__init__.py").exists():
with open(REPO_ROOT / f"core/sdk/{folder}/__init__.py", "w") as f:
f.write(
"# ######### THIS FILE IS AUTO GENERATED - ANY CHANGES WILL BE VOID ######### #\r"
"# flake8: noqa\r# pylint: disable=unused-import,wrong-import-order\r\r"
)
if not (REPO_ROOT / "core/sdk/__init__.py").exists():
with open(REPO_ROOT / "core/sdk/__init__.py", "w") as f:
f.write("")
def add_todict(self, d: dict, location_path: list, tmap: Trailmap) -> dict:
"""Add the trailmap to the dictionary.
A trailmap is a path to a function in the sdk.
This function creates the dictionary paths to the function.
"""
if location_path[0] not in d:
d[location_path[0]] = {}
if len(location_path) > 1:
self.add_todict(d[location_path[0]], location_path[1:], tmap)
else:
d[location_path[0]][tmap.class_attr] = tmap
return d
def get_nested_dict(self, d: dict) -> dict:
"""Get the nested dictionary of the category."""
nested_dict = {}
for k, v in d.items():
if isinstance(v, dict):
nested_dict[k] = self.get_nested_dict(v)
return nested_dict
def get_subcategory_fullname(self, cat: str) -> str:
"""Get the full category name from the shortened category name."""
if cat in sub_names:
return sub_names[cat]
return cat.title().replace(" ", "")
def check_submodules(self, category: str) -> bool:
"""Check if a category has submodules."""
return any(isinstance(d, dict) for d in self.categories[category].values())
def write_init_imports(self, import_string: str, file_string: str) -> None:
"""Check if a category has submodules and adds the imports to the init file."""
regex = re.compile(import_string)
with open(REPO_ROOT / file_string) as init_file:
check_init = bool(regex.search(init_file.read()))
if not check_init:
with open(REPO_ROOT / file_string, "a") as init_file:
init_file.write(f"{import_string}\r")
def write_sdk_class(
self, category: str, f: TextIO, cls_type: Optional[str] = ""
) -> None:
"""Write the sdk class to the file.
Parameters
----------
category : str
The category name.
f : TextIO
The file to write to.
cls_type : Optional[str], optional
The class type, by default ""
"""
if category in self.root_modules:
class_name = f"{category.title()}{cls_type}(model.{category.title()}Root)"
else:
class_name = f"{category.title()}{cls_type}"
f.write(
f'class {class_name}:\r """{self.get_subcategory_fullname(category)} Module.\r'
)
def write_class_property(
self, category: str, f: Te
|