seolpyo-mplchart 0.1.3.4__py3-none-any.whl → 1.0.0__py3-none-any.whl

seolpyo_mplchart/__init__.py

@@ -1,63 +1,107 @@
-"""
-This software includes Matplotlib, which is licensed under the BSD License.
-Matplotlib Copyright (c) 2012- Matplotlib Development Team.
-Full license can be found in the LICENSE file or at https://matplotlib.org/stable/users/license.html
-"""
-
-
 import json
-from pathlib import Path
 from typing import Literal
+from pathlib import Path
 
 import matplotlib.pyplot as plt
-from matplotlib.figure import Figure
 import pandas as pd
 
-
-from .slider import Chart as CM
+from .draw import Chart as BaseChart
+from .cursor import Chart as BaseCursorChart, format_candleinfo_ko, format_volumeinfo_ko, format_candleinfo_en, format_volumeinfo_en
+from .slider import Chart as BaseSliderChart
 
 
 __all__ = [
-    'pd',
-    'plt',
+    'path_samsung', 'path_apple',
+    'format_candleinfo_ko', 'format_volumeinfo_ko',
+    'format_candleinfo_en', 'format_volumeinfo_en',
+    'sample', 'switch_backend', 'show', 'close',
+    'Chart', 'CursorChart', 'SliderChart',
+]
 
-    'Chart',
 
