seolpyo-mplchart 0.1.3.1__py3-none-any.whl → 2.0.0.3__py3-none-any.whl

seolpyo_mplchart/__init__.py

@@ -1,120 +1,185 @@
-"""
-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
-
-
-__all__ = [
-    'pd',
-    'plt',
-
-    'Chart',
-
-    'sample',
-    'show',
-    'close',
-]
-
-
-class Chart(CM):
-    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 ('원', '주').
-
-        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.
-        color_background: color of background. default '#fafafa'.
-        color_grid: color of grid. default '#d0d0d0'.
-
-        df: stock data.
-        date: date column key. default 'date'
-        Open, high, low, close: price column key. default ('open', 'high', 'low', 'close')
-        volume: volume column key. default 'volume'
-
-        label_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',)
-
-        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'
-
-        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')
-
-        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)
-
-        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
-    """
-    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:
+from ._chart import OnlyChart, CursorChart, SliderChart
+from ._config import DEFAULTCONFIG, DEFAULTCONFIG_EN, SLIDERCONFIG, SLIDERCONFIG_EN, ConfigData, SliderConfigData
+
+
+# __all__ = [
+#     'path_samsung', 'path_apple',
+#     'format_candleinfo_ko', 'format_volumeinfo_ko',
+#     'format_candleinfo_en', 'format_volumeinfo_en',
+#     'sample', 'switch_backend', 'show', 'close',
+#     'OnlyChart', 'CursorChart', 'SliderChart',
+#     'set_theme',
+# ]
+
+
+pkg_name = 'seolpyo_mplchart'
+path_pkg = Path(__file__)
+while path_pkg.name != pkg_name:
+    path_pkg = path_pkg.parent
+path_samsung = path_pkg / 'sample' / 'samsung.txt'
+path_apple = path_pkg / 'sample' / 'apple.txt'
+
+def sample(stock: Literal['samsung', 'apple']='samsung', chart: Literal['Chart', 'CursorChart', 'SliderChart']='SliderChart'):
+    d = {
+        'Chart': OnlyChart,
+        'CursorChart': CursorChart,
+        'SliderChart': SliderChart,
+    }
+    C = d[chart]
+    path_file = path_samsung if stock == 'samsung' else path_apple
+    if stock == 'samsung':
+        if chart == 'SliderChart':
+            config = SLIDERCONFIG
+        else:
+            config = DEFAULTCONFIG
+    else:
+        if chart == 'SliderChart':
+            config = SLIDERCONFIG_EN
+        else:
+            config = DEFAULTCONFIG_EN
+
+    CHART: SliderChart = C(config)
+
+    with open(path_file, 'r', encoding='utf-8') as txt:
         data = json.load(txt)
-    data = data
     df = pd.DataFrame(data)
 
-    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)
+    CHART.set_data(df)
+
     show()
     close()
     return
 
 
-def show():
-    return plt.show()
+def switch_backend(newbackend='TkAgg'):
+    "call matplotlib.pyplot.switch_backend(newbackend)"
+    return plt.switch_backend(newbackend)
 
 
-def close(fig: int|str|Figure|None='all'):
+def close(fig='all'):
+    "call matplotlib.pyplot.close(fig)"
     return plt.close(fig)
 
+def show(Close=True):
+    """
+    call matplotlib.pyplot.show()
+    ```if Close``` if True, run matplotlib.pyplot.close('all') after window closee.
+    """
+    plt.show()
+    if Close:
+        close()
+    return
 
-if __name__ == '__main__':
-    sample('apple')
 
