Coverage for /pythoncovmergedfiles/medio/medio/usr/local/lib/python3.11/site-packages/plotext/_core.py: 60%

1# /usr/bin/env python3 

2# -*- coding: utf-8 -*- 

3 

4# This file contains all the main plotext functions available externally to the user 

5 

6############################################## 

7########### Initialisation ############# 

8############################################## 

9 

10import plotext._doc 

11from plotext._doc_utils import documentation as doc 

12from plotext._doc_utils import add 

13 

14from ._figure import _figure_class 

15from time import sleep as _sleep 

16import plotext._global as _glob 

17from plotext import __version__ 

18import plotext._utility as _ut 

19 

20_figure = _glob.figure # the main figure at top level (defined in _global.py because it is useful also there) 

21 

22############################################## 

23######### Subplots Functions ########### 

24############################################## 

25 

26def subplots(rows = None, cols = None): 

27 sub = _figure._active.subplots(rows, cols) 

28 _figure.show() if _figure._interactive else None 

29 return sub 

30 

31def subplot(row = None, col = None): 

32 sub = _figure.subplot(row, col) 

33 _figure.show() if _figure._interactive else None 

34 return sub 

35 

36def main(): 

37 return _figure.main() 

38 

39def active(): 

40 return _figure._active 

41 

42############################################## 

43####### Outside Set Functions ########## 

44############################################## 

45 

46def interactive(interactive = None): 

47 _figure._set_interactive(interactive) 

48 

49def plot_size(width = None, height = None): 

50 size = _figure._active.plot_size(width, height) 

51 _figure.show() if _figure._interactive else None 

52 return size 

53plotsize = plot_size 

54 

55def limit_size(width = None, height = None): 

56 #_figure._master._set_size() 

57 _figure._master._limit_size(width, height) 

58limitsize = limit_size 

59 

60def take_min(): 

61 _figure._active.take_min() 

62takemin = take_min 

63 

64def title(label): 

65 _figure._active.title(label) 

66 _figure.show() if _figure._interactive else None 

67 

68def xlabel(label = None, xside = None): 

69 _figure._active.xlabel(label = label, xside = xside) 

70 _figure.show() if _figure._interactive else None 

71 

72def ylabel(label = None, yside = None): 

73 _figure._active.ylabel(label = label, yside = yside) 

74 _figure.show() if _figure._interactive else None 

75 

76def xlim(left = None, right = None, xside = None): 

77 _figure._active.xlim(left = left, right = right, xside = xside) 

78 _figure.show() if _figure._interactive else None 

79 

80def ylim(lower = None, upper = None, yside = None): 

81 _figure._active.ylim(lower = lower, upper = upper, yside = yside) 

82 _figure.show() if _figure._interactive else None 

83 

84def xscale(scale = None, xside = None): 

85 _figure._active.xscale(scale = scale, xside = xside) 

86 _figure.show() if _figure._interactive else None 

87 

88def yscale(scale = None, yside = None): 

89 _figure._active.yscale(scale = scale, yside = yside) 

90 _figure.show() if _figure._interactive else None 

91 

92def xticks(ticks = None, labels = None, xside = None): 

93 _figure._active.xticks(ticks = ticks, labels = labels, xside = xside) 

94 _figure.show() if _figure._interactive else None 

95 

96def yticks(ticks = None, labels = None, yside = None): 

97 _figure._active.yticks(ticks = ticks, labels = labels, yside = yside) 

98 _figure.show() if _figure._interactive else None 

99 

100def xfrequency(frequency = None, xside = None): 

101 _figure._active.xfrequency(frequency = frequency, xside = xside) 

102 _figure.show() if _figure._interactive else None 

103 

104def yfrequency(frequency = None, yside = None): 

105 _figure._active.yfrequency(frequency = frequency, yside = yside) 

106 _figure.show() if _figure._interactive else None 

107 

108def xreverse(reverse = None, xside = None): 

109 _figure._active.xreverse(reverse = reverse, xside = xside) 

110 _figure.show() if _figure._interactive else None 

111 

112def yreverse(reverse = None, yside = None): 

113 _figure._active.yreverse(reverse = reverse, yside = yside) 

114 _figure.show() if _figure._interactive else None 

115 

116def xaxes(lower = None, upper = None): 

