implement alias plot types

Author: DanielGoldfarb

src/mplfinance/_arg_validators.py

@@ -60,6 +60,31 @@ def _check_and_prepare_data(data, config):
 
     return dates, opens, highs, lows, closes, volumes
 
+def _get_valid_plot_types(plottype=None):
+
+    _alias_types = {
+        'candlestick'       : 'candle',
+        'ohlc_bars'         : 'ohlc',
+        'hollow_candle'     : 'hollow_and_filled',
+        'hollow'            : 'hollow_and_filled',
+        'hnf'               : 'hollow_and_filled',
+    }
+
+    _valid_types = ['candle','ohlc', 'line','renko','pnf','hollow_and_filled']
+
+    _valid_types_all = _valid_types.copy()
+    _valid_types_all.extend(_alias_types.keys())
+
+    if plottype is None:
+        return _valid_types_all
+
+    if plottype not in _valid_types_all:
+        return None
+    elif plottype in _alias_types:
+        return _alias_types[plottype]
+    else:
+        return plottype
+        
 
 def _mav_validator(mav_value):
     ''' 

src/mplfinance/_utils.py

@@ -68,7 +68,7 @@ def _construct_mpf_collections(ptype,dates,xdates,opens,highs,lows,closes,volume
         collections = _construct_candlestick_collections(xdates, opens, highs, lows, closes,
                                                          marketcolors=style['marketcolors'],config=config )
 
-    elif ptype =='hollow_candle':
+    elif ptype =='hollow_and_filled':
             collections = _construct_hollow_candlestick_collections(xdates, opens, highs, lows, closes,
                                                          marketcolors=style['marketcolors'],config=config )
 

src/mplfinance/plotting.py

@@ -30,6 +30,7 @@
 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
@@ -99,8 +100,7 @@ def _valid_plot_kwargs():
                                                                    and len(value) == 5
                                                                    and all(isinstance(c, str) for c in value) },
         'type'                      : { 'Default'     : 'ohlc',
-                                        'Validator'   : lambda value: value in ('candle','candlestick','ohlc','ohlc_bars',
-                                                                                'line','renko','pnf','hollow_candle') },
+                                        'Validator'   : lambda value: value in _get_valid_plot_types() },
 
         'style'                     : { 'Default'     : None,
                                         'Validator'   : _styles._valid_mpf_style },
@@ -277,6 +277,9 @@ def plot( data, **kwargs ):
     """
 
     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)