-    'sample',
-    'show',
-    'close',
-]
+path_samsung = Path(__file__).parent / 'sample/samsung.txt'
+path_apple = Path(__file__).parent / 'sample/apple.txt'
+
+def sample(stock: Literal['samsung', 'apple']='samsung', chart: Literal['Chart', 'CursorChart', 'SliderChart']='SliderChart'):
+    C: BaseSliderChart = {'Chart': BaseChart, 'CursorChart': BaseCursorChart, 'SliderChart': BaseSliderChart}[chart]()
+    path_file = path_samsung if stock == 'samsung' else path_apple
+    if stock == 'samsung':
+        C.format_candleinfo = format_candleinfo_ko
+        C.format_volumeinfo = format_volumeinfo_ko
+    else:
+        C.format_candleinfo = format_candleinfo_en
+        C.format_volumeinfo = format_volumeinfo_en
+        C.unit_price = '$'
+        C.unit_volume = 'Vol'
+        C.digit_price = 3
+        C.format_ma = 'ma{}'
+
+    with open(path_file, 'r', encoding='utf-8') as txt:
+        data = json.load(txt)
+    df = pd.DataFrame(data)
+
+    C.set_data(df)
+
+    show()
+    close()
+    return
+
+
+def switch_backend(newbackend='TkAgg'):
+    "call matplotlib.pyplot.switch_backend(newbackend)"
+    return plt.switch_backend(newbackend)
+
+
+def show(Close=False):
+    """
+    call matplotlib.pyplot.show()
+    ```if Close``` if True, run matplotlib.pyplot.close('all') after window closee.
+    """
+    plt.show()
+    if Close: close()
+    return
+
+
+def close(fig='all'):
+    "call matplotlib.pyplot.close(fig)"
+    return plt.close(fig)
 
 
-class Chart(CM):
+class Chart(BaseChart):
     r"""
     You can see the guidance document:
         Korean: https://white.seolpyo.com/entry/147/
         English: https://white.seolpyo.com/entry/148/
 
-    Variables:
-        unit_price, unit_volume: unit for price and volume. default ('원', '주').
+    Quick Start:
+        ```
+        import seolpyo_mplchart as mc
+        chart = mc.SliderChart() # Create instance
+        chart.set_data(df) # set stock price data
+        mc.show() # show chart(run ```matplotlib.pyplot.show()```)
+        mc.close() # run ```matplotlib.pyplot.close('close')```
+        ```
+
+    Class Variables:
+        watermark: watermark text.
 
-        figsize: figure size if you use plt.show(). default (12, 6).
-        ratio_ax_slider, ratio_ax_legend, ratio_ax_price, ratio_ax_volume: Axes ratio. default (3, 2, 18, 5).
-        adjust: figure adjust. default dict(top=0.95, bottom=0.05, left=0.01, right=0.93, wspace=0, hspace=0).
-        slider_top: ax_slider is located at the top or bottom. default True.
+        figsize: Default size when creating a matplotlib window
+        ratio_ax_legend, ratio_ax_price, ratio_ax_volume: Axes ratio
+        adjust: figure adjust. default ```dict(top=0.95, bottom=0.05, left=0.01, right=0.93, wspace=0, hspace=0)```.
         color_background: color of background. default '#fafafa'.
-        color_grid: color of grid. default '#d0d0d0'.
+        gridKwargs: kwargs applied to the grid
+        color_tick, color_tick_label: Tick and tick label colors. default ('k', 'k').
 
-        df: stock data.
+        df: stock data DataFrame.
         date: date column key. default 'date'
         Open, high, low, close: price column key. default ('open', 'high', 'low', 'close')
-        volume: volume column key. default 'volume'
+        volume: volume column key. default 'volume'. If ```if self.volume``` is ```False```, the volume chart is not drawn.
 
-        label_ma: moving average legend label format. default '{}일선'
+        format_ma: moving average legend label format. default '{}일선'
         list_ma: Decide how many days to draw the moving average line. default (5, 20, 60, 120, 240)
-        list_macolor: Color the moving average line. If the number of colors is greater than the moving average line, black is applied. default ('darkred', 'fuchsia', 'olive', 'orange', 'navy', 'darkmagenta', 'limegreen', 'darkcyan',)
+        list_macolor: Color the moving average line. If the number of colors is greater than the moving average line, black is applied
 
-        candle_on_ma: Decide whether to draw candles on the moving average line. default True
-        color_sliderline: Color of closing price line in ax_slider. default 'k'
-        color_navigatorline: Color of left and right dividing lines in selected area. default '#1e78ff'
-        color_navigator: Color of unselected area. default 'k'
+        candle_on_ma: Decide whether to draw candles on the moving average line. default ```True```
 
         color_up: The color of the candle. When the closing price is greater than the opening price. default '#fe3032'
         color_down: The color of the candle. When the opening price is greater than the opening price. default '#0095ff'
@@ -66,55 +110,162 @@ class Chart(CM):
         color_down_up: The color of the candle. If the opening price is greater than the closing price, but is higher than the closing price of the previous day. default 'w'
         colors_volume: The color of the volume bar. default '#1f77b4'
 
-        lineKwargs: Options applied to horizontal and vertical lines drawn along the mouse position. default dict(edgecolor='k', linewidth=1, linestyle='-')
-        textboxKwargs: Options that apply to the information text box. dufault dict(boxstyle='round', facecolor='w')
+        color_priceline: The color of the price line. default 'k'
+
+        facecolor_volume, edgecolor_volume = The color of the volume. default ('#1f77b4', 'k')
+
+        candle_width_half, volume_width_half: half of the thickness of the candle and volume
+
+        color_box: The color of the candlebox and volumebox. Used when the mouse is over a candle or volume bar. default 'k'
+
+        limit_candle: Maximum number of candles to draw. default 800
+        limit_wick:  Maximum number of candle wicks to draw. default 4,000
+    """
+    pass
+
+
+class CursorChart(BaseCursorChart):
+    r"""
+    You can see the guidance document:
+        Korean: https://white.seolpyo.com/entry/147/
+        English: https://white.seolpyo.com/entry/148/
+
+    Quick Start:
+        ```
+        import seolpyo_mplchart as mc
+        chart = mc.SliderChart() # Create instance
+        chart.set_data(df) # set stock price data
+        mc.show() # show chart(run ```matplotlib.pyplot.show()```)
+        mc.close() # run ```matplotlib.pyplot.close('close')```
+        ```
+
+    Class Variables:
+        watermark: watermark text.
+
+        unit_price, unit_volume: price and volume unit. default ('원', '주').
+        digit_price, digit_volume: display decimal places when displaying price and volume. default (0, 0),
+
+        figsize: Default size when creating a matplotlib window
+        ratio_ax_legend, ratio_ax_price, ratio_ax_volume: Axes ratio
+        adjust: figure adjust. default ```dict(top=0.95, bottom=0.05, left=0.01, right=0.93, wspace=0, hspace=0)```.
+        color_background: color of background. default '#fafafa'.
+        gridKwargs: kwargs applied to the grid
+        color_tick, color_tick_label: Tick and tick label colors. default ('k', 'k').
+
+        df: stock data DataFrame.
+        date: date column key. default 'date'
+        Open, high, low, close: price column key. default ('open', 'high', 'low', 'close')
+        volume: volume column key. default 'volume'. If ```if self.volume``` is ```False```, the volume chart is not drawn.
+
+        format_ma: moving average legend label format. default '{}일선'
+        list_ma: Decide how many days to draw the moving average line. default (5, 20, 60, 120, 240)
+        list_macolor: Color the moving average line. If the number of colors is greater than the moving average line, black is applied
+
+        candle_on_ma: Decide whether to draw candles on the moving average line. default ```True```
+
+        color_up: The color of the candle. When the closing price is greater than the opening price. default '#fe3032'
+        color_down: The color of the candle. When the opening price is greater than the opening price. default '#0095ff'
+        color_flat: The color of the candle. WWhen the closing price is the same as the opening price. default 'k'
+        color_up_down: The color of the candle. If the closing price is greater than the opening price, but is lower than the previous day's closing price. default 'w'
+        color_down_up: The color of the candle. If the opening price is greater than the closing price, but is higher than the closing price of the previous day. default 'w'
+        colors_volume: The color of the volume bar. default '#1f77b4'
+
+        color_priceline: The color of the price line. default 'k'
+
+        facecolor_volume, edgecolor_volume = The color of the volume. default ('#1f77b4', 'k')
+
+        candle_width_half, volume_width_half: half of the thickness of the candle and volume
+
+        color_box: The color of the candlebox and volumebox. Used when the mouse is over a candle or volume bar. default 'k'
+
+        lineKwargs: kwarg applied to lines drawn based on mouse cursor position
+        textboxKwargs: kwarg applied to the info text bbox drawn on the chart. When this is applied, the following occurs: ```textKwargs['bbox'] = textboxKwargs```
+        textKwargs: A kwarg that applies to the informational text drawn on the chart. When this is applied, the following occurs: ```textKwargs['bbox'] = textboxKwargs```
 
         fraction: Decide whether to express information as a fraction. default False
-        candleformat: Candle information text format. default '{dt}\n\n종가:　 {close}\n등락률: {rate}\n대비:　 {compare}\n시가:　 {open}({rate_open})\n고가:　 {high}({rate_high})\n저가:　 {low}({rate_low})\n거래량: {volume}({rate_volume})'
-        volumeformat: Volume information text format. default '{dt}\n\n거래량　　　: {volume}\n거래량증가율: {rate_volume}'
-        digit_price, digit_volume: Number of decimal places expressed in informational text. default (0, 0)
+        format_candleinfo: Candle information text format. default '{dt}\n\n종가:　 {close}\n등락률: {rate}\n대비:　 {compare}\n시가:　 {open}({rate_open})\n고가:　 {high}({rate_high})\n저가:　 {low}({rate_low})\n거래량: {volume}({rate_volume})'
+        format_volumeinfo: Volume information text format. default '{dt}\n\n거래량　　　: {volume}\n거래량증가율: {rate_volume}'
 
-        min_distance: Minimum number of candles that can be selected with the slider. default 30
-        simpler: Decide whether to display candles simply when moving the chart. default False
-        limit_volume: Maximum number of volume bars drawn when moving the chart. default 2_000
+        limit_candle: Maximum number of candles to draw. default 800
+        limit_wick:  Maximum number of candle wicks to draw. default 4,000
     """
     pass
 
 
