Merge pull request #36 from DanielGoldfarb/master

bypass kwarg validator; not implemented kwarg; update version and release notes

Author: DanielGoldfarb

README.md

@@ -555,6 +555,7 @@ For more examples of using mplfinance, please see the jupyter notebooks in the *
 
 | Version  |  Description   | Release Date |
 |:---------|:-------------|:---------------|
+| 0.12.3a2   | - implement custom markers (issue#30)<br> - fix minor issue with chart `type` validator<br> -- Thank you Amir Atashin @amiaty for contributing the above.<br> - add internal functions: `_bypass_kwarg_validation()` and `_kwarg_not_implemented()` | 2020-02-21 |
 | 0.12.3a1   | - fix issue#28: math.log crash on zero in data<br> - remove "Implemented" field from kwarg dicts<br> - yahoo style show colors for `ohlc bars` | 2020-02-16 |
 | 0.12.3a0   | - kwarg `block=False` for non-blocking call to `mpf.plot()`<br> - customize aspect ratio, figure title, y-labels<br> - customize colors and other `style` aspects of plot<br> - `no_xgaps` now defaults to True: use `show_nontrading=True` to set no_xgaps to false<br> - secondary y-axis available to `make_addplot()`<br> - bug fix for volume widths | 2020-02-12 |
 | 0.12.0a3   | Increase mav limit from 3 to 7 different mavs  | 2020-01-16 |

src/mplfinance/_arg_validators.py

@@ -56,6 +56,23 @@ def _mav_validator(mav_value):
             return False
     return True
 
+def _bypass_kwarg_validation(value):
+    ''' For some kwargs, we either don't know enough, or
+        the validation is too complex to make it worth while,
+        so we bypass kwarg validation.  If the kwarg is 
+        invalid, then eventually an exception will be 
+        raised at the time the kwarg value is actually used.
+    '''
+    return True
+
+def _kwarg_not_implemented(value):
+    ''' If you want to list a kwarg in a valid_kwargs dict for a given
+        function, but you have not yet, or don't yet want to, implement
+        the kwarg; or you simply want to (temporarily) disable the kwarg,
+        then use this function as the kwarg validator
+    '''
+    raise NotImplementedError('kwarg NOT implemented.')
+
 def _validate_vkwargs_dict(vkwargs):
     # Check that we didn't make a typo in any of the things
     # that should be the same for all vkwargs dict items:

src/mplfinance/_version.py

@@ -1,4 +1,4 @@
-version_info = (0, 12, 3, 'alpha', 1)
+version_info = (0, 12, 3, 'alpha', 2)
 
 _specifier_ = {'alpha': 'a', 'beta': 'b', 'candidate': 'rc', 'final': ''}
 

src/mplfinance/plotting.py

@@ -20,6 +20,7 @@
 
 from mplfinance._arg_validators import _check_and_prepare_data, _mav_validator
 from mplfinance._arg_validators import _process_kwargs, _validate_vkwargs_dict
+from mplfinance._arg_validators import _kwarg_not_implemented, _bypass_kwarg_validation
 
 
 def with_rc_context(func):
@@ -72,7 +73,8 @@ def _valid_plot_kwargs():
                           'Validator'   : _mav_validator },
 
         'study'       : { 'Default'     : None,
-                          'Validator'   : lambda value: isinstance(value,dict) }, #{'studyname': {study parms}} example: {'TE':{'mav':20,'upper':2,'lower':2}}
+                         #'Validator'   : lambda value: isinstance(value,dict) }, #{'studyname': {study parms}} example: {'TE':{'mav':20,'upper':2,'lower':2}}
+                          'Validator'   : lambda value: _kwarg_not_implemented(value) }, 
 
         'marketcolors': { 'Default'     : None, # use 'style' for default, instead.
                           'Validator'   : lambda value: isinstance(value,dict) },
@@ -475,7 +477,7 @@ def _valid_addplot_kwargs():
                           'Validator'   : lambda value: value in ['main','lower'] },
 
         'marker'      : { 'Default'     : 'o',
-                          'Validator'   : lambda value: not isinstance(value,bool)  },
+                          'Validator'   : lambda value: _bypass_kwarg_validation(value)  },
 
         'markersize'  : { 'Default'     : 18,
                           'Validator'   : lambda value: isinstance(value,(int,float)) },