+def set_theme(config: ConfigData|SliderConfigData, theme: Literal['light', 'dark']='dark'):
+    if theme == 'light':
+        # axes
+        config.FIGURE.facecolor = '#fafafa'
+        config.AX.facecolor = '#fafafa'
+        config.AX.TICK.edgecolor = 'k'
+        config.AX.TICK.fontcolor = 'k'
+        config.AX.GRID.color = '#d0d0d0'
+
+        # candle
+        config.CANDLE.line_color = 'k'
+        config.CANDLE.FACECOLOR.bull_rise = '#FF2400'
+        config.CANDLE.FACECOLOR.bull_fall = 'w'
+        config.CANDLE.FACECOLOR.bear_fall = '#1E90FF'
+        config.CANDLE.FACECOLOR.bear_rise = 'w'
+
+        config.CANDLE.EDGECOLOR.bull_rise = '#FF2400'
+        config.CANDLE.EDGECOLOR.bull_fall = '#FF2400'
+        config.CANDLE.EDGECOLOR.bear_fall = '#1E90FF'
+        config.CANDLE.EDGECOLOR.bear_rise = '#1E90FF'
+        config.CANDLE.EDGECOLOR.doji = 'k'
+
+        # volume
+        config.VOLUME.FACECOLOR.rise = '#F27663'
+        config.VOLUME.FACECOLOR.fall = '#70B5F2'
+        config.VOLUME.FACECOLOR.doji = '#BEBEBE'
+
+        config.VOLUME.EDGECOLOR.rise = '#F27663'
+        config.VOLUME.EDGECOLOR.fall = '#70B5F2'
+        config.VOLUME.EDGECOLOR.doji = '#BEBEBE'
+
+        # ma
+        config.MA.color_default = 'k'
+        config.MA.color_list = ['#8B00FF', '#008000', '#A0522D', '#008B8B', '#FF0080']
+        # text
+        config.CURSOR.TEXT.BBOX.facecolor = 'w'
+        config.CURSOR.TEXT.BBOX.edgecolor = 'k'
+        config.CURSOR.TEXT.color = 'k'
+
+        # box
+        config.CURSOR.BOX.edgecolor = 'k'
+
+        # line
+        config.CURSOR.CROSSLINE.edgecolor = 'k'
+
+        # wartermark
+        config.FIGURE.WATERMARK.color = 'k'
+
+        if getattr(config, 'SLIDER', None):
+            config.SLIDER.NAVIGATOR.edgecolor = '#2962FF'
+            config.SLIDER.NAVIGATOR.facecolor = '#0000002E'
+    elif theme == 'dark':
+        # axes
+        config.FIGURE.facecolor = '#0f0f0f'
+        config.AX.facecolor = '#0f0f0f'
+        config.AX.TICK.edgecolor = '#dbdbdb'
+        config.AX.TICK.fontcolor = '#dbdbdb'
+        config.AX.GRID.color = '#1c1c1c'
+
+        # candle
+        config.CANDLE.line_color = 'w'
+        config.CANDLE.FACECOLOR.bull_rise = '#089981'
+        config.CANDLE.FACECOLOR.bull_fall = '#0f0f0f'
+        config.CANDLE.FACECOLOR.bear_fall = '#f23645'
+        config.CANDLE.FACECOLOR.bear_rise = '#0f0f0f'
+
+        config.CANDLE.EDGECOLOR.bull_rise = '#089981'
+        config.CANDLE.EDGECOLOR.bull_fall = '#089981'
+        config.CANDLE.EDGECOLOR.bear_fall = '#f23645'
+        config.CANDLE.EDGECOLOR.bear_rise = '#f23645'
+        config.CANDLE.EDGECOLOR.doji = 'w'
+
+        # volume
+        config.VOLUME.FACECOLOR.rise = '#2A8076'
+        config.VOLUME.FACECOLOR.fall = '#BE4F58'
+        config.VOLUME.FACECOLOR.doji = '#82828A'
+
+        config.VOLUME.EDGECOLOR.rise = '#2A8076'
+        config.VOLUME.EDGECOLOR.fall = '#BE4F58'
+        config.VOLUME.EDGECOLOR.doji = '#82828A'
+
+        # ma
+        config.MA.color_default = 'w'
+        config.MA.color_list = ['#FFB300', '#03A9F4', '#AB47BC', '#8BC34A', '#EF5350']
+
+        # text
+        config.CURSOR.TEXT.BBOX.facecolor = '#3d3d3d'
+        config.CURSOR.TEXT.BBOX.edgecolor = '#ffffff'
+        config.CURSOR.TEXT.color = '#ffffff'
+
+        # box
+        config.CURSOR.BOX.edgecolor = 'w'
+
+        # line
+        config.CURSOR.CROSSLINE.edgecolor = '#9c9c9c'
+
+        # wartermark
+        config.FIGURE.WATERMARK.color = 'w'
+
+        if getattr(config, 'SLIDER', None):
+            config.SLIDER.NAVIGATOR.edgecolor = "#00A6FF"
+            config.SLIDER.NAVIGATOR.facecolor = '#FFFFFF4D'
+
+    return config
 