-_name = {'samsung', 'apple'}
-def sample(name: Literal['samsung', 'apple']='samsung'):
-    if name not in _name:
-        print('name should be either samsung or apple.')
-        return
-    file = Path(__file__).parent / f'data/{name}.txt'
-    with open(file, 'r', encoding='utf-8') as txt:
-        data = json.load(txt)
-    data = data
-    df = pd.DataFrame(data)
+class SliderChart(BaseSliderChart):
+    r"""
+    You can see the guidance document:
+        Korean: https://white.seolpyo.com/entry/147/
+        English: https://white.seolpyo.com/entry/148/
 
-    c = Chart()
-    if name == 'apple':
-        c.unit_price = '$'
-        c.unit_volume = ' vol'
-        c.digit_price = 3
-        c.label_ma = 'ma{}'
-        c.candleformat = '{}\n\nend:     {}\nrate:    {}\ncompare: {}\nopen:    {}({})\nhigh:    {}({})\nlow:     {}({})\nvolume:  {}({})'
-        c.volumeformat = '{}\n\nvolume:      {}\nvolume rate: {}'
-    c.set_data(df)
-    show()
-    close()
-    return
+    Quick Start:
+        ```
+        import seolpyo_mplchart as mc
+        chart = mc.SliderChart() # Create instance
+        chart.set_data(df) # set stock price data
+        mc.show() # show chart(run ```matplotlib.pyplot.show()```)
+        mc.close() # run ```matplotlib.pyplot.close('close')```
+        ```
 
+    Class Variables:
+        watermark: watermark text.
 
-def show():
-    return plt.show()
+        unit_price, unit_volume: price and volume unit. default ('원', '주').
+        digit_price, digit_volume: display decimal places when displaying price and volume. default (0, 0),
 
+        figsize: Default size when creating a matplotlib window
+        slider_top: ax_slider is located at the top or bottom. default ```True```.
+        ratio_ax_slider, ratio_ax_legend, ratio_ax_price, ratio_ax_volume: Axes ratio
+        ratio_ax_none: Ratio between volume chart and slider. Used only when slider_top is ```False```
+        adjust: figure adjust. default ```dict(top=0.95, bottom=0.05, left=0.01, right=0.93, wspace=0, hspace=0)```.
+        color_background: color of background. default '#fafafa'.
+        gridKwargs: kwargs applied to the grid
+        color_tick, color_tick_label: Tick and tick label colors. default ('k', 'k').
 
-def close(fig: int|str|Figure|None='all'):
-    return plt.close(fig)
+        df: stock data DataFrame.
+        date: date column key. default 'date'
+        Open, high, low, close: price column key. default ('open', 'high', 'low', 'close')
+        volume: volume column key. default 'volume'. If ```if self.volume``` is ```False```, the volume chart is not drawn.
+
+        format_ma: moving average legend label format. default '{}일선'
+        list_ma: Decide how many days to draw the moving average line. default (5, 20, 60, 120, 240)
+        list_macolor: Color the moving average line. If the number of colors is greater than the moving average line, black is applied
+
+        candle_on_ma: Decide whether to draw candles on the moving average line. default ```True```
+        color_sliderline: Color of closing price line in ax_slider. default 'k'
+        color_navigatorline: Color of left and right dividing lines in selected area. default '#1e78ff'
+        color_navigator: Color of unselected area. default 'k'
+
+        color_up: The color of the candle. When the closing price is greater than the opening price. default '#fe3032'
+        color_down: The color of the candle. When the opening price is greater than the opening price. default '#0095ff'
+        color_flat: The color of the candle. WWhen the closing price is the same as the opening price. default 'k'
+        color_up_down: The color of the candle. If the closing price is greater than the opening price, but is lower than the previous day's closing price. default 'w'
+        color_down_up: The color of the candle. If the opening price is greater than the closing price, but is higher than the closing price of the previous day. default 'w'
+        colors_volume: The color of the volume bar. default '#1f77b4'
+
+        color_priceline: The color of the price line. default 'k'
 
+        facecolor_volume, edgecolor_volume = The color of the volume. default ('#1f77b4', 'k')
 
-if __name__ == '__main__':
-    sample('apple')
+        candle_width_half, volume_width_half: half of the thickness of the candle and volume
 
+        color_box: The color of the candlebox and volumebox. Used when the mouse is over a candle or volume bar. default 'k'
 
+        lineKwargs: kwarg applied to lines drawn based on mouse cursor position
+        textboxKwargs: kwarg applied to the info text bbox drawn on the chart. When this is applied, the following occurs: ```textKwargs['bbox'] = textboxKwargs```
+        textKwargs: A kwarg that applies to the informational text drawn on the chart. When this is applied, the following occurs: ```textKwargs['bbox'] = textboxKwargs```
+
+        fraction: Decide whether to express information as a fraction. default False
+        format_candleinfo: Candle information text format. default '{dt}\n\n종가:　 {close}\n등락률: {rate}\n대비:　 {compare}\n시가:　 {open}({rate_open})\n고가:　 {high}({rate_high})\n저가:　 {low}({rate_low})\n거래량: {volume}({rate_volume})'
+        format_volumeinfo: Volume information text format. default '{dt}\n\n거래량　　　: {volume}\n거래량증가율: {rate_volume}'
+
+        min_distance: Minimum number of candles that can be selected with the slider. default 30
+        limit_candle: Maximum number of candles to draw. default 800
+        limit_wick:  Maximum number of candle wicks to draw. default 4,000
+        limit_volume: Maximum number of volume bars to draw. default 800. Applies only to drawing candle wicks or price line.
+        limit_ma: If the number of displayed data is more than this, the price moving average line is not drawn. default 8,000
+
+        color_navigator_line: Navigator divider color. default '#1e78ff'
+        color_navigator_cover: Unselected slider area color. default = 'k'
+    """
+    pass