117 _figure._active.xaxes(lower = lower, upper = upper) 

118 _figure.show() if _figure._interactive else None 

119 

120def yaxes(left = None, right = None): 

121 _figure._active.yaxes(left = left, right = right) 

122 _figure.show() if _figure._interactive else None 

123 

124def frame(frame = None): 

125 _figure._active.frame(frame = frame) 

126 _figure.show() if _figure._interactive else None 

127 

128def grid(horizontal = None, vertical = None): 

129 _figure._active.grid(horizontal = horizontal, vertical = vertical) 

130 _figure.show() if _figure._interactive else None 

131 

132def canvas_color(color = None): 

133 _figure._active.canvas_color(color) 

134 _figure.show() if _figure._interactive else None 

135 

136def axes_color(color = None): 

137 _figure._active.axes_color(color) 

138 _figure.show() if _figure._interactive else None 

139 

140def ticks_color(color = None): 

141 _figure._active.ticks_color(color) 

142 _figure.show() if _figure._interactive else None 

143 

144def ticks_style(style = None): 

145 _figure._active.ticks_style(style) 

146 _figure.show() if _figure._interactive else None 

147 

148def theme(theme = None): 

149 _figure._active.theme(theme) 

150 _figure.show() if _figure._interactive else None 

151 

152############################################## 

153########### Clear Functions ############ 

154############################################## 

155 

156def clear_figure(): 

157 _figure._active.clear_figure() 

158 _figure.show() if _figure._interactive else None 

159clf = clear_figure 

160 

161def clear_data(): 

162 _figure._active.clear_data() 

163 _figure.show() if _figure._interactive else None 

164cld = clear_data 

165 

166def clear_color(): 

167 _figure._active.clear_color() 

168 _figure.show() if _figure._interactive else None 

169clc = clear_color 

170 

171def clear_terminal(lines = None): 

172 _figure._active.clear_terminal(lines = lines) 

173clt = clear_terminal 

174 

175############################################## 

176###### Main Plotting Functions ######### 

177############################################## 

178 

179def scatter(*args, marker = None, color = None, style = None, fillx = None, filly = None, xside = None, yside = None, label = None): 

180 _figure._active.scatter(*args, xside = xside, yside = yside, marker = marker, color = color, style = style, fillx = fillx, filly = filly, label = label) 

181 _figure.show() if _figure._interactive else None 

182 

183def plot(*args, marker = None, color = None, style = None, fillx = None, filly = None, xside = None, yside = None, label = None): 

184 _figure._active.plot(*args, xside = xside, yside = yside, marker = marker, color = color, fillx = fillx, filly = filly, label = label) 

185 _figure.show() if _figure._interactive else None 

186 

187def candlestick(dates, data, xside = None, yside = None, orientation = None, colors = None, label = None): 

188 _figure._active.candlestick(dates, data, xside = xside, yside = yside, orientation = orientation, colors = colors, label = label) 

189 _figure.show() if _figure._interactive else None 

190 

191def bar(*args, marker = None, color = None, fill = None, width = None, orientation = None, minimum = None, reset_ticks = None, xside = None, yside = None, label = None): 

192 _figure._active.bar(*args, xside = xside, yside = yside, marker = marker, color = color, fill = fill, width = width, orientation = orientation, label = label, minimum = minimum, reset_ticks = reset_ticks) 

193 _figure.show() if _figure._interactive else None 

194 

195def simple_bar(*args, marker = None, color = None, title = None, width = None): 

196 _glob.simple_bar(*args, width = width, marker = marker, color = color, title = title) 

197 _figure.show() if _figure._interactive else None 

198 

199def multiple_bar(*args, marker = None, color = None, fill = None, width = None, orientation = None, minimum = None, reset_ticks = None, xside = None, yside = None, labels = None): 

200 _figure._active.multiple_bar(*args, xside = xside, yside = yside, marker = marker, color = color, fill = fill, width = width, orientation = orientation, labels = labels, minimum = minimum, reset_ticks = reset_ticks) 

201 _figure.show() if _figure._interactive else None 

202 

203def simple_multiple_bar(*args, marker = None, colors = None, title = None, width = None, labels = None): 

204 _glob.simple_multiple_bar(*args, width = width, marker = marker, colors = colors, title = title, labels = labels) 

