Merge pull request #65 from DanielGoldfarb/master

Return Figure and Axes (plus some minor changes)

Author: DanielGoldfarb

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,7 +1,7 @@
 ---
 name: Feature request
 about: Suggest an idea for this project
-title: 'Feature Reuest:'
+title: 'Feature Request:'
 labels: 'enhancement'
 assignees: ''
 

src/mplfinance/plotting.py

@@ -125,6 +125,9 @@ def _valid_plot_kwargs():
         'block'       : { 'Default'     : True, 
                           'Validator'   : lambda value: isinstance(value,bool) },
 
+        'returnfig'   : { 'Default'     : False, 
+                          'Validator'   : lambda value: isinstance(value,bool) },
+ 
     }
 
     _validate_vkwargs_dict(vkwargs)
@@ -476,22 +479,29 @@ def plot( data, **kwargs ):
     if not used_ax4 and ax4 is not None:
         ax4.get_yaxis().set_visible(False)
 
+    if config['returnfig']:
+        axlist = [ax1, ax3]
+        if ax2: axlist.append(ax2)
+        if ax4: axlist.append(ax4)
+
     if config['savefig'] is not None:
         save = config['savefig']
         if isinstance(save,dict):
             plt.savefig(**save)
         else:
             plt.savefig(save)
-    else:
+    elif not config['returnfig']:
         # https://stackoverflow.com/a/13361748/1639359 suggests plt.show(block=False)
         plt.show(block=config['block'])
+    
+    if config['returnfig']:
+        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 _valid_addplot_kwargs():

tests/original_flavor/test_date_demo1.py

@@ -31,7 +31,7 @@ def test_date_demo1():
     infile = os.path.join('examples','data','yahoofinance-INTC-19950101-20040412.csv')
     quotes = pd.read_csv(infile,index_col=0,parse_dates=True,infer_datetime_format=True)
 
-    dates = quotes.index
+    dates = quotes.index.values
     opens = quotes['Open']
 
     fig, ax = plt.subplots()

tests/original_flavor/test_date_demo2.py

@@ -35,7 +35,7 @@ def test_date_demo2():
     # select desired range of dates
     quotes = quotes[(quotes.index >= date1) & (quotes.index <= date2)]
 
-    dates = quotes.index
+    dates = quotes.index.values
     opens = quotes['Open']
 
 

tests/original_flavor/test_finance_work2.py

@@ -109,12 +109,12 @@ def moving_average_convergence(x, nslow=26, nfast=12):
     rsi = relative_strength(prices)
     fillcolor = 'darkgoldenrod'
 
-    ax1.plot(r.index, rsi, color=fillcolor)
+    ax1.plot(r.index.values, rsi, color=fillcolor)
     ax1.axhline(70, color=fillcolor)
     ax1.axhline(30, color=fillcolor)
-    ax1.fill_between(r.index, rsi, 70, where=(rsi >= 70),
+    ax1.fill_between(r.index.values, rsi, 70, where=(rsi >= 70),
                      facecolor=fillcolor, edgecolor=fillcolor)
-    ax1.fill_between(r.index, rsi, 30, where=(rsi <= 30),
+    ax1.fill_between(r.index.values, rsi, 30, where=(rsi <= 30),
                      facecolor=fillcolor, edgecolor=fillcolor)
     ax1.text(0.6, 0.9, '>70 = overbought', va='top',
              transform=ax1.transAxes, fontsize=textsize)
@@ -140,8 +140,8 @@ def moving_average_convergence(x, nslow=26, nfast=12):
     ma20 = moving_average(prices, 20, type='simple')
     ma200 = moving_average(prices, 200, type='simple')
 
-    linema20, = ax2.plot(r.index, ma20, color='blue', lw=2, label='MA (20)')
-    linema200, = ax2.plot(r.index, ma200, color='red', lw=2, label='MA (200)')
+    linema20, = ax2.plot(r.index.values, ma20, color='blue', lw=2, label='MA (20)')
+    linema200, = ax2.plot(r.index.values, ma200, color='red', lw=2, label='MA (200)')
 
     last = r.tail(1)
     s = '%s O:%1.2f H:%1.2f L:%1.2f C:%1.2f, V:%1.1fM Chg:%+1.2f' % (
@@ -173,8 +173,8 @@ def moving_average_convergence(x, nslow=26, nfast=12):
     emaslow, emafast, macd = moving_average_convergence(
         prices, nslow=nslow, nfast=nfast)
     ema9 = moving_average(macd, nema, type='exponential')
-    ax3.plot(r.index, macd, color='black', lw=2)
-    ax3.plot(r.index, ema9, color='blue', lw=1)
+    ax3.plot(r.index.values, macd, color='black', lw=2)
+    ax3.plot(r.index.values, ema9, color='blue', lw=1)
     ax3.fill_between(r.index, macd - ema9, 0, alpha=0.5,
                      facecolor=fillcolor, edgecolor=fillcolor)
 

tests/original_flavor/test_longshort.py

@@ -54,7 +54,7 @@ def test_longshort():
 
     # plot the return
     fig, ax = plt.subplots()
-    ax.plot(r.index, tr)
+    ax.plot(r.index.values, tr)
     ax.set_title('total return: long APPL, short GOOG')
     ax.grid()
     fig.autofmt_xdate()