Merge pull request #3 from matplotlib/master

Merge with upstream

Author: coffincw

RELEASE_NOTES.md

@@ -1,8 +1,12 @@
 ####
 ---
 
-### <a name="v0.12.7a11"></a>v0.12.7a11 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; To Be released 2021-03-30
+### <a name="v0.12.7a12"></a>v0.12.7a12 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; released 2021-04-09
 
+- <a name="v0.12.7a12"></a>v0.12.7a12 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; merged 2021-04-08
+  - Fixed kwarg **`return_calculated_values`**
+    - It was *not* returning all values for `type='pnf'` (point and figure).
+    - See **[stackoverflow 66991998](https://stackoverflow.com/questions/66991998/)** for more information.
 - <a name="v0.12.7a11"></a>v0.12.7a11 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; merged 2021-03-26
   - Prior to this version, **`xlim`** kwarg accepted only float or int:
     - float as matplotlib date; (only when `show_nontrading=True`)

examples/scratch_pad/price-movement_ret_calc_vals.ipynb

@@ -857,7 +857,9 @@ def _construct_renko_collections(dates, highs, lows, volumes, config_renko_param
                                     edgecolors=edge_colors,
                                     linewidths=lw
                                     )
-    return [rectCollection,], new_dates, new_volumes, brick_values, brick_size
+    calculated_values = dict(dates=new_dates,volumes=new_volumes,
+                             values=brick_values,size=brick_size)
+    return [rectCollection,], calculated_values
 
 
 def _construct_pointnfig_collections(dates, highs, lows, volumes, config_pointnfig_params, closes, marketcolors=None):
@@ -1052,7 +1054,7 @@ def _construct_pointnfig_collections(dates, highs, lows, volumes, config_pointnf
     box_values = [] # y values for the boxes
     circle_patches = [] # list of circle patches to be used to create the cirCollection
     line_seg = [] # line segments that make up the Xs
-    
+
     for index, difference in enumerate(boxes):
         diff = abs(difference)
 
@@ -1061,9 +1063,9 @@ def _construct_pointnfig_collections(dates, highs, lows, volumes, config_pointnf
 
         x = [index] * (diff)
         y = [curr_price + (i * box_size * sign) for i in range(start_iteration, diff+start_iteration)]
-        
+
         curr_price += (box_size * sign * (diff))
-        box_values.append(sum(y) / len(y))
+        box_values.append( y )
 
         for i in range(len(x)): # x and y have the same length
             height = box_size * 0.85
@@ -1090,7 +1092,9 @@ def _construct_pointnfig_collections(dates, highs, lows, volumes, config_pointnf
                                  linewidths=lw,
                                  antialiaseds=useAA
                                  )
-    return [cirCollection, xCollection], new_dates, new_volumes, box_values, box_size
+    calculated_values = dict(dates=new_dates,counts=boxes,values=box_values,
+                             volumes=new_volumes,size=box_size)
+    return [cirCollection, xCollection], calculated_values
 
 
 def _construct_aline_collections(alines, dtix=None):

src/mplfinance/_utils.py

@@ -1,5 +1,5 @@
 
-version_info = (0, 12, 7, 'alpha', 11)
+version_info = (0, 12, 7, 'alpha', 12)
 
 _specifier_ = {'alpha': 'a','beta': 'b','candidate': 'rc','final': ''}
 

src/mplfinance/_version.py

@@ -400,16 +400,25 @@ def plot( data, **kwargs ):
         collections =_construct_mpf_collections(ptype,dates,xdates,opens,highs,lows,closes,volumes,config,style)
 
     if ptype in VALID_PMOVE_TYPES:
-        collections, new_dates, volumes, brick_values, size = collections
-        formatter = IntegerIndexDateTimeFormatter(new_dates, fmtstring)
-        xdates = np.arange(len(new_dates))
+        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,brick_values)
+        mavprices = _plot_mav(axA1,config,xdates,pmove_avgvals)
     else:
         mavprices = _plot_mav(axA1,config,xdates,closes)
 
@@ -428,8 +437,8 @@ def plot( data, **kwargs ):
         _lows  = lows
         _highs = highs
     else:
-        _lows  = brick_values
-        _highs = [brick+size for brick in brick_values]
+        _lows  = pmove_avgvals
+        _highs = [value+pmove_size for value in pmove_avgvals]
 
     miny = np.nanmin(_lows)
     maxy = np.nanmax(_highs)
@@ -458,13 +467,18 @@ def plot( data, **kwargs ):
 
     if config['return_calculated_values'] is not None:
         retdict = config['return_calculated_values']
-        if ptype in VALID_PMOVE_TYPES:
-            prekey = ptype
-            retdict[prekey+'_bricks'] = brick_values
-            retdict[prekey+'_dates'] = mdates.num2date(new_dates)
-            retdict[prekey+'_size'] = size
-            if config['volume']:
-                retdict[prekey+'_volumes'] = volumes
+        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):
@@ -480,7 +494,7 @@ def plot( data, **kwargs ):
     # 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(new_dates)])
+        dtix = pd.DatetimeIndex([dt for dt in mdates.num2date(pmove_dates)])
     elif not config['show_nontrading']:
         dtix = data.index
     else: