Merge pull request #347 from DanielGoldfarb/fontscale_iss038

DanielGoldfarb · web-flow · commit edec6eb0421e · 2021-03-01T20:35:09.000-05:00
Fontscale Issue#38
diff --git a/examples/scratch_pad/fontscale.ipynb b/examples/scratch_pad/fontscale.ipynb
diff --git a/src/mplfinance/_styledata/binance.py b/src/mplfinance/_styledata/binance.py
@@ -22,6 +22,8 @@
                                ('lines.linewidth' ,  2.0      ),
                                ('font.weight'     , 'medium'  ),
                                ('font.size'       ,  12.0     ),
+                               ('figure.titlesize', 'x-large' ),
+                               ('figure.titleweight','semibold'),
                              ],
              base_mpf_style= 'binance'
             )
diff --git a/src/mplfinance/_styledata/blueskies.py b/src/mplfinance/_styledata/blueskies.py
@@ -13,11 +13,11 @@
              facecolor     = '#dbf1ff',
              gridcolor     = None,
              gridstyle     = None,
-             rc            = [('patch.linewidth'      ,  1.0 ),
-                              ('patch.force_edgecolor', True ),
-                              ('lines.linewidth'      ,  1.0 ),
-                             #('axes.facecolor'       , 'w'  ),
-                             #('figure.facecolor'     , 'w'  )
+             rc            = [('patch.linewidth'      ,  1.0      ),
+                              ('patch.force_edgecolor', True      ),
+                              ('lines.linewidth'      ,  1.0      ),
+                              ('figure.titlesize'     , 'x-large' ),
+                              ('figure.titleweight'   , 'semibold'),
                              ],
              base_mpf_style='blueskies', 
             )
diff --git a/src/mplfinance/_styledata/brasil.py b/src/mplfinance/_styledata/brasil.py
@@ -17,7 +17,9 @@
                 'grid.color'    : '#fedf00',
                 'grid.linestyle': '--',
                 'axes.facecolor': '#009b3a',
-                'axes.edgecolor': '#002776'
+                'axes.edgecolor': '#002776',
+                'figure.titlesize'  : 'x-large',
+                'figure.titleweight': 'semibold',
                },
          'base_mpf_style': 'brasil'
         }
diff --git a/src/mplfinance/_styledata/charles.py b/src/mplfinance/_styledata/charles.py
@@ -23,6 +23,8 @@
                                ('lines.linewidth' ,  2.0      ),
                                ('font.weight'     , 'medium'  ),
                                ('font.size'       ,  10.0     ),
+                               ('figure.titlesize', 'x-large' ),
+                               ('figure.titleweight','semibold'),
                              ],
              base_mpf_style= 'charles'
             )
diff --git a/src/mplfinance/_styledata/checkers.py b/src/mplfinance/_styledata/checkers.py
@@ -19,5 +19,8 @@
                             'ytick.color'   : 'k',
                             'xtick.color'   : 'k',
                             'lines.markeredgecolor': 'k',
-                            'patch.force_edgecolor': True},
+                            'patch.force_edgecolor': True,
+                            'figure.titlesize'     : 'x-large',
+                            'figure.titleweight'   : 'semibold',
+                           },
          'base_mpf_style': 'checkers'}
diff --git a/src/mplfinance/_styledata/classic.py b/src/mplfinance/_styledata/classic.py
@@ -19,9 +19,10 @@
                                ('axes.labelsize'  , 'large'   ),
                                ('axes.labelweight', 'semibold'),
                                ('lines.linewidth' ,  2.0      ),
-                              #('patch.force_edgecolor', True ),
                                ('font.weight'     , 'medium'  ),
                                ('font.size'       ,  12.0     ),
+                               ('figure.titlesize', 'x-large' ),
+                               ('figure.titleweight','semibold'),
                              ],
              base_mpf_style= 'classic'
             )
diff --git a/src/mplfinance/_styledata/default.py b/src/mplfinance/_styledata/default.py
@@ -22,6 +22,8 @@
                                ('lines.linewidth' ,  2.0      ),
                                ('font.weight'     , 'medium'  ),
                                ('font.size'       ,  12.0     ),
+                               ('figure.titlesize', 'x-large' ),
+                               ('figure.titleweight','semibold'),
                              ],
              base_mpf_style= 'default'
             )