205 _figure.show() if _figure._interactive else None 

206 

207def stacked_bar(*args, marker = None, color = None, fill = None, width = None, orientation = None, minimum = None, reset_ticks = None, xside = None, yside = None, labels = None): 

208 _figure._active.stacked_bar(*args, xside = xside, yside = yside, marker = marker, color = color, fill = fill, width = width, orientation = orientation, labels = labels, minimum = minimum, reset_ticks = reset_ticks) 

209 _figure.show() if _figure._interactive else None 

210 

211def simple_stacked_bar(*args, marker = None, colors = None, title = None, width = None, labels = None): 

212 _glob.simple_stacked_bar(*args, width = width, marker = marker, colors = colors, title = title, labels = labels) 

213 _figure.show() if _figure._interactive else None 

214 

215def hist(data, bins = None, marker = None, color = None, fill = None, norm = None, width = None, orientation = None, minimum = None, xside = None, yside = None, label = None): 

216 _figure._active.hist(data, bins = bins, norm = norm, xside = xside, yside = yside, marker = marker, color = color, fill = fill, width = width, orientation = orientation, label = label, minimum = minimum) 

217 _figure.show() if _figure._interactive else None 

218 

219def candlestick(dates, data, colors = None, orientation = None, xside = None, yside = None, label = None): 

220 _figure._active.candlestick(dates, data, xside = xside, yside = yside, orientation = orientation, colors = colors, label = label) 

221 _figure.show() if _figure._interactive else None 

222 

223def box(*args, quintuples = None, colors = None, fill = None, width = None, orientation = None, minimum = None, reset_ticks = None, xside = None, yside = None, label = None): 

224 _figure._active.box(*args, xside = xside, yside = yside, orientation = orientation, colors = colors, label = label, fill=fill, width = width, minimum = minimum, reset_ticks = reset_ticks, quintuples = quintuples) 

225 _figure.show() if _figure._interactive else None 

226 

227############################################## 

228########### Plotting Tools ############# 

229############################################## 

230 

231def error(*args, xerr = None, yerr = None, color = None, xside = None, yside = None, label = None): 

232 _figure.error(*args, xerr = xerr, yerr = yerr, xside = xside, yside = yside, color = color, label = label) 

233 _figure.show() if _figure._interactive else None 

234 

235def event_plot(data, marker = None, color = None, orientation = None, side = None): 

236 _figure._active.event_plot(data, orientation = orientation, marker = marker, color = color, side = side) 

237 _figure.show() if _figure._interactive else None 

238 

239eventplot = event_plot 

240 

241def vertical_line(coordinate, color = None, xside = None): 

242 _figure._active.vertical_line(coordinate, color = color, xside = xside) 

243 _figure.show() if _figure._interactive else None 

244vline = vertical_line 

245 

246def horizontal_line(coordinate, color = None, yside = None): 

247 _figure._active.horizontal_line(coordinate, color = color, yside = yside) 

248 _figure.show() if _figure._interactive else None 

249hline = horizontal_line 

250 

251def text(label, x, y, color = None, background = None, style = None, orientation = None, alignment = None, xside = None, yside = None): 

252 _figure._active.text(label, x, y, xside = xside, yside = yside, color = color, background = background, style = style, orientation = orientation, alignment = alignment) 

253 _figure.show() if _figure._interactive else None 

254 

255def rectangle(x = None, y = None, marker = None, color = None, lines = None, fill = None, xside = None, yside = None, label = None): 

256 _figure._active.rectangle(x = x, y = y, xside = xside, yside = yside, lines = lines, marker = marker, color = color, fill = fill, label = label) 

257 _figure.show() if _figure._interactive else None 

258 

259def polygon(x = None, y = None, radius = None, sides = None, marker = None, color = None, lines = None, fill = None, xside = None, yside = None, label = None): 

260 _figure._active.polygon(x = x, y = y, radius = radius, sides = sides, xside = xside, yside = yside, lines = lines, marker = marker, color = color, fill = fill, label = label) 

261 _figure.show() if _figure._interactive else None 

262 

263def confusion_matrix(actual, predicted, color = None, style = None, labels = None): 

264 _figure._active.confusion_matrix(actual, predicted, labels = labels, color = color, style = style) 