seolpyo_mplchart/_base.py

@@ -0,0 +1,117 @@
+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 dict_unit, dict_unit_en
+
+
+try: plt.switch_backend('TkAgg')
+except: pass
+
+# 한글 깨짐 문제 방지
+try: plt.rcParams['font.family'] ='Malgun Gothic'
+except: pass
+
+mplstyle.use('fast')
+
+
+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
+
+
+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  # 플롯간 간격
+    )
+
+    title = 'seolpyo mplchart'
+    color_background = '#fafafa'
+    gridKwargs = {}
+    color_tick, color_tick_label = ('k', 'k')
+
+    unit_price, unit_volume = ('원', '주')
+
+    def draw_canvas(self): return self.figure.canvas.draw()
+    def blit_canvas(self): return self.figure.canvas.blit()
+
+    def __init__(self, *args, **kwargs):
+        # 기본 툴바 비활성화
+        plt.rcParams['toolbar'] = 'None'
+        # plt.rcParams['figure.dpi'] = 600
+
+        self._get_plot()
+        return
+
+    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)
+        self.figure.subplots_adjust(**self.adjust)
+
+        self.ax_legend.set_axis_off()
+
+        # y ticklabel foramt 설정
+        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': 0.7, 'color': '#d0d0d0', 'linestyle': '-', 'dashes': (1, 0)}
+        gridKwargs.update(self.gridKwargs)
+        # 공통 설정
+        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 우측으로 이동
+            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)
+
+            # 차트 영역 배경 색상
+            ax.set_facecolor(self.color_background)
+
+            # grid(구분선, 격자) 그리기
+            # 어째서인지 grid의 zorder 값을 선언해도 1.6을 값으로 한다.
+            ax.grid(**gridKwargs)
+        return
+

seolpyo_mplchart/_chart/__init__.py