diff --git a/src/mplfinance/_styledata/ibd.py b/src/mplfinance/_styledata/ibd.py
@@ -31,6 +31,8 @@
                                     ('grid.color'      , '#b0b0b0' ),
                                     ('grid.linestyle'  , 'solid'      ),
                                     ('grid.linewidth'  ,  0.8      ),
+                                    ('figure.titlesize', 'x-large' ),
+                                    ('figure.titleweight','semibold'),
                               ],
              base_mpf_style= 'ibd'
             )
diff --git a/src/mplfinance/_styledata/kenan.py b/src/mplfinance/_styledata/kenan.py
@@ -26,5 +26,8 @@
                       ('axes.labelweight', 'semibold'),
                       ('lines.linewidth', 2.0),
                       ('font.weight', 'medium'),
-                      ('font.size', 12.0)],
+                      ('font.size', 12.0),
+                      ('figure.titlesize', 'x-large' ),
+                      ('figure.titleweight','semibold'),
+                  ],
             'base_mpf_style': 'default'}
diff --git a/src/mplfinance/_styledata/mike.py b/src/mplfinance/_styledata/mike.py
@@ -29,6 +29,8 @@
                                ('lines.linewidth' ,  1.0      ),
                                ('font.weight'     , 'medium'  ),
                                ('font.size'       ,  10.0     ),
+                               ('figure.titlesize', 'x-large' ),
+                               ('figure.titleweight','semibold'),
                              ],
              base_mpf_style= 'mike'
             )
diff --git a/src/mplfinance/_styledata/nightclouds.py b/src/mplfinance/_styledata/nightclouds.py
@@ -15,7 +15,9 @@
              gridcolor     = '#999999',
              gridstyle     = '--',
              rc            = [('patch.linewidth' ,  1.0      ),
-                              ('lines.linewidth' ,  1.0      )
+                              ('lines.linewidth' ,  1.0      ),
+                              ('figure.titlesize', 'x-large' ),
+                              ('figure.titleweight','semibold'),
                              ],
              base_mpf_style='nightclouds', 
             )
diff --git a/src/mplfinance/_styledata/starsandstripes.py b/src/mplfinance/_styledata/starsandstripes.py
@@ -16,7 +16,9 @@
                 'axes.grid'     :  True,
                 'axes.grid.axis': 'y',
                 'grid.color'    : '#082865',
-                'grid.linestyle': '--'
+                'grid.linestyle': '--',
+                'figure.titlesize'  :'x-large',
+                'figure.titleweight':'semibold',
                },
          'base_mpf_style': 'starsandstripes'
         }
diff --git a/src/mplfinance/_styledata/yahoo.py b/src/mplfinance/_styledata/yahoo.py
@@ -16,5 +16,8 @@
                             'axes.edgecolor' : 'f0f0f0',
                             'axes.grid.axis' : 'y',
                             'ytick.color'    : '#101010',
-                            'xtick.color'    : '#101010'},
+                            'xtick.color'    : '#101010',
+                            'figure.titlesize': 'x-large',
+                            'figure.titleweight':'semibold',
+                           },
          'base_mpf_style': 'yahoo'}
diff --git a/src/mplfinance/_styles.py b/src/mplfinance/_styles.py
@@ -96,6 +96,9 @@ def _valid_make_mpf_style_kwargs():
         'rc'            : { 'Default'     : None,
                             'Validator'   : lambda value: isinstance(value,dict) },
 
+        'legacy_rc'     : { 'Default'     : None,  # Just in case someone depended upon old behavior
+                            'Validator'   : lambda value: isinstance(value,dict) },
+
         'style_name'    : { 'Default'     : None,
                             'Validator'   : lambda value: isinstance(value,str) },
 
@@ -108,9 +111,36 @@ def available_styles():
        
 def make_mpf_style( **kwargs ):
     config = _process_kwargs(kwargs, _valid_make_mpf_style_kwargs())
+    if config['rc'] is not None and config['legacy_rc'] is not None:
+        raise ValueError('kwargs `rc` and `legacy_rc` may NOT be used together!')
+
+    # -----------
+    # March 2021: Found bug that if caller used `base_mpf_style` and `rc` at
+    #   the same time, then the caller's `rc` will completely replace the `rc` 
+    #   of `base_mpf_style`.  That was never the intention!  Rather it should be
+    #   that the caller's `rc` merely adds to and/or modifies the `rc` of the
+    #   `base_mpf_style`.  In order to provide a path to "backwards compatibility"
+    #   for users who may have depended on the bug behavior (callers `rc` replaces
+    #   `rc` of `base_mpf_style`) we provide a new kwarg `legacy_rc` which will
+    #   now behave the way that `rc` used to behave.
+    # -----------
 
     if config['base_mpf_style'] is not None:
         style  = _get_mpfstyle(config['base_mpf_style'])