seolpyo_mplchart/base.py

@@ -1,10 +1,13 @@
+from re import search
+
 import matplotlib.pyplot as plt
 import matplotlib.style as mplstyle
 from matplotlib.axes import Axes
 from matplotlib.backends.backend_agg import FigureCanvasAgg
+from matplotlib.figure import Figure as Fig
 
 
-from .utils import convert_unit
+from .utils import dict_unit, dict_unit_en
 
 
 try: plt.switch_backend('TkAgg')
@@ -17,95 +20,95 @@ except: pass
 mplstyle.use('fast')
 
 
-class Base:
+def convert_unit(value: float, digit=0, word='원'):
+    v = value.__abs__()
+    du = dict_unit if search('[가-힣]', word) else dict_unit_en
+    for unit, n in du.items():
+        if n <= v:
+            num = (value / n).__round__(digit)
+            if not num % 1: num = int(num)
+            return f'{num:,}{unit} {word}'
+    value = value.__round__(digit)
+    if not value % 1: value = int(value)
+    elif value < 10: digit = 2
+    text = f'{value:,}{word}'
+    return text
+
+
+class Figure(Fig):
     canvas: FigureCanvasAgg
-    unit_price, unit_volume = ('원', '주')
 
-    figsize = (12, 6)
-    ratio_ax_slider, ratio_ax_legend, ratio_ax_price, ratio_ax_volume = (3, 2, 18, 5)
+
+class Base:
+    figure: Figure
+
+    figsize = (14, 7)
+    ratio_ax_legend, ratio_ax_price, ratio_ax_volume = (2, 18, 5)
     adjust = dict(
         top=0.95, bottom=0.05, left=0.01, right=0.93, # 여백
         wspace=0, hspace=0  # 플롯간 간격
     )
