Merge pull request #1920 from tacaswell/ochl_to_ohlc

dmcdougall · dmcdougall · commit 17216bba038d · 2013-08-17T14:40:43.000-07:00
finance ochl-&gt;ohlc
diff --git a/doc/api/api_changes.rst b/doc/api/api_changes.rst
@@ -48,8 +48,16 @@ original location:
   - mstream -> `from matplotlib import stream as mstream`
   - mtable -> `from matplotlib import table as mtable`
 
+
+* In :module:`~matplotlib.finance`, almost all functions have been deprecated and
+  replaced with a pair of functions name `*_ochl` and `*_ohlc`.  The former is
+  'open-close-high-low' order of quotes, and what the module used and the later
+  is 'open-high-low-close' order of quotes, which is the standard in finance.
+
+
 .. _changes_in_1_3:
 
+
 Changes in 1.3.x
 ================
 
diff --git a/doc/api/finance_api.rst b/doc/api/finance_api.rst
@@ -0,0 +1,12 @@
+*******
+finance
+*******
+
+
+:mod:`matplotlib.finance`
+=========================
+
+.. automodule:: matplotlib.finance
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/doc/api/index.rst b/doc/api/index.rst
@@ -28,6 +28,7 @@
    colors_api.rst
    dates_api.rst
    figure_api.rst
+   finance_api.rst
    font_manager_api.rst
    gridspec_api.rst
    legend_api.rst
diff --git a/examples/pylab_examples/date_demo1.py b/examples/pylab_examples/date_demo1.py
@@ -15,17 +15,17 @@
 """
 
 import matplotlib.pyplot as plt
-from matplotlib.finance import quotes_historical_yahoo
+from matplotlib.finance import quotes_historical_yahoo_ochl
 from matplotlib.dates import YearLocator, MonthLocator, DateFormatter
 import datetime
-date1 = datetime.date( 1995, 1, 1 )
-date2 = datetime.date( 2004, 4, 12 )
+date1 = datetime.date(1995, 1, 1)
+date2 = datetime.date(2004, 4, 12)
 
-years    = YearLocator()   # every year
-months   = MonthLocator()  # every month
+years = YearLocator()   # every year
+months = MonthLocator()  # every month
 yearsFmt = DateFormatter('%Y')
 
-quotes = quotes_historical_yahoo(
+quotes = quotes_historical_yahoo_ochl(
     'INTC', date1, date2)
 if len(quotes) == 0:
     raise SystemExit
diff --git a/examples/pylab_examples/date_demo2.py b/examples/pylab_examples/date_demo2.py
@@ -9,22 +9,22 @@
 import datetime
 import matplotlib.pyplot as plt
 from matplotlib.dates import MONDAY
-from matplotlib.finance import quotes_historical_yahoo
+from matplotlib.finance import quotes_historical_yahoo_ochl
 from matplotlib.dates import MonthLocator, WeekdayLocator, DateFormatter
 
 
-date1 = datetime.date( 2002, 1, 5 )
-date2 = datetime.date( 2003, 12, 1 )
+date1 = datetime.date(2002, 1, 5)
+date2 = datetime.date(2003, 12, 1)
 
 # every monday
-mondays   = WeekdayLocator(MONDAY)
+mondays = WeekdayLocator(MONDAY)
 
 # every 3rd month
-months    = MonthLocator(range(1,13), bymonthday=1, interval=3)
+months = MonthLocator(range(1, 13), bymonthday=1, interval=3)
 monthsFmt = DateFormatter("%b '%y")
 
 
-quotes = quotes_historical_yahoo('INTC', date1, date2)
+quotes = quotes_historical_yahoo_ochl('INTC', date1, date2)
 if len(quotes) == 0:
     print ('Found no quotes')
     raise SystemExit
diff --git a/examples/pylab_examples/finance_demo.py b/examples/pylab_examples/finance_demo.py
@@ -1,21 +1,21 @@
 #!/usr/bin/env python
 import matplotlib.pyplot as plt
-from matplotlib.dates import  DateFormatter, WeekdayLocator, HourLocator, \
+from matplotlib.dates import DateFormatter, WeekdayLocator,\
      DayLocator, MONDAY
-from matplotlib.finance import quotes_historical_yahoo, candlestick,\
-     plot_day_summary, candlestick2
+from matplotlib.finance import quotes_historical_yahoo_ohlc, candlestick_ohlc
+
 
 # (Year, month, day) tuples suffice as args for quotes_historical_yahoo
-date1 = ( 2004, 2, 1)
-date2 = ( 2004, 4, 12 )
+date1 = (2004, 2, 1)
+date2 = (2004, 4, 12)
 
 
 mondays = WeekdayLocator(MONDAY)        # major ticks on the mondays
-alldays    = DayLocator()              # minor ticks on the days
+alldays = DayLocator()              # minor ticks on the days
 weekFormatter = DateFormatter('%b %d')  # e.g., Jan 12
 dayFormatter = DateFormatter('%d')      # e.g., 12
 
-quotes = quotes_historical_yahoo('INTC', date1, date2)
+quotes = quotes_historical_yahoo_ohlc('INTC', date1, date2)
 if len(quotes) == 0:
     raise SystemExit
 
@@ -27,11 +27,10 @@
 #ax.xaxis.set_minor_formatter(dayFormatter)
 
 #plot_day_summary(ax, quotes, ticksize=3)
-candlestick(ax, quotes, width=0.6)
+candlestick_ohlc(ax, quotes, width=0.6)
 
 ax.xaxis_date()
 ax.autoscale_view()
-plt.setp( plt.gca().get_xticklabels(), rotation=45, horizontalalignment='right')
+plt.setp(plt.gca().get_xticklabels(), rotation=45, horizontalalignment='right')
 
 plt.show()
-
diff --git a/lib/matplotlib/finance.py b/lib/matplotlib/finance.py
