-
Notifications
You must be signed in to change notification settings - Fork 643
/
Copy pathplotting.py
1095 lines (902 loc) · 48.3 KB
/
plotting.py
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
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import matplotlib.dates as mdates
import matplotlib.pyplot as plt
import matplotlib.colors as mcolors
import matplotlib.axes as mpl_axes
import matplotlib.figure as mpl_fig
import pandas as pd
import numpy as np
import copy
import io
import math
import warnings
import statistics as stat
from itertools import cycle
#from pandas.plotting import register_matplotlib_converters
#register_matplotlib_converters()
from mplfinance._utils import _construct_aline_collections
from mplfinance._utils import _construct_hline_collections
from mplfinance._utils import _construct_vline_collections
from mplfinance._utils import _construct_tline_collections
from mplfinance._utils import _construct_mpf_collections
from mplfinance._widths import _determine_width_config
from mplfinance._utils import _updown_colors
from mplfinance._utils import IntegerIndexDateTimeFormatter
from mplfinance._utils import _mscatter
from mplfinance._utils import _check_and_convert_xlim_configuration
from mplfinance import _styles
from mplfinance._arg_validators import _check_and_prepare_data, _mav_validator
from mplfinance._arg_validators import _get_valid_plot_types
from mplfinance._arg_validators import _process_kwargs, _validate_vkwargs_dict
from mplfinance._arg_validators import _kwarg_not_implemented, _bypass_kwarg_validation
from mplfinance._arg_validators import _hlines_validator, _vlines_validator
from mplfinance._arg_validators import _alines_validator, _tlines_validator
from mplfinance._arg_validators import _scale_padding_validator, _yscale_validator
from mplfinance._arg_validators import _valid_panel_id, _check_for_external_axes
from mplfinance._arg_validators import _xlim_validator
from mplfinance._panels import _build_panels
from mplfinance._panels import _set_ticks_on_bottom_panel_only
from mplfinance._helpers import _determine_format_string
from mplfinance._helpers import _list_of_dict
from mplfinance._helpers import _num_or_seq_of_num
from mplfinance._helpers import _adjust_color_brightness
VALID_PMOVE_TYPES = ['renko', 'pnf']
DEFAULT_FIGRATIO = (8.00,5.75)
def with_rc_context(func):
'''
This decoractor creates an rcParams context around a function, so that any changes
the function makes to rcParams will be reversed when the decorated function returns
(therefore those changes have no effect outside of the decorated function).
'''
def decorator(*args, **kwargs):
with plt.rc_context():
return func(*args, **kwargs)
return decorator
def _warn_no_xgaps_deprecated(value):
warnings.warn('\n\n ================================================================= '+
'\n\n WARNING: `no_xgaps` is deprecated:'+
'\n Default value is now `no_xgaps=True`'+
'\n However, to set `no_xgaps=False` and silence this warning,'+
'\n use instead: `show_nontrading=True`.'+
'\n\n ================================================================ ',
category=DeprecationWarning)
return isinstance(value,bool)
def _warn_set_ylim_deprecated(value):
warnings.warn('\n\n ================================================================= '+
'\n\n WARNING: `set_ylim=(ymin,ymax)` kwarg '+
'\n has been replaced with: '+
'\n `ylim=(ymin,ymax)`.'+
'\n\n ================================================================ ',
category=DeprecationWarning)
return isinstance(value,bool)
def _valid_plot_kwargs():
'''
Construct and return the "valid kwargs table" for the mplfinance.plot() function.
A valid kwargs table is a `dict` of `dict`s. The keys of the outer dict are the
valid key-words for the function. The value for each key is a dict containing
2 specific keys: "Default", and "Validator" with the following values:
"Default" - The default value for the kwarg if none is specified.
"Validator" - A function that takes the caller specified value for the kwarg,
and validates that it is the correct type, and (for kwargs with
a limited set of allowed values) may also validate that the
kwarg value is one of the allowed values.
'''
vkwargs = {
'columns' : { 'Default' : None, # use default names: ('Open', 'High', 'Low', 'Close', 'Volume')
'Validator' : lambda value: isinstance(value, (tuple, list))
and len(value) == 5
and all(isinstance(c, str) for c in value) },
'type' : { 'Default' : 'ohlc',
'Validator' : lambda value: value in _get_valid_plot_types() },
'style' : { 'Default' : None,
'Validator' : _styles._valid_mpf_style },
'volume' : { 'Default' : False,
'Validator' : lambda value: isinstance(value,bool) or isinstance(value,mpl_axes.Axes) },
'mav' : { 'Default' : None,
'Validator' : _mav_validator },
'renko_params' : { 'Default' : dict(),
'Validator' : lambda value: isinstance(value,dict) },
'pnf_params' : { 'Default' : dict(),
'Validator' : lambda value: isinstance(value,dict) },
'study' : { 'Default' : None,
'Validator' : lambda value: _kwarg_not_implemented(value) },
'marketcolors' : { 'Default' : None, # use 'style' for default, instead.
'Validator' : lambda value: isinstance(value,dict) },
'no_xgaps' : { 'Default' : True, # None means follow default logic below:
'Validator' : lambda value: _warn_no_xgaps_deprecated(value) },
'show_nontrading' : { 'Default' : False,
'Validator' : lambda value: isinstance(value,bool) },
'figscale' : { 'Default' : None, # scale base figure size up or down.
'Validator' : lambda value: isinstance(value,float) or isinstance(value,int) },
'figratio' : { 'Default' : None, # aspect ratio; scaled to 8.0 height
'Validator' : lambda value: isinstance(value,(tuple,list))
and len(value) == 2
and isinstance(value[0],(float,int))
and isinstance(value[1],(float,int)) },
'figsize' : { 'Default' : None, # figure size; overrides figratio and figscale
'Validator' : lambda value: isinstance(value,(tuple,list))
and len(value) == 2
and isinstance(value[0],(float,int))
and isinstance(value[1],(float,int)) },
'fontscale' : { 'Default' : None, # scale all fonts up or down
'Validator' : lambda value: isinstance(value,float) or isinstance(value,int) },
'linecolor' : { 'Default' : None, # line color in line plot
'Validator' : lambda value: mcolors.is_color_like(value) },
'title' : { 'Default' : None, # Figure Title
'Validator' : lambda value: isinstance(value,(str,dict)) },
'axtitle' : { 'Default' : None, # Axes Title (subplot title)
'Validator' : lambda value: isinstance(value,(str,dict)) },
'ylabel' : { 'Default' : 'Price', # y-axis label
'Validator' : lambda value: isinstance(value,str) },
'ylabel_lower' : { 'Default' : None, # y-axis label default logic below
'Validator' : lambda value: isinstance(value,str) },
'addplot' : { 'Default' : None,
'Validator' : lambda value: isinstance(value,dict) or (isinstance(value,list) and all([isinstance(d,dict) for d in value])) },
'savefig' : { 'Default' : None,
'Validator' : lambda value: isinstance(value,dict) or isinstance(value,str) or isinstance(value, io.BytesIO) },
'block' : { 'Default' : None,
'Validator' : lambda value: isinstance(value,bool) },
'returnfig' : { 'Default' : False,
'Validator' : lambda value: isinstance(value,bool) },
'return_calculated_values' : {'Default' : None,
'Validator' : lambda value: isinstance(value, dict) and len(value) == 0},
'set_ylim' : {'Default' : None,
'Validator' : lambda value: _warn_set_ylim_deprecated(value) },
'ylim' : {'Default' : None,
'Validator' : lambda value: isinstance(value, (list,tuple)) and len(value) == 2
and all([isinstance(v,(int,float)) for v in value])},
'xlim' : {'Default' : None,
'Validator' : lambda value: _xlim_validator(value) },
'set_ylim_panelB' : {'Default' : None,
'Validator' : lambda value: _warn_set_ylim_deprecated(value) },
'hlines' : { 'Default' : None,
'Validator' : lambda value: _hlines_validator(value) },
'vlines' : { 'Default' : None,
'Validator' : lambda value: _vlines_validator(value) },
'alines' : { 'Default' : None,
'Validator' : lambda value: _alines_validator(value) },
'tlines' : { 'Default' : None,
'Validator' : lambda value: _tlines_validator(value) },
'panel_ratios' : { 'Default' : None,
'Validator' : lambda value: isinstance(value,(tuple,list)) and len(value) <= 10 and
all([isinstance(v,(int,float)) for v in value]) },
'main_panel' : { 'Default' : 0,
'Validator' : lambda value: _valid_panel_id(value) },
'volume_panel' : { 'Default' : 1,
'Validator' : lambda value: _valid_panel_id(value) },
'num_panels' : { 'Default' : None,
'Validator' : lambda value: isinstance(value,int) and value in range(1,10+1) },
'datetime_format' : { 'Default' : None,
'Validator' : lambda value: isinstance(value,str) },
'xrotation' : { 'Default' : 45,
'Validator' : lambda value: isinstance(value,(int,float)) },
'axisoff' : { 'Default' : False,
'Validator' : lambda value: isinstance(value,bool) },
'closefig' : { 'Default' : 'auto',
'Validator' : lambda value: isinstance(value,bool) },
'fill_between' : { 'Default' : None,
'Validator' : lambda value: _num_or_seq_of_num(value) or
(isinstance(value,dict) and 'y1' in value and
_num_or_seq_of_num(value['y1'])) },
'tight_layout' : { 'Default' : False,
'Validator' : lambda value: isinstance(value,bool) },
'width_adjuster_version' : { 'Default' : 'v1',
'Validator' : lambda value: value in ('v0', 'v1') },
'scale_width_adjustment' : { 'Default' : None,
'Validator' : lambda value: isinstance(value,dict) and len(value) > 0 },
'update_width_config' : { 'Default' : None,
'Validator' : lambda value: isinstance(value,dict) and len(value) > 0 },
'return_width_config' : { 'Default' : None,
'Validator' : lambda value: isinstance(value,dict) and len(value)==0 },
'saxbelow' : { 'Default' : True, # Issue#115 Comment#639446764
'Validator' : lambda value: isinstance(value,bool) },
'scale_padding' : { 'Default' : 1.0, # Issue#193
'Validator' : lambda value: _scale_padding_validator(value) },
'ax' : { 'Default' : None,
'Validator' : lambda value: isinstance(value,mpl_axes.Axes) },
'volume_exponent' : { 'Default' : None,
'Validator' : lambda value: isinstance(value,int) or value == 'legacy'},
'tz_localize' : { 'Default' : True,
'Validator' : lambda value: isinstance(value,bool) },
'yscale' : { 'Default' : None,
'Validator' : lambda value: _yscale_validator(value) },
'volume_yscale' : { 'Default' : None,
'Validator' : lambda value: _yscale_validator(value) },
'warn_too_much_data' : { 'Default' : 599,
'Validator' : lambda value: isinstance(value,int) },
}
_validate_vkwargs_dict(vkwargs)
return vkwargs
###@with_rc_context
def plot( data, **kwargs ):
"""
Given a Pandas DataFrame containing columns Open,High,Low,Close and optionally Volume
with a DatetimeIndex, plot the data.
Available plots include ohlc bars, candlestick, and line plots.
Also provide visually analysis in the form of common technical studies, such as:
moving averages, renko, etc.
Also provide ability to plot trading signals, and/or addtional user-defined data.
"""
config = _process_kwargs(kwargs, _valid_plot_kwargs())
# translate alias types:
config['type'] = _get_valid_plot_types(config['type'])
dates,opens,highs,lows,closes,volumes = _check_and_prepare_data(data, config)
config['xlim'] = _check_and_convert_xlim_configuration(data, config)
if config['type'] in VALID_PMOVE_TYPES and config['addplot'] is not None:
err = "`addplot` is not supported for `type='" + config['type'] +"'`"
raise ValueError(err)
external_axes_mode = _check_for_external_axes(config)
if external_axes_mode:
if config['figscale'] is not None:
warnings.warn('\n\n ================================================================= '+
'\n\n WARNING: `figscale` has NO effect in External Axes Mode.'+
'\n\n ================================================================ ',
category=UserWarning)
if config['figratio'] is not None:
warnings.warn('\n\n ================================================================= '+
'\n\n WARNING: `figratio` has NO effect in External Axes Mode.'+
'\n\n ================================================================ ',
category=UserWarning)
if config['figsize'] is not None:
warnings.warn('\n\n ================================================================= '+
'\n\n WARNING: `figsize` has NO effect in External Axes Mode.'+
'\n\n ================================================================ ',
category=UserWarning)
else:
if config['figscale'] is None: config['figscale'] = 1.0
if config['figratio'] is None: config['figratio'] = DEFAULT_FIGRATIO
style = config['style']
if external_axes_mode and hasattr(config['ax'],'mpfstyle') and style is None:
style = config['ax'].mpfstyle
elif style is None:
style = 'default'
if isinstance(style,str):
style = _styles._get_mpfstyle(style)
config['style'] = style
if isinstance(style,dict):
if not external_axes_mode: _styles._apply_mpfstyle(style)
else:
raise TypeError('style should be a `dict`; why is it not?')
# ----------------------------------------------------------------------
# TODO: Add some warnings, or raise an exception, if external_axes_mode
# and user is trying to figscale, figratio, or figsize.
# ----------------------------------------------------------------------
if not external_axes_mode:
fig = plt.figure()
_adjust_figsize(fig,config)
else:
fig = None
_adjust_fontsize(config)
if config['volume'] and volumes is None:
raise ValueError('Request for volume, but NO volume data.')
if external_axes_mode:
panels = None
if config['volume']:
volumeAxes = config['volume']
volumeAxes.set_axisbelow(config['saxbelow'])
else:
panels = _build_panels(fig, config)
volumeAxes = panels.at[config['volume_panel'],'axes'][0] if config['volume'] is True else None
fmtstring = _determine_format_string(dates, config['datetime_format'])
ptype = config['type']
if config['show_nontrading']:
formatter = mdates.DateFormatter(fmtstring)
xdates = dates
else:
formatter = IntegerIndexDateTimeFormatter(dates, fmtstring)
xdates = np.arange(len(dates))
if external_axes_mode:
axA1 = config['ax']
axA1.set_axisbelow(config['saxbelow'])
else:
axA1 = panels.at[config['main_panel'],'axes'][0]
# Will have to handle widths config separately for PMOVE types ??
config['_width_config'] = _determine_width_config(xdates, config)
rwc = config['return_width_config']
if isinstance(rwc,dict) and len(rwc)==0:
config['return_width_config'].update(config['_width_config'])
collections = None
if ptype == 'line':
lw = config['_width_config']['line_width']
axA1.plot(xdates, closes, color=config['linecolor'], linewidth=lw)
else:
collections =_construct_mpf_collections(ptype,dates,xdates,opens,highs,lows,closes,volumes,config,style)
if ptype in VALID_PMOVE_TYPES:
collections, calculated_values = collections
volumes = calculated_values['volumes']
pmove_dates = calculated_values['dates']
pmove_values = calculated_values['values']
if all([isinstance(v,(list,tuple)) for v in pmove_values]):
pmove_avgvals = [sum(v)/len(v) for v in pmove_values]
else:
pmove_avgvals = pmove_values
pmove_size = calculated_values['size']
pmove_counts = calculated_values['counts'] if 'counts' in calculated_values else None
formatter = IntegerIndexDateTimeFormatter(pmove_dates, fmtstring)
xdates = np.arange(len(pmove_dates))
if collections is not None:
for collection in collections:
axA1.add_collection(collection)
if ptype in VALID_PMOVE_TYPES:
mavprices = _plot_mav(axA1,config,xdates,pmove_avgvals)
else:
mavprices = _plot_mav(axA1,config,xdates,closes)
avg_dist_between_points = (xdates[-1] - xdates[0]) / float(len(xdates))
if not config['tight_layout']:
minx = xdates[0] - avg_dist_between_points
maxx = xdates[-1] + avg_dist_between_points
else:
minx = xdates[0] - (0.45 * avg_dist_between_points)
maxx = xdates[-1] + (0.45 * avg_dist_between_points)
if len(xdates) == 1: # kludge special case
minx = minx - 0.75
maxx = maxx + 0.75
if ptype not in VALID_PMOVE_TYPES:
_lows = lows
_highs = highs
else:
_lows = pmove_avgvals
_highs = [value+pmove_size for value in pmove_avgvals]
miny = np.nanmin(_lows)
maxy = np.nanmax(_highs)
if config['ylim'] is not None:
axA1.set_ylim(config['ylim'][0], config['ylim'][1])
elif config['tight_layout']:
ydelta = 0.01 * (maxy-miny)
if miny > 0.0:
# don't let it go negative:
setminy = max(0.9*miny,miny-ydelta)
else:
setminy = miny-ydelta
axA1.set_ylim(setminy,maxy+ydelta)
if config['xlim'] is not None:
axA1.set_xlim(config['xlim'][0], config['xlim'][1])
elif config['tight_layout']:
axA1.set_xlim(minx,maxx)
if (config['ylim'] is None and
config['xlim'] is None and
not config['tight_layout']):
corners = (minx, miny), (maxx, maxy)
axA1.update_datalim(corners)
if config['return_calculated_values'] is not None:
retdict = config['return_calculated_values']
if ptype == 'renko':
retdict['renko_bricks' ] = pmove_values
retdict['renko_dates' ] = mdates.num2date(pmove_dates)
retdict['renko_size' ] = pmove_size
retdict['renko_volumes'] = volumes if config['volume'] else None
elif ptype == 'pnf':
retdict['pnf_dates' ] = mdates.num2date(pmove_dates)
retdict['pnf_counts' ] = pmove_counts
retdict['pnf_values' ] = pmove_values
retdict['pnf_avgvals' ] = pmove_avgvals
retdict['pnf_size' ] = pmove_size
retdict['pnf_volumes' ] = volumes if config['volume'] else None
if config['mav'] is not None:
mav = config['mav']
if len(mav) != len(mavprices):
warnings.warn('len(mav)='+str(len(mav))+' BUT len(mavprices)='+str(len(mavprices)))
else:
for jj in range(0,len(mav)):
retdict['mav' + str(mav[jj])] = mavprices[jj]
retdict['minx'] = minx
retdict['maxx'] = maxx
retdict['miny'] = miny
retdict['maxy'] = maxy
# Note: these are NOT mutually exclusive, so the order of this
# if/elif is important: VALID_PMOVE_TYPES must be first.
if ptype in VALID_PMOVE_TYPES:
dtix = pd.DatetimeIndex([dt for dt in mdates.num2date(pmove_dates)])
elif not config['show_nontrading']:
dtix = data.index
else:
dtix = None
line_collections = []
line_collections.append(_construct_aline_collections(config['alines'], dtix))
line_collections.append(_construct_hline_collections(config['hlines'], minx, maxx))
line_collections.append(_construct_vline_collections(config['vlines'], dtix, miny, maxy))
tlines = config['tlines']
if isinstance(tlines,(list,tuple)) and all([isinstance(item,dict) for item in tlines]):
pass
else:
tlines = [tlines,]
for tline_item in tlines:
line_collections.append(_construct_tline_collections(tline_item, dtix, dates, opens, highs, lows, closes))
for collection in line_collections:
if collection is not None:
axA1.add_collection(collection)
datalen = len(xdates)
if config['volume']:
vup,vdown = style['marketcolors']['volume'].values()
#-- print('vup,vdown=',vup,vdown)
vcolors = _updown_colors(vup, vdown, opens, closes, use_prev_close=style['marketcolors']['vcdopcod'])
#-- print('len(vcolors),len(opens),len(closes)=',len(vcolors),len(opens),len(closes))
#-- print('vcolors=',vcolors)
w = config['_width_config']['volume_width']
lw = config['_width_config']['volume_linewidth']
adjc = _adjust_color_brightness(vcolors,0.90)
volumeAxes.bar(xdates,volumes,width=w,linewidth=lw,color=vcolors,ec=adjc)
vymin = 0.3 * np.nanmin(volumes)
vymax = 1.1 * np.nanmax(volumes)
volumeAxes.set_ylim(vymin,vymax)
xrotation = config['xrotation']
if not external_axes_mode:
_set_ticks_on_bottom_panel_only(panels,formatter,rotation=xrotation)
else:
axA1.tick_params(axis='x',rotation=xrotation)
axA1.xaxis.set_major_formatter(formatter)
ysd = config['yscale']
if isinstance(ysd,dict):
yscale = ysd['yscale']
del ysd['yscale']
axA1.set_yscale(yscale,**ysd)
elif isinstance(ysd,str):
axA1.set_yscale(ysd)
addplot = config['addplot']
if addplot is not None and ptype not in VALID_PMOVE_TYPES:
# NOTE: If in external_axes_mode, then all code relating
# to panels and secondary_y becomes irrrelevant.
# If the user wants something on a secondary_y then user should
# determine that externally, and pass in the appropriate axes.
if not external_axes_mode:
# Calculate the Order of Magnitude Range ('mag')
# If addplot['secondary_y'] == 'auto', then: If the addplot['data']
# is out of the Order of Magnitude Range, then use secondary_y.
lo = math.log(max(math.fabs(np.nanmin(lows)),1e-7),10) - 0.5
hi = math.log(max(math.fabs(np.nanmax(highs)),1e-7),10) + 0.5
panels['mag'] = [None]*len(panels) # create 'mag'nitude column
panels.at[config['main_panel'],'mag'] = {'lo':lo,'hi':hi} # update main panel magnitude range
if config['volume']:
lo = math.log(max(math.fabs(np.nanmin(volumes)),1e-7),10) - 0.5
hi = math.log(max(math.fabs(np.nanmax(volumes)),1e-7),10) + 0.5
panels.at[config['volume_panel'],'mag'] = {'lo':lo,'hi':hi}
if isinstance(addplot,dict):
addplot = [addplot,] # make list of dict to be consistent
elif not _list_of_dict(addplot):
raise TypeError('addplot must be `dict`, or `list of dict`, NOT '+str(type(addplot)))
for apdict in addplot:
panid = apdict['panel']
if not external_axes_mode:
if panid == 'main' : panid = 0 # for backwards compatibility
elif panid == 'lower': panid = 1 # for backwards compatibility
if apdict['y_on_right'] is not None:
panels.at[panid,'y_on_right'] = apdict['y_on_right']
aptype = apdict['type']
if aptype == 'ohlc' or aptype == 'candle':
ax = _addplot_collections(panid,panels,apdict,xdates,config)
_addplot_apply_supplements(ax,apdict)
else:
apdata = apdict['data']
if isinstance(apdata,list) and not isinstance(apdata[0],(float,int)):
raise TypeError('apdata is list but NOT of float or int')
if isinstance(apdata,pd.DataFrame):
havedf = True
else:
havedf = False # must be a single series or array
apdata = [apdata,] # make it iterable
for column in apdata:
ydata = apdata.loc[:,column] if havedf else column
ax = _addplot_columns(panid,panels,ydata,apdict,xdates,config)
_addplot_apply_supplements(ax,apdict)
# fill_between is NOT supported for external_axes_mode
# (caller can easily call ax.fill_between() themselves).
if config['fill_between'] is not None and not external_axes_mode:
fb = config['fill_between']
panid = config['main_panel']
if isinstance(fb,dict):
if 'x' in fb:
raise ValueError('fill_between dict may not contain `x`')
if 'panel' in fb:
panid = fb['panel']
del fb['panel']
else:
fb = dict(y1=fb)
fb['x'] = xdates
ax = panels.at[panid,'axes'][0]
ax.fill_between(**fb)
# put the primary axis on one side,
# and the twinx() on the "other" side:
if not external_axes_mode:
for panid,row in panels.iterrows():
ax = row['axes']
y_on_right = style['y_on_right'] if row['y_on_right'] is None else row['y_on_right']
_set_ylabels_side(ax[0],ax[1],y_on_right)
else:
y_on_right = style['y_on_right']
_set_ylabels_side(axA1,None,y_on_right)
# TODO: ================================================================
# TODO: Investigate:
# TODO: ===========
# TODO: It appears to me that there may be some or significant overlap
# TODO: between what the following functions actually do:
# TODO: At the very least, all four of them appear to communicate
# TODO: to matplotlib that the xaxis should be treated as dates:
# TODO: -> 'ax.autoscale_view()'
# TODO: -> 'ax.xaxis_dates()'
# TODO: -> 'plt.autofmt_xdates()'
# TODO: -> 'fig.autofmt_xdate()'
# TODO: ================================================================
#if config['autofmt_xdate']:
#print('CALLING fig.autofmt_xdate()')
#fig.autofmt_xdate()
axA1.autoscale_view() # Is this really necessary??
# It appears to me, based on experience coding types 'ohlc' and 'candle'
# for `addplot`, that this IS necessary when the only thing done to the
# the axes is .add_collection(). (However, if ax.plot() .scatter() or
# .bar() was called, then possibly this is not necessary; not entirely
# sure, but it definitely was necessary to get 'ohlc' and 'candle'
# working in `addplot`).
axA1.set_ylabel(config['ylabel'])
if config['volume']:
if external_axes_mode:
volumeAxes.tick_params(axis='x',rotation=xrotation)
volumeAxes.xaxis.set_major_formatter(formatter)
vscale = 'linear'
ysd = config['volume_yscale']
if isinstance(ysd,dict):
yscale = ysd['yscale']
del ysd['yscale']
volumeAxes.set_yscale(yscale,**ysd)
vscale = yscale
elif isinstance(ysd,str):
volumeAxes.set_yscale(ysd)
vscale = ysd
offset = ''
if vscale == 'linear':
vxp = config['volume_exponent']
if vxp == 'legacy':
volumeAxes.figure.canvas.draw() # This is needed to calculate offset
offset = volumeAxes.yaxis.get_major_formatter().get_offset()
if len(offset) > 0:
offset = (' x '+offset)
elif isinstance(vxp,int) and vxp > 0:
volumeAxes.ticklabel_format(useOffset=False,scilimits=(vxp,vxp),axis='y')
offset = ' $10^{'+str(vxp)+'}$'
elif isinstance(vxp,int) and vxp == 0:
volumeAxes.ticklabel_format(useOffset=False,style='plain',axis='y')
offset = ''
else:
offset = ''
scilims = plt.rcParams['axes.formatter.limits']
if scilims[0] < scilims[1]:
for power in (5,4,3,2,1):
xp = scilims[1]*power
if vymax >= 10.**xp:
volumeAxes.ticklabel_format(useOffset=False,scilimits=(xp,xp),axis='y')
offset = ' $10^{'+str(xp)+'}$'
break
elif scilims[0] == scilims[1] and scilims[1] != 0:
volumeAxes.ticklabel_format(useOffset=False,scilimits=scilims,axis='y')
offset = ' $10^'+str(scilims[1])+'$'
volumeAxes.yaxis.offsetText.set_visible(False)
if config['ylabel_lower'] is None:
vol_label = 'Volume'+offset
else:
if len(offset) > 0:
offset = '\n'+offset
vol_label = config['ylabel_lower'] + offset
volumeAxes.set_ylabel(vol_label)
if config['title'] is not None:
if config['tight_layout']:
# IMPORTANT: `y=0.89` is based on the top of the top panel
# being at 0.18+0.7 = 0.88. See _panels.py
# If the value changes there, then it needs to change here.
title_kwargs = dict(va='bottom', y=0.89)
else:
title_kwargs = dict(va='center')
if isinstance(config['title'],dict):
title_dict = config['title']
if 'title' not in title_dict:
raise ValueError('Must have "title" entry in title dict')
else:
title = title_dict['title']
del title_dict['title']
title_kwargs.update(title_dict) # allows override default values set by mplfinance above
else:
title = config['title'] # config['title'] is a string
fig.suptitle(title,**title_kwargs)
if config['axtitle'] is not None:
axA1.set_title(config['axtitle'])
if not external_axes_mode:
for panid,row in panels.iterrows():
if not row['used2nd']:
row['axes'][1].set_visible(False)
if external_axes_mode:
return None
# Should we create a new kwarg to return a flattened axes list
# versus a list of tuples of primary and secondary axes?
# For now, for backwards compatibility, we flatten axes list:
axlist = [ax for axes in panels['axes'] for ax in axes]
if config['axisoff']:
for ax in axlist:
ax.set_axis_off()
if config['savefig'] is not None:
save = config['savefig']
if isinstance(save,dict):
if config['tight_layout'] and 'bbox_inches' not in save:
plt.savefig(**save,bbox_inches='tight')
else:
plt.savefig(**save)
else:
if config['tight_layout']:
plt.savefig(save,bbox_inches='tight')
else:
plt.savefig(save)
if config['closefig']: # True or 'auto'
plt.close(fig)
elif not config['returnfig']:
plt.show(block=config['block']) # https://stackoverflow.com/a/13361748/1639359
if config['closefig'] == True or (config['block'] and config['closefig']):
plt.close(fig)
if config['returnfig']:
if config['closefig'] == True: plt.close(fig)
return (fig, axlist)
# rcp = copy.deepcopy(plt.rcParams)
# rcpdf = rcParams_to_df(rcp)
# print('type(rcpdf)=',type(rcpdf))
# print('rcpdfhead(3)=',rcpdf.head(3))
# return # rcpdf
def _adjust_figsize(fig,config):
if fig is None:
return
if config['figsize'] is None:
w,h = config['figratio']
r = float(w)/float(h)
if r < 0.20 or r > 5.0:
raise ValueError('"figratio" (aspect ratio) must be between 0.20 and 5.0 (but is '+str(r)+')')
default_scale = DEFAULT_FIGRATIO[1]/h
h *= default_scale
w *= default_scale
base = (w,h)
figscale = config['figscale']
fsize = [d*figscale for d in base]
else:
fsize = config['figsize']
fig.set_size_inches(fsize)
def _adjust_fontsize(config):
if config['fontscale'] is None:
return
if not isinstance(plt.rcParams['font.size'],(float,int)):
warnings.warn('\n\n ================================================================= '+
'\n\n WARNING: Unable to scale fonts: plt.rcParams["font.size"] is NOT a float!'+
'\n\n ================================================================ ',
category=UserWarning)
return
plt.rcParams['font.size'] *= config['fontscale']
# --------------------------------------------
# From: matplotlib.font_manager.font_scalings:
# font_scalings = {
# 'xx-small': 0.579,
# 'x-small': 0.694,
# 'small': 0.833,
# 'medium': 1.0,
# 'large': 1.200,
# 'x-large': 1.440,
# 'xx-large': 1.728,
# 'larger': 1.2,
# 'smaller': 0.833,
# None: 1.0,
# }
# --------------------------------------------
fontstuff = ['axes.labelsize','axes.titlesize', 'figure.titlesize','legend.fontsize',
'legend.title_fontsize','xtick.labelsize','ytick.labelsize']
for item in fontstuff:
if isinstance(plt.rcParams[item],(float,int)):
plt.rcParams[item] *= config['fontscale']
def _addplot_collections(panid,panels,apdict,xdates,config):
apdata = apdict['data']
aptype = apdict['type']
external_axes_mode = apdict['ax'] is not None
#--------------------------------------------------------------#
# Note: _auto_secondary_y() sets the 'magnitude' column in the
# `panels` dataframe, which is needed for automatically
# determining if secondary_y is needed. Therefore we call
# _auto_secondary_y() for *all* addplots, even those that
# are set to True or False (not 'auto') for secondary_y
# because their magnitudes may be needed if *any* apdicts
# contain secondary_y='auto'.
# In theory we could first loop through all apdicts to see
# if any have secondary_y='auto', but since that is the
# default value, we will just assume we have at least one.
valid_apc_types = ['ohlc','candle']
if aptype not in valid_apc_types:
raise TypeError('Invalid aptype='+str(aptype)+'. Must be one of '+str(valid_apc_types))
if not isinstance(apdata,pd.DataFrame):
raise TypeError('addplot type "'+aptype+'" MUST be accompanied by addplot data of type `pd.DataFrame`')
d,o,h,l,c,v = _check_and_prepare_data(apdata,config)
collections = _construct_mpf_collections(aptype,d,xdates,o,h,l,c,v,config,config['style'])
if not external_axes_mode:
lo = math.log(max(math.fabs(np.nanmin(l)),1e-7),10) - 0.5
hi = math.log(max(math.fabs(np.nanmax(h)),1e-7),10) + 0.5
secondary_y = _auto_secondary_y( panels, panid, lo, hi )
if 'auto' != apdict['secondary_y']:
secondary_y = apdict['secondary_y']
if secondary_y:
ax = panels.at[panid,'axes'][1]
panels.at[panid,'used2nd'] = True
else:
ax = panels.at[panid,'axes'][0]
else:
ax = apdict['ax']
for coll in collections:
ax.add_collection(coll)
if apdict['mav'] is not None:
apmavprices = _plot_mav(ax,config,xdates,c,apdict['mav'])
ax.autoscale_view()
return ax
def _addplot_columns(panid,panels,ydata,apdict,xdates,config):
external_axes_mode = apdict['ax'] is not None
if not external_axes_mode:
secondary_y = False
if apdict['secondary_y'] == 'auto':
yd = [y for y in ydata if not math.isnan(y)]
ymhi = math.log(max(math.fabs(np.nanmax(yd)),1e-7),10)
ymlo = math.log(max(math.fabs(np.nanmin(yd)),1e-7),10)
secondary_y = _auto_secondary_y( panels, panid, ymlo, ymhi )
else:
secondary_y = apdict['secondary_y']
#print("apdict['secondary_y'] says secondary_y is",secondary_y)
if secondary_y:
ax = panels.at[panid,'axes'][1]
panels.at[panid,'used2nd'] = True
else:
ax = panels.at[panid,'axes'][0]
else:
ax = apdict['ax']
aptype = apdict['type']
if aptype == 'scatter':
size = apdict['markersize']
mark = apdict['marker']
color = apdict['color']
alpha = apdict['alpha']
if isinstance(mark,(list,tuple,np.ndarray)):
_mscatter(xdates,ydata,ax=ax,m=mark,s=size,color=color,alpha=alpha)
else:
ax.scatter(xdates,ydata,s=size,marker=mark,color=color,alpha=alpha)
elif aptype == 'bar':
width = 0.8 if apdict['width'] is None else apdict['width']
bottom = apdict['bottom']
color = apdict['color']
alpha = apdict['alpha']
ax.bar(xdates,ydata,width=width,bottom=bottom,color=color,alpha=alpha)
elif aptype == 'line':
ls = apdict['linestyle']
color = apdict['color']
width = apdict['width'] if apdict['width'] is not None else 1.6*config['_width_config']['line_width']
alpha = apdict['alpha']
ax.plot(xdates,ydata,linestyle=ls,color=color,linewidth=width,alpha=alpha)
else:
raise ValueError('addplot type "'+str(aptype)+'" NOT yet supported.')
if apdict['mav'] is not None:
apmavprices = _plot_mav(ax,config,xdates,ydata,apdict['mav'])
return ax
def _addplot_apply_supplements(ax,apdict):
if (apdict['ylabel'] is not None):
ax.set_ylabel(apdict['ylabel'])
if apdict['ylim'] is not None:
ax.set_ylim(apdict['ylim'][0],apdict['ylim'][1])
if apdict['title'] is not None:
ax.set_title(apdict['title'])
ysd = apdict['yscale']
if isinstance(ysd,dict):
yscale = ysd['yscale']
del ysd['yscale']
ax.set_yscale(yscale,**ysd)
elif isinstance(ysd,str):
ax.set_yscale(ysd)
def _set_ylabels_side(ax_pri,ax_sec,primary_on_right):
# put the primary axis on one side,
# and the twinx() on the "other" side:
if primary_on_right == True:
ax_pri.yaxis.set_label_position('right')
ax_pri.yaxis.tick_right()
if ax_sec is not None:
ax_sec.yaxis.set_label_position('left')
ax_sec.yaxis.tick_left()
else: # treat non-True as False, whether False, None, or anything else.
ax_pri.yaxis.set_label_position('left')
ax_pri.yaxis.tick_left()
if ax_sec is not None:
ax_sec.yaxis.set_label_position('right')
ax_sec.yaxis.tick_right()
def _plot_mav(ax,config,xdates,prices,apmav=None,apwidth=None):
style = config['style']
if apmav is not None:
mavgs = apmav
else:
mavgs = config['mav']
mavp_list = []
if mavgs is not None:
if isinstance(mavgs,int):
mavgs = mavgs, # convert to tuple
if len(mavgs) > 7:
mavgs = mavgs[0:7] # take at most 7
if style['mavcolors'] is not None:
mavc = cycle(style['mavcolors'])
else:
mavc = None
for mav in mavgs:
mavprices = pd.Series(prices).rolling(mav).mean().values
lw = config['_width_config']['line_width']
if mavc:
ax.plot(xdates, mavprices, linewidth=lw, color=next(mavc))
else:
ax.plot(xdates, mavprices, linewidth=lw)
mavp_list.append(mavprices)
return mavp_list
def _auto_secondary_y( panels, panid, ylo, yhi ):
# If mag(nitude) for this panel is not yet set, then set it
# here, as this is the first ydata to be plotted on this panel:
# i.e. consider this to be the 'primary' axis for this panel.
secondary_y = False
p = panid,'mag'
if panels.at[p] is None:
panels.at[p] = {'lo':ylo,'hi':yhi}