-    color_grid = '#d0d0d0'
-    color_background = '#fafafa'
 
-    slider_top = True
     title = 'seolpyo mplchart'
+    color_background = '#fafafa'
+    gridKwargs = {}
+    color_tick, color_tick_label = ('k', 'k')
+
+    unit_price, unit_volume = ('원', '주')
 
     def __init__(self, *args, **kwargs):
         # 기본 툴바 비활성화
         plt.rcParams['toolbar'] = 'None'
+        # plt.rcParams['figure.dpi'] = 600
 
-        self._set_plot()
+        self._get_plot()
         return
 
-    def _set_plot(self):
-        if self.slider_top:
-            fig, ax = plt.subplots(
-                4, # row 수
-                figsize=self.figsize, # 기본 크기
-                height_ratios=(self.ratio_ax_slider, self.ratio_ax_legend, self.ratio_ax_price, self.ratio_ax_volume) # row 크기 비율
-            )
-            ax: list[Axes]
-            ax_slider, ax_legend, ax_price, ax_volume = ax
-        else:
-            fig, ax = plt.subplots(
-                5, # row 수
-                figsize=self.figsize, # 기본 크기
-                height_ratios=(self.ratio_ax_legend, self.ratio_ax_price, self.ratio_ax_volume, self.ratio_ax_legend, self.ratio_ax_slider) # row 크기 비율
-            )
-            ax: list[Axes]
-            ax_legend, ax_price, ax_volume, ax_none, ax_slider = ax
-            # 사용하지 않는 axes 숨기기
-            ax_none.axis('off')
-        ax_legend.axis('off')
-
-        ax_slider.xaxis.set_animated(True)
-        ax_slider.yaxis.set_animated(True)
-
-        ax_price.xaxis.set_animated(True)
-        ax_price.yaxis.set_animated(True)
-
-        ax_volume.xaxis.set_animated(True)
-        ax_volume.yaxis.set_animated(True)
-
-        fig.canvas.manager.set_window_title(f'{self.title}')
+    def _get_plot(self):
+        self.figure, axes = plt.subplots(
+            3, # row 수
+            figsize=self.figsize, # 기본 크기
+            height_ratios=(self.ratio_ax_legend, self.ratio_ax_price, self.ratio_ax_volume) # row 크기 비율
+        )
+        axes: list[Axes]
+        self.ax_legend, self.ax_price, self.ax_volume = axes
+        self.ax_legend.set_label('legend ax')
+        self.ax_price.set_label('price ax')
+        self.ax_volume.set_label('volume ax')
+
+        self.figure.canvas.manager.set_window_title(f'{self.title}')
+        self.figure.set_facecolor(self.color_background)
 
         # 플롯간 간격 제거(Configure subplots)