@@ -0,0 +1,137 @@
+from ._draw import Chart as _OC
+from ._cursor import Chart as _CC
+from ._slider import Chart as _SC
+
+
+
+class OnlyChart(_OC):
+    r"""
+    You can see the guidance document:
+        Korean: https://white.seolpyo.com/entry/147/?from=package
+        English: https://github.com/white-seolpyo/seolpyo-mplchart/blob/main/README.md
+
+    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.
+
+        df: stock data DataFrame.
+        key_date: date column key. default 'date'
+        key_open, key_high, key_low, key_close: price column key. default ('open', 'high', 'low', 'close')
+        key_volume: volume column key. default 'volume'. If ```if config.VOLUME.EDGECOLOR.volume``` is ```False```, the volume chart is not drawn.
+
+        cnadle_on_ma: if True: draw candle above ma. else: draw candle below ma lines.
+        limit_candle: If (`the number of candles to draw < limit_candle or not limit_candle`): draw candles, else: draw wicks.
+        limit_wick: If (`the number of candles to draw < limit_wick or not limit_wick`): draw wicks, else: draw line.
+        limit_volume: If (`the number of candles to draw < limit_volume or not limit_volume`): draw volumebar, else: draw wicks.
+        limit_ma: If (`the number of candles to draw < limit_ma or not limit_ma`): draw ma lines, else: don't draw ma lines.
+        fraction: if True and number has a fractional part, display it as a fraction.
+    """
+    key_date = 'date'
+    key_open, key_high, key_low, key_close = ('open', 'high', 'low', 'close')
+    key_volume = 'volume'
+
+    candle_on_ma = True
+    limit_candle = 400
+    limit_wick = 2_000
+    limit_volume = 200
+    limit_ma = None
+    watermark = 'seolpyo mplchart'
+
+
+class CursorChart(_CC):
+    r"""
+    You can see the guidance document:
+        Korean: https://white.seolpyo.com/entry/147/?from=package
+        English: https://github.com/white-seolpyo/seolpyo-mplchart/blob/main/README.md
+
+    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 
+
+        df: stock data DataFrame.
+        key_date: date column key. default 'date'
+        key_open, key_high, key_low, key_close: price column key. default ('open', 'high', 'low', 'close')
+        key_volume: volume column key. default 'volume'. If ```if config.VOLUME.EDGECOLOR.volume``` is ```False```, the volume chart is not drawn.
+
+        cnadle_on_ma: if True: draw candle above ma. else: draw candle below ma lines.
+        limit_candle: If (`the number of candles to draw < limit_candle or not limit_candle`): draw candles, else: draw wicks.
+        limit_wick: If (`the number of candles to draw < limit_wick or not limit_wick`): draw wicks, else: draw line.
+        limit_volume: If (`the number of candles to draw < limit_volume or not limit_volume`): draw volumebar, else: draw wicks.
+        limit_ma: If (`the number of candles to draw < limit_ma or not limit_ma`): draw ma lines, else: don't draw ma lines.
+        fraction: if True and number has a fractional part, display it as a fraction.
+    """
+    key_date = 'date'
+    key_open, key_high, key_low, key_close = ('open', 'high', 'low', 'close')
+    key_volume = 'volume'
+
+    candle_on_ma = True
+    limit_candle = 400
+    limit_wick = 2_000
+    limit_volume = 200
+    limit_ma = None
+    watermark = 'seolpyo mplchart'
+    fraction = False
+
+
+class SliderChart(_SC):
+    r"""
+    You can see the guidance document:
+        Korean: https://white.seolpyo.com/entry/147/?from=package
+        English: https://github.com/white-seolpyo/seolpyo-mplchart/blob/main/README.md
+
+    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.
+
+        df: stock data DataFrame.
+        key_date: date column key. default 'date'
+        key_open, key_high, key_low, key_close: price column key. default ('open', 'high', 'low', 'close')
+        key_volume: volume column key. default 'volume'. If ```if config.VOLUME.EDGECOLOR.volume``` is ```False```, the volume chart is not drawn.
+
+        cnadle_on_ma: if True: draw candle above ma. else: draw candle below ma lines.
+        limit_candle: If (`the number of candles to draw < limit_candle or not limit_candle`): draw candles, else: draw wicks.
+        limit_wick: If (`the number of candles to draw < limit_wick or not limit_wick`): draw wicks, else: draw line.
+        limit_volume: If (`the number of candles to draw < limit_volume or not limit_volume`): draw volumebar, else: draw wicks.
+        limit_ma: If (`the number of candles to draw < limit_ma or not limit_ma`): draw ma lines, else: don't draw ma lines.
+        fraction: if True and number has a fractional part, display it as a fraction.
+        slider_top: set slider position. if True: slider top. else: bottom
+        min_distance: the minimum number of candles displayed on the screen.
+    """
+    key_date = 'date'
+    key_open, key_high, key_low, key_close = ('open', 'high', 'low', 'close')
+    key_volume = 'volume'
+
+    candle_on_ma = True
+    limit_candle = 400
+    limit_wick = 2_000
+    limit_volume = 200
+    limit_ma = 8_000
+    watermark = 'seolpyo mplchart'
+    fraction = False
+    slider_top = True
+    min_distance = 5
+