265 _figure.show() if _figure._interactive else None 

266 

267cmatrix = confusion_matrix 

268 

269def indicator(value, label = None, color = None, style = None): 

270 _figure._active.indicator(value, label = label, color = color, style = style) 

271 _figure.show() if _figure._interactive else None 

272 

273############################################## 

274############## 2D Plots ################ 

275##############################################  

276 

277def matrix_plot(matrix, marker = None, style = None, fast = False): 

278 _figure._active.matrix_plot(matrix, marker = marker, style = style, fast = fast) 

279 _figure.show() if _figure._interactive else None 

280 

281def heatmap(dataframe, color = None, style=None): 

282 _figure._active.heatmap(dataframe, color = color, style = style) 

283 _figure.show() if _figure._interactive else None 

284 

285def image_plot(path, marker = None, style = None, fast = False, grayscale = False): 

286 _figure._active.image_plot(path, marker = marker, style = style, grayscale = grayscale, fast = fast) 

287 _figure.show() if _figure._interactive else None 

288 

289def play_gif(path): 

290 _glob.play_gif(path) 

291 _figure.show() if _figure._interactive else None 

292 

293def play_video(path, from_youtube = False): 

294 _glob.play_video(path, from_youtube) 

295 _figure.show() if _figure._interactive else None 

296 

297def play_youtube(url): 

298 _glob.play_youtube(url) 

299 _figure.show() if _figure._interactive else None 

300 

301def get_youtube(url, path = None, log = True): 

302 _glob.get_youtube(url, path, log) 

303 

304############################################## 

305########## Build Functions ############# 

306############################################## 

307 

308def show(): 

309 _figure.show() 

310 

311def build(): 

312 return _figure.build() 

313 

314def sleep(time = 0): 

315 _sleep(time) 

316 

317def time(show = True): 

318 return _figure._get_time(show) 

319 

320def save_fig(path = None, append = False, keep_colors = False): 

321 _figure.save_fig(path, append, keep_colors) 

322savefig = save_fig 

323 

324def from_matplotlib(fig, marker = None): 

325 _glob.from_matplotlib(fig, marker = marker) 

326 

327############################################## 

328########## Date Functions ############# 

329############################################## 

330 

331def date_form(input_form = None, output_form = None): 

332 _figure._active.date_form(input_form, output_form) 

333 

334def set_time0(string, input_form = None): 

335 _figure._active.set_time0(string, input_form = input_form) 

336 

337def today_datetime(): 

338 return _figure._active.today_datetime() 

339 

340def today_string(output_form = None): 

341 return _figure._active.today_string(output_form) 

342 

343def datetime_to_string(datetime, output_form = None): 

344 return _figure._active.datetime_to_string(datetime, output_form = output_form) 

345 

346def datetimes_to_strings(datetimes, output_form = None): 

347 return _figure._active.datetimes_to_strings(datetimes, output_form = output_form) 

348 

349datetimes_to_string = datetimes_to_strings 

350 

351def string_to_datetime(string, input_form = None): 

352 return _figure._active.string_to_datetime(string, input_form = input_form) 

353 

354def string_to_time(string, input_form = None):##########ADD DOC############ 

355 return _figure._active.string_to_time(string, input_form = input_form) 

356 

357def strings_to_time(string, input_form = None):##########ADD DOC############ 

358 return _figure._active.strings_to_time(string, input_form = input_form) 

359 

360############################################## 

361########## File Functions ############ 

362############################################## 

363 

364script_folder = _ut.script_folder 

365 

366def parent_folder(path, level = 1): 

367 return _ut.parent_folder(path, level = level) 

368 

369def join_paths(*args): 

370 return _ut.join_paths(*args) 

371 

372def save_text(text, path, log = True): 

373 _ut.save_text(text, path, log = log) 

374 

375def read_data(path, delimiter = None, columns = None, first_row = None, log = True): 

376 return _ut.read_data(path, delimiter = delimiter, columns = columns, first_row = first_row, log = log) 

377 

378def write_data(data, path, delimiter = None, columns = None, log = True): 

379 _ut.write_data(data, path, delimiter = delimiter, columns = columns, log = log) 

380 

381def download(url, path, log = True): 