-        fig.subplots_adjust(**self.adjust)
+        self.figure.subplots_adjust(**self.adjust)
+
+        self.ax_legend.set_axis_off()
 
         # y ticklabel foramt 설정
-        ax_slider.yaxis.set_major_formatter(lambda x, _: convert_unit(x, word=self.unit_price))
-        ax_price.yaxis.set_major_formatter(lambda x, _: convert_unit(x, word=self.unit_price))
-        ax_volume.yaxis.set_major_formatter(lambda x, _: convert_unit(x, word=self.unit_volume))
+        self.ax_price.yaxis.set_major_formatter(lambda x, _: convert_unit(x, word=self.unit_price, digit=2))
+        self.ax_volume.yaxis.set_major_formatter(lambda x, _: convert_unit(x, word=self.unit_volume, digit=2))
 
+        gridKwargs = {'visible': True, 'linewidth': 1, 'color': '#d0d0d0', 'linestyle': '--'}
+        gridKwargs.update(self.gridKwargs)
         # 공통 설정
-        for a in [ax_slider, ax_price, ax_volume]:
+        for ax in (self.ax_price, self.ax_volume):
+            ax.xaxis.set_animated(True)
+            ax.yaxis.set_animated(True)
+
+            # x tick 외부 눈금 표시하지 않기
+            ax.xaxis.set_ticks_position('none')
+            # x tick label 제거
+            ax.set_xticklabels([])
             # y tick 우측으로 이동
-            a.tick_params(left=False, right=True, labelleft=False, labelright=True)
-            # 차트 영역 배경 색상
-            a.set_facecolor(self.color_background)
-            # grid(구분선, 격자) 그리기
-            a.grid(True, color=self.color_grid, linewidth=1)
-            # x tick 제거
-            a.set_xticklabels([])
-
-        self.fig, self.canvas = (fig, fig.canvas)
-        self.ax_slider, self.ax_legend, self.ax_price, self.ax_volume = (ax_slider, ax_legend, ax_price, ax_volume)
+            ax.tick_params(left=False, right=True, labelleft=False, labelright=True, colors=self.color_tick_label)
+            # Axes 외곽선 색 변경
+            for i in ['top', 'bottom', 'left', 'right']: ax.spines[i].set_color(self.color_tick)
 
-        return self.set_plot()
+            # 차트 영역 배경 색상
+            ax.set_facecolor(self.color_background)
 
-    def set_plot(self):
-        "This function works after set plot process is done."
+            # grid(구분선, 격자) 그리기
+            # 어째서인지 grid의 zorder 값을 선언해도 1.6을 값으로 한다.
+            ax.grid(**gridKwargs)
         return
 
-
-class Chart(Base):
-    pass
-
-
-if __name__ == '__main__':
-    Base()
-    
-    plt.show()