+        # Have to handle 'rc' separately, so we don't wipe 
+        # out the 'rc' params in the `base_mpf_style` that
+        # are not specified in the `make_mpf_style` config:
+        if config['rc'] is not None:
+            rc = config['rc']
+            del config['rc']
+            if isinstance(style['rc'],list):
+                style['rc'] = dict(style['rc'])
+            if style['rc'] is None:
+                style['rc'] = {}
+            style['rc'].update(rc)
+        elif config['legacy_rc'] is not None:
+            config['rc'] = config['legacy_rc']
+            del config['legacy_rc']
         update = [ (k,v) for k,v in config.items() if v is not None ]
         style.update(update)
     else:
diff --git a/src/mplfinance/_version.py b/src/mplfinance/_version.py
@@ -1,5 +1,5 @@
 
-version_info = (0, 12, 7, 'alpha', 8)
+version_info = (0, 12, 7, 'alpha', 9)
 
 _specifier_ = {'alpha': 'a','beta': 'b','candidate': 'rc','final': ''}
 
diff --git a/src/mplfinance/plotting.py b/src/mplfinance/plotting.py
@@ -143,6 +143,9 @@ def _valid_plot_kwargs():
                                                                       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) },
@@ -151,7 +154,7 @@ def _valid_plot_kwargs():
                                         'Validator'   : lambda value: isinstance(value,(str,dict)) },
  
         'axtitle'                   : { 'Default'     : None, # Axes Title (subplot title)
-                                        'Validator'   : lambda value: isinstance(value,str) },
+                                        'Validator'   : lambda value: isinstance(value,(str,dict)) },
  
         'ylabel'                    : { 'Default'     : 'Price', # y-axis label
                                         'Validator'   : lambda value: isinstance(value,str) },
@@ -343,6 +346,8 @@ def plot( data, **kwargs ):
     else:
         fig = None
 
+    _adjust_fontsize(config)
+
     if config['volume'] and volumes is None:
         raise ValueError('Request for volume, but NO volume data.')
 
@@ -691,12 +696,12 @@ def plot( data, **kwargs ):
     
     if config['title'] is not None:
         if config['tight_layout']:
-            # IMPORTANT: 0.89 is based on the top of the top panel
+            # 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(size='x-large',weight='semibold', va='bottom', y=0.89)
+            title_kwargs = dict(va='bottom', y=0.89)
         else:
-            title_kwargs = dict(size='x-large',weight='semibold', va='center')
+            title_kwargs = dict(va='center')
         if isinstance(config['title'],dict):
             title_dict = config['title']
             if 'title' not in title_dict:
@@ -777,6 +782,37 @@ def _adjust_figsize(fig,config):
         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']

Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,8 @@`
`22`	`22`	`('lines.linewidth' , 2.0 ),`
`23`	`23`	`('font.weight' , 'medium' ),`
`24`	`24`	`('font.size' , 12.0 ),`
	`25`	`+ ('figure.titlesize', 'x-large' ),`
	`26`	`+ ('figure.titleweight','semibold'),`
`25`	`27`	`],`
`26`	`28`	`base_mpf_style= 'binance'`
`27`	`29`	`)`
Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,8 @@`
`23`	`23`	`('lines.linewidth' , 2.0 ),`
`24`	`24`	`('font.weight' , 'medium' ),`
`25`	`25`	`('font.size' , 10.0 ),`
	`26`	`+ ('figure.titlesize', 'x-large' ),`
	`27`	`+ ('figure.titleweight','semibold'),`
`26`	`28`	`],`
`27`	`29`	`base_mpf_style= 'charles'`
`28`	`30`	`)`
Original file line number	Diff line number	Diff line change
`@@ -31,6 +31,8 @@`
`31`	`31`	`('grid.color' , '#b0b0b0' ),`
`32`	`32`	`('grid.linestyle' , 'solid' ),`
`33`	`33`	`('grid.linewidth' , 0.8 ),`
	`34`	`+ ('figure.titlesize', 'x-large' ),`
	`35`	`+ ('figure.titleweight','semibold'),`
`34`	`36`	`],`
`35`	`37`	`base_mpf_style= 'ibd'`
`36`	`38`	`)`