382 _ut.download(url, path, log) 

383 

384def delete_file(path, log = True): 

385 _ut.delete_file(path, log = log) 

386 

387test_data_url = _glob.test_data_url 

388test_bar_data_url = _glob.test_bar_data_url 

389test_image_url = _glob.test_image_url 

390test_gif_url = _glob.test_gif_url 

391test_video_url = _glob.test_video_url 

392test_youtube_url = _glob.test_youtube_url 

393 

394############################################## 

395########## Other Functions ############ 

396############################################## 

397 

398def colorize(string, color = None, style = None, background = None, show = False): 

399 return _ut.colorize(string, color = color, style = style, background = background, show = show) 

400 

401def uncolorize(string): 

402 return _ut.uncolorize(string) 

403 

404def terminal_size(): 

405 return _ut.terminal_size() 

406 

407ts = terminal_size 

408 

409def terminal_width(): 

410 return _ut.terminal_width() 

411 

412tw = terminal_width 

413 

414def terminal_height(): 

415 return _ut.terminal_height() 

416 

417th = terminal_height 

418 

419def sin(periods = 2, length = 200, amplitude = 1, phase = 0, decay = 0): 

420 return _ut.sin(periods = periods, length = length, amplitude = amplitude, phase = phase, decay = decay) 

421 

422def square(periods = 2, length = 200, amplitude = 1): 

423 return _ut.square(periods = periods, length = length, amplitude = amplitude) 

424 

425def transpose(data): 

426 return _ut.transpose(data) 

427 

428colors = _glob.colors 

429 

430styles = _glob.styles 

431 

432markers = _glob.markers 

433 

434themes = _glob.themes 

435 

436test = _glob.test 

437 

438version = __version__ 

439 

440platform = _ut.platform 

441 

442############################################## 

443############ Docstrings ############### 

444##############################################  

445 

446add(subplots) 

447add(subplot) 

448add(main) 

449add(active) 

450 

451add(interactive) 

452add(plot_size) 

453add(limit_size) 

454add(take_min) 

455 

456add(title) 

457add(xlabel) 

458add(ylabel) 

459add(xlim) 

460add(ylim) 

461add(xscale) 

462add(yscale) 

463add(xticks) 

464add(yticks) 

465add(xfrequency) 

466add(yfrequency) 

467add(xreverse) 

468add(yreverse) 

469add(xaxes) 

470add(yaxes) 

471add(frame) 

472add(grid) 

473add(canvas_color) 

474add(axes_color) 

475add(ticks_color) 

476add(ticks_style) 

477add(theme) 

478 

479add(clear_figure) 

480add(clear_data) 

481add(clear_color) 

482add(clear_terminal) 

483 

484add(scatter) 

485add(plot) 

486add(candlestick) 

487add(bar) 

488add(simple_bar) 

489add(multiple_bar) 

490add(simple_multiple_bar) 

491add(stacked_bar) 

492add(simple_stacked_bar) 

493add(simple_bar) 

494add(hist) 

495add(box) 

496 

497add(error) 

498add(event_plot) 

499add(vertical_line) 

500add(horizontal_line) 

501add(text) 

502add(rectangle) 

503add(polygon) 

504add(confusion_matrix) 

505add(indicator) 

506 

507add(matrix_plot) 

508add(image_plot) 

509 

510add(play_gif) 

511add(play_video) 

512add(play_youtube) 

513add(get_youtube) 

514 

515add(show) 

516add(build) 

517add(sleep) 

518add(time) 

519add(save_fig) 

520add(from_matplotlib) 

521 

522add(date_form) 

523add(set_time0) 

524add(today_datetime) 

525add(today_string) 

526add(datetime_to_string) 

527add(datetimes_to_strings) 

528add(string_to_datetime) 

529 

530add(script_folder) 

531add(parent_folder) 

532add(join_paths) 

533add(save_text) 

534add(read_data) 

535add(write_data) 

536add(download) 

537add(delete_file) 

538 

539add(colorize) 

540add(uncolorize) 

541add(terminal_size) 

542add(terminal_width) 

543add(terminal_height) 

544add(sin) 

545add(square) 

546add(transpose) 

547 

548add(colors) 

549add(styles) 

550add(markers) 

551add(themes) 

552add(test)