. diff --git a/LICENSE.MIT b/LICENSE.MIT deleted file mode 100644 index e329dc3e..00000000 --- a/LICENSE.MIT +++ /dev/null @@ -1,21 +0,0 @@ -MIT License - -Copyright (c) 2021 Yunseong Hwang - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. diff --git a/MANIFEST.in b/MANIFEST.in deleted file mode 100644 index d25f0cbe..00000000 --- a/MANIFEST.in +++ /dev/null @@ -1,14 +0,0 @@ -include AUTHORS.rst -include CONTRIBUTING.rst -include HISTORY.rst -include LICENSE -include LICENSE.MIT -include LICENSE.APACHE-2.0 -include LICENSE.GPL-3.0-OR-LATER -include README.rst - -recursive-include tests * -recursive-exclude * __pycache__ -recursive-exclude * *.py[co] - -recursive-include docs *.rst conf.py Makefile make.bat *.jpg *.png *.gif diff --git a/README.rst b/README.rst deleted file mode 100644 index 6daed5ee..00000000 --- a/README.rst +++ /dev/null @@ -1,1139 +0,0 @@ -===== -KOAPY -===== - -.. container:: - - .. image:: https://img.shields.io/pypi/v/koapy.svg - :target: https://pypi.python.org/pypi/koapy - :alt: PyPI Version - - .. image:: https://img.shields.io/pypi/pyversions/koapy.svg - :target: https://pypi.python.org/pypi/koapy/ - :alt: PyPI Python Versions - - .. image:: https://img.shields.io/pypi/status/koapy.svg - :target: https://pypi.python.org/pypi/koapy/ - :alt: PyPI Status - - .. badges from below are commendted out - - .. .. image:: https://img.shields.io/pypi/dm/koapy.svg - :target: https://pypi.python.org/pypi/koapy/ - :alt: PyPI Monthly Donwloads - -.. container:: - - .. image:: https://img.shields.io/github/workflow/status/elbakramer/koapy/CI/master - :target: https://github.com/elbakramer/koapy/actions/workflows/ci.yml - :alt: CI Build Status - .. .. image:: https://github.com/elbakramer/koapy/actions/workflows/ci.yml/badge.svg?branch=master - - .. image:: https://img.shields.io/github/workflow/status/elbakramer/koapy/Documentation/master?label=docs - :target: https://elbakramer.github.io/koapy/ - :alt: Documentation Build Status - .. .. image:: https://github.com/elbakramer/koapy/actions/workflows/documentation.yml/badge.svg?branch=master - - .. image:: https://img.shields.io/codecov/c/github/elbakramer/koapy.svg - :target: https://codecov.io/gh/elbakramer/koapy - :alt: Codecov Coverage - .. .. image:: https://codecov.io/gh/elbakramer/koapy/branch/master/graph/badge.svg - - .. image:: https://requires.io/github/elbakramer/koapy/requirements.svg?branch=master - :target: https://requires.io/github/elbakramer/koapy/requirements/?branch=master - :alt: Requires.io Requirements Status - - .. badges from below are commendted out - - .. .. image:: https://img.shields.io/travis/elbakramer/koapy.svg - :target: https://travis-ci.com/elbakramer/koapy - :alt: Travis CI Build Status - .. .. image:: https://travis-ci.com/elbakramer/koapy.svg?branch=master - - .. .. image:: https://img.shields.io/readthedocs/koapy/latest.svg - :target: https://koapy.readthedocs.io/en/latest/?badge=latest - :alt: ReadTheDocs Documentation Build Status - .. .. image:: https://readthedocs.org/projects/koapy/badge/?version=latest - - .. .. image:: https://pyup.io/repos/github/elbakramer/koapy/shield.svg - :target: https://pyup.io/repos/github/elbakramer/koapy/ - :alt: PyUp Updates - -.. container:: - - .. image:: https://img.shields.io/pypi/l/koapy.svg - :target: https://github.com/elbakramer/koapy/blob/master/LICENSE - :alt: PyPI License - - .. badges from below are commendted out - - .. .. image:: https://app.fossa.com/api/projects/git%2Bgithub.com%2Felbakramer%2Fkoapy.svg?type=shield - :target: https://app.fossa.com/projects/git%2Bgithub.com%2Felbakramer%2Fkoapy?ref=badge_shield - :alt: FOSSA Status - -.. container:: - - .. image:: https://badges.gitter.im/elbakramer/koapy.svg - :target: https://gitter.im/koapy/community - :alt: Gitter Chat - .. .. image:: https://img.shields.io/gitter/room/elbakramer/koapy.svg - - .. image:: https://img.shields.io/badge/code%20style-black-000000.svg - :target: https://github.com/psf/black - :alt: Code Style: Black - - -Kiwoom Open Api Plus Python - -* Free software: `MIT`_ OR `Apache-2.0`_ OR `GPL-3.0-or-later`_ -* Documentation: https://koapy.readthedocs.io. - -.. _`MIT`: https://github.com/elbakramer/koapy/blob/master/LICENSE.MIT -.. _`Apache-2.0`: https://github.com/elbakramer/koapy/blob/master/LICENSE.APACHE-2.0 -.. _`GPL-3.0-or-later`: https://github.com/elbakramer/koapy/blob/master/LICENSE.GPL-3.0-OR-LATER - - -Introduction ------------- - -KOAPY 는 `키움증권의 OpenAPI+`_ 를 Python_ 에서 쉽게 사용할 수 있도록 만든 -라이브러리 패키지 및 툴입니다. - -키움에서 제공하는 OpenAPI+ 를 활용하는데 필요한 구체적인 지식들을 전혀 알지 못해도, -기본적인 Python_ 에 대한 지식만 어느 정도 있다면 쉽게 사용할 수 있도록 하는 것에 -초점을 두었습니다. - -예를 들어 Python_ 기준으로 아래와 같은 내용들을 잘 모르더라도 충분히 모든 기능을 -사용할 수 있음을 의미합니다. - -* 키움에서 제공하는 OpenAPI+ 의 OCX 라이브러리 구조 -* OCX 를 Python_ 에서 구동하기 위해 PyQt5_/PySide2_ 라이브러리의 |QAxWidget|_ 생성 -* 컨트롤에서 함수 호출을 위해 |dynamicCall|_ 함수 사용 -* 이벤트 처리를 위해 적절한 |signal|_/|slot|_ 설정 및 이벤트 처리 - -.. _`키움증권의 OpenAPI+`: https://www3.kiwoom.com/nkw.templateFrameSet.do?m=m1408000000 -.. _Python: https://www.python.org/ - -.. _PyQt5: https://www.riverbankcomputing.com/software/pyqt/ -.. _PySide2: https://doc.qt.io/qtforpython/index.html - -.. |QAxWidget| replace:: ``QAxWidget`` -.. _QAxWidget: https://doc.qt.io/qt-5/qaxwidget.html -.. |dynamicCall| replace:: ``dynamicCall`` -.. _dynamicCall: https://doc.qt.io/qt-5/qaxbase.html#dynamicCall -.. |signal| replace:: ``signal`` -.. _signal: https://doc.qt.io/qt-5/signalsandslots.html#signals -.. |slot| replace:: ``slot`` -.. _slot: https://doc.qt.io/qt-5/signalsandslots.html#slots - - -Showcase --------- - -테이블 데이터 처리를 위한 pandas 임포트 -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. code-block:: python - - >>> import pandas as pd - -엔트리포인트 객체 생성 -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. code-block:: python - - >>> from koapy import KiwoomOpenApiPlusEntrypoint - -.. code-block:: python - - >>> entrypoint = KiwoomOpenApiPlusEntrypoint() - -키움증권 서버와의 연결 확인 및 로그인 처리 -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. code-block:: python - - >>> entrypoint.IsConnected() - False - >>> entrypoint.EnsureConnected() - True - >>> entrypoint.IsConnected() - True - -종목 리스트 및 종목 코드와 이름 확인 -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. code-block:: python - - >>> code_list = entrypoint.GetCodeListByMarketAsList("0") - >>> code_list - ['000020', '000040', '000050', '000060', '000070', ...] - -.. code-block:: python - - >>> name_list = [entrypoint.GetMasterCodeName(code) for code in code_list] - >>> name_list - ['동화약품', 'KR모터스', '경방', '메리츠화재', '삼양홀딩스', ...] - -.. code-block:: python - - >>> code_by_name = {name: code for code, name in zip(code_list, name_list)} - -.. code-block:: python - - >>> name = "삼성전자" - >>> code = code_by_name[name] - >>> code - '005930' - -단일 종목의 기본정보 확인 -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. code-block:: python - - >>> info = entrypoint.GetStockBasicInfoAsDict(code) - >>> info - {'종목코드': '005930', '종목명': '삼성전자', '결산월': '12', '액면가': '100', '자본금': '7780', '상장주식': '5969783', '신용비율': '+0.12', '연중최고': '+79800', '연중최저': '-71200', '시가총액': '4417639', '시가총액비중': '', '외인소진률': '+52.09', '대용가': '57170', 'PER': '19.27', 'EPS': '3841', 'ROE': '10.0', 'PBR': '1.88', 'EV': '5.09', 'BPS': '39406', '매출액': '2368070', '영업이익': '359939', '당기순이익': '264078', '250최고': '+86400', '250최저': '-68300', '시가': '+74300', '고가': '+74600', '저가': '+73400', '상한가': '+95200', '하한가': '-51400', '기준가': '73300', '예상체결가': '-0', '예상체결수량': '0', '250최고가일': '20210202', '250최고가대비율': '-14.35', '250최저가일': '20211013', '250최저가대비율': '+8.35', '현재가': '+74000', '대비기호': '2', '전일대비': '+700', '등락율': '+0.95', '거래량': '12730034', '거래대비': '-71.74', '액면가단위': '원', '유통주식': '4459119', '유통비율': '74.7'} - -복수 종목의 기본정보 확인 -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. code-block:: python - - >>> code_list_info = entrypoint.GetStockQuoteInfoAsDataFrame(code_list) - >>> code_list_info - 종목코드 종목명 현재가 기준가 전일대비 전일대비기호 등락율 \ - 0 000020 동화약품 +12450 12300 +150 2 +1.22 - 1 000040 KR모터스 +810 790 +20 2 +2.53 - 2 000050 경방 +14450 14200 +250 2 +1.76 - 3 000060 메리츠화재 49450 49450 0 3 0.00 - 4 000070 삼양홀딩스 +90700 88400 +2300 2 +2.60 - ... ... ... ... ... ... ... ... - 1744 580031 KB 인버스 KOSDAQ150 선물 ETN -10930 10960 -30 5 -0.27 - 1745 580032 KB 레버리지 구리 선물 ETN(H) -20515 20560 -45 5 -0.22 - 1746 580033 KB 인버스 2X 구리 선물 ETN(H) +18350 18280 +70 2 +0.38 - 1747 580010 KB Wise 분할매매 ETN +10820 10770 +50 2 +0.46 - 1748 590018 미래에셋 중국 심천 100 ETN +18810 18645 +165 2 +0.88 - - 거래량 거래대금 체결량 ... ELW만기일 미결제약정 미결제전일대비 이론가 내재변동성 델타 감마 쎄타 베가 \ - 0 135513 1670 +500 ... 00000000 - 1 230165 186 -10 ... 00000000 - 2 6214 89 97 ... 00000000 - 3 411584 20423 -4 ... 00000000 - 4 9052 813 +5 ... 00000000 - ... ... ... ... ... ... ... ... .. ... .. .. .. .. - 1744 2 0 -1 ... 00000000 - 1745 0 0 ... 00000000 - 1746 17 0 +10 ... 00000000 - 1747 0 0 ... 00000000 - 1748 1 0 +1 ... 00000000 - - 로 - 0 - 1 - 2 - 3 - 4 - ... .. - 1744 - 1745 - 1746 - 1747 - 1748 - - [1749 rows x 63 columns] - -특정 종목의 차트 데이터 확인 -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. code-block:: python - - >>> chart_data = entrypoint.GetDailyStockDataAsDataFrame(code) - >>> chart_data - 종목코드 현재가 거래량 거래대금 일자 시가 고가 저가 수정주가구분 \ - 0 005930 74000 12730034 941413 20220204 74300 74600 73400 - 1 73300 17744721 1314506 20220203 74900 74900 73300 - 2 73300 21367447 1552586 20220128 71300 73700 71200 - 3 71300 22274777 1603685 20220127 73800 74000 71300 - 4 73300 12976730 955547 20220126 73900 74400 73100 - ... ... ... ... ... ... ... ... ... ... - 9797 8010 4970 1 19850109 8240 8240 7950 - 9798 8300 12930 4 19850108 8400 8400 8300 - 9799 8410 11810 3 19850107 8400 8500 8390 - 9800 8390 1660 0 19850105 8400 8440 8390 - 9801 8450 1710 0 19850104 8500 8500 8450 - - 수정비율 대업종구분 소업종구분 종목정보 수정주가이벤트 전일종가 - 0 - 1 - 2 - 3 - 4 - ... ... ... ... ... ... ... - 9797 - 9798 - 9799 - 9800 - 9801 - - [9802 rows x 15 columns] - -키움증권의 TR 메타 정보 확인 -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. code-block:: python - - >>> from koapy import KiwoomOpenApiPlusTrInfo - -.. code-block:: python - - >>> tr_info_list = KiwoomOpenApiPlusTrInfo.get_trinfo_list() - -.. code-block:: python - - >>> data = pd.DataFrame.from_records([(info.tr_code, info.name) for info in tr_info_list], columns=['tr_code', 'name']) - >>> data - tr_code name - 0 opt10001 주식기본정보요청 - 1 opt10059 종목별투자자기관별요청 - 2 opt10087 시간외단일가요청 - 3 opt50037 코스피200지수요청 - 4 opt90005 프로그램매매추이요청 - .. ... ... - 220 opw20013 계좌미결제청산가능수량조회요청 - 221 opw20014 선옵실시간증거금산출요청 - 222 opw20015 옵션매도주문증거금현황요청 - 223 opw20016 신용융자 가능종목요청 - 224 opw20017 신용융자 가능문의 - - [225 rows x 2 columns] - -OPT10001 TR 요청 전송 및 응답 처리 (싱글데이터) -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. code-block:: python - - >>> opt10001_info = KiwoomOpenApiPlusTrInfo.get_trinfo_by_code("opt10001") - >>> opt10001_info - KiwoomOpenApiPlusTrInfo('opt10001', '주식기본정보요청', 'STOCK', '', '1', '', [KiwoomOpenApiPlusTrInfo.Field('종목코드', 0, 6, 9001)], '주식기본정보', [KiwoomOpenApiPlusTrInfo.Field('종목코드', 0, 20, 389), KiwoomOpenApiPlusTrInfo.Field('종목명', 20, 50, 302), KiwoomOpenApiPlusTrInfo.Field('결산월', 40, 20, 315), KiwoomOpenApiPlusTrInfo.Field('액면가', 60, 20, 310), KiwoomOpenApiPlusTrInfo.Field('자본금', 80, 20, 309), KiwoomOpenApiPlusTrInfo.Field('상장주식', 100, 20, 312), KiwoomOpenApiPlusTrInfo.Field('신용비율', 120, 20, 329), KiwoomOpenApiPlusTrInfo.Field('연중최고', 140, 20, 1006), KiwoomOpenApiPlusTrInfo.Field('연중최저', 160, 20, 1009), KiwoomOpenApiPlusTrInfo.Field('시가총액', 180, 20, 311), KiwoomOpenApiPlusTrInfo.Field('시가총액비중', 200, 20, 336), KiwoomOpenApiPlusTrInfo.Field('외인소진률', 220, 20, 314), KiwoomOpenApiPlusTrInfo.Field('대용가', 240, 20, 308), KiwoomOpenApiPlusTrInfo.Field('PER', 260, 20, 1600), KiwoomOpenApiPlusTrInfo.Field('EPS', 280, 20, 1604), KiwoomOpenApiPlusTrInfo.Field('ROE', 300, 20, 1630), KiwoomOpenApiPlusTrInfo.Field('PBR', 320, 20, 1601), KiwoomOpenApiPlusTrInfo.Field('EV', 340, 20, 1608), KiwoomOpenApiPlusTrInfo.Field('BPS', 360, 20, 1605), KiwoomOpenApiPlusTrInfo.Field('매출액', 380, 20, 1610), KiwoomOpenApiPlusTrInfo.Field('영업이익', 400, 20, 1611), KiwoomOpenApiPlusTrInfo.Field('당기순이익', 420, 20, 1614), KiwoomOpenApiPlusTrInfo.Field('250최고', 440, 20, 1000), KiwoomOpenApiPlusTrInfo.Field('250최저', 460, 20, 1003), KiwoomOpenApiPlusTrInfo.Field('시가', 480, 20, 16), KiwoomOpenApiPlusTrInfo.Field('고가', 500, 20, 17), KiwoomOpenApiPlusTrInfo.Field('저가', 520, 20, 18), KiwoomOpenApiPlusTrInfo.Field('상한가', 540, 20, 305), KiwoomOpenApiPlusTrInfo.Field('하한가', 560, 20, 306), KiwoomOpenApiPlusTrInfo.Field('기준가', 580, 20, 307), KiwoomOpenApiPlusTrInfo.Field('예상체결가', 600, 20, 10023), KiwoomOpenApiPlusTrInfo.Field('예상체결수량', 620, 20, 10024), KiwoomOpenApiPlusTrInfo.Field('250최고가일', 640, 20, 1001), KiwoomOpenApiPlusTrInfo.Field('250최고가대비율', 660, 20, 1002), KiwoomOpenApiPlusTrInfo.Field('250최저가일', 680, 20, 1004), KiwoomOpenApiPlusTrInfo.Field('250최저가대비율', 700, 20, 1005), KiwoomOpenApiPlusTrInfo.Field('현재가', 720, 20, 10), KiwoomOpenApiPlusTrInfo.Field('대비기호', 740, 20, 25), KiwoomOpenApiPlusTrInfo.Field('전일대비', 760, 20, 11), KiwoomOpenApiPlusTrInfo.Field('등락율', 780, 20, 12), KiwoomOpenApiPlusTrInfo.Field('거래량', 800, 20, 13), KiwoomOpenApiPlusTrInfo.Field('거래대비', 820, 20, 30), KiwoomOpenApiPlusTrInfo.Field('액면가단위', 840, 20, 796), KiwoomOpenApiPlusTrInfo.Field('유통주식', 840, 20, 1683), KiwoomOpenApiPlusTrInfo.Field('유통비율', 840, 20, 1684)], '', []) - - >>> opt10001_info.inputs - [KiwoomOpenApiPlusTrInfo.Field('종목코드', 0, 6, 9001)] - - >>> opt10001_info.single_outputs - [KiwoomOpenApiPlusTrInfo.Field('종목코드', 0, 20, 389), KiwoomOpenApiPlusTrInfo.Field('종목명', 20, 50, 302), KiwoomOpenApiPlusTrInfo.Field('결산월', 40, 20, 315), KiwoomOpenApiPlusTrInfo.Field('액면가', 60, 20, 310), KiwoomOpenApiPlusTrInfo.Field('자본금', 80, 20, 309), KiwoomOpenApiPlusTrInfo.Field('상장주식', 100, 20, 312), KiwoomOpenApiPlusTrInfo.Field('신용비율', 120, 20, 329), KiwoomOpenApiPlusTrInfo.Field('연중최고', 140, 20, 1006), KiwoomOpenApiPlusTrInfo.Field('연중최저', 160, 20, 1009), KiwoomOpenApiPlusTrInfo.Field('시가총액', 180, 20, 311), KiwoomOpenApiPlusTrInfo.Field('시가총액비중', 200, 20, 336), KiwoomOpenApiPlusTrInfo.Field('외인소진률', 220, 20, 314), KiwoomOpenApiPlusTrInfo.Field('대용가', 240, 20, 308), KiwoomOpenApiPlusTrInfo.Field('PER', 260, 20, 1600), KiwoomOpenApiPlusTrInfo.Field('EPS', 280, 20, 1604), KiwoomOpenApiPlusTrInfo.Field('ROE', 300, 20, 1630), KiwoomOpenApiPlusTrInfo.Field('PBR', 320, 20, 1601), KiwoomOpenApiPlusTrInfo.Field('EV', 340, 20, 1608), KiwoomOpenApiPlusTrInfo.Field('BPS', 360, 20, 1605), KiwoomOpenApiPlusTrInfo.Field('매출액', 380, 20, 1610), KiwoomOpenApiPlusTrInfo.Field('영업이익', 400, 20, 1611), KiwoomOpenApiPlusTrInfo.Field('당기순이익', 420, 20, 1614), KiwoomOpenApiPlusTrInfo.Field('250최고', 440, 20, 1000), KiwoomOpenApiPlusTrInfo.Field('250최저', 460, 20, 1003), KiwoomOpenApiPlusTrInfo.Field('시가', 480, 20, 16), KiwoomOpenApiPlusTrInfo.Field('고가', 500, 20, 17), KiwoomOpenApiPlusTrInfo.Field('저가', 520, 20, 18), KiwoomOpenApiPlusTrInfo.Field('상한가', 540, 20, 305), KiwoomOpenApiPlusTrInfo.Field('하한가', 560, 20, 306), KiwoomOpenApiPlusTrInfo.Field('기준가', 580, 20, 307), KiwoomOpenApiPlusTrInfo.Field('예상체결가', 600, 20, 10023), KiwoomOpenApiPlusTrInfo.Field('예상체결수량', 620, 20, 10024), KiwoomOpenApiPlusTrInfo.Field('250최고가일', 640, 20, 1001), KiwoomOpenApiPlusTrInfo.Field('250최고가대비율', 660, 20, 1002), KiwoomOpenApiPlusTrInfo.Field('250최저가일', 680, 20, 1004), KiwoomOpenApiPlusTrInfo.Field('250최저가대비율', 700, 20, 1005), KiwoomOpenApiPlusTrInfo.Field('현재가', 720, 20, 10), KiwoomOpenApiPlusTrInfo.Field('대비기호', 740, 20, 25), KiwoomOpenApiPlusTrInfo.Field('전일대비', 760, 20, 11), KiwoomOpenApiPlusTrInfo.Field('등락율', 780, 20, 12), KiwoomOpenApiPlusTrInfo.Field('거래량', 800, 20, 13), KiwoomOpenApiPlusTrInfo.Field('거래대비', 820, 20, 30), KiwoomOpenApiPlusTrInfo.Field('액면가단위', 840, 20, 796), KiwoomOpenApiPlusTrInfo.Field('유통주식', 840, 20, 1683), KiwoomOpenApiPlusTrInfo.Field('유통비율', 840, 20, 1684)] - - >>> opt10001_info.multi_outputs - [] - -.. code-block:: python - - >>> request_name = "주식기본정보요청" # 사용자 구분명, 구분가능한 임의의 문자열 - >>> tr_code = "opt10001" - >>> screen_no = "0001" # 화면번호, 0000 을 제외한 4자리 숫자 임의로 지정, None 의 경우 내부적으로 화면번호 자동할당 - >>> inputs = { - ... "종목코드": "005930", # 삼성전자 종목코드 - ... } - - >>> output = {} - - >>> for event in entrypoint.TransactionCall(request_name, tr_code, screen_no, inputs): - ... names = event.single_data.names - ... values = event.single_data.values - ... for name, value in zip(names, values): - ... output[name] = value - - >>> output - {'종목코드': '005930', '종목명': '삼성전자', '결산월': '12', '액면가': '100', '자본금': '7780', '상장주식': '5969783', '신용비율': '+0.12', '연중최고': '+79800', '연중최저': '-71200', '시가총액': '4417639', '시가총액비중': '', '외인소진률': '+52.09', '대용가': '57170', 'PER': '19.27', 'EPS': '3841', 'ROE': '10.0', 'PBR': '1.88', 'EV': '5.09', 'BPS': '39406', '매출액': '2368070', '영업이익': '359939', '당기순이익': '264078', '250최고': '+86400', '250최저': '-68300', '시가': '+74300', '고가': '+74600', '저가': '+73400', '상한가': '+95200', '하한가': '-51400', '기준가': '73300', '예상체결가': '-0', '예상체결수량': '0', '250최고가일': '20210202', '250최고가대비율': '-14.35', '250최저가일': '20211013', '250최저가대비율': '+8.35', '현재가': '+74000', '대비기호': '2', '전일대비': '+700', '등락율': '+0.95', '거래량': '12730034', '거래대비': '-71.74', '액면가단위': '원', '유통주식': '4459119', '유통비율': '74.7'} - -OPT10081 TR 요청 전송 및 응답 처리 (멀티데이터) -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. code-block:: python - - >>> opt10081_info = KiwoomOpenApiPlusTrInfo.get_trinfo_by_code("opt10081") - >>> opt10081_info - KiwoomOpenApiPlusTrInfo('opt10081', '주식일봉차트조회요청', 'SCHART', '', '1', '3003', [KiwoomOpenApiPlusTrInfo.Field('종목코드', 0, 20, 9001), KiwoomOpenApiPlusTrInfo.Field('기준일자', 20, 20, 9004), KiwoomOpenApiPlusTrInfo.Field('수정주가구분', 40, 20, 9055)], '주식일봉차트', [KiwoomOpenApiPlusTrInfo.Field('종목코드', 0, 20, 9001)], '주식일봉차트조회', [KiwoomOpenApiPlusTrInfo.Field('종목코드', 0, 20, 9001), KiwoomOpenApiPlusTrInfo.Field('현재가', 0, 20, 10), KiwoomOpenApiPlusTrInfo.Field('거래량', 40, 20, 13), KiwoomOpenApiPlusTrInfo.Field('거래대금', 60, 20, 14), KiwoomOpenApiPlusTrInfo.Field('일자', 80, 20, 22), KiwoomOpenApiPlusTrInfo.Field('시가', 100, 20, 16), KiwoomOpenApiPlusTrInfo.Field('고가', 120, 20, 17), KiwoomOpenApiPlusTrInfo.Field('저가', 140, 20, 18), KiwoomOpenApiPlusTrInfo.Field('수정주가구분', 160, 20, 3502), KiwoomOpenApiPlusTrInfo.Field('수정비율', 180, 20, 3503), KiwoomOpenApiPlusTrInfo.Field('대업종구분', 200, 20, 317), KiwoomOpenApiPlusTrInfo.Field('소업종구분', 220, 20, 318), KiwoomOpenApiPlusTrInfo.Field('종목정보', 240, 20, 370), KiwoomOpenApiPlusTrInfo.Field('수정주가이벤트', 260, 20, 3501), KiwoomOpenApiPlusTrInfo.Field('전일종가', 280, 20, 346)]) - - >>> opt10081_info.inputs - [KiwoomOpenApiPlusTrInfo.Field('종목코드', 0, 20, 9001), KiwoomOpenApiPlusTrInfo.Field('기준일자', 20, 20, 9004), KiwoomOpenApiPlusTrInfo.Field('수정주가구분', 40, 20, 9055)] - - >>> opt10081_info.single_outputs - [KiwoomOpenApiPlusTrInfo.Field('종목코드', 0, 20, 9001)] - - >>> opt10081_info.multi_outputs - [KiwoomOpenApiPlusTrInfo.Field('종목코드', 0, 20, 9001), KiwoomOpenApiPlusTrInfo.Field('현재가', 0, 20, 10), KiwoomOpenApiPlusTrInfo.Field('거래량', 40, 20, 13), KiwoomOpenApiPlusTrInfo.Field('거래대금', 60, 20, 14), KiwoomOpenApiPlusTrInfo.Field('일자', 80, 20, 22), KiwoomOpenApiPlusTrInfo.Field('시가', 100, 20, 16), KiwoomOpenApiPlusTrInfo.Field('고가', 120, 20, 17), KiwoomOpenApiPlusTrInfo.Field('저가', 140, 20, 18), KiwoomOpenApiPlusTrInfo.Field('수정주가구분', 160, 20, 3502), KiwoomOpenApiPlusTrInfo.Field('수정비율', 180, 20, 3503), KiwoomOpenApiPlusTrInfo.Field('대업종구분', 200, 20, 317), KiwoomOpenApiPlusTrInfo.Field('소업종구분', 220, 20, 318), KiwoomOpenApiPlusTrInfo.Field('종목정보', 240, 20, 370), KiwoomOpenApiPlusTrInfo.Field('수정주가이벤트', 260, 20, 3501), KiwoomOpenApiPlusTrInfo.Field('전일종가', 280, 20, 346)] - -.. code-block:: python - - >>> import datetime - - >>> date = datetime.datetime.now().strftime("%Y%m%d") - >>> date - '20220206' - -.. code-block:: python - - >>> request_name = "주식일봉차트조회요청" # 사용자 구분명, 구분가능한 임의의 문자열 - >>> tr_code = "opt10081" - >>> screen_no = "0001" # 화면번호, 0000 을 제외한 4자리 숫자 임의로 지정, None 의 경우 내부적으로 화면번호 자동할당 - >>> inputs = { - ... "종목코드": "005930", # 삼성전자 종목코드 - ... "기준일자": "20220206", # 가장 최근 날짜의 YYYYMMDD 포맷 - ... "수정주가구분": "0", # 0:일반주가, 1:수정주가 - ... } - - >>> data_list = [] - - >>> for event in entrypoint.TransactionCall(request_name, tr_code, screen_no, inputs): - ... columns = event.multi_data.names - ... records = [values.values for values in event.multi_data.values] - ... data = pd.DataFrame.from_records(records, columns=columns) - ... data_list.append(data) - - >>> data = pd.concat(data_list, axis=0).reset_index(drop=True) - >>> data - 종목코드 현재가 거래량 거래대금 일자 시가 고가 저가 수정주가구분 \ - 0 005930 74000 12730034 941413 20220204 74300 74600 73400 - 1 73300 17744721 1314506 20220203 74900 74900 73300 - 2 73300 21367447 1552586 20220128 71300 73700 71200 - 3 71300 22274777 1603685 20220127 73800 74000 71300 - 4 73300 12976730 955547 20220126 73900 74400 73100 - ... ... ... ... ... ... ... ... ... ... - 9797 8010 4970 1 19850109 8240 8240 7950 - 9798 8300 12930 4 19850108 8400 8400 8300 - 9799 8410 11810 3 19850107 8400 8500 8390 - 9800 8390 1660 0 19850105 8400 8440 8390 - 9801 8450 1710 0 19850104 8500 8500 8450 - - 수정비율 대업종구분 소업종구분 종목정보 수정주가이벤트 전일종가 - 0 - 1 - 2 - 3 - 4 - ... ... ... ... ... ... ... - 9797 - 9798 - 9799 - 9800 - 9801 - - [9802 rows x 15 columns] - -조건검색 조건식 설정 불러오기 -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. code-block:: python - - >>> entrypoint.IsConditionLoaded() - False - >>> entrypoint.EnsureConditionLoaded() - 1 - >>> entrypoint.IsConditionLoaded() - True - -불러온 조건식 목록 확인 -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. code-block:: python - - >>> condition_name_list = entrypoint.GetConditionNameListAsList() - >>> condition_name_list - [(0, '대형 저평가 우량주'), (1, '중소형 저평가주')] - -조건식 단순 검색 -~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. code-block:: python - - >>> condition_name = "대형 저평가 우량주" - >>> condition_met_code_list, condition_met_code_list_info = entrypoint.GetCodeListByCondition(condition_name, with_info=True) - - >>> condition_met_code_list - ['000240', '001800', '001880', '003230', '003550', '004000', '006040', '006390', '006650', '007700', '009970', '011780', '014830', '020000', '021240', '025540', '030520', '033290', '033780', '036830', '042420', '056190', '057050', '060150', '064960', '069080', '081660', '095660', '096530', '110790', '111770', '137310', '161390', '161890', '185750', '192080', '192400', '200130', '243070', '271560', '284740', '285130', '294870', '300720', '950130'] - - >>> condition_met_code_list_info # same as entrypoint.GetStockQuoteInfoAsDataFrame(condition_met_code_list) - 종목코드 종목명 현재가 기준가 전일대비 전일대비기호 등락율 거래량 거래대금 \ - 0 000240 한국앤컴퍼니 +13500 13400 +100 2 +0.75 56484 760 - 1 001800 오리온홀딩스 +14600 14250 +350 2 +2.46 69827 1008 - 2 001880 DL건설 -27950 28050 -100 5 -0.36 20925 583 - 3 003230 삼양식품 +91300 90000 +1300 2 +1.44 58660 5289 - 4 003550 LG +76300 74600 +1700 2 +2.28 249415 18925 - .. ... ... ... ... ... ... ... ... ... - 40 284740 쿠쿠홈시스 +36700 35900 +800 2 +2.23 30134 1102 - 41 285130 SK케미칼 +130500 129500 +1000 2 +0.77 58032 7544 - 42 294870 HDC현대산업개발 +15600 14600 +1000 2 +6.85 3145356 49106 - 43 300720 한일시멘트 +19250 18750 +500 2 +2.67 159419 3021 - 44 950130 엑세스바이오 -18400 22400 -4000 5 -17.86 5877689 119649 - - 체결량 ... ELW만기일 미결제약정 미결제전일대비 이론가 내재변동성 델타 감마 쎄타 베가 로 - 0 5549 ... 00000000 - 1 +1 ... 00000000 - 2 369 ... 00000000 - 3 +2 ... 00000000 - 4 +100 ... 00000000 - .. ... ... ... ... ... .. ... .. .. .. .. .. - 40 -3 ... 00000000 - 41 -1 ... 00000000 - 42 -25 ... 00000000 - 43 -4 ... 00000000 - 44 -36 ... 00000000 - - [45 rows x 63 columns] - -GRPC 스트림 처리 관련 유틸리티 함수 (데모 목적) -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. code-block:: python - - >>> import contextlib - >>> import threading - >>> import warnings - - >>> import grpc - - >>> @contextlib.contextmanager - ... def warn_on_rpc_error_context(): - ... try: - ... yield - ... except grpc.RpcError as e: - ... warnings.warn(str(e)) - - >>> def warn_on_rpc_error(stream): - ... with warn_on_rpc_error_context(): - ... for event in stream: - ... yield event - - >>> def cancel_after(stream, after): - ... timer = threading.Timer(after, stream.cancel) - ... timer.start() - ... return warn_on_rpc_error(stream) - -조건식 실시간 검색 -~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. code-block:: python - - >>> condition_name = "중소형 저평가주" - >>> stream = entrypoint.GetCodeListByConditionAsStream(condition_name) - - >>> condition_met_code_list = [] - >>> data_list = [] - - >>> for event in cancel_after(stream, 10): - ... if event.name == "OnReceiveTrCondition": - ... initially_included_code_list = event.arguments[1].string_value - ... initially_included_code_list = initially_included_code_list.rstrip(';').split(';') if initially_included_code_list else [] - ... condition_met_code_list.extend(initially_included_code_list) - ... elif event.name == "OnReceiveRealCondition": - ... code = event.arguments[0].string_value - ... condition_type = event.arguments[1].string_value - ... if condition_type == "I": - ... code_inserted = code - ... condition_met_code_list.append(code_inserted) - ... elif condition_type == "D": - ... code_deleted = code - ... condition_met_code_list.remove(code_deleted) - ... elif event.name == "OnReceiveTrData": - ... columns = event.multi_data.names - ... records = [values.values for values in event.multi_data.values] - ... data = pd.DataFrame.from_records(records, columns=columns) - ... data_list.append(data) - - >>> condition_met_code_list - ['900290', '900310', '900340', '002170', '017890', '023600', '036190', '037710', '049430', '073560', '140910', '187870', '192440', '210540', '225220', '263690', '352700', '950190', '900280', '900250'] - - >>> data_list - [] - -계좌정보 확인 -~~~~~~~~~~~~~~~~~~~~~~ - -.. code-block:: python - - >>> account_list = entrypoint.GetAccountList() - >>> account_list - ['8014526011'] - - >>> first_account_no = entrypoint.GetFirstAvailableAccount() - >>> first_account_no - '8014526011' - -주문 요청 (삼성전자 시장가 매수) -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. code-block:: python - - >>> request_name = "삼성전자 1주 시장가 신규 매수" # 사용자 구분명, 구분가능한 임의의 문자열 - >>> screen_no = "0001" # 화면번호, 0000 을 제외한 4자리 숫자 임의로 지정, None 의 경우 내부적으로 화면번호 자동할당 - >>> account_no = "8014526011" # 계좌번호 10자리, 여기서는 계좌번호 목록에서 첫번째로 발견한 계좌번호로 매수처리 - >>> order_type = 1 # 주문유형, 1:신규매수 - >>> code = "005930" # 종목코드, 앞의 삼성전자 종목코드 - >>> quantity = 1 # 주문수량, 1주 매수 - >>> price = 0 # 주문가격, 시장가 매수는 가격 설정 의미 없으므로 기본값 0 으로 설정 - >>> quote_type = "03" # 거래구분, 03:시장가 - >>> original_order_no = "" # 원주문번호, 주문 정정/취소 등에서 사용 - - >>> stream = entrypoint.OrderCall(request_name, screen_no, account_no, order_type, code, quantity, price, quote_type, original_order_no) - - >>> for event in warn_on_rpc_error(stream): - ... if event.name == "OnReceiveTrData": - ... order_no = event.single_data.values[0] - ... elif event.name == "OnReceiveChejanData": - ... gubun = event.arguments[0].string_value - ... data = dict(zip(event.single_data.names, event.single_data.values)) - ... if gubun == "0": - ... status = data["주문상태"] - ... if status == "접수": - ... pass - ... elif status == "체결": - ... orders_filled = data["체결량"] - ... orders_left = data["미체결수량"] - ... elif status == "확인": - ... org_order_no = data["원주문번호"] - ... assert original_order_no == org_order_no - ... elif gubun in ["1", "4"]: - ... stocks = data["보유수량"] - -키움증권의 실시간 데이터 메타 정보 확인 -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. code-block:: python - - >>> from koapy import KiwoomOpenApiPlusRealType - -.. code-block:: python - - >>> realtype_list = KiwoomOpenApiPlusRealType.get_realtype_info_list() - -.. code-block:: python - - >>> realtype_descs = [realtype.desc for realtype in realtype_list] - >>> realtype_descs - ['주식시세', '주식체결', '주식상하한', '주식우선호가', '주식호가잔량', '주식시간외호가', '주식당일거래원', 'ETF NAV', 'ELW 지표', 'ELW 이론가', '주식예상체결', '주식종목정보', '임의연장정보', 'ECN주식시세', 'ECN주식체결', 'ECN주식우선호가', 'ECN주식호가잔량', 'ECN주식시간외호가', 'ECN주식당일거래원', '시간외종목정보', '주식거래원', '주식거래원(1LINE)', '종목별프로그램매매', 'VI정적예상가', 'VI발동/해제-종목별', '종목별프로그램매매2', '종목투자자(잠정)', '종목투자자(거래소)', '대주가능수량', '선물옵션우선호가', '선물시세', '선물호가잔량', '선물이론가', '선물기초자산시세', '실시간상하한가', '옵션시세', '옵션호가잔량', '옵션이론가', '주식옵션시세', '주식옵션호가잔량', '주식옵션이론가', '업종지수', '업종등락', '자체업종지수', '예상업종지수', '시황/뉴스', '환률', '장시작시간', '투자자ticker', '상하한가폭변경', 'VI발동/해제', '투자자별매매', '프로그램매매', '해외시세', '주문체결', '파생잔고', '현물잔고', '예수금', '해외주문체결', '해외잔고', '순간체결량', '주문체결서버상태', '증거금', 'CFD주문', 'CFD체결', 'CFD마진콜경고', 'CFD입출고', '자유포멧', '조건검색', '일반신호', '리얼잔고', '해외리얼잔고', '리얼잔고총합', '해외잔고총합', '스톱로스', '선물옵션합계', '스톱주문', 'CFD주문체결', 'CFD리얼잔고', 'CFD리얼잔고총합', '모니터링 실시간LOG', '주식선물호가잔량', '실시간증거금', 'X-Ray순간체결량', '매입인도체결', '매입인도호가', '코넥스경매매체결', '데이터셋실시간', '홍콩체결', '홍콩시세', '홍콩호가잔량', '홍콩단일가시세', '홍콩업종지수', '홍콩실시간상하한가', '수동자동주문', '자동주문결과', 'TS고저변경', '잔고편입', '기준가변경', '멀티차단', '잔고청산삭제', '후강퉁체결', '후강퉁시세', '후강퉁호가잔량', '후강퉁단일가시세', '후강퉁업종지수', '미체결통보시스템', '채널K실시간티커', '빅데이터종목1분', '빅데이터종목10분', '빅데이터종목1시간', '빅데이터종목당일', '빅데이터뉴스', '신호관리자투자정보', '빅데이터급상승', '빅데이터종목30초', '알-종목포착이탈', '알-매도감시시작', '알-매도감시포착', '알-주문결과', '알-청산시작', '알-청산완료', '알-감시시작', '알-내조건식수정', '알-주문조건수정', '알-제한여부', '알-멀티차단', '알-TS변경', '알-모의주문체결', '알-모의현물잔고', '알-모의 주문체결', '알-모의 리얼잔고', '알-모의리얼잔고총합', '채권체결', '채권호가잔량', '소액채권체결', '소액채권호가잔량', 'CME시세', 'CME미결제약정', 'CME호가잔량', 'EUF시세', 'EUF호가잔량', 'EUREX시세', 'EUREX호가', '배치데이터갱신', '종목마스터갱신', '해외주식주문', '해외주식체결', '해외실시간잔고조회', '미국입출고', '미국종목변경', 'CME/EUREX주문', 'CME/EUREX체결', 'CME배치', 'EUREX배치', 'CME미체결', 'CME실시간잔고', 'CME잔고합', '분할반복주문'] - - >>> realtype_info = KiwoomOpenApiPlusRealType.get_realtype_info_by_name("주식시세") - >>> realtype_info - KiwoomOpenApiPlusRealType('0A', '주식시세', 21, [10, 11, 12, 27, 28, 13, 14, 16, 17, 18, 25, 26, 29, 30, 31, 32, 311, 822, 567, 568, 732]) - - >>> fid_list = KiwoomOpenApiPlusRealType.get_fids_by_realtype_name("주식시세") - >>> fid_list - [10, 11, 12, 27, 28, 13, 14, 16, 17, 18, 25, 26, 29, 30, 31, 32, 311, 822, 567, 568, 732] - - >>> KiwoomOpenApiPlusRealType.Fid.get_name_by_fid(10) - '현재가' - - >>> fid_names = KiwoomOpenApiPlusRealType.get_field_names_by_realtype_name("주식시세") - >>> fid_names - ['현재가', '전일대비', '등락율', '매도호가', '매수호가', '누적거래량', '누적거래대금', '시가', '고가', '저가', '전일대비기호', '거래량전일대비', '거래대금증감', '전일거래량대비율', '거래회전율', '거래비용', '시가총액', '822', '567', '568', '732'] - -실시간 데이터 요청 (삼성전자 주식시세 실시간 데이터 요청) -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -.. code-block:: python - - >>> code_list = ["005930"] - >>> fid_list = KiwoomOpenApiPlusRealType.get_fids_by_realtype_name("주식시세") - >>> opt_type = "0" # 기존 화면에 추가가 아니라 신규 생성 - - >>> stream = entrypoint.GetRealDataForCodesAsStream( - ... code_list, - ... fid_list, - ... opt_type, - ... screen_no=None, # 화면번호, 0000 을 제외한 4자리 숫자 임의로 지정, None 의 경우 내부적으로 화면번호 자동할당 - ... infer_fids=True, # True 로 설정 시 주어진 fid_list 를 고집하지 말고 이벤트 처리 함수의 인자로 전달받는 실시간데이터 이름에 따라 유연하게 fid_list 를 추론 - ... readable_names=True, # True 로 설정 시 각 fid 마다 숫자 대신 읽을 수 있는 이름으로 변환하여 반환 - ... fast_parse=False, # True 로 설정 시 이벤트 처리 함수내에서 데이터 값 읽기 시 GetCommRealData() 함수 호출 대신, 이벤트 처리 함수의 인자로 넘어오는 데이터를 직접 활용, infer_fids 가 True 로 설정된 경우만 유의미함 - ... ) - - >>> for event in cancel_after(stream, 10): - ... if event.name == "OnReceiveRealData": - ... data = dict(zip(event.single_data.names, event.single_data.values)) - ... if "현재가" in data: - ... current_price = data["현재가"] - -사용 종료 후 엔트리포인트 객체 리소스 해제 (연결 해제 및 서버 어플리케이션 종료) -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -직접 ``close()`` 메소드 호출: - -.. code-block:: python - - >>> entrypoint.close() - -혹은 처음부터 컨텍스트 매니저 형태로 리소스 관리: - -.. code-block:: python - - >>> with KiwoomOpenApiPlusEntrypoint() as entrypoint: - ... entrypoint.EnsureConnected() - ... ... - - -Installation ------------- - -대표적으로 아래와 같이 PyPI_ 를 통해서 설치가 가능합니다: - -.. code-block:: console - - $ pip install koapy - -만약에 개발 환경을 구축하고자 하는 경우에는 |poetry|_ 를 활용해 구성합니다. - -.. code-block:: console - - $ # Install poetry (here using pipx) - $ python -m pip install pipx - $ python -m pipx ensurepath - $ pipx install poetry - - $ # Clone repository - $ git clone https://github.com/elbakramer/koapy.git - $ cd koapy/ - - $ # Install dependencies and hooks - $ poetry install - $ poetry run pre-commit install - -이외에 자세한 설치방법과 관련해서는 Installation_ 문서를 참고하세요. - -.. _PyPI: https://pypi.org/project/koapy/ -.. |poetry| replace:: ``poetry`` -.. _poetry: https://python-poetry.org/ -.. _Installation: https://koapy.readthedocs.io/en/latest/installation.html - - -Usage ------ - -설치 이후 일반적인 사용법에 대해서는 Usage_ 를 참고하세요. - -추가적으로 사용법과 관련된 다양한 예시들은 examples_ 폴더 및 notebooks_ipynb_ 폴더에서도 확인 가능합니다. -혹시나 notebooks_ipynb_ 폴더의 ``.ipynb`` 파일들을 Github 을 통해서 보는데 문제가 있는 경우, -해당 노트북 주소를 nbviewer_ 에 입력하여 확인해 보세요. - -현재 알파 단계이기 때문에 많은 기능들이 실제로 문제없이 동작하는지 충분히 테스트되지 않았습니다. -만약에 실전 트레이딩에 사용하려는 경우 자체적으로 충분한 테스트를 거친 후 사용하시기 바랍니다. - -개발자는 라이브러리 사용으로 인해 발생하는 손실에 대해 어떠한 책임도 지지 않습니다. - -또한 알파 단계에서 개발이 진행되면서 라이브러리의 구조가 계속 급격하게 변경될 수 있으니 참고 바랍니다. - -.. _Usage: https://koapy.readthedocs.io/en/latest/usage.html -.. _examples: https://github.com/elbakramer/koapy/tree/master/koapy/examples -.. _notebooks_ipynb: https://github.com/elbakramer/koapy/tree/master/docs/source/notebooks_ipynb -.. _nbviewer: https://nbviewer.jupyter.org/ - - -Features --------- - -KOAPY 는 아래와 같은 방향성을 가지고 개발되었습니다. - -GUI 어플리케이션만으로 제한되지 않는 다양한 사용성 -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -일반적으로 인터넷 등지에서 접하기 쉬운 관련 예시들을 처음으로 따라가다 보면, 자기도 -모르는 사이에 Qt 기반 어플리케이션을 하나 만들고, 버튼을 하나 추가하고, 이후 모든 -기능들을 죄다 해당 버튼을 클릭 시 작동하는 콜백 함수 하나에 쑤셔 넣고 있는.. 자신을 -발견하게 되더군요. - -.. code-block:: python - - # https://wikidocs.net/4240 - - import sys - - from PyQt5.QtWidgets import * - from PyQt5.QtGui import * - from PyQt5.QAxContainer import * - - class MyWindow(QMainWindow): - def __init__(self): - super().__init__() - self.setWindowTitle("PyStock") - self.setGeometry(300, 300, 300, 150) - - self.kiwoom = QAxWidget("KHOPENAPI.KHOpenAPICtrl.1") - - btn1 = QPushButton("Login", self) - btn1.move(20, 20) - btn1.clicked.connect(self.btn1_clicked) - - btn2 = QPushButton("Check state", self) - btn2.move(20, 70) - btn2.clicked.connect(self.btn2_clicked) - - def btn1_clicked(self): - ret = self.kiwoom.dynamicCall("CommConnect()") - - def btn2_clicked(self): - if self.kiwoom.dynamicCall("GetConnectState()") == 0: - self.statusBar().showMessage("Not connected") - else: - self.statusBar().showMessage("Connected") - - if __name__ == "__main__": - app = QApplication(sys.argv) - myWindow = MyWindow() - myWindow.show() - app.exec_() - -사실 기반 라이브러리가 애초에 OCX 형태로서 제공되는 것도 있고, 다른 여러 가지 이유들로 -인해 이처럼 GUI 어플리케이션 형태로 개발을 하는 것이 자연스러운 흐름이고 절대 -잘못되었다고 생각되진 않습니다. - -다만 이러한 GUI 환경이 일반적으로 Python 에서 REPL 혹은 Jupyter Notebook 등을 통해서 -인터랙티브하게 결과 값들을 확인해가면서 조금씩 개발해 나가던 것과는 거리가 멀어지면서 -결론적으로 생산성이 떨어지게 되는 건 아닌가 하는 생각이 들었고, 그로 인해 KOAPY 의 -기본적인 인터페이스는 기반이 되는 Qt 환경을 개발자가 직접적으로 고려하진 않으면서도 -기능은 쉽게 사용해 볼 수 있게 끔 하는 게 좋겠다고 생각했습니다. - -따라서 KOAPY 의 기본적인 디자인은 우선 외적으로 봤을 때 이게 내부적으로는 Qt 같은 -환경하에서 돌아간다는 것을 바로 알아챌 순 없게 끔 되어 있습니다. 그리고 기본적인 -기능들을 이용하는 데에 있어서도 버튼 클릭 등의 이벤트에 기반한 호출보단 일반적인 함수 -호출과 같은 명령형 프로그래밍이 가능하도록 디자인 하였으며, 문서에서도 해당 사용 -시나리오들을 중점적으로 먼저 소개하고 있습니다. - -.. code-block:: python - - from koapy import KiwoomOpenApiPlusEntrypoint - - with KiwoomOpenApiPlusEntrypoint() as entrypoint: - entrypoint.EnsureConnected() - is_connected = entrypoint.IsConnected() - print(is_connected) - - -결론적으로 PyQt5_ 혹은 PySide2_ 를 기반한 GUI 환경에 얽매일 필요 없이 일반적인 -라이브러리처럼 가져다 활용할 수 있으며, 여전히 GUI 기반 어플리케이션 개발이 필요하다면 -내부적으로 사용되는 요소들을 통해 직접 GUI 방향으로 개발을 할 수도 있습니다. - -.. code-block:: python - - from koapy.compat.pyside2.QtWidgets import QApplication, QMainWindow - from koapy import KiwoomOpenApiPlusQAxWidget - - class MyWindow(QMainWindow): - def __init__(self): - super().__init__() - - self.kiwoom = KiwoomOpenApiPlusQAxWidget() - ... - - -함수 호출등의 과정에서 일반적인 Python 의 관습을 크게 해치지 않는 매끄러운 인터페이스 구성 -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Qt 를 통해서 COM/OLE/OCX 객체의 메서드를 호출하려면 |dynamicCall|_ 함수를 활용해야 합니다. - -해당 |dynamicCall|_ 함수는 호출하고자 하는 메서드의 프로토타입을 문자열 형태 인자로서 -입력하도록 되어있는데, 단순하게는 매번 메서드를 호출하고자 할 때마다 해당 메서드의 -프로토타입이 어떻게 생겼는지를 문서 등을 참고하고 일일이 적어 넣어줘야 할 수 있습니다. - -.. code-block:: python - - control = QAxWidget("KHOPENAPI.KHOpenAPICtrl.1") - control.dynamicCall("SetInputValue(const QString&, const QString&)", "종목코드", code) - -그 다음으로 보다 나은 방식으로는 이러한 프로토타입을 모든 함수들에 대해서 확인해서 -간단한 래퍼 함수들을 만들어두고 활용하는 게 있겠죠. - -.. code-block:: python - - def SetInputValue(name, value): - return control.dynamicCall("SetInputValue(const QString&, const QString&)", name, value) - -일반적으로는 이런 방식들로도 충분히 사용하는데 무리가 없으리라 생각됩니다만 -개인적으로는 위와 같은 접근 방식에서 몇 가지 우려되는 점들이 신경이 쓰였습니다. - -* 프로토타입을 입력하거나 래퍼 함수들을 만들어 넣는 과정에서 발생할 수 있는 휴먼에러 -* 래퍼 함수들을 만들어 놓았더라도 추후 함수의 목록 혹은 특정 함수의 프로토타입에서 - 변경이 발생하는 경우 매번 직접적인 대응이 필요함 - -따라서 KOAPY 에서는 이러한 지원 함수 목록 및 함수별 프로토타입 정보 확인, 그리고 -이것들을 활용해 특정 메서드를 호출하는 과정까지를 어떻게 프로그래밍적으로 대응할 수 -없을까를 고민했고, 현재는 OpenAPI+ OCX 의 TypeLib 정보를 읽어와 메서드들을 동적으로 -생성하도록 구현해 위에서 우려했던 점들을 해결했습니다. - -최종적으론 컨트롤 함수 호출 시 매뉴얼의 명세에 적혀있는 형태 그대로 Python 함수였던 -것처럼 호출이 가능하며, 이후는 KOAPY 가 유연하게 처리합니다. 매번 명세에 맞게 -|dynamicCall|_ 함수의 인자를 적어 넣거나, 모든 존재하는 함수에 대해 미리 래퍼 함수를 -손 아프게 만들어놓을 필요가 없습니다. - -.. code-block:: python - - control = KiwoomOpenApiPlusQAxWidget() - control.SetInputValue("종목코드", code) - -이벤트 처리 및 비동기 프로그래밍 관련 복잡하지 않은 인터페이스 제공 -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -비동기 프로그래밍은 일반적으로 어렵습니다. 특히 OpenAPI+ 및 KOAPY 의 경우를 예로 -들어보면 아래와 같은 고민해 볼 만한 부분들이 있습니다. - -* 여러 요청에 대한 응답 결과들을 이벤트 타입별 하나씩의 통로로 처리하기 때문에 그들 - 간의 교통정리부터 필요합니다. -* 콜백 함수 내에서 OpenAPI+ 가 기대하는 혹은 가이드하는 방식에 맞춰서 처리해 주어야 - 하는 특정 단계 혹은 프로세스가 존재하며 이를 적절히 대응해 주어야 합니다. -* 콜백 함수에서 받은 결과를 최종적으로 해당 결과가 필요한 곳으로 (일반적으론 요청한 - 대상에게로) 잘 전달해 주어야 합니다. - -KOAPY 에서는 위의 문제들을 나름의 방식대로 고민하였고 문제들을 해결하여 더 쉽고 나은 -인터페이스를 사용자에게 제공하고 있습니다. - -구체적으로 예를 하나 들자면, 일반적인 요청-응답 과정에서 내부적으로 gRPC -클라이언트-서버 관계를 만들어 요청자가 gRPC 를 통해 특정 요청을 전달하면, 이후 gRPC -서버에서는 해당 요청에 대한 응답들만 추려서 결과를 요청자측에 스트림 형태로 전달하도록 -디자인되어 있는데요. 여기서 교통정리 및 결과 전달 문제가 자연스럽게 해결되며 부수적으로 -사용자 입장에서는 직접 콜백 함수를 다루기보다는 간접적으로 스트림을 -(``for`` 문을 활용하여) 다룸으로써 더 쉽게 비동기 프로그래밍이 필요한 기능들을 사용할 -수 있는 이점이 있습니다. - -PySide2 를 통한 직접적인 방식: - -.. code-block:: python - - # 컨트롤 객체 - control = QAxWidget("KHOPENAPI.KHOpenAPICtrl.1") - - # 이벤트 시그널 - on_receive_tr_data_signal = SIGNAL("OnReceiveTrData(const QString&, const QString&, const QString&, const QString&, const QString&, int, const QString&, const QString&, const QString&)") - - # 이벤트 콜백 함수 - def on_receive_tr_data(screen_no, request_name, tr_code, record_name, prev_next, data_length, error_code, message, splmmsg): - handle_event(...) - - # 이벤트 처리 후 필요하다면 등록된 콜백 함수 제거 - if should_disconnect: - control.disconnect(on_receive_tr_data_signal, on_receive_tr_data) - - # 이벤트 시그널에 콜백 함수 연결 - control.connect(on_receive_tr_data_signal, on_receive_tr_data) - - # TR 입력값 설정 - control.dynamicCall("SetInputValue(const QString&, const QString&)", ..., ...) - ... - - # TR 요청 - err_code = control.dynamicCall( - "CommRqData(const QString&, const QString&, int, const QString&)", - request_name, - tr_code, - prev_next, - screen_no, - ) - -KOAPY 방식: - -.. code-block:: python - - # TR 요청 후 이벤트가 스트림 형태로 반환 - for event in entrypoint.TransactionCall(request_name, tr_code, screen_no, inputs): - handle_event(event) - -결론적으로는 사용자가 이벤트 처리 및 비동기 프로그래밍에 익숙하지 않더라도 그보다 -비교적 쉬운 인터페이스를 통해 관련 기능들을 활용할 수 있습니다. - -더 나아가서는 가장 간단한 로그인 처리부터 TR/실시간 데이터 처리, 그리고 주문처리까지 -다양한 시나리오에 대한 기본 이벤트 처리 로직을 구현해 제공해 사용자들이 비동기 -프로그래밍이 필요한 기능 중 주로 사용되는 기능들에 쉽게 접근할 수 있도록 했습니다. - -.. code-block:: python - - stream = entrypoint.LoginCall() - stream = entrypoint.TransactionCall(request_name, tr_code, screen_no, inputs) - stream = entrypoint.RealCall(screen_no, codes, fids, opt_type) - stream = entrypoint.OrderCall(request_name, screen_no, account_no, order_type, code, quantity, price, quote_type, original_order_no) - -여러 일반적인 시나리오들에 대한 다양한 기본 구현체들을 제공 -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -KOAPY 에서는 일반적으로 자주 사용되는 기능들에 대해서 사용자들이 쉽게 접근할 수 있도록, -예를 들어 주식 기본정보 요청부터 일봉/분봉 등 시세 데이터 확인 그리고 예수금/잔고 확인 등등에 대해 미리 구현된 함수를 제공합니다. - -.. code-block:: python - - stock_info = entrypoint.GetStockBasicInfoAsDict(stock_code) - stock_chart_data = entrypoint.GetDailyStockDataAsDataFrame(stock_code) - - account_deposit = entrypoint.GetDepositInfo(account_no) - account_evaluation = ( - account_evaluation_summary, - account_evaluation_per_stock, - ) = entrypoint.GetAccountEvaluationStatusAsSeriesAndDataFrame(account_no) - -이 중에 함수 호출 결과 중 테이블성 정보들은 |pandas.DataFrame|_ 타입으로 제공해 이후 분석 및 처리가 유용하게끔 했습니다. - -.. |pandas.DataFrame| replace:: ``pandas.DataFrame`` -.. _`pandas.DataFrame`: https://pandas.pydata.org/pandas-docs/stable/reference/api/pandas.DataFrame.html - -개발과정에서 라이브러리 밖을 드나들 필요가 없도록 자주 확인이 필요한 여러가지 메타 정보들을 함께 제공 -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -일반적으로 인터넷 등지에서 접하기 쉬운 관련 대부분 예시들은 사용자가 OpenAPI+ 에 대한 -여러 가지 메타정보들을 이미 다 알고 있다는 걸 가정하고, 아니면 적어도 외부 참고자료를 -확인하는 것을 가정하고 작성되어 있는 경우가 많습니다. - -예를 들어 TR 의 입력과 출력 데이터 구조, 실시간 데이터별 FID 목록, 에러코드에 대한 -설명문 등이 이러한 메타정보들에 해당되는데요. 앞서 함수 호출 방식에서의 이슈와 비슷하게, -이러한 정보들을 매번 참고 자료를 확인하고 그에 맞춰 개발하는 방식에는 어느 정도 한계가 -있습니다. - -따라서 KOAPY 에서는 이러한 정보들을 개발하는 과정에서 언어 내 라이브러리에서 바로 조회 -및 활용이 가능하도록 포함시켜 제공합니다. 이로 인해 일차적으로 사용자 입장에서는 매번 -매뉴얼_ 이나 KOAStudio_ 를 열어서 참고하고 이후 일일이 하나씩 하드코딩할 필요가 -없어졌습니다. - -.. code-block:: python - - from koapy import KiwoomOpenApiPlusTrInfo - tr_info = KiwoomOpenApiPlusTrInfo.get_trinfo_by_code("opt10001") - - from koapy import KiwoomOpenApiPlusRealType - realtype_info = KiwoomOpenApiPlusRealType.get_realtype_info_by_name("주식시세") - - from koapy import KiwoomOpenApiPlusError - error_message = KiwoomOpenApiPlusError.get_error_message_by_code(-101) - -덧붙여서 TR 관련 정보나 실시간 데이터 관련 정보들은 OpenAPI+ 가 설치되어 있는 경우 -해당 경로의 데이터를 참고해 동적으로 생성하도록 되어있는데요. 이로 인해 직접 하드코딩 -등을 했을 때 발생할 수 있는 이슈 없이, 매번 업데이트 시 변경된 내용이 바로바로 적용될 -수 있는 이점 또한 가지고 있습니다. - -.. _매뉴얼: https://download.kiwoom.com/web/openapi/kiwoom_openapi_plus_devguide_ver_1.5.pdf -.. _KOAStudio: https://download.kiwoom.com/web/openapi/kiwoom_openapi_plus_devguide_ver_1.5.pdf#page=7 - -라이브러리 호환성으로 인해 특정 환경이 강제되는 것을 우회할 수 있도록 시스템 구성 -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -키움증권의 OpenAPI+ 는 32bit 환경만 제공하고 있기 때문에 이를 사용하는 쪽도 자연스럽게 -32bit 기반이 되어야 합니다. - -여기서는 Python_ 을 32bit 로 사용해야 하는 조건이 붙게 되는 것인데요. 몇몇 외부 -서드파티들에서는 더 이상 32bit 를 지원하지 않는 경우도 많아 다양한 서드파티 기능들과 -접목시키기에는 32bit 제약이 번거로운 점이 많습니다. - -KOAPY 에서는 이를 해소하기 위해 gRPC_ 서버-클라이언트 형태의 구성을 잡아 서버에서는 -32bit 기반으로 OpenAPI+ 의 핵심 기능만 제공하도록 하고, 클라이언트에서는 이런 32bit -제약 없이 결과들을 받아서 이후 여러 서드파티 기능들과 함께 활용할 수 있도록 했습니다. - -앞에서는 주로 32bit 제약을 가지고 이야기했지만 더 나아가서는 gRPC_ 의 많은 언어들에 -대한 확장성을 활용하여 Python 이외에 gRPC_ 에서 지원하는 다른 언어들로 클라이언트를 -작성해 사용하는 방식으로도 확장이 가능합니다. - -또한 Python_ 에서 Qt_ 를 사용하기 위해서는 PyQt5_ 혹은 PySide2_ 를 사용해야 하는데요. -KOAPY 에서는 라이선스 등을 고려해서 기본값으로 PySide2_ 를 사용하도록 되어있지만, -사용자의 필요성에 따라 PySide2_ 대신 PyQt5_ 를 사용하려 할 때 쉽게 변경할 수 있도록 -|qtpy|_ 를 통해서 지원하고 있습니다. - -.. _gRPC: https://grpc.io/ - -.. _Python: https://www.python.org/ -.. _Qt: https://www.qt.io/ - -.. _PyQt5: https://www.riverbankcomputing.com/software/pyqt/ -.. _PySide2: https://doc.qt.io/qtforpython/index.html - -.. |qtpy| replace:: ``qtpy`` -.. _qtpy: https://github.com/spyder-ide/qtpy - -키움증권의 OpenAPI+ 기능 자체 이외에 부수적으로 필요할만한 다양한 기능들을 추가로 제공 -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -KOAPY 는 키움증권의 OpenAPI+ 핵심 기능 이외에 전체적인 개발 및 활용에 필요한 다양한 -부가기능들을 추가로 제공합니다. - -* TR 호출 시 호출 횟수 제한 회피 -* KRX 거래소 휴장일 확인 (|exchange_calendars|_ API 활용) -* 알람 및 메시지 기능 (|discord.py|_ API 활용) - -.. |exchange_calendars| replace:: ``exchange_calendars`` -.. _exchange_calendars: https://github.com/gerrymanoim/exchange_calendars -.. |discord.py| replace:: ``discord.py`` -.. _`discord.py`: https://discordpy.readthedocs.io/en/stable/ - -라이브러리 뿐만 아니라 관련 기능들을 추가적인 코드 구현없이 쉽게 사용해볼 수 있도록 (+ 개념 증명 목적으로서) CLI 제공 -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -굳이 Python 코드를 작성하지 않더라도 기본적인 기능들을 활용해 볼 수 있도록 여러 -커맨드를 포함하는 CLI 를 제공합니다. - -CLI 를 활용하면 마켓별 코드 목록 확인, 주식 기본 정보 확인, 일봉/분봉 데이터 확인 및 -저장, 실시간 데이터 구독 등 다양한 기능들을 코드 구현 없이 사용할 수 있습니다. - -.. code-block:: console - - $ koapy get stockcode --market=0 - $ koapy get stockinfo --code=005930 - $ koapy get daily --code=005930 --output=005930.xlsx - $ koapy watch --code=005930 --realtype="주식시세" - -서버도 CLI 커맨드로 쉽게 띄울 수 있습니다. - -.. code-block:: console - - $ koapy serve - - -Licensing ---------- - -KOAPY 는 다중 라이선스 방식으로 배포되며, -사용자는 자신의 의도 및 사용 방식에 따라 아래 라이선스 옵션들 중 하나를 선택해 사용할 수 있습니다. - -* `MIT License`_ -* `Apache License 2.0`_ -* `GNU General Public License v3.0`_ or later - -라이선스 선택과 관련하여 추천하는 가이드라인은 아래와 같습니다. - -MIT License -~~~~~~~~~~~ - -* 일반적인 사용자에게 알맞습니다. -* 짧고 단순한 라이선스를 선호하시면 해당 라이선스를 선택하세요. - -Apache License 2.0 -~~~~~~~~~~~~~~~~~~ - -* MIT 라이선스와 큰 차이는 없지만, 특허와 관련해서 명시적인 허가조항이 있습니다. -* 추후 특허권 침해 소송이 우려되는 경우 MIT 라이선스 대신에 선택하시면 됩니다. - -GNU General Public License v3.0 or later -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -* FSF_/GPL_ 이 추구하는 Copyleft_ 의 가치를 따르신다면 선택 가능한 옵션중 하나입니다. -* 이외에 backtrader_ 관련 기능들을 활용하시는 경우, KOAPY 는 **반드시** GPLv3+ 로만 배포되어야 합니다. -* 구체적으로 |koapy.backtrader|_ 모듈 하위의 기능들을 사용한다면 GPLv3+ 배포 조건에 해당됩니다. -* 이것은 backtrader_ 가 GPLv3+ 로 배포되고 있으며, - 해당 라이선스의 요구사항에 따라 그것을 사용하는 소프트웨어 또한 GPLv3+ 로 배포되어야 하기 때문입니다. - -각 라이선스의 허가 및 요구사항과 관련해서 쉽게 정리된 내용은 `tl;drLegal`_ 에서 참고하실 수 있습니다. - -다만 위의 내용이 법률적 조언은 아닌 점 참고 바랍니다. - -.. _`MIT License`: https://spdx.org/licenses/MIT.html -.. _`Apache License 2.0`: http://www.apache.org/licenses/LICENSE-2.0 -.. _`GNU General Public License v3.0`: https://www.gnu.org/licenses/gpl-3.0.html - -.. _FSF: https://www.fsf.org/ -.. _GPL: https://www.gnu.org/licenses/licenses.html#GPL -.. _Copyleft: https://www.gnu.org/licenses/copyleft.html - -.. _backtrader: https://github.com/mementum/backtrader -.. |koapy.backtrader| replace:: ``koapy.backtrader`` -.. _`koapy.backtrader`: https://github.com/elbakramer/koapy/tree/master/koapy/backtrader - -.. _`tl;drLegal`: https://tldrlegal.com/ - - -Credits -------- - -이 패키지는 Cookiecutter_ 와 `elbakramer/cookiecutter-poetry`_ 프로젝트 탬플릿을 사용하여 생성되었습니다. - -.. _Cookiecutter: https://github.com/audreyr/cookiecutter -.. _`elbakramer/cookiecutter-poetry`: https://github.com/elbakramer/cookiecutter-poetry diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index 7ba16ae6..00000000 --- a/SECURITY.md +++ /dev/null @@ -1,15 +0,0 @@ -# Security Policy - -## Supported Versions - -While this project is currently in alpha, -no major security update supports are guaranteed. - -| Version | Supported | -| ------- | ------------------ | -| < 1.0 | :x: | - -## Reporting a Vulnerability - -Go to Issues and create a new issue about the vulnerability to report. -Add `security` tag to the issue while creating the issue. diff --git a/_modules/index.html b/_modules/index.html new file mode 100644 index 00000000..ecc8fff3 --- /dev/null +++ b/_modules/index.html @@ -0,0 +1,315 @@ + + + + + + + + Overview: module code — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

All modules for which code is available

koapy.cli.commands.disable

koapy.cli.commands.disable.auto_login

koapy.cli.commands.enable

koapy.cli.commands.enable.auto_login

koapy.cli.commands.generate

koapy.cli.commands.generate.grpc

koapy.cli.commands.generate.grpc.ssl_credentials

koapy.cli.commands.generate.openapi

koapy.cli.commands.generate.openapi.python_stubs

koapy.cli.commands.get

koapy.cli.commands.install

koapy.cli.commands.show.account_window

koapy.cli.commands.uninstall

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/daishin_cybos_plus/core/CybosPlusEntrypoint.html b/_modules/koapy/backend/daishin_cybos_plus/core/CybosPlusEntrypoint.html new file mode 100644 index 00000000..8e8bbe6b --- /dev/null +++ b/_modules/koapy/backend/daishin_cybos_plus/core/CybosPlusEntrypoint.html @@ -0,0 +1,268 @@ + + + + + + + + koapy.backend.daishin_cybos_plus.core.CybosPlusEntrypoint — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.daishin_cybos_plus.core.CybosPlusEntrypoint

+import threading
+
+import pywintypes
+import win32com.client
+
+from requests.structures import CaseInsensitiveDict
+
+from koapy.backend.daishin_cybos_plus.core.CybosPlusEntrypointMixin import (
+    CybosPlusEntrypointMixin,
+)
+from koapy.backend.daishin_cybos_plus.core.CybosPlusError import CybosPlusRequestError
+from koapy.backend.daishin_cybos_plus.core.CybosPlusRateLimiter import (
+    CybosPlusLookupRequestRateLimiter,
+    CybosPlusTradeRequestRateLimiter,
+)
+from koapy.utils.platform import is_32bit
+
+
+[docs]class CybosPlusDispatch:
+    def __init__(self, entrypoint, progid):
+        self._entrypoint = entrypoint
+        self._progid = progid
+        self._is_trade_related = progid.startswith("CpTrade.")
+
+        self._dispatch = win32com.client.gencache.EnsureDispatch(progid)
+
+        if self._is_trade_related:
+            self._rate_limiter = self._entrypoint._trade_rate_limiter
+        else:
+            self._rate_limiter = self._entrypoint._lookup_rate_limiter
+
+        self._error_checking_request_methods = {}
+        self._rate_limited_request_methods = {}
+
+        for name in ["BlockRequest", "BlockRequest2", "Request"]:
+            if hasattr(self._dispatch, name):
+                method = getattr(self._dispatch, name)
+                if callable(method):
+                    method = CybosPlusRequestError.wrap_to_check_code_or_raise(method)
+                    self._error_checking_request_methods[
+                        "ErrorChecking" + name
+                    ] = method
+                    method = self._rate_limiter(method)
+                    self._rate_limited_request_methods["RateLimited" + name] = method
+
+    def __getattr__(self, name):
+        if hasattr(self._dispatch, name):
+            return getattr(self._dispatch, name)
+        elif name in self._rate_limited_request_methods:
+            return self._rate_limited_request_methods[name]
+        elif name in self._error_checking_request_methods:
+            return self._error_checking_request_methods[name]
+        else:
+            raise AttributeError(
+                "'{}' object has no attribute '{}'".format(type(self), name)
+            )
+
+    def __repr__(self):
+        return "{}({!r}, {!r})".format(
+            self.__class__.__name__, self._entrypoint, self._progid
+        )
+
+
+[docs]class CybosPlusIncompleteProgID:
+    def __init__(self, entrypoint, prefix):
+        self._entrypoint = entrypoint
+        self._prefix = prefix
+
+        self._cache = {}
+        self._lock = threading.RLock()
+
+    def __getattr__(self, name):
+        if name not in self._cache:
+            with self._lock:
+                if name not in self._cache:
+                    progid = "{}.{}".format(self._prefix, name)
+                    try:
+                        dispatch = CybosPlusDispatch(self._entrypoint, progid)
+                    except pywintypes.com_error as e:  # pylint: disable=no-member
+                        raise AttributeError(
+                            "'{}' object has no attribute '{}'".format(type(self), name)
+                        ) from e
+                    self._cache[name] = dispatch
+        return self._cache[name]
+
+    def __repr__(self):
+        return "{}({!r}, {!r})".format(
+            self.__class__.__name__, self._entrypoint, self._prefix
+        )
+
+
+[docs]class CybosPlusEntrypoint(CybosPlusEntrypointMixin):
+
+    """
+    http://cybosplus.github.io/
+    """
+
+    def __init__(self):
+        assert is_32bit(), "Control object should be created in 32bit environment"
+
+        self._attribute_mapping = {
+            "CpDib": "DsCbo1",
+            "CpSysDib": "CpSysDib",
+            "CpTrade": "CpTrade",
+            "CpUtil": "CpUtil",
+            "DsCbo1": "DsCbo1",
+        }
+        self._attribute_mapping = CaseInsensitiveDict(self._attribute_mapping)
+
+        self._cache = {}
+        self._lock = threading.RLock()
+
+        self._lookup_rate_limiter = CybosPlusLookupRequestRateLimiter()
+        self._trade_rate_limiter = CybosPlusTradeRequestRateLimiter()
+
+    def __getattr__(self, name):
+        if name not in self._attribute_mapping:
+            raise AttributeError(
+                "'{}' object has no attribute '{}'".format(type(self), name)
+            )
+        name = self._attribute_mapping[name]
+        if name not in self._cache:
+            with self._lock:
+                if name not in self._cache:
+                    self._cache[name] = CybosPlusIncompleteProgID(self, name)
+        return self._cache[name]
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/daishin_cybos_plus/core/CybosPlusEntrypointMixin.html b/_modules/koapy/backend/daishin_cybos_plus/core/CybosPlusEntrypointMixin.html new file mode 100644 index 00000000..f58f74ba --- /dev/null +++ b/_modules/koapy/backend/daishin_cybos_plus/core/CybosPlusEntrypointMixin.html @@ -0,0 +1,700 @@ + + + + + + + + koapy.backend.daishin_cybos_plus.core.CybosPlusEntrypointMixin — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.daishin_cybos_plus.core.CybosPlusEntrypointMixin

+import datetime
+import json
+import logging
+import math
+import subprocess
+
+import pandas as pd
+import pytz
+
+from exchange_calendars import get_calendar
+
+from koapy.utils.ctypes import is_admin
+from koapy.utils.exchange_calendars import get_last_session_date
+from koapy.utils.itertools import chunk
+from koapy.utils.logging.Logging import Logging
+from koapy.utils.subprocess import function_to_subprocess_args
+
+
+[docs]class CybosPlusEntrypointMixin(Logging):
+[docs]    def GetConnectState(self):
+        return self.CpUtil.CpCybos.IsConnect
+
+    @classmethod
+[docs]    def ConnectUsingPywinauto_Impl(cls, credentials=None):
+        """
+        https://github.com/ippoeyeslhw/cppy/blob/master/cp_luncher.py
+        """
+
+        import pywinauto
+
+        is_in_development = False
+
+        if credentials is None:
+            from koapy.config import config
+
+            credentials = config.get("koapy.backend.daishin_cybos_plus.credentials")
+
+        userid = credentials.get("user_id")
+        password = credentials.get("user_password")
+        cert = credentials.get("cert_password")
+
+        auto_account_password = credentials.get("auto_account_password")
+        auto_cert_password = credentials.get("auto_cert_password")
+        price_check_only = credentials.get("price_check_only")
+
+        account_passwords = credentials.get("account_passwords")
+
+        cls.logger.info("Starting CYBOS Starter application")
+        _app = pywinauto.Application().start(
+            r"C:\DAISHIN\STARTER\ncStarter.exe /prj:cp"
+        )  # pylint: disable=unused-variable
+        desktop = pywinauto.Desktop(allow_magic_lookup=False)
+
+        try:
+            cls.logger.info(
+                "Waiting for possible popup which asks for shutting down existing program"
+            )
+            ask_stop = desktop.window(title="ncStarter")
+            ask_stop.wait("ready", timeout=10)
+        except pywinauto.timings.TimeoutError:
+            cls.logger.info("No existing program found to be shutdown")
+        else:
+            cls.logger.info("Existing program found, shutting down")
+            if is_in_development:
+                ask_stop.print_control_identifiers()
+            if ask_stop["Static2"].window_text().endswith("종료하시겠습니까?"):
+                ask_stop["Button1"].click()
+                try:
+                    cls.logger.info("Wating for possible failure message on shutdown")
+                    ask_stop = desktop.window(title="ncStarter")
+                    ask_stop.wait("ready", timeout=10)
+                except pywinauto.timings.TimeoutError:
+                    cls.logger.info("Successfully shutdown existing program")
+                else:
+                    cls.logger.error("Failed to shutdown existing program")
+                    if is_in_development:
+                        ask_stop.print_control_identifiers()
+                    if ask_stop["Static2"].window_text().endswith("종료할 수 없습니다."):
+                        ask_stop["Button"].click()
+                        raise RuntimeError("Cannot stop existing program")
+
+        try:
+            cls.logger.info("Waiting for CYBOS Starter login screen")
+            starter = desktop.window(title="CYBOS Starter")
+            starter.wait("ready", timeout=30)
+        except pywinauto.timings.TimeoutError:
+            cls.logger.exception("Failed to find login screen")
+            raise
+
+        if is_in_development:
+            starter.print_control_identifiers()
+
+        if userid:
+            cls.logger.info("Putting user id")
+            starter["Edit1"].set_text(userid)
+        if password:
+            cls.logger.info("Putting user password")
+            starter["Edit2"].set_text(password)
+        else:
+            raise RuntimeError("No user password given")
+
+        if not price_check_only:
+            if cert:
+                cls.logger.info("Putting cert password")
+                starter["Edit3"].set_text(cert)
+            else:
+                raise RuntimeError("No cert password given")
+
+        if price_check_only:
+            if starter["Edit3"].is_enabled():
+                cls.logger.info("Checking price check only option")
+                starter["Button6"].check_by_click()
+        else:
+            if not starter["Edit3"].is_enabled():
+                starter["Button6"].uncheck_by_click()
+
+        if auto_account_password:
+            cls.logger.info("Checking auto account password option")
+            starter["Button4"].check()  # check dosen't work
+            try:
+                confirm = desktop.window(title="대신증권")
+                confirm.wait("ready", timeout=5)
+            except pywinauto.timings.TimeoutError:
+                pass
+            else:
+                if is_in_development:
+                    confirm.print_control_identifiers()
+                confirm["Button"].click()
+        else:
+            starter["Button4"].uncheck()  # uncheck dosen't work
+
+        if auto_cert_password:
+            cls.logger.info("Checking auto cert password option")
+            starter["Button5"].check()  # check dosen't work
+            try:
+                confirm = desktop.window(title="대신증권")
+                confirm.wait("ready", timeout=5)
+            except pywinauto.timings.TimeoutError:
+                pass
+            else:
+                if is_in_development:
+                    confirm.print_control_identifiers()
+                confirm["Button"].click()
+        else:
+            starter["Button5"].uncheck()  # uncheck dosen't work
+
+        cls.logger.info("Clicking login button")
+        starter["Button1"].click()
+
+        cls.logger.info("Setting account passwords if necessary")
+        should_stop = False
+        while not should_stop:
+            try:
+                cls.logger.info("Waiting for account password setting screen")
+                account_password = desktop.window(title="종합계좌 비밀번호 확인 입력")
+                account_password.wait("ready", timeout=5)
+            except pywinauto.timings.TimeoutError:
+                cls.logger.info("Account password setting screen not found")
+                should_stop = True
+            else:
+                cls.logger.info("Account password setting screen found")
+                if is_in_development:
+                    account_password.print_control_identifiers()
+                account_no = (
+                    account_password["Static"].window_text().split(":")[-1].strip()
+                )
+                if account_no in account_passwords:
+                    account_password["Edit"].set_text(account_passwords[account_no])
+                else:
+                    raise RuntimeError(
+                        "No account password given for account %s" % account_no
+                    )
+                account_password["Button1"].click()
+
+        try:
+            cls.logger.info("Waiting for starter screen to be closed")
+            starter.wait_not("visible", timeout=60)
+        except pywinauto.timings.TimeoutError:
+            cls.logger.warning("Could not wait for starter screen to be closed")
+        else:
+            cls.logger.info("Starter screen is closed")
+            try:
+                cls.logger.info("Waiting for notice window")
+                notice = desktop.window(title="공지사항")
+                notice.wait("ready", timeout=60)
+            except pywinauto.timings.TimeoutError:
+                cls.logger.info("No notice window found")
+            else:
+                cls.logger.info("Closing notice window")
+                notice.close()
+                try:
+                    cls.logger.info("Waiting for the notice window to be closed")
+                    notice.wait_not("visible", timeout=60)
+                except pywinauto.timings.TimeoutError:
+                    cls.logger.warning("Could not wait for notice screen to be closed")
+                else:
+                    cls.logger.info("Notice window is closed")
+
+    @classmethod
+[docs]    def ConnectUsingPywinauto_RunScriptInSubprocess(cls, credentials=None):
+        def main():
+            # pylint: disable=redefined-outer-name,reimported,import-self
+            import json
+            import sys
+
+            from koapy.backend.daishin_cybos_plus.core.CybosPlusEntrypoint import (
+                CybosPlusEntrypoint,
+            )
+
+            credentials = json.load(sys.stdin)
+            CybosPlusEntrypoint.ConnectUsingPywinauto_Impl(credentials)
+
+        args = function_to_subprocess_args(main)
+        return subprocess.run(
+            args, input=json.dumps(credentials), text=True, check=True
+        )
+
+[docs]    def ConnectUsingPywinauto(self, credentials=None):
+        return self.ConnectUsingPywinauto_RunScriptInSubprocess(credentials)
+
+[docs]    def Connect(self, credentials=None):
+        assert is_admin(), "Connect() method requires to be run as administrator"
+
+        self.ConnectUsingPywinauto(credentials)
+
+        if self.GetConnectState() == 0:
+            self.logger.error("Failed to start and connect to CYBOS Plus")
+        else:
+            self.logger.info("Succesfully connected to CYBOS Plus")
+
+        return self.GetConnectState()
+
+[docs]    def CommConnect(self, credentials=None):
+        return self.Connect(credentials)
+
+[docs]    def EnsureConnected(self, credentials=None):
+        errcode = 0
+        if self.GetConnectState() == 0:
+            self.Connect(credentials)
+        if self.GetConnectState() == 0:
+            raise RuntimeError("CYBOS Plus is not running, please start CYBOS Plus")
+        return errcode
+
+[docs]    def GetCodeListByMarketAsList(self, market):
+        """
+        0: 구분없음
+        1: 거래소
+        2: 코스닥
+        3: 프리보드
+        4: KRX
+        """
+        codes = self.CpUtil.CpCodeMgr.GetStockListByMarket(market)
+        codes = list(codes)
+        return codes
+
+[docs]    def GetKospiCodeList(self):
+        codes = self.GetCodeListByMarketAsList(1)
+        return codes
+
+[docs]    def GetKosdaqCodeList(self):
+        codes = self.GetCodeListByMarketAsList(2)
+        return codes
+
+[docs]    def GetGeneralCodeList(
+        self,
+        include_preferred_stock=False,
+        include_etn=False,
+        include_etf=False,
+        include_mutual_fund=False,
+        include_reits=False,
+        include_kosdaq=False,
+    ):
+
+        codes = self.GetCodeListByMarketAsList(1)
+        codemgr = self.CpUtil.CpCodeMgr
+
+        if not include_preferred_stock:
+            codes = [code for code in codes if code.endswith("0")]
+        if not include_etn:
+            codes = [code for code in codes if not code.startswith("Q")]
+        if not include_etf:
+            codes = [
+                code
+                for code in codes
+                if codemgr.GetStockSectionKind(code) not in [10, 12]
+            ]
+        if not include_mutual_fund:
+            codes = [
+                code for code in codes if codemgr.GetStockSectionKind(code) not in [2]
+            ]
+        if not include_reits:
+            codes = [
+                code for code in codes if codemgr.GetStockSectionKind(code) not in [3]
+            ]
+
+        if include_kosdaq:
+            codes += self.GetCodeListByMarketAsList(2)
+
+        codes = sorted(codes)
+
+        return codes
+
+[docs]    def GetStockDataAsDataFrame(
+        self,
+        code,
+        chart_type,
+        interval,
+        start_date=None,
+        end_date=None,
+        adjusted_price=False,
+        adjustement_only=False,
+    ):
+        """
+        http://cybosplus.github.io/cpsysdib_rtf_1_/stockchart.htm
+        """
+        chart = self.CpSysDib.StockChart
+
+        calendar = get_calendar("XKRX")
+        tz = calendar.tz or pytz.timezone("Asia/Seoul")
+
+        needs_time = chart_type in ["m", "T"]
+
+        if len(code) == 6 and not code.startswith("A"):
+            code = "A" + code
+
+        fids = [0]
+
+        if needs_time:
+            fids += [1]
+
+        if not adjustement_only:
+            fids += [2, 3, 4, 5, 8, 9]
+        else:
+            assert chart_type == "D"
+            adjusted_price = True
+
+        if adjusted_price and chart_type == "D":
+            fids += [18, 19]
+
+        num_fids = len(fids)
+        sorted_fids = sorted(fids)
+        field_indexes = [sorted_fids.index(i) for i in fids]
+
+        maximum_value_count = 20000
+        expected_count = math.floor(maximum_value_count / num_fids) - 1
+        request_count = expected_count + 1
+
+        date_format_arg = "%Y%m%d%H%M%S"
+        date_format_input = "%Y%m%d"
+
+        if start_date is None:
+            start_date = get_last_session_date().astimezone(tz).to_pydatetime()
+        if isinstance(start_date, str):
+            start_date_len = len(start_date)
+            if start_date_len == 14:
+                start_date = datetime.datetime.strptime(start_date, date_format_arg)
+            elif start_date_len == 8:
+                start_date = datetime.datetime.strptime(start_date, date_format_input)
+            else:
+                raise ValueError
+        if not isinstance(start_date, datetime.datetime):
+            raise ValueError
+
+        start_date = start_date.astimezone(tz)
+
+        internal_start_date = start_date
+
+        if end_date is not None:
+            if isinstance(end_date, str):
+                end_date_len = len(end_date)
+                if end_date_len == 14:
+                    end_date = datetime.datetime.strptime(end_date, date_format_arg)
+                elif end_date_len == 8:
+                    end_date = datetime.datetime.strptime(end_date, date_format_input)
+                else:
+                    raise ValueError
+            if not isinstance(end_date, datetime.datetime):
+                raise ValueError
+
+            end_date = end_date.astimezone(tz)
+
+        should_stop = False
+        dataframes = []
+
+        while not should_stop:
+            chart.SetInputValue(0, code)
+            chart.SetInputValue(1, ord("2"))
+            chart.SetInputValue(2, int(internal_start_date.strftime(date_format_input)))
+            chart.SetInputValue(4, request_count)
+            chart.SetInputValue(5, fids)
+            chart.SetInputValue(6, ord(chart_type))
+            chart.SetInputValue(7, int(interval))
+            chart.SetInputValue(
+                9, ord("1") if adjusted_price else ord("0")
+            )  # 기본으로 수정주가 적용하지 않음
+
+            self.logger.debug("Requesting from %s", internal_start_date)
+            chart.RateLimitedBlockRequest()
+
+            received_count = chart.GetHeaderValue(3)
+            self.logger.debug(
+                "Requested %d, received %d records", request_count, received_count
+            )
+
+            num_fields = chart.GetHeaderValue(1)
+            assert num_fields == num_fids
+
+            names = chart.GetHeaderValue(2)
+            names = [names[i] for i in field_indexes]
+
+            records = []
+            for i in range(received_count):
+                record = [chart.GetDataValue(j, i) for j in field_indexes]
+                records.append(record)
+
+            df = pd.DataFrame.from_records(records, columns=names)
+
+            last_date = datetime.datetime.strptime(
+                df.iloc[-1]["날짜"].astype(int).astype(str), date_format_input
+            )
+            last_date = last_date.astimezone(tz)
+
+            if df.shape[0] > 0 and self.logger.isEnabledFor(logging.DEBUG):
+                from_date = datetime.datetime.strptime(
+                    df.iloc[0]["날짜"].astype(int).astype(str), date_format_input
+                )
+                from_date = from_date.astimezone(tz)
+                self.logger.debug(
+                    "Received data from %s to %s for code %s",
+                    from_date,
+                    last_date,
+                    code,
+                )
+
+            should_stop = received_count < expected_count
+
+            if not should_stop and end_date is not None:
+                should_stop = last_date <= end_date
+
+            if not should_stop:
+                self.logger.debug("More data to request remains")
+                internal_start_date = last_date
+                nrows_before_truncate = df.shape[0]
+                datetimes = pd.to_datetime(
+                    df["날짜"].astype(int).astype(str), format="%Y%m%d"
+                )
+                datetimes = datetimes.dt.tz_localize(tz)
+                condition = datetimes > last_date
+                df = df.loc[condition]
+                nrows_after_truncate = df.shape[0]
+                self.logger.debug(
+                    "Trailing rows truncated: %d",
+                    nrows_before_truncate - nrows_after_truncate,
+                )
+            else:
+                self.logger.debug("No more data to request")
+                if end_date is not None:
+                    nrows_before_truncate = df.shape[0]
+                    dates = df["날짜"].astype(int).astype(str)
+                    if needs_time:
+                        times = df["시간"].astype(int).astype(str).str.ljust(6, "0")
+                        datetimes = dates.str.cat(times)
+                        datetimes = pd.to_datetime(datetimes, format="%Y%m%d%H%M%S")
+                    else:
+                        datetimes = dates
+                        datetimes = pd.to_datetime(datetimes, format="%Y%m%d")
+                    datetimes = datetimes.dt.tz_localize(tz)
+                    condition = datetimes > end_date
+                    df = df.loc[condition]
+                    nrows_after_truncate = df.shape[0]
+                    self.logger.debug(
+                        "Trailing rows truncated: %d",
+                        nrows_before_truncate - nrows_after_truncate,
+                    )
+
+            dataframes.append(df)
+
+        df = pd.concat(dataframes)
+        df.reset_index(drop=True, inplace=True)
+
+        return df
+
+[docs]    def GetDailyStockDataAsDataFrame(
+        self, code, start_date=None, end_date=None, adjusted_price=False
+    ):
+        return self.GetStockDataAsDataFrame(
+            code, "D", 1, start_date, end_date, adjusted_price=adjusted_price
+        )
+
+[docs]    def GetMinuteStockDataAsDataFrame(
+        self, code, interval, start_date=None, end_date=None, adjusted_price=False
+    ):
+        return self.GetStockDataAsDataFrame(
+            code, "m", interval, start_date, end_date, adjusted_price=adjusted_price
+        )
+
+[docs]    def GetDailyAdjustmentRatioAsDataFrame(self, code, start_date=None, end_date=None):
+        return self.GetStockDataAsDataFrame(
+            code, "D", 1, start_date, end_date, adjustement_only=True
+        )
+
+[docs]    def GetCurrentStockDataAsDataFrame(self, codes):
+        """
+        http://cybosplus.github.io/cpdib_rtf_1_/stockmst2.htm
+        """
+        stock = self.DsCbo1.StockMst2
+
+        names = [
+            "종목코드",
+            "종목명",
+            "시간",
+            "현재가",
+            "전일대비",
+            "상태구분",
+            "시가",
+            "고가",
+            "저가",
+            "매도호가",
+            "매수호가",
+            "거래량",
+            "거래대금",
+            "총매도잔량",
+            "총매수잔량",
+            "매도잔량",
+            "매수잔량",
+            "상장주식수",
+            "외국인보유비율",
+            "전일종가",
+            "전일거래량",
+            "체결강도",
+            "순간체결량",
+            "체결가비교",
+            "호가비교",
+            "동시호가구분",
+            "예상체결가",
+            "예상체결가 전일대비",
+            "예상체결가 상태구분",
+            "예상체결가 거래량",
+        ]
+        fids = list(range(len(names)))
+
+        dataframes = []
+        for code_chunk in chunk(codes, 110):
+            stock.SetInputValue(0, ",".join(code_chunk))
+            stock.RateLimitedBlockRequest()
+            received_count = stock.GetHeaderValue(0)
+            records = []
+            for i in range(received_count):
+                record = [stock.GetDataValue(j, i) for j in fids]
+                records.append(record)
+
+            df = pd.DataFrame.from_records(records, columns=names)
+            dataframes.append(df)
+
+        df = pd.concat(dataframes)
+        df.reset_index(drop=True, inplace=True)
+
+        return df
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/daishin_cybos_plus/core/CybosPlusError.html b/_modules/koapy/backend/daishin_cybos_plus/core/CybosPlusError.html new file mode 100644 index 00000000..07609002 --- /dev/null +++ b/_modules/koapy/backend/daishin_cybos_plus/core/CybosPlusError.html @@ -0,0 +1,216 @@ + + + + + + + + koapy.backend.daishin_cybos_plus.core.CybosPlusError — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.daishin_cybos_plus.core.CybosPlusError

+from functools import wraps
+
+
+[docs]class CybosPlusError(Exception):
+
+    pass
+
+
+[docs]class CybosPlusRequestError(CybosPlusError):
+
+    """
+    아래 문서에서 [BlockRequest/Blockrequest2/Request의 리턴값] 내용 참조
+    http://cybosplus.github.io/cputil_rtf_1_/cybosplus_interface.htm
+    """
+
+[docs]    ERROR_MESSAGE_BY_CODE = {
+        0: "정상요청",
+        1: "통신요청 실패",
+        2: "주문확인창에서 취소",
+        3: "그외의 내부 오류",
+        4: "주문요청 제한 개수 초과",
+    }
+
+    @classmethod
+[docs]    def get_error_message_by_code(cls, code, default=None):
+        return cls.ERROR_MESSAGE_BY_CODE.get(code, default)
+
+    @classmethod
+[docs]    def check_code_or_raise(cls, code):
+        if code != 0:
+            raise cls(code)
+        return code
+
+    @classmethod
+[docs]    def wrap_to_check_code_or_raise(cls, func):
+        @wraps(func)
+        def wrapper(*args, **kwargs):
+            return cls.check_code_or_raise(func(*args, **kwargs))
+
+        return wrapper
+
+    @classmethod
+[docs]    def try_or_raise(cls, arg):
+        if isinstance(arg, int):
+            return cls.check_code_or_raise(arg)
+        elif callable(arg):
+            return cls.wrap_to_check_code_or_raise(arg)
+        else:
+            raise TypeError("Expected 'int' or 'callable' but %s found" % type(arg))
+
+    def __init__(self, code, message=None):
+        if message is None:
+            message = self.get_error_message_by_code(code)
+
+        super().__init__(message)
+
+        self._code = code
+        self._message = message
+
+    def __str__(self):
+        return self._message
+
+    def __repr__(self):
+        return "{}({!r}, {!r})".format(
+            self.__class__.__name__, self._code, self._message
+        )
+
+    @property
+[docs]    def code(self):
+        return self._code
+
+    @property
+[docs]    def message(self):
+        return self._message
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/daishin_cybos_plus/core/CybosPlusRateLimiter.html b/_modules/koapy/backend/daishin_cybos_plus/core/CybosPlusRateLimiter.html new file mode 100644 index 00000000..af79da39 --- /dev/null +++ b/_modules/koapy/backend/daishin_cybos_plus/core/CybosPlusRateLimiter.html @@ -0,0 +1,169 @@ + + + + + + + + koapy.backend.daishin_cybos_plus.core.CybosPlusRateLimiter — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.daishin_cybos_plus.core.CybosPlusRateLimiter

+from koapy.utils.rate_limiting.RateLimiter import TimeWindowRateLimiter
+
+
+[docs]class CybosPlusLookupRequestRateLimiter(TimeWindowRateLimiter):
+
+    """
+    시세 오브젝트 조회 제한: 15초에 최대 60건으로제한
+
+    Q. 플러스 데이터 요청 사용 제한에 대해 알고 싶습니다.
+    http://money2.daishin.com/e5/mboard/ptype_accordion/plusFAQ/DW_Basic_List.aspx?boardseq=298&m=9508&p=8835&v=8640
+    """
+
+    def __init__(self):
+        super().__init__(15, 60)
+
+
+[docs]class CybosPlusTradeRequestRateLimiter(TimeWindowRateLimiter):
+
+    """
+    주문관련 오브젝트 조회 제한: 15초에 최대 20건으로제한
+
+    Q. 플러스 데이터 요청 사용 제한에 대해 알고 싶습니다.
+    http://money2.daishin.com/e5/mboard/ptype_accordion/plusFAQ/DW_Basic_List.aspx?boardseq=298&m=9508&p=8835&v=8640
+    """
+
+    def __init__(self):
+        super().__init__(15, 20)
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/daishin_cybos_plus/proxy/CybosPlusEntrypointProxy.html b/_modules/koapy/backend/daishin_cybos_plus/proxy/CybosPlusEntrypointProxy.html new file mode 100644 index 00000000..ca044a81 --- /dev/null +++ b/_modules/koapy/backend/daishin_cybos_plus/proxy/CybosPlusEntrypointProxy.html @@ -0,0 +1,302 @@ + + + + + + + + koapy.backend.daishin_cybos_plus.proxy.CybosPlusEntrypointProxy — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.daishin_cybos_plus.proxy.CybosPlusEntrypointProxy

+import threading
+
+import grpc
+
+from requests.structures import CaseInsensitiveDict
+
+from koapy.backend.daishin_cybos_plus.core.CybosPlusEntrypointMixin import (
+    CybosPlusEntrypointMixin,
+)
+from koapy.backend.daishin_cybos_plus.proxy import (
+    CybosPlusProxyService_pb2,
+    CybosPlusProxyService_pb2_grpc,
+)
+from koapy.backend.daishin_cybos_plus.proxy.CybosPlusProxyServiceMessageUtils import (
+    AssignPrimitive,
+    ExtractPrimitive,
+)
+from koapy.utils.logging.Logging import Logging
+
+
+[docs]class CybosPlusDispatchProxyMethod:
+    def __init__(self, proxy, name):
+        self._proxy = proxy
+        self._name = name
+
+    def __call__(self, *args, **kwargs):
+        return self._proxy._InvokeMethod(self._name, args)
+
+
+[docs]class CybosPlusDispatchProxy(Logging):
+    def __init__(self, proxy, progid):
+        self._proxy = proxy
+        self._progid = progid
+
+        self._is_trade_related = self._progid.startswith("CpTrade.")
+
+        request = CybosPlusProxyService_pb2.DispatchRequest()
+        request.prog = self._progid
+
+        self._dispatch = self._proxy._stub.Dispatch(request)
+
+    def _GetProperty(self, name):
+        request = CybosPlusProxyService_pb2.PropertyRequest()
+        request.prog = self._progid
+        request.name = name
+        should_stop = False
+        while not should_stop:
+            # pylint: disable=protected-access
+            response_future = self._proxy._stub.Property.future(
+                request, timeout=self._proxy._timeout
+            )
+            try:
+                response = response_future.result()
+            except grpc.RpcError:
+                if response_future.code() == grpc.StatusCode.DEADLINE_EXCEEDED:
+                    self.logger.warning("Property %s lookup failed, retrying...", name)
+                else:
+                    raise
+            else:
+                should_stop = True
+        result = ExtractPrimitive(response.value)
+        return result
+
+    def _InvokeMethod(self, name, args):
+        request = CybosPlusProxyService_pb2.MethodRequest()
+        request.prog = self._progid
+        request.name = name
+        for arg in args:
+            AssignPrimitive(request.arguments.add().value, arg)
+        should_stop = False
+        while not should_stop:
+            # pylint: disable=protected-access
+            response_future = self._proxy._stub.Method.future(
+                request, timeout=self._proxy._timeout
+            )
+            try:
+                response = response_future.result()
+            except grpc.RpcError:
+                if response_future.code() == grpc.StatusCode.DEADLINE_EXCEEDED:
+                    self.logger.warning(
+                        "Method invocation %s(%s) timed out, retrying...",
+                        name,
+                        ", ".join(map(repr, args)),
+                    )
+                else:
+                    raise
+            else:
+                should_stop = True
+        result = ExtractPrimitive(response.return_value)
+        return result
+
+    def __getattr__(self, name):
+        if name in self._dispatch.properties:
+            return self._GetProperty(name)
+        elif name in self._dispatch.methods:
+            return CybosPlusDispatchProxyMethod(self, name)
+        else:
+            raise AttributeError
+
+
+[docs]class CybosPlusIncompleteProgIDProxy:
+    def __init__(self, proxy, prefix):
+        self._proxy = proxy
+        self._prefix = prefix
+
+        self._cache = {}
+        self._lock = threading.RLock()
+
+    def __getattr__(self, name):
+        if name not in self._cache:
+            with self._lock:
+                if name not in self._cache:
+                    progid = "{}.{}".format(self._prefix, name)
+                    self._cache[name] = CybosPlusDispatchProxy(self._proxy, progid)
+        return self._cache[name]
+
+
+[docs]class CybosPlusEntrypointProxy(CybosPlusEntrypointMixin):
+    def __init__(self, host=None, port=None):
+        if host is None:
+            host = "localhost"
+        if port is None:
+            port = 3031
+
+        self._host = host
+        self._port = port
+
+        self._address = self._host + ":" + str(self._port)
+        self._channel = grpc.insecure_channel(self._address)
+        self._stub = CybosPlusProxyService_pb2_grpc.CybosPlusProxyServiceStub(
+            self._channel
+        )
+
+        self._timeout = 10
+
+        grpc.channel_ready_future(self._channel).result(timeout=5)
+
+        self._attribute_mapping = {
+            "CpDib": "DsCbo1",
+            "CpSysDib": "CpSysDib",
+            "CpTrade": "CpTrade",
+            "CpUtil": "CpUtil",
+            "DsCbo1": "DsCbo1",
+        }
+        self._attribute_mapping = CaseInsensitiveDict(self._attribute_mapping)
+
+        self._cache = {}
+        self._lock = threading.RLock()
+
+    def __getattr__(self, name):
+        if name not in self._attribute_mapping:
+            raise AttributeError(
+                "'{}' object has no attribute '{}'".format(type(self), name)
+            )
+        name = self._attribute_mapping[name]
+        if name not in self._cache:
+            with self._lock:
+                if name not in self._cache:
+                    self._cache[name] = CybosPlusIncompleteProgIDProxy(self, name)
+        return self._cache[name]
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/daishin_cybos_plus/proxy/CybosPlusProxyService.html b/_modules/koapy/backend/daishin_cybos_plus/proxy/CybosPlusProxyService.html new file mode 100644 index 00000000..95901cb1 --- /dev/null +++ b/_modules/koapy/backend/daishin_cybos_plus/proxy/CybosPlusProxyService.html @@ -0,0 +1,188 @@ + + + + + + + + koapy.backend.daishin_cybos_plus.proxy.CybosPlusProxyService — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.daishin_cybos_plus.proxy.CybosPlusProxyService

+from concurrent.futures import ThreadPoolExecutor
+
+import grpc
+
+from koapy.backend.daishin_cybos_plus.proxy import CybosPlusProxyService_pb2_grpc
+from koapy.backend.daishin_cybos_plus.proxy.CybosPlusProxyServiceServicer import (
+    CybosPlusProxyServiceServicer,
+)
+
+
+[docs]class CybosPlusProxyService:
+    def __init__(self, host=None, port=None, max_workers=None):
+        if host is None:
+            host = "localhost"
+        if port is None:
+            port = 3031
+
+        if max_workers is None:
+            max_workers = None
+
+        self._host = host
+        self._port = port
+        self._max_workers = max_workers
+
+        self._address = self._host + ":" + str(self._port)
+        self._servicer = CybosPlusProxyServiceServicer()
+        self._executor = ThreadPoolExecutor(max_workers=self._max_workers)
+
+        self._server = grpc.server(self._executor)
+        CybosPlusProxyService_pb2_grpc.add_CybosPlusProxyServiceServicer_to_server(
+            self._servicer, self._server
+        )
+        self._server.add_insecure_port(self._address)
+
+    def __getattr__(self, name):
+        return getattr(self._server, name)
+
+
+[docs]def main():
+    service = CybosPlusProxyService()
+    service.start()
+    service.wait_for_termination()
+
+
+if __name__ == "__main__":
+    main()
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/daishin_cybos_plus/proxy/CybosPlusProxyServiceMessageUtils.html b/_modules/koapy/backend/daishin_cybos_plus/proxy/CybosPlusProxyServiceMessageUtils.html new file mode 100644 index 00000000..18702d2a --- /dev/null +++ b/_modules/koapy/backend/daishin_cybos_plus/proxy/CybosPlusProxyServiceMessageUtils.html @@ -0,0 +1,205 @@ + + + + + + + + koapy.backend.daishin_cybos_plus.proxy.CybosPlusProxyServiceMessageUtils — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.daishin_cybos_plus.proxy.CybosPlusProxyServiceMessageUtils

+import os
+import subprocess
+
+
+[docs]def AssignPrimitive(message, value):
+    if value is None:
+        pass
+    elif isinstance(value, str):
+        message.string_value = value
+    elif isinstance(value, int):
+        message.long_value = value
+    elif isinstance(value, bool):
+        message.bool_value = value
+    elif isinstance(value, float):
+        message.float_value = value
+    elif isinstance(value, list):
+        for item in value:
+            AssignPrimitive(message.list_value.values.add(), item)
+    elif isinstance(value, tuple):
+        for item in value:
+            AssignPrimitive(message.tuple_value.values.add(), item)
+    else:
+        raise TypeError
+    return message
+
+
+[docs]def ExtractPrimitive(message):
+    if message.HasField("string_value"):
+        return message.string_value
+    elif message.HasField("long_value"):
+        return message.long_value
+    elif message.HasField("bool_value"):
+        return message.bool_value
+    elif message.HasField("float_value"):
+        return message.float_value
+    elif message.HasField("list_value"):
+        return list(ExtractPrimitive(value) for value in message.list_value.values)
+    elif message.HasField("tuple_value"):
+        return tuple(ExtractPrimitive(value) for value in message.tuple_value.values)
+
+
+[docs]def Protoc():
+    proto_filename = "CybosPlusProxyService.proto"
+    proto_filedir = os.path.dirname(os.path.realpath(__file__))
+    project_dir = os.path.realpath(os.path.join(proto_filedir, "../../.."))
+    proto_path = project_dir
+    python_out = project_dir
+    grpc_python_out = python_out
+    proto_filepath = os.path.join(proto_filedir, proto_filename)
+    cmd = [
+        "python",
+        "-m",
+        "grpc_tools.protoc",
+        "--proto_path=%s" % proto_path,
+        "--python_out=%s" % python_out,
+        "--grpc_python_out=%s" % grpc_python_out,
+        proto_filepath,
+    ]
+    _ = subprocess.run(cmd, cwd=project_dir, check=True)
+
+
+if __name__ == "__main__":
+    Protoc()
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/daishin_cybos_plus/proxy/CybosPlusProxyServiceServicer.html b/_modules/koapy/backend/daishin_cybos_plus/proxy/CybosPlusProxyServiceServicer.html new file mode 100644 index 00000000..e368faf6 --- /dev/null +++ b/_modules/koapy/backend/daishin_cybos_plus/proxy/CybosPlusProxyServiceServicer.html @@ -0,0 +1,307 @@ + + + + + + + + koapy.backend.daishin_cybos_plus.proxy.CybosPlusProxyServiceServicer — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.daishin_cybos_plus.proxy.CybosPlusProxyServiceServicer

+import queue
+import threading
+
+import pythoncom
+import win32com.client
+
+from koapy.backend.daishin_cybos_plus.proxy import (
+    CybosPlusProxyService_pb2,
+    CybosPlusProxyService_pb2_grpc,
+)
+from koapy.backend.daishin_cybos_plus.proxy.CybosPlusProxyServiceMessageUtils import (
+    AssignPrimitive,
+    ExtractPrimitive,
+)
+
+
+[docs]class CybosPlusEvent:
+    def __init__(self, iterator):
+        self._iterator = iterator
+        self._done = threading.Event()
+
+    def __del__(self):
+        self.done()
+
+[docs]    def done(self):
+        self._done.set()
+        self._iterator._events.task_done()  # pylint: disable=protected-access
+
+[docs]    def wait_for_done(self):
+        self._done.wait()
+
+
+[docs]class CybosPlusEventIterator:
+    def __init__(self, handler):
+        self._handler = handler
+        self._events = queue.Queue()
+        self._sentinel = object()
+        self._invalid = False
+        with self._handler._lock:
+            self._handler._iterators.append(self)
+
+    def __del__(self):
+        self._invalid = True
+        self._events.put(self._sentinel)
+        with self._handler._lock:
+            if self in self._handler._iterators:
+                self._handler._iterators.remove(self)
+
+[docs]    def notify(self):
+        if not self._invalid:
+            event = CybosPlusEvent(self)
+            self._events.put(event)
+            return event
+        else:
+            raise ValueError
+
+    def __next__(self):
+        if self._invalid:
+            raise StopIteration
+        event = self._events.get()
+        if event is self._sentinel:
+            raise StopIteration
+        return event
+
+
+[docs]class CybosPlusEventHandler:
+    def __init__(self):
+        self._lock = threading.RLock()
+        self._iterators = []
+
+[docs]    def OnRecieved(self):
+        with self._lock:
+            events = [iterator.notify() for iterator in self._iterators]
+        for event in events:
+            event.wait_for_done()
+
+    def __iter__(self):
+        return CybosPlusEventIterator(self)
+
+
+[docs]class CybosPlusProxyServiceServicer(
+    CybosPlusProxyService_pb2_grpc.CybosPlusProxyServiceServicer
+):
+
+    _lock = threading.RLock()
+
+    _dispatches = {}
+    _handlers = {}
+
+    def _EnsureDispatch(self, prog):
+        if prog not in self._dispatches:
+            with self._lock:
+                if prog not in self._dispatches:
+                    pythoncom.CoInitialize()  # pylint: disable=no-member
+                    dispatch = win32com.client.gencache.EnsureDispatch(prog)
+                    self._dispatches[prog] = dispatch
+                    if False:  # TODO: 이벤트 처리 관련해서 아직 개발하지 못함
+                        handler = win32com.client.WithEvents(
+                            dispatch, CybosPlusEventHandler
+                        )
+                        self._handlers[prog] = handler
+        dispatch = self._dispatches[prog]
+        return dispatch
+
+    def _GetHandler(self, prog):
+        handler = None
+        _ = self._EnsureDispatch(prog)
+        if prog in self._handlers:
+            handler = self._handlers[prog]
+        return handler
+
+[docs]    def Dispatch(self, request, context):
+        prog = request.prog
+        dispatch = self._EnsureDispatch(prog)
+        # pylint: disable=protected-access
+        properties = [p for p in dispatch._prop_map_get_.keys()]
+        methods = [
+            m
+            for m in dir(dispatch)
+            if not m.startswith("_") and m not in ["CLSID", "coclass_clsid"]
+        ]
+        response = CybosPlusProxyService_pb2.DispatchResponse()
+        response.prog = prog
+        response.properties.extend(properties)  # pylint: disable=no-member
+        response.methods.extend(methods)  # pylint: disable=no-member
+        return response
+
+[docs]    def Property(self, request, context):
+        prog = request.prog
+        dispatch = self._EnsureDispatch(prog)
+        name = request.name
+        value = getattr(dispatch, name)
+        response = CybosPlusProxyService_pb2.PropertyResponse()
+        AssignPrimitive(response.value, value)  # pylint: disable=no-member
+        return response
+
+[docs]    def Method(self, request, context):
+        prog = request.prog
+        dispatch = self._EnsureDispatch(prog)
+        name = request.name
+        method = getattr(dispatch, name)
+        arguments = [ExtractPrimitive(arg.value) for arg in request.arguments]
+        return_value = method(*arguments)
+        response = CybosPlusProxyService_pb2.MethodResponse()
+        AssignPrimitive(
+            response.return_value, return_value
+        )  # pylint: disable=no-member
+        return response
+
+[docs]    def Event(self, request_iterator, context):
+        start_request = next(request_iterator)
+        assert start_request.HasField("start")
+        prog = start_request.start.prog
+        handler = self._GetHandler(prog)
+        response = CybosPlusProxyService_pb2.EventResponse()
+        response.started  # pylint: disable=no-member,pointless-statement
+        yield response
+        for event in handler:
+            response = CybosPlusProxyService_pb2.EventResponse()
+            response.fired  # pylint: disable=no-member,pointless-statement
+            yield response
+            done_request = next(request_iterator)
+            event.done()
+            if done_request.HasField("stop"):
+                break
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/daishin_cybos_plus/proxy/CybosPlusProxyService_pb2.html b/_modules/koapy/backend/daishin_cybos_plus/proxy/CybosPlusProxyService_pb2.html new file mode 100644 index 00000000..8309c520 --- /dev/null +++ b/_modules/koapy/backend/daishin_cybos_plus/proxy/CybosPlusProxyService_pb2.html @@ -0,0 +1,1358 @@ + + + + + + + + koapy.backend.daishin_cybos_plus.proxy.CybosPlusProxyService_pb2 — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.daishin_cybos_plus.proxy.CybosPlusProxyService_pb2

+# -*- coding: utf-8 -*-
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: koapy/backend/cybos/CybosPlusProxyService.proto
+"""Generated protocol buffer code."""
+from google.protobuf import descriptor as _descriptor
+from google.protobuf import message as _message
+from google.protobuf import reflection as _reflection
+from google.protobuf import symbol_database as _symbol_database
+
+# @@protoc_insertion_point(imports)
+
+_sym_db = _symbol_database.Default()
+
+
+[docs]DESCRIPTOR = _descriptor.FileDescriptor(
+    name="koapy/backend/cybos/CybosPlusProxyService.proto",
+    package="",
+    syntax="proto3",
+    serialized_options=None,
+    create_key=_descriptor._internal_create_key,
+    serialized_pb=b'\n/koapy/backend/cybos/CybosPlusProxyService.proto"\x1f\n\x0f\x44ispatchRequest\x12\x0c\n\x04prog\x18\x01 \x01(\t"Q\n\x10\x44ispatchResponse\x12\x0c\n\x04prog\x18\x01 \x01(\t\x12\x12\n\nproperties\x18\x02 \x03(\t\x12\x0f\n\x07methods\x18\x03 \x03(\t\x12\n\n\x02id\x18\x04 \x01(\t"-\n\x0fPropertyRequest\x12\x0c\n\x04prog\x18\x01 \x01(\t\x12\x0c\n\x04name\x18\x02 \x01(\t"6\n\x13PrimitiveValueArray\x12\x1f\n\x06values\x18\x01 \x03(\x0b\x32\x0f.PrimitiveValue"\xcd\x01\n\x0ePrimitiveValue\x12\x16\n\x0cstring_value\x18\x01 \x01(\tH\x00\x12\x14\n\nlong_value\x18\x02 \x01(\x03H\x00\x12\x14\n\nbool_value\x18\x03 \x01(\x08H\x00\x12\x15\n\x0b\x66loat_value\x18\x04 \x01(\x01H\x00\x12*\n\nlist_value\x18\x05 \x01(\x0b\x32\x14.PrimitiveValueArrayH\x00\x12+\n\x0btuple_value\x18\x06 \x01(\x0b\x32\x14.PrimitiveValueArrayH\x00\x42\x07\n\x05value"2\n\x10PropertyResponse\x12\x1e\n\x05value\x18\x01 \x01(\x0b\x32\x0f.PrimitiveValue"*\n\x08\x41rgument\x12\x1e\n\x05value\x18\x01 \x01(\x0b\x32\x0f.PrimitiveValue"I\n\rMethodRequest\x12\x0c\n\x04prog\x18\x01 \x01(\t\x12\x0c\n\x04name\x18\x02 \x01(\t\x12\x1c\n\targuments\x18\x03 \x03(\x0b\x32\t.Argument"7\n\x0eMethodResponse\x12%\n\x0creturn_value\x18\x01 \x01(\x0b\x32\x0f.PrimitiveValue"!\n\x11\x45ventStartRequest\x12\x0c\n\x04prog\x18\x01 \x01(\t"9\n\x10\x45ventDoneRequest\x12%\n\x0creturn_value\x18\x01 \x01(\x0b\x32\x0f.PrimitiveValue"\x12\n\x10\x45ventStopRequest"s\n\x0c\x45ventRequest\x12!\n\x05start\x18\x01 \x01(\x0b\x32\x12.EventStartRequest\x12\x1f\n\x04\x64one\x18\x02 \x01(\x0b\x32\x11.EventDoneRequest\x12\x1f\n\x04stop\x18\x03 \x01(\x0b\x32\x11.EventStopRequest"\x16\n\x14\x45ventStartedResponse"\x14\n\x12\x45ventFiredResponse"k\n\rEventResponse\x12(\n\x07started\x18\x01 \x01(\x0b\x32\x15.EventStartedResponseH\x00\x12$\n\x05\x66ired\x18\x02 \x01(\x0b\x32\x13.EventFiredResponseH\x00\x42\n\n\x08response2\xd8\x01\n\x15\x43ybosPlusProxyService\x12\x31\n\x08\x44ispatch\x12\x10.DispatchRequest\x1a\x11.DispatchResponse"\x00\x12\x31\n\x08Property\x12\x10.PropertyRequest\x1a\x11.PropertyResponse"\x00\x12+\n\x06Method\x12\x0e.MethodRequest\x1a\x0f.MethodResponse"\x00\x12,\n\x05\x45vent\x12\r.EventRequest\x1a\x0e.EventResponse"\x00(\x01\x30\x01\x62\x06proto3',
+)
+
+
+_DISPATCHREQUEST = _descriptor.Descriptor(
+    name="DispatchRequest",
+    full_name="DispatchRequest",
+    filename=None,
+    file=DESCRIPTOR,
+    containing_type=None,
+    create_key=_descriptor._internal_create_key,
+    fields=[
+        _descriptor.FieldDescriptor(
+            name="prog",
+            full_name="DispatchRequest.prog",
+            index=0,
+            number=1,
+            type=9,
+            cpp_type=9,
+            label=1,
+            has_default_value=False,
+            default_value=b"".decode("utf-8"),
+            message_type=None,
+            enum_type=None,
+            containing_type=None,
+            is_extension=False,
+            extension_scope=None,
+            serialized_options=None,
+            file=DESCRIPTOR,
+            create_key=_descriptor._internal_create_key,
+        ),
+    ],
+    extensions=[],
+    nested_types=[],
+    enum_types=[],
+    serialized_options=None,
+    is_extendable=False,
+    syntax="proto3",
+    extension_ranges=[],
+    oneofs=[],
+    serialized_start=51,
+    serialized_end=82,
+)
+
+
+_DISPATCHRESPONSE = _descriptor.Descriptor(
+    name="DispatchResponse",
+    full_name="DispatchResponse",
+    filename=None,
+    file=DESCRIPTOR,
+    containing_type=None,
+    create_key=_descriptor._internal_create_key,
+    fields=[
+        _descriptor.FieldDescriptor(
+            name="prog",
+            full_name="DispatchResponse.prog",
+            index=0,
+            number=1,
+            type=9,
+            cpp_type=9,
+            label=1,
+            has_default_value=False,
+            default_value=b"".decode("utf-8"),
+            message_type=None,
+            enum_type=None,
+            containing_type=None,
+            is_extension=False,
+            extension_scope=None,
+            serialized_options=None,
+            file=DESCRIPTOR,
+            create_key=_descriptor._internal_create_key,
+        ),
+        _descriptor.FieldDescriptor(
+            name="properties",
+            full_name="DispatchResponse.properties",
+            index=1,
+            number=2,
+            type=9,
+            cpp_type=9,
+            label=3,
+            has_default_value=False,
+            default_value=[],
+            message_type=None,
+            enum_type=None,
+            containing_type=None,
+            is_extension=False,
+            extension_scope=None,
+            serialized_options=None,
+            file=DESCRIPTOR,
+            create_key=_descriptor._internal_create_key,
+        ),
+        _descriptor.FieldDescriptor(
+            name="methods",
+            full_name="DispatchResponse.methods",
+            index=2,
+            number=3,
+            type=9,
+            cpp_type=9,
+            label=3,
+            has_default_value=False,
+            default_value=[],
+            message_type=None,
+            enum_type=None,
+            containing_type=None,
+            is_extension=False,
+            extension_scope=None,
+            serialized_options=None,
+            file=DESCRIPTOR,
+            create_key=_descriptor._internal_create_key,
+        ),
+        _descriptor.FieldDescriptor(
+            name="id",
+            full_name="DispatchResponse.id",
+            index=3,
+            number=4,
+            type=9,
+            cpp_type=9,
+            label=1,
+            has_default_value=False,
+            default_value=b"".decode("utf-8"),
+            message_type=None,
+            enum_type=None,
+            containing_type=None,
+            is_extension=False,
+            extension_scope=None,
+            serialized_options=None,
+            file=DESCRIPTOR,
+            create_key=_descriptor._internal_create_key,
+        ),
+    ],
+    extensions=[],
+    nested_types=[],
+    enum_types=[],
+    serialized_options=None,
+    is_extendable=False,
+    syntax="proto3",
+    extension_ranges=[],
+    oneofs=[],
+    serialized_start=84,
+    serialized_end=165,
+)
+
+
+_PROPERTYREQUEST = _descriptor.Descriptor(
+    name="PropertyRequest",
+    full_name="PropertyRequest",
+    filename=None,
+    file=DESCRIPTOR,
+    containing_type=None,
+    create_key=_descriptor._internal_create_key,
+    fields=[
+        _descriptor.FieldDescriptor(
+            name="prog",
+            full_name="PropertyRequest.prog",
+            index=0,
+            number=1,
+            type=9,
+            cpp_type=9,
+            label=1,
+            has_default_value=False,
+            default_value=b"".decode("utf-8"),
+            message_type=None,
+            enum_type=None,
+            containing_type=None,
+            is_extension=False,
+            extension_scope=None,
+            serialized_options=None,
+            file=DESCRIPTOR,
+            create_key=_descriptor._internal_create_key,
+        ),
+        _descriptor.FieldDescriptor(
+            name="name",
+            full_name="PropertyRequest.name",
+            index=1,
+            number=2,
+            type=9,
+            cpp_type=9,
+            label=1,
+            has_default_value=False,
+            default_value=b"".decode("utf-8"),
+            message_type=None,
+            enum_type=None,
+            containing_type=None,
+            is_extension=False,
+            extension_scope=None,
+            serialized_options=None,
+            file=DESCRIPTOR,
+            create_key=_descriptor._internal_create_key,
+        ),
+    ],
+    extensions=[],
+    nested_types=[],
+    enum_types=[],
+    serialized_options=None,
+    is_extendable=False,
+    syntax="proto3",
+    extension_ranges=[],
+    oneofs=[],
+    serialized_start=167,
+    serialized_end=212,
+)
+
+
+_PRIMITIVEVALUEARRAY = _descriptor.Descriptor(
+    name="PrimitiveValueArray",
+    full_name="PrimitiveValueArray",
+    filename=None,
+    file=DESCRIPTOR,
+    containing_type=None,
+    create_key=_descriptor._internal_create_key,
+    fields=[
+        _descriptor.FieldDescriptor(
+            name="values",
+            full_name="PrimitiveValueArray.values",
+            index=0,
+            number=1,
+            type=11,
+            cpp_type=10,
+            label=3,
+            has_default_value=False,
+            default_value=[],
+            message_type=None,
+            enum_type=None,
+            containing_type=None,
+            is_extension=False,
+            extension_scope=None,
+            serialized_options=None,
+            file=DESCRIPTOR,
+            create_key=_descriptor._internal_create_key,
+        ),
+    ],
+    extensions=[],
+    nested_types=[],
+    enum_types=[],
+    serialized_options=None,
+    is_extendable=False,
+    syntax="proto3",
+    extension_ranges=[],
+    oneofs=[],
+    serialized_start=214,
+    serialized_end=268,
+)
+
+
+_PRIMITIVEVALUE = _descriptor.Descriptor(
+    name="PrimitiveValue",
+    full_name="PrimitiveValue",
+    filename=None,
+    file=DESCRIPTOR,
+    containing_type=None,
+    create_key=_descriptor._internal_create_key,
+    fields=[
+        _descriptor.FieldDescriptor(
+            name="string_value",
+            full_name="PrimitiveValue.string_value",
+            index=0,
+            number=1,
+            type=9,
+            cpp_type=9,
+            label=1,
+            has_default_value=False,
+            default_value=b"".decode("utf-8"),
+            message_type=None,
+            enum_type=None,
+            containing_type=None,
+            is_extension=False,
+            extension_scope=None,
+            serialized_options=None,
+            file=DESCRIPTOR,
+            create_key=_descriptor._internal_create_key,
+        ),
+        _descriptor.FieldDescriptor(
+            name="long_value",
+            full_name="PrimitiveValue.long_value",
+            index=1,
+            number=2,
+            type=3,
+            cpp_type=2,
+            label=1,
+            has_default_value=False,
+            default_value=0,
+            message_type=None,
+            enum_type=None,
+            containing_type=None,
+            is_extension=False,
+            extension_scope=None,
+            serialized_options=None,
+            file=DESCRIPTOR,
+            create_key=_descriptor._internal_create_key,
+        ),
+        _descriptor.FieldDescriptor(
+            name="bool_value",
+            full_name="PrimitiveValue.bool_value",
+            index=2,
+            number=3,
+            type=8,
+            cpp_type=7,
+            label=1,
+            has_default_value=False,
+            default_value=False,
+            message_type=None,
+            enum_type=None,
+            containing_type=None,
+            is_extension=False,
+            extension_scope=None,
+            serialized_options=None,
+            file=DESCRIPTOR,
+            create_key=_descriptor._internal_create_key,
+        ),
+        _descriptor.FieldDescriptor(
+            name="float_value",
+            full_name="PrimitiveValue.float_value",
+            index=3,
+            number=4,
+            type=1,
+            cpp_type=5,
+            label=1,
+            has_default_value=False,
+            default_value=float(0),
+            message_type=None,
+            enum_type=None,
+            containing_type=None,
+            is_extension=False,
+            extension_scope=None,
+            serialized_options=None,
+            file=DESCRIPTOR,
+            create_key=_descriptor._internal_create_key,
+        ),
+        _descriptor.FieldDescriptor(
+            name="list_value",
+            full_name="PrimitiveValue.list_value",
+            index=4,
+            number=5,
+            type=11,
+            cpp_type=10,
+            label=1,
+            has_default_value=False,
+            default_value=None,
+            message_type=None,
+            enum_type=None,
+            containing_type=None,
+            is_extension=False,
+            extension_scope=None,
+            serialized_options=None,
+            file=DESCRIPTOR,
+            create_key=_descriptor._internal_create_key,
+        ),
+        _descriptor.FieldDescriptor(
+            name="tuple_value",
+            full_name="PrimitiveValue.tuple_value",
+            index=5,
+            number=6,
+            type=11,
+            cpp_type=10,
+            label=1,
+            has_default_value=False,
+            default_value=None,
+            message_type=None,
+            enum_type=None,
+            containing_type=None,
+            is_extension=False,
+            extension_scope=None,
+            serialized_options=None,
+            file=DESCRIPTOR,
+            create_key=_descriptor._internal_create_key,
+        ),
+    ],
+    extensions=[],
+    nested_types=[],
+    enum_types=[],
+    serialized_options=None,
+    is_extendable=False,
+    syntax="proto3",
+    extension_ranges=[],
+    oneofs=[
+        _descriptor.OneofDescriptor(
+            name="value",
+            full_name="PrimitiveValue.value",
+            index=0,
+            containing_type=None,
+            create_key=_descriptor._internal_create_key,
+            fields=[],
+        ),
+    ],
+    serialized_start=271,
+    serialized_end=476,
+)
+
+
+_PROPERTYRESPONSE = _descriptor.Descriptor(
+    name="PropertyResponse",
+    full_name="PropertyResponse",
+    filename=None,
+    file=DESCRIPTOR,
+    containing_type=None,
+    create_key=_descriptor._internal_create_key,
+    fields=[
+        _descriptor.FieldDescriptor(
+            name="value",
+            full_name="PropertyResponse.value",
+            index=0,
+            number=1,
+            type=11,
+            cpp_type=10,
+            label=1,
+            has_default_value=False,
+            default_value=None,
+            message_type=None,
+            enum_type=None,
+            containing_type=None,
+            is_extension=False,
+            extension_scope=None,
+            serialized_options=None,
+            file=DESCRIPTOR,
+            create_key=_descriptor._internal_create_key,
+        ),
+    ],
+    extensions=[],
+    nested_types=[],
+    enum_types=[],
+    serialized_options=None,
+    is_extendable=False,
+    syntax="proto3",
+    extension_ranges=[],
+    oneofs=[],
+    serialized_start=478,
+    serialized_end=528,
+)
+
+
+_ARGUMENT = _descriptor.Descriptor(
+    name="Argument",
+    full_name="Argument",
+    filename=None,
+    file=DESCRIPTOR,
+    containing_type=None,
+    create_key=_descriptor._internal_create_key,
+    fields=[
+        _descriptor.FieldDescriptor(
+            name="value",
+            full_name="Argument.value",
+            index=0,
+            number=1,
+            type=11,
+            cpp_type=10,
+            label=1,
+            has_default_value=False,
+            default_value=None,
+            message_type=None,
+            enum_type=None,
+            containing_type=None,
+            is_extension=False,
+            extension_scope=None,
+            serialized_options=None,
+            file=DESCRIPTOR,
+            create_key=_descriptor._internal_create_key,
+        ),
+    ],
+    extensions=[],
+    nested_types=[],
+    enum_types=[],
+    serialized_options=None,
+    is_extendable=False,
+    syntax="proto3",
+    extension_ranges=[],
+    oneofs=[],
+    serialized_start=530,
+    serialized_end=572,
+)
+
+
+_METHODREQUEST = _descriptor.Descriptor(
+    name="MethodRequest",
+    full_name="MethodRequest",
+    filename=None,
+    file=DESCRIPTOR,
+    containing_type=None,
+    create_key=_descriptor._internal_create_key,
+    fields=[
+        _descriptor.FieldDescriptor(
+            name="prog",
+            full_name="MethodRequest.prog",
+            index=0,
+            number=1,
+            type=9,
+            cpp_type=9,
+            label=1,
+            has_default_value=False,
+            default_value=b"".decode("utf-8"),
+            message_type=None,
+            enum_type=None,
+            containing_type=None,
+            is_extension=False,
+            extension_scope=None,
+            serialized_options=None,
+            file=DESCRIPTOR,
+            create_key=_descriptor._internal_create_key,
+        ),
+        _descriptor.FieldDescriptor(
+            name="name",
+            full_name="MethodRequest.name",
+            index=1,
+            number=2,
+            type=9,
+            cpp_type=9,
+            label=1,
+            has_default_value=False,
+            default_value=b"".decode("utf-8"),
+            message_type=None,
+            enum_type=None,
+            containing_type=None,
+            is_extension=False,
+            extension_scope=None,
+            serialized_options=None,
+            file=DESCRIPTOR,
+            create_key=_descriptor._internal_create_key,
+        ),
+        _descriptor.FieldDescriptor(
+            name="arguments",
+            full_name="MethodRequest.arguments",
+            index=2,
+            number=3,
+            type=11,
+            cpp_type=10,
+            label=3,
+            has_default_value=False,
+            default_value=[],
+            message_type=None,
+            enum_type=None,
+            containing_type=None,
+            is_extension=False,
+            extension_scope=None,
+            serialized_options=None,
+            file=DESCRIPTOR,
+            create_key=_descriptor._internal_create_key,
+        ),
+    ],
+    extensions=[],
+    nested_types=[],
+    enum_types=[],
+    serialized_options=None,
+    is_extendable=False,
+    syntax="proto3",
+    extension_ranges=[],
+    oneofs=[],
+    serialized_start=574,
+    serialized_end=647,
+)
+
+
+_METHODRESPONSE = _descriptor.Descriptor(
+    name="MethodResponse",
+    full_name="MethodResponse",
+    filename=None,
+    file=DESCRIPTOR,
+    containing_type=None,
+    create_key=_descriptor._internal_create_key,
+    fields=[
+        _descriptor.FieldDescriptor(
+            name="return_value",
+            full_name="MethodResponse.return_value",
+            index=0,
+            number=1,
+            type=11,
+            cpp_type=10,
+            label=1,
+            has_default_value=False,
+            default_value=None,
+            message_type=None,
+            enum_type=None,
+            containing_type=None,
+            is_extension=False,
+            extension_scope=None,
+            serialized_options=None,
+            file=DESCRIPTOR,
+            create_key=_descriptor._internal_create_key,
+        ),
+    ],
+    extensions=[],
+    nested_types=[],
+    enum_types=[],
+    serialized_options=None,
+    is_extendable=False,
+    syntax="proto3",
+    extension_ranges=[],
+    oneofs=[],
+    serialized_start=649,
+    serialized_end=704,
+)
+
+
+_EVENTSTARTREQUEST = _descriptor.Descriptor(
+    name="EventStartRequest",
+    full_name="EventStartRequest",
+    filename=None,
+    file=DESCRIPTOR,
+    containing_type=None,
+    create_key=_descriptor._internal_create_key,
+    fields=[
+        _descriptor.FieldDescriptor(
+            name="prog",
+            full_name="EventStartRequest.prog",
+            index=0,
+            number=1,
+            type=9,
+            cpp_type=9,
+            label=1,
+            has_default_value=False,
+            default_value=b"".decode("utf-8"),
+            message_type=None,
+            enum_type=None,
+            containing_type=None,
+            is_extension=False,
+            extension_scope=None,
+            serialized_options=None,
+            file=DESCRIPTOR,
+            create_key=_descriptor._internal_create_key,
+        ),
+    ],
+    extensions=[],
+    nested_types=[],
+    enum_types=[],
+    serialized_options=None,
+    is_extendable=False,
+    syntax="proto3",
+    extension_ranges=[],
+    oneofs=[],
+    serialized_start=706,
+    serialized_end=739,
+)
+
+
+_EVENTDONEREQUEST = _descriptor.Descriptor(
+    name="EventDoneRequest",
+    full_name="EventDoneRequest",
+    filename=None,
+    file=DESCRIPTOR,
+    containing_type=None,
+    create_key=_descriptor._internal_create_key,
+    fields=[
+        _descriptor.FieldDescriptor(
+            name="return_value",
+            full_name="EventDoneRequest.return_value",
+            index=0,
+            number=1,
+            type=11,
+            cpp_type=10,
+            label=1,
+            has_default_value=False,
+            default_value=None,
+            message_type=None,
+            enum_type=None,
+            containing_type=None,
+            is_extension=False,
+            extension_scope=None,
+            serialized_options=None,
+            file=DESCRIPTOR,
+            create_key=_descriptor._internal_create_key,
+        ),
+    ],
+    extensions=[],
+    nested_types=[],
+    enum_types=[],
+    serialized_options=None,
+    is_extendable=False,
+    syntax="proto3",
+    extension_ranges=[],
+    oneofs=[],
+    serialized_start=741,
+    serialized_end=798,
+)
+
+
+_EVENTSTOPREQUEST = _descriptor.Descriptor(
+    name="EventStopRequest",
+    full_name="EventStopRequest",
+    filename=None,
+    file=DESCRIPTOR,
+    containing_type=None,
+    create_key=_descriptor._internal_create_key,
+    fields=[],
+    extensions=[],
+    nested_types=[],
+    enum_types=[],
+    serialized_options=None,
+    is_extendable=False,
+    syntax="proto3",
+    extension_ranges=[],
+    oneofs=[],
+    serialized_start=800,
+    serialized_end=818,
+)
+
+
+_EVENTREQUEST = _descriptor.Descriptor(
+    name="EventRequest",
+    full_name="EventRequest",
+    filename=None,
+    file=DESCRIPTOR,
+    containing_type=None,
+    create_key=_descriptor._internal_create_key,
+    fields=[
+        _descriptor.FieldDescriptor(
+            name="start",
+            full_name="EventRequest.start",
+            index=0,
+            number=1,
+            type=11,
+            cpp_type=10,
+            label=1,
+            has_default_value=False,
+            default_value=None,
+            message_type=None,
+            enum_type=None,
+            containing_type=None,
+            is_extension=False,
+            extension_scope=None,
+            serialized_options=None,
+            file=DESCRIPTOR,
+            create_key=_descriptor._internal_create_key,
+        ),
+        _descriptor.FieldDescriptor(
+            name="done",
+            full_name="EventRequest.done",
+            index=1,
+            number=2,
+            type=11,
+            cpp_type=10,
+            label=1,
+            has_default_value=False,
+            default_value=None,
+            message_type=None,
+            enum_type=None,
+            containing_type=None,
+            is_extension=False,
+            extension_scope=None,
+            serialized_options=None,
+            file=DESCRIPTOR,
+            create_key=_descriptor._internal_create_key,
+        ),
+        _descriptor.FieldDescriptor(
+            name="stop",
+            full_name="EventRequest.stop",
+            index=2,
+            number=3,
+            type=11,
+            cpp_type=10,
+            label=1,
+            has_default_value=False,
+            default_value=None,
+            message_type=None,
+            enum_type=None,
+            containing_type=None,
+            is_extension=False,
+            extension_scope=None,
+            serialized_options=None,
+            file=DESCRIPTOR,
+            create_key=_descriptor._internal_create_key,
+        ),
+    ],
+    extensions=[],
+    nested_types=[],
+    enum_types=[],
+    serialized_options=None,
+    is_extendable=False,
+    syntax="proto3",
+    extension_ranges=[],
+    oneofs=[],
+    serialized_start=820,
+    serialized_end=935,
+)
+
+
+_EVENTSTARTEDRESPONSE = _descriptor.Descriptor(
+    name="EventStartedResponse",
+    full_name="EventStartedResponse",
+    filename=None,
+    file=DESCRIPTOR,
+    containing_type=None,
+    create_key=_descriptor._internal_create_key,
+    fields=[],
+    extensions=[],
+    nested_types=[],
+    enum_types=[],
+    serialized_options=None,
+    is_extendable=False,
+    syntax="proto3",
+    extension_ranges=[],
+    oneofs=[],
+    serialized_start=937,
+    serialized_end=959,
+)
+
+
+_EVENTFIREDRESPONSE = _descriptor.Descriptor(
+    name="EventFiredResponse",
+    full_name="EventFiredResponse",
+    filename=None,
+    file=DESCRIPTOR,
+    containing_type=None,
+    create_key=_descriptor._internal_create_key,
+    fields=[],
+    extensions=[],
+    nested_types=[],
+    enum_types=[],
+    serialized_options=None,
+    is_extendable=False,
+    syntax="proto3",
+    extension_ranges=[],
+    oneofs=[],
+    serialized_start=961,
+    serialized_end=981,
+)
+
+
+_EVENTRESPONSE = _descriptor.Descriptor(
+    name="EventResponse",
+    full_name="EventResponse",
+    filename=None,
+    file=DESCRIPTOR,
+    containing_type=None,
+    create_key=_descriptor._internal_create_key,
+    fields=[
+        _descriptor.FieldDescriptor(
+            name="started",
+            full_name="EventResponse.started",
+            index=0,
+            number=1,
+            type=11,
+            cpp_type=10,
+            label=1,
+            has_default_value=False,
+            default_value=None,
+            message_type=None,
+            enum_type=None,
+            containing_type=None,
+            is_extension=False,
+            extension_scope=None,
+            serialized_options=None,
+            file=DESCRIPTOR,
+            create_key=_descriptor._internal_create_key,
+        ),
+        _descriptor.FieldDescriptor(
+            name="fired",
+            full_name="EventResponse.fired",
+            index=1,
+            number=2,
+            type=11,
+            cpp_type=10,
+            label=1,
+            has_default_value=False,
+            default_value=None,
+            message_type=None,
+            enum_type=None,
+            containing_type=None,
+            is_extension=False,
+            extension_scope=None,
+            serialized_options=None,
+            file=DESCRIPTOR,
+            create_key=_descriptor._internal_create_key,
+        ),
+    ],
+    extensions=[],
+    nested_types=[],
+    enum_types=[],
+    serialized_options=None,
+    is_extendable=False,
+    syntax="proto3",
+    extension_ranges=[],
+    oneofs=[
+        _descriptor.OneofDescriptor(
+            name="response",
+            full_name="EventResponse.response",
+            index=0,
+            containing_type=None,
+            create_key=_descriptor._internal_create_key,
+            fields=[],
+        ),
+    ],
+    serialized_start=983,
+    serialized_end=1090,
+)
+
+_PRIMITIVEVALUEARRAY.fields_by_name["values"].message_type = _PRIMITIVEVALUE
+_PRIMITIVEVALUE.fields_by_name["list_value"].message_type = _PRIMITIVEVALUEARRAY
+_PRIMITIVEVALUE.fields_by_name["tuple_value"].message_type = _PRIMITIVEVALUEARRAY
+_PRIMITIVEVALUE.oneofs_by_name["value"].fields.append(
+    _PRIMITIVEVALUE.fields_by_name["string_value"]
+)
+_PRIMITIVEVALUE.fields_by_name[
+    "string_value"
+].containing_oneof = _PRIMITIVEVALUE.oneofs_by_name["value"]
+_PRIMITIVEVALUE.oneofs_by_name["value"].fields.append(
+    _PRIMITIVEVALUE.fields_by_name["long_value"]
+)
+_PRIMITIVEVALUE.fields_by_name[
+    "long_value"
+].containing_oneof = _PRIMITIVEVALUE.oneofs_by_name["value"]
+_PRIMITIVEVALUE.oneofs_by_name["value"].fields.append(
+    _PRIMITIVEVALUE.fields_by_name["bool_value"]
+)
+_PRIMITIVEVALUE.fields_by_name[
+    "bool_value"
+].containing_oneof = _PRIMITIVEVALUE.oneofs_by_name["value"]
+_PRIMITIVEVALUE.oneofs_by_name["value"].fields.append(
+    _PRIMITIVEVALUE.fields_by_name["float_value"]
+)
+_PRIMITIVEVALUE.fields_by_name[
+    "float_value"
+].containing_oneof = _PRIMITIVEVALUE.oneofs_by_name["value"]
+_PRIMITIVEVALUE.oneofs_by_name["value"].fields.append(
+    _PRIMITIVEVALUE.fields_by_name["list_value"]
+)
+_PRIMITIVEVALUE.fields_by_name[
+    "list_value"
+].containing_oneof = _PRIMITIVEVALUE.oneofs_by_name["value"]
+_PRIMITIVEVALUE.oneofs_by_name["value"].fields.append(
+    _PRIMITIVEVALUE.fields_by_name["tuple_value"]
+)
+_PRIMITIVEVALUE.fields_by_name[
+    "tuple_value"
+].containing_oneof = _PRIMITIVEVALUE.oneofs_by_name["value"]
+_PROPERTYRESPONSE.fields_by_name["value"].message_type = _PRIMITIVEVALUE
+_ARGUMENT.fields_by_name["value"].message_type = _PRIMITIVEVALUE
+_METHODREQUEST.fields_by_name["arguments"].message_type = _ARGUMENT
+_METHODRESPONSE.fields_by_name["return_value"].message_type = _PRIMITIVEVALUE
+_EVENTDONEREQUEST.fields_by_name["return_value"].message_type = _PRIMITIVEVALUE
+_EVENTREQUEST.fields_by_name["start"].message_type = _EVENTSTARTREQUEST
+_EVENTREQUEST.fields_by_name["done"].message_type = _EVENTDONEREQUEST
+_EVENTREQUEST.fields_by_name["stop"].message_type = _EVENTSTOPREQUEST
+_EVENTRESPONSE.fields_by_name["started"].message_type = _EVENTSTARTEDRESPONSE
+[docs]_EVENTRESPONSE.fields_by_name["fired"].message_type = _EVENTFIREDRESPONSE
+_EVENTRESPONSE.oneofs_by_name["response"].fields.append(
+    _EVENTRESPONSE.fields_by_name["started"]
+)
+_EVENTRESPONSE.fields_by_name[
+    "started"
+].containing_oneof = _EVENTRESPONSE.oneofs_by_name["response"]
+_EVENTRESPONSE.oneofs_by_name["response"].fields.append(
+    _EVENTRESPONSE.fields_by_name["fired"]
+)
+[docs]_EVENTRESPONSE.fields_by_name["fired"].containing_oneof = _EVENTRESPONSE.oneofs_by_name[
+    "response"
+]
+DESCRIPTOR.message_types_by_name["DispatchRequest"] = _DISPATCHREQUEST
+DESCRIPTOR.message_types_by_name["DispatchResponse"] = _DISPATCHRESPONSE
+DESCRIPTOR.message_types_by_name["PropertyRequest"] = _PROPERTYREQUEST
+DESCRIPTOR.message_types_by_name["PrimitiveValueArray"] = _PRIMITIVEVALUEARRAY
+DESCRIPTOR.message_types_by_name["PrimitiveValue"] = _PRIMITIVEVALUE
+DESCRIPTOR.message_types_by_name["PropertyResponse"] = _PROPERTYRESPONSE
+DESCRIPTOR.message_types_by_name["Argument"] = _ARGUMENT
+DESCRIPTOR.message_types_by_name["MethodRequest"] = _METHODREQUEST
+DESCRIPTOR.message_types_by_name["MethodResponse"] = _METHODRESPONSE
+DESCRIPTOR.message_types_by_name["EventStartRequest"] = _EVENTSTARTREQUEST
+DESCRIPTOR.message_types_by_name["EventDoneRequest"] = _EVENTDONEREQUEST
+DESCRIPTOR.message_types_by_name["EventStopRequest"] = _EVENTSTOPREQUEST
+DESCRIPTOR.message_types_by_name["EventRequest"] = _EVENTREQUEST
+DESCRIPTOR.message_types_by_name["EventStartedResponse"] = _EVENTSTARTEDRESPONSE
+DESCRIPTOR.message_types_by_name["EventFiredResponse"] = _EVENTFIREDRESPONSE
+DESCRIPTOR.message_types_by_name["EventResponse"] = _EVENTRESPONSE
+_sym_db.RegisterFileDescriptor(DESCRIPTOR)
+
+[docs]DispatchRequest = _reflection.GeneratedProtocolMessageType(
+    "DispatchRequest",
+    (_message.Message,),
+    {
+        "DESCRIPTOR": _DISPATCHREQUEST,
+        "__module__": "koapy.backend.cybos.CybosPlusProxyService_pb2"
+        # @@protoc_insertion_point(class_scope:DispatchRequest)
+    },
+)
+_sym_db.RegisterMessage(DispatchRequest)
+
+[docs]DispatchResponse = _reflection.GeneratedProtocolMessageType(
+    "DispatchResponse",
+    (_message.Message,),
+    {
+        "DESCRIPTOR": _DISPATCHRESPONSE,
+        "__module__": "koapy.backend.cybos.CybosPlusProxyService_pb2"
+        # @@protoc_insertion_point(class_scope:DispatchResponse)
+    },
+)
+_sym_db.RegisterMessage(DispatchResponse)
+
+[docs]PropertyRequest = _reflection.GeneratedProtocolMessageType(
+    "PropertyRequest",
+    (_message.Message,),
+    {
+        "DESCRIPTOR": _PROPERTYREQUEST,
+        "__module__": "koapy.backend.cybos.CybosPlusProxyService_pb2"
+        # @@protoc_insertion_point(class_scope:PropertyRequest)
+    },
+)
+_sym_db.RegisterMessage(PropertyRequest)
+
+[docs]PrimitiveValueArray = _reflection.GeneratedProtocolMessageType(
+    "PrimitiveValueArray",
+    (_message.Message,),
+    {
+        "DESCRIPTOR": _PRIMITIVEVALUEARRAY,
+        "__module__": "koapy.backend.cybos.CybosPlusProxyService_pb2"
+        # @@protoc_insertion_point(class_scope:PrimitiveValueArray)
+    },
+)
+_sym_db.RegisterMessage(PrimitiveValueArray)
+
+[docs]PrimitiveValue = _reflection.GeneratedProtocolMessageType(
+    "PrimitiveValue",
+    (_message.Message,),
+    {
+        "DESCRIPTOR": _PRIMITIVEVALUE,
+        "__module__": "koapy.backend.cybos.CybosPlusProxyService_pb2"
+        # @@protoc_insertion_point(class_scope:PrimitiveValue)
+    },
+)
+_sym_db.RegisterMessage(PrimitiveValue)
+
+[docs]PropertyResponse = _reflection.GeneratedProtocolMessageType(
+    "PropertyResponse",
+    (_message.Message,),
+    {
+        "DESCRIPTOR": _PROPERTYRESPONSE,
+        "__module__": "koapy.backend.cybos.CybosPlusProxyService_pb2"
+        # @@protoc_insertion_point(class_scope:PropertyResponse)
+    },
+)
+_sym_db.RegisterMessage(PropertyResponse)
+
+[docs]Argument = _reflection.GeneratedProtocolMessageType(
+    "Argument",
+    (_message.Message,),
+    {
+        "DESCRIPTOR": _ARGUMENT,
+        "__module__": "koapy.backend.cybos.CybosPlusProxyService_pb2"
+        # @@protoc_insertion_point(class_scope:Argument)
+    },
+)
+_sym_db.RegisterMessage(Argument)
+
+[docs]MethodRequest = _reflection.GeneratedProtocolMessageType(
+    "MethodRequest",
+    (_message.Message,),
+    {
+        "DESCRIPTOR": _METHODREQUEST,
+        "__module__": "koapy.backend.cybos.CybosPlusProxyService_pb2"
+        # @@protoc_insertion_point(class_scope:MethodRequest)
+    },
+)
+_sym_db.RegisterMessage(MethodRequest)
+
+[docs]MethodResponse = _reflection.GeneratedProtocolMessageType(
+    "MethodResponse",
+    (_message.Message,),
+    {
+        "DESCRIPTOR": _METHODRESPONSE,
+        "__module__": "koapy.backend.cybos.CybosPlusProxyService_pb2"
+        # @@protoc_insertion_point(class_scope:MethodResponse)
+    },
+)
+_sym_db.RegisterMessage(MethodResponse)
+
+[docs]EventStartRequest = _reflection.GeneratedProtocolMessageType(
+    "EventStartRequest",
+    (_message.Message,),
+    {
+        "DESCRIPTOR": _EVENTSTARTREQUEST,
+        "__module__": "koapy.backend.cybos.CybosPlusProxyService_pb2"
+        # @@protoc_insertion_point(class_scope:EventStartRequest)
+    },
+)
+_sym_db.RegisterMessage(EventStartRequest)
+
+[docs]EventDoneRequest = _reflection.GeneratedProtocolMessageType(
+    "EventDoneRequest",
+    (_message.Message,),
+    {
+        "DESCRIPTOR": _EVENTDONEREQUEST,
+        "__module__": "koapy.backend.cybos.CybosPlusProxyService_pb2"
+        # @@protoc_insertion_point(class_scope:EventDoneRequest)
+    },
+)
+_sym_db.RegisterMessage(EventDoneRequest)
+
+[docs]EventStopRequest = _reflection.GeneratedProtocolMessageType(
+    "EventStopRequest",
+    (_message.Message,),
+    {
+        "DESCRIPTOR": _EVENTSTOPREQUEST,
+        "__module__": "koapy.backend.cybos.CybosPlusProxyService_pb2"
+        # @@protoc_insertion_point(class_scope:EventStopRequest)
+    },
+)
+_sym_db.RegisterMessage(EventStopRequest)
+
+[docs]EventRequest = _reflection.GeneratedProtocolMessageType(
+    "EventRequest",
+    (_message.Message,),
+    {
+        "DESCRIPTOR": _EVENTREQUEST,
+        "__module__": "koapy.backend.cybos.CybosPlusProxyService_pb2"
+        # @@protoc_insertion_point(class_scope:EventRequest)
+    },
+)
+_sym_db.RegisterMessage(EventRequest)
+
+[docs]EventStartedResponse = _reflection.GeneratedProtocolMessageType(
+    "EventStartedResponse",
+    (_message.Message,),
+    {
+        "DESCRIPTOR": _EVENTSTARTEDRESPONSE,
+        "__module__": "koapy.backend.cybos.CybosPlusProxyService_pb2"
+        # @@protoc_insertion_point(class_scope:EventStartedResponse)
+    },
+)
+_sym_db.RegisterMessage(EventStartedResponse)
+
+[docs]EventFiredResponse = _reflection.GeneratedProtocolMessageType(
+    "EventFiredResponse",
+    (_message.Message,),
+    {
+        "DESCRIPTOR": _EVENTFIREDRESPONSE,
+        "__module__": "koapy.backend.cybos.CybosPlusProxyService_pb2"
+        # @@protoc_insertion_point(class_scope:EventFiredResponse)
+    },
+)
+_sym_db.RegisterMessage(EventFiredResponse)
+
+[docs]EventResponse = _reflection.GeneratedProtocolMessageType(
+    "EventResponse",
+    (_message.Message,),
+    {
+        "DESCRIPTOR": _EVENTRESPONSE,
+        "__module__": "koapy.backend.cybos.CybosPlusProxyService_pb2"
+        # @@protoc_insertion_point(class_scope:EventResponse)
+    },
+)
+_sym_db.RegisterMessage(EventResponse)
+
+
+_CYBOSPLUSPROXYSERVICE = _descriptor.ServiceDescriptor(
+    name="CybosPlusProxyService",
+    full_name="CybosPlusProxyService",
+    file=DESCRIPTOR,
+    index=0,
+    serialized_options=None,
+    create_key=_descriptor._internal_create_key,
+    serialized_start=1093,
+    serialized_end=1309,
+    methods=[
+        _descriptor.MethodDescriptor(
+            name="Dispatch",
+            full_name="CybosPlusProxyService.Dispatch",
+            index=0,
+            containing_service=None,
+            input_type=_DISPATCHREQUEST,
+            output_type=_DISPATCHRESPONSE,
+            serialized_options=None,
+            create_key=_descriptor._internal_create_key,
+        ),
+        _descriptor.MethodDescriptor(
+            name="Property",
+            full_name="CybosPlusProxyService.Property",
+            index=1,
+            containing_service=None,
+            input_type=_PROPERTYREQUEST,
+            output_type=_PROPERTYRESPONSE,
+            serialized_options=None,
+            create_key=_descriptor._internal_create_key,
+        ),
+        _descriptor.MethodDescriptor(
+            name="Method",
+            full_name="CybosPlusProxyService.Method",
+            index=2,
+            containing_service=None,
+            input_type=_METHODREQUEST,
+            output_type=_METHODRESPONSE,
+            serialized_options=None,
+            create_key=_descriptor._internal_create_key,
+        ),
+        _descriptor.MethodDescriptor(
+            name="Event",
+            full_name="CybosPlusProxyService.Event",
+            index=3,
+            containing_service=None,
+            input_type=_EVENTREQUEST,
+            output_type=_EVENTRESPONSE,
+            serialized_options=None,
+            create_key=_descriptor._internal_create_key,
+        ),
+    ],
+)
+_sym_db.RegisterServiceDescriptor(_CYBOSPLUSPROXYSERVICE)
+
+DESCRIPTOR.services_by_name["CybosPlusProxyService"] = _CYBOSPLUSPROXYSERVICE
+
+# @@protoc_insertion_point(module_scope)
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/daishin_cybos_plus/proxy/CybosPlusProxyService_pb2_grpc.html b/_modules/koapy/backend/daishin_cybos_plus/proxy/CybosPlusProxyService_pb2_grpc.html new file mode 100644 index 00000000..7f2990c0 --- /dev/null +++ b/_modules/koapy/backend/daishin_cybos_plus/proxy/CybosPlusProxyService_pb2_grpc.html @@ -0,0 +1,358 @@ + + + + + + + + koapy.backend.daishin_cybos_plus.proxy.CybosPlusProxyService_pb2_grpc — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.daishin_cybos_plus.proxy.CybosPlusProxyService_pb2_grpc

+# Generated by the gRPC Python protocol compiler plugin. DO NOT EDIT!
+"""Client and server classes corresponding to protobuf-defined services."""
+import grpc
+
+from koapy.backend.daishin_cybos_plus.proxy import (
+    CybosPlusProxyService_pb2 as koapy_dot_backend_dot_cybos_dot_CybosPlusProxyService__pb2,
+)
+
+
+[docs]class CybosPlusProxyServiceStub(object):
+    """Missing associated documentation comment in .proto file."""
+
+    def __init__(self, channel):
+        """Constructor.
+
+        Args:
+            channel: A grpc.Channel.
+        """
+        self.Dispatch = channel.unary_unary(
+            "/CybosPlusProxyService/Dispatch",
+            request_serializer=koapy_dot_backend_dot_cybos_dot_CybosPlusProxyService__pb2.DispatchRequest.SerializeToString,
+            response_deserializer=koapy_dot_backend_dot_cybos_dot_CybosPlusProxyService__pb2.DispatchResponse.FromString,
+        )
+        self.Property = channel.unary_unary(
+            "/CybosPlusProxyService/Property",
+            request_serializer=koapy_dot_backend_dot_cybos_dot_CybosPlusProxyService__pb2.PropertyRequest.SerializeToString,
+            response_deserializer=koapy_dot_backend_dot_cybos_dot_CybosPlusProxyService__pb2.PropertyResponse.FromString,
+        )
+        self.Method = channel.unary_unary(
+            "/CybosPlusProxyService/Method",
+            request_serializer=koapy_dot_backend_dot_cybos_dot_CybosPlusProxyService__pb2.MethodRequest.SerializeToString,
+            response_deserializer=koapy_dot_backend_dot_cybos_dot_CybosPlusProxyService__pb2.MethodResponse.FromString,
+        )
+        self.Event = channel.stream_stream(
+            "/CybosPlusProxyService/Event",
+            request_serializer=koapy_dot_backend_dot_cybos_dot_CybosPlusProxyService__pb2.EventRequest.SerializeToString,
+            response_deserializer=koapy_dot_backend_dot_cybos_dot_CybosPlusProxyService__pb2.EventResponse.FromString,
+        )
+
+
+[docs]class CybosPlusProxyServiceServicer(object):
+    """Missing associated documentation comment in .proto file."""
+
+[docs]    def Dispatch(self, request, context):
+        """Missing associated documentation comment in .proto file."""
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details("Method not implemented!")
+        raise NotImplementedError("Method not implemented!")
+
+[docs]    def Property(self, request, context):
+        """Missing associated documentation comment in .proto file."""
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details("Method not implemented!")
+        raise NotImplementedError("Method not implemented!")
+
+[docs]    def Method(self, request, context):
+        """Missing associated documentation comment in .proto file."""
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details("Method not implemented!")
+        raise NotImplementedError("Method not implemented!")
+
+[docs]    def Event(self, request_iterator, context):
+        """Missing associated documentation comment in .proto file."""
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details("Method not implemented!")
+        raise NotImplementedError("Method not implemented!")
+
+
+[docs]def add_CybosPlusProxyServiceServicer_to_server(servicer, server):
+    rpc_method_handlers = {
+        "Dispatch": grpc.unary_unary_rpc_method_handler(
+            servicer.Dispatch,
+            request_deserializer=koapy_dot_backend_dot_cybos_dot_CybosPlusProxyService__pb2.DispatchRequest.FromString,
+            response_serializer=koapy_dot_backend_dot_cybos_dot_CybosPlusProxyService__pb2.DispatchResponse.SerializeToString,
+        ),
+        "Property": grpc.unary_unary_rpc_method_handler(
+            servicer.Property,
+            request_deserializer=koapy_dot_backend_dot_cybos_dot_CybosPlusProxyService__pb2.PropertyRequest.FromString,
+            response_serializer=koapy_dot_backend_dot_cybos_dot_CybosPlusProxyService__pb2.PropertyResponse.SerializeToString,
+        ),
+        "Method": grpc.unary_unary_rpc_method_handler(
+            servicer.Method,
+            request_deserializer=koapy_dot_backend_dot_cybos_dot_CybosPlusProxyService__pb2.MethodRequest.FromString,
+            response_serializer=koapy_dot_backend_dot_cybos_dot_CybosPlusProxyService__pb2.MethodResponse.SerializeToString,
+        ),
+        "Event": grpc.stream_stream_rpc_method_handler(
+            servicer.Event,
+            request_deserializer=koapy_dot_backend_dot_cybos_dot_CybosPlusProxyService__pb2.EventRequest.FromString,
+            response_serializer=koapy_dot_backend_dot_cybos_dot_CybosPlusProxyService__pb2.EventResponse.SerializeToString,
+        ),
+    }
+    generic_handler = grpc.method_handlers_generic_handler(
+        "CybosPlusProxyService", rpc_method_handlers
+    )
+    server.add_generic_rpc_handlers((generic_handler,))
+
+
+# This class is part of an EXPERIMENTAL API.
+[docs]class CybosPlusProxyService(object):
+    """Missing associated documentation comment in .proto file."""
+
+    @staticmethod
+[docs]    def Dispatch(
+        request,
+        target,
+        options=(),
+        channel_credentials=None,
+        call_credentials=None,
+        insecure=False,
+        compression=None,
+        wait_for_ready=None,
+        timeout=None,
+        metadata=None,
+    ):
+        return grpc.experimental.unary_unary(
+            request,
+            target,
+            "/CybosPlusProxyService/Dispatch",
+            koapy_dot_backend_dot_cybos_dot_CybosPlusProxyService__pb2.DispatchRequest.SerializeToString,
+            koapy_dot_backend_dot_cybos_dot_CybosPlusProxyService__pb2.DispatchResponse.FromString,
+            options,
+            channel_credentials,
+            insecure,
+            call_credentials,
+            compression,
+            wait_for_ready,
+            timeout,
+            metadata,
+        )
+
+    @staticmethod
+[docs]    def Property(
+        request,
+        target,
+        options=(),
+        channel_credentials=None,
+        call_credentials=None,
+        insecure=False,
+        compression=None,
+        wait_for_ready=None,
+        timeout=None,
+        metadata=None,
+    ):
+        return grpc.experimental.unary_unary(
+            request,
+            target,
+            "/CybosPlusProxyService/Property",
+            koapy_dot_backend_dot_cybos_dot_CybosPlusProxyService__pb2.PropertyRequest.SerializeToString,
+            koapy_dot_backend_dot_cybos_dot_CybosPlusProxyService__pb2.PropertyResponse.FromString,
+            options,
+            channel_credentials,
+            insecure,
+            call_credentials,
+            compression,
+            wait_for_ready,
+            timeout,
+            metadata,
+        )
+
+    @staticmethod
+[docs]    def Method(
+        request,
+        target,
+        options=(),
+        channel_credentials=None,
+        call_credentials=None,
+        insecure=False,
+        compression=None,
+        wait_for_ready=None,
+        timeout=None,
+        metadata=None,
+    ):
+        return grpc.experimental.unary_unary(
+            request,
+            target,
+            "/CybosPlusProxyService/Method",
+            koapy_dot_backend_dot_cybos_dot_CybosPlusProxyService__pb2.MethodRequest.SerializeToString,
+            koapy_dot_backend_dot_cybos_dot_CybosPlusProxyService__pb2.MethodResponse.FromString,
+            options,
+            channel_credentials,
+            insecure,
+            call_credentials,
+            compression,
+            wait_for_ready,
+            timeout,
+            metadata,
+        )
+
+    @staticmethod
+[docs]    def Event(
+        request_iterator,
+        target,
+        options=(),
+        channel_credentials=None,
+        call_credentials=None,
+        insecure=False,
+        compression=None,
+        wait_for_ready=None,
+        timeout=None,
+        metadata=None,
+    ):
+        return grpc.experimental.stream_stream(
+            request_iterator,
+            target,
+            "/CybosPlusProxyService/Event",
+            koapy_dot_backend_dot_cybos_dot_CybosPlusProxyService__pb2.EventRequest.SerializeToString,
+            koapy_dot_backend_dot_cybos_dot_CybosPlusProxyService__pb2.EventResponse.FromString,
+            options,
+            channel_credentials,
+            insecure,
+            call_credentials,
+            compression,
+            wait_for_ready,
+            timeout,
+            metadata,
+        )
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusCondition.html b/_modules/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusCondition.html new file mode 100644 index 00000000..90e02158 --- /dev/null +++ b/_modules/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusCondition.html @@ -0,0 +1,355 @@ + + + + + + + + koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusCondition — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusCondition

+import contextlib
+
+from os import PathLike
+from pathlib import Path
+from typing import Optional, Sequence, TextIO, Union
+
+
+[docs]class KiwoomOpenApiPlusConditionEntry:
+    def __init__(
+        self,
+        header,
+        item_id,
+        group_id,
+        group_name,
+        group_tp,
+        name,
+        group_id_small,
+        order_no,
+        type_position,
+        upjong,
+        portfolio,
+        recommend,
+        acc,
+        group,
+        excepts,
+        month,
+        exp,
+        count,
+        rules,
+    ):
+        self.header = header
+        self.item_id = item_id
+        self.group_id = group_id
+        self.group_name = group_name
+        self.group_tp = group_tp
+        self.name = name
+        self.group_id_small = group_id_small
+        self.order_no = order_no
+        self.type_position = type_position
+        self.upjong = upjong
+        self.portfolio = portfolio
+        self.recommend = recommend
+        self.acc = acc
+        self.group = group
+        self.excepts = excepts
+        self.month = month
+        self.exp = exp
+        self.count = count
+        self.rules = rules
+
+    def __repr__(self):
+        template = "{}" + "({})".format(", ".join(["{!r}" for _ in range(19)]))
+        return template.format(
+            self.__class__.__name__,
+            self.header,
+            self.item_id,
+            self.group_id,
+            self.group_name,
+            self.group_tp,
+            self.name,
+            self.group_id_small,
+            self.order_no,
+            self.type_position,
+            self.upjong,
+            self.portfolio,
+            self.recommend,
+            self.acc,
+            self.group,
+            self.excepts,
+            self.month,
+            self.exp,
+            self.count,
+            self.rules,
+        )
+
+    @classmethod
+[docs]    def from_datfile(cls, f: TextIO):
+        lines = iter(f)
+        lines = map(lambda line: line.rstrip("\n"), lines)
+        line = next(lines)
+        while line == "":
+            line = next(lines)
+        assert line.startswith("[") and line.endswith("]")
+        header = line
+        line = next(lines)
+        assert line.startswith("ItemID=")
+        item_id = line.split("=", 2)[1]
+        line = next(lines)
+        assert line.startswith("GroupID=")
+        group_id = line.split("=", 2)[1]
+        line = next(lines)
+        assert line.startswith("GroupName=")
+        group_name = line.split("=", 2)[1]
+        line = next(lines)
+        assert line.startswith("GroupTp=")
+        group_tp = line.split("=", 2)[1]
+        line = next(lines)
+        assert line.startswith("Name=")
+        name = line.split("=", 2)[1]
+        line = next(lines)
+        assert line.startswith("GroupId=")
+        group_id_small = line.split("=", 2)[1]
+        line = next(lines)
+        assert line.startswith("OrderNo=")
+        order_no = line.split("=", 2)[1]
+        line = next(lines)
+        assert line.startswith("TypePosition=")
+        type_position = line.split("=", 2)[1]
+        line = next(lines)
+        assert line.startswith("Upjong=")
+        upjong = line.split("=", 2)[1]
+        line = next(lines)
+        assert line.startswith("Portfolio=")
+        portfolio = line.split("=", 2)[1]
+        line = next(lines)
+        assert line.startswith("Recommend=")
+        recommend = line.split("=", 2)[1]
+        line = next(lines)
+        assert line.startswith("Acc=")
+        acc = line.split("=", 2)[1]
+        line = next(lines)
+        assert line.startswith("Group=")
+        group = line.split("=", 2)[1]
+        excepts = []
+        for i in range(22):
+            line = next(lines)
+            assert line.startswith(f"Except{i+1}=")
+            except_item = line.split("=", 2)[1]
+            excepts.append(except_item)
+        line = next(lines)
+        assert line.startswith("Month=")
+        month = line.split("=", 2)[1]
+        line = next(lines)
+        assert line.startswith("Exp=")
+        exp = line.split("=", 2)[1]
+        line = next(lines)
+        assert line.startswith("Count=")
+        count = line.split("=", 2)[1]
+        count = int(count)
+        rules = []
+        for i in range(count):
+            line = next(lines)
+            assert line.startswith(f"{str(i).zfill(2)}=")
+            rule_num, rule_expr = line.split("=", 2)
+            rule = (rule_num, rule_expr)
+            rules.append(rule)
+        return cls(
+            header,
+            item_id,
+            group_id,
+            group_name,
+            group_tp,
+            name,
+            group_id_small,
+            order_no,
+            type_position,
+            upjong,
+            portfolio,
+            recommend,
+            acc,
+            group,
+            excepts,
+            month,
+            exp,
+            count,
+            rules,
+        )
+
+
+[docs]class KiwoomOpenApiPlusConditionFile:
+    def __init__(
+        self, version: str, entries: Sequence[KiwoomOpenApiPlusConditionEntry]
+    ):
+        self.version = version
+        self.entries = list(entries)
+
+    def __repr__(self):
+        template = "{}" + "({})".format(", ".join(["{!r}" for _ in range(2)]))
+        return template.format(
+            self.__class__.__name__,
+            self.version,
+            self.entries,
+        )
+
+    @classmethod
+[docs]    def from_datfile(
+        cls, f: Union[str, PathLike, TextIO], encoding: Optional[str] = None
+    ):
+        if isinstance(f, str):
+            f = Path(f)
+        if encoding is None:
+            encoding = "euc-kr"
+        with contextlib.ExitStack() as stack:
+            if isinstance(f, PathLike):
+                f = open(f, "r", encoding=encoding)
+                f = stack.enter_context(f)
+            lines = iter(f)
+            lines = map(lambda line: line.rstrip("\n"), lines)
+            line = next(lines)
+            assert line == "[Version]"
+            line = next(lines)
+            assert line.startswith("ver=")
+            version = line.split("=", 2)[1]
+            entries = []
+            should_stop = False
+            while not should_stop:
+                try:
+                    cond = KiwoomOpenApiPlusConditionEntry.from_datfile(f)
+                except StopIteration:
+                    break
+                else:
+                    entries.append(cond)
+            return cls(version, entries)
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusDispatchFunctions.html b/_modules/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusDispatchFunctions.html new file mode 100644 index 00000000..4aad3b24 --- /dev/null +++ b/_modules/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusDispatchFunctions.html @@ -0,0 +1,1381 @@ + + + + + + + + koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusDispatchFunctions — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusDispatchFunctions

+[docs]class KiwoomOpenApiPlusDispatchFunctions:
+[docs]    def CommConnect(self) -> int:
+        """
+        로그인 윈도우를 실행한다.
+
+        수동 로그인 설정인 경우 로그인창을 출력.
+        자동 로그인 설정인 경우 로그인창에서 자동으로 로그인을 시도합니다.
+
+        로그인이 성공하거나 실패하는 경우 OnEventConnect() 이벤트가 발생하고 이벤트의
+        인자 값으로 로그인 성공 여부를 알 수 있다.
+
+        Returns:
+            int: 에러코드, 성공하면 0 을, 실패하면 음수를 반환
+        """
+        ...
+
+[docs]    def CommTerminate(self) -> None:
+        """
+        더 이상 지원하지 않는 함수.
+
+        프로그램 종료없이 서버와의 접속만 단절시키는 함수입니다.
+        ※ 함수 사용 후 사용자의 오해소지가 생기는 이유로 더 이상 사용할 수 없는 함수입니다.
+
+        통신 연결 상태는 GetConnectState() 메소드로 알 수 있다.
+        """
+        ...
+
+[docs]    def CommRqData(
+        self, sRQName: str, sTrCode: str, nPrevNext: int, sScreenNo: str
+    ) -> int:
+        """
+        통신 데이터를 서버로 전송한다.
+
+        반환 코드 구분:
+            - OP_ERR_NONE(0): 정상처리
+            - OP_ERR_SISE_OVERFLOW(-200): 과도한 시세조회로 인한 통신불가
+            - OP_ERR_RQ_STRUCT_FAIL(-201): 입력 구조체 생성 실패
+            - OP_ERR_RQ_STRING_FAIL(-202): 요청전문 작성 실패
+
+        Args:
+            sRQName (str): 사용자 구분명 (임의로 지정, 한글 지원)
+            sTrCode (str): 조회하려는 TR 코드
+            nPrevNext (int): 연속조회 여부 (0:조회, 2:연속)
+            sScreenNo (str): 화면번호 (4자리 숫자 임의로 지정)
+
+        Returns:
+            int: 에러코드, 성공하면 0 을, 실패하면 음수를 반환
+        """
+        ...
+
+[docs]    def GetLoginInfo(self, sTag: str) -> str:
+        """
+        로그인한 사용자 정보를 반환한다.
+
+        태그값 구분:
+            - "ACCOUNT_CNT": 전체 보유계좌 개수를 반환합니다.
+            - "ACCLIST" 또는 "ACCNO": 구분자 ';' 로 연결된 전체 보유계좌 목록을 반환합니다.
+            - "USER_ID": 사용자 ID를 반환합니다.
+            - "USER_NAME": 사용자 이름을 반환합니다.
+            - "KEY_BSECGB": 키보드 보안 해지 여부를 반환합니다. (0:정상, 1:해지)
+            - "FIREW_SECGB": 방화벽 설정 여부를 반환합니다. (0:미설정, 1:설정, 2:해지)
+            - "GetServerGubun": 접속서버 구분을 반환합니다. (1:모의투자, 나머지:실거래서버)
+
+        Args:
+            sTag (str): 사용자 정보 구분 태그 값
+
+        Returns:
+            str: 태그값에 따른 데이터 반환
+        """
+        ...
+
+[docs]    def SendOrder(
+        self,
+        sRQName: str,
+        sScreenNo: str,
+        sAccNo: str,
+        nOrderType: int,
+        sCode: str,
+        nQty: int,
+        nPrice: int,
+        sHogaGb: str,
+        sOrgOrderNo: str,
+    ) -> int:
+        """
+        주식 주문을 서버로 전송한다.
+
+        서버에 주문을 전송하는 함수 입니다.
+        9개 인자값을 가진 주식주문 함수이며 리턴값이 0이면 성공이며 나머지는 에러입니다.
+        1초에 5회만 주문가능하며 그 이상 주문요청하면 에러 -308을 리턴합니다.
+
+        ※ 시장가, 최유리지정가, 최우선지정가, 시장가IOC, 최유리IOC, 시장가FOK, 최유리FOK, 장전시간외, 장후시간외 주문시 주문가격은 0으로 입력합니다.
+        ※ 취소 주문일때 주문가격은 0으로 입력합니다.
+
+        거래 구분:
+            - 00: 지정가
+            - 03: 시장가
+            - 05: 조건부지정가
+            - 06: 최유리지정가
+            - 07: 최우선지정가
+            - 10: 지정가IOC
+            - 13: 시장가IOC
+            - 16: 최유리IOC
+            - 20: 지정가FOK
+            - 23: 시장가FOK
+            - 26: 최유리FOK
+            - 61: 장전시간외종가
+            - 62: 시간외단일가매매
+            - 81: 장후시간외종가
+
+        ※ 모의투자에서는 지정가 주문과 시장가 주문만 가능합니다.
+
+        정규장 외 주문:
+            - 장전 동시호가 주문
+                - 08:30 ~ 09:00.	거래구분 00:지정가/03:시장가 (일반주문처럼)
+                - ※ 08:20 ~ 08:30 시간의 주문은 키움에서 대기하여 08:30 에 순서대로 거래소로 전송합니다.
+            - 장전시간외 종가
+                - 08:30 ~ 08:40. 	거래구분 61:장전시간외종가.  가격 0입력
+                - ※ 전일 종가로 거래. 미체결시 자동취소되지 않음
+            - 장마감 동시호가 주문
+                - 15:20 ~ 15:30.	거래구분 00:지정가/03:시장가 (일반주문처럼)
+            - 장후 시간외 종가
+                - 15:40 ~ 16:00.	거래구분 81:장후시간외종가.  가격 0입력
+                - ※ 당일 종가로 거래
+            - 시간외 단일가
+                - 16:00 ~ 18:00.	거래구분 62:시간외단일가.  가격 입력
+                - ※ 10분 단위로 체결, 당일 종가대비 +-10% 가격으로 거래
+
+        주문 유형:
+            - 1: 신규매수
+            - 2: 신규매도
+            - 3: 매수취소
+            - 4: 매도취소
+            - 5: 매수정정
+            - 6: 매도정정
+
+        Args:
+            sRQName (str): 사용자 구분 요청명
+            sScreenNo (str): 화면번호 (4자리)
+            sAccNo (str): 계좌번호 (10자리)
+            nOrderType (int): 주문유형 (1:신규매수, 2:신규매도, 3:매수취소, 4:매도취소, 5:매수정정, 6:매도정정)
+            sCode (str): 종목코드 (6자리)
+            nQty (int): 주문수량
+            nPrice (int): 주문단가
+            sHogaGb (str): 거래구분 (혹은 호가구분)
+            sOrgOrderNo (str): 원주문번호, 신규주문에는 공백 입력, 정정/취소시 입력합니다.
+
+        Returns:
+            int: 에러코드, 성공하면 0 을, 실패하면 음수를 반환
+        """
+        ...
+
+[docs]    def SendOrderFO(
+        self,
+        sRQName: str,
+        sScreenNo: str,
+        sAccNo: str,
+        sCode: str,
+        lOrdKind: int,
+        sSlbyTp: str,
+        sOrdTp: str,
+        lQty: int,
+        sPrice: str,
+        sOrgOrdNo: str,
+    ) -> int:
+        """
+        선물/옵션 주문을 서버로 전송한다.
+
+        서버에 주문을 전송하는 함수 입니다.
+        코스피지수200 선물옵션 전용 주문함수입니다.
+
+        거래 구분:
+            - 1: 지정가
+            - 2: 조건부지정가
+            - 3: 시장가
+            - 4: 최유리지정가
+            - 5: 지정가(IOC)
+            - 6: 지정가(FOK)
+            - 7: 시장가(IOC)
+            - 8: 시장가(FOK)
+            - 9: 최유리지정가(IOC)
+            - A: 최유리지정가(FOK)
+
+        ※ 장종료 후 시간외 주문은 지정가 선택
+
+        Args:
+            sRQName (str): 사용자 구분명
+            sScreenNo (str): 화면번호
+            sAccNo (str): 계좌번호 (10자리)
+            sCode (str): 종목코드
+            lOrdKind (int): 주문종류 (1:신규매매, 2:정정, 3:취소)
+            sSlbyTp (str): 매매구분 (1:매도, 2:매수)
+            sOrdTp (str): 거래구분
+            lQty (int): 주문수량
+            sPrice (str): 주문가격
+            sOrgOrdNo (str): 원주문번호
+
+        Returns:
+            int: 에러코드, 성공하면 0 을, 실패하면 음수를 반환
+        """
+        ...
+
+[docs]    def SetInputValue(self, sID: str, sValue: str) -> None:
+        """
+        TR 입력 값을 서버통신 전에 입력한다.
+
+        조회요청시 TR의 Input값을 지정하는 함수입니다.
+        CommRqData() 호출 전에 입력값들을 셋팅합니다.
+        각 TR마다 Input 항목이 다릅니다. 순서에 맞게 Input 값들을 셋팅해야 합니다.
+
+        Args:
+            sID (str): TR에 명시된 Input 이름
+            sValue (str): Input 이름으로 지정한 값
+        """
+        ...
+
+[docs]    def SetOutputFID(self, sID: str) -> int:
+        """
+        1.0.0.1 버전 이후 사용하지 않음.
+        """
+        ...
+
+[docs]    def CommGetData(
+        self,
+        sJongmokCode: str,
+        sRealType: str,
+        sFieldName: str,
+        nIndex: int,
+        sInnerFieldName: str,
+    ) -> str:
+        """
+        이 함수는 지원하지 않을 것이므로 용도에 맞는 전용 함수를 사용할 것. (비고참고)
+
+        일부 TR에서 사용상 제약이 있으므로 이 함수 대신 GetCommData() 함수를 사용하시기 바랍니다.
+
+        비고:
+            - 조회 정보 요청: GetCommData(strTrCode: str, strRecordName: str, nIndex: int, strItemName: str)
+            - 실시간 정보 요청: GetCommRealData(sTrCode: str, nFid: int)
+            - 체결 정보 요청: GetChejanData(nFid: int)
+        """
+        ...
+
+[docs]    def DisconnectRealData(self, sScnNo: str) -> None:
+        """
+        화면 내 모든 리얼데이터 요청을 제거한다.
+
+        시세데이터를 요청할때 사용된 화면번호를 이용하여
+        해당 화면번호로 등록되어져 있는 종목의 실시간시세를 서버에 등록해지 요청합니다.
+        이후 해당 종목의 실시간시세는 수신되지 않습니다.
+        단, 해당 종목이 또다른 화면번호로 실시간 등록되어 있는 경우 해당종목에대한 실시간시세 데이터는 계속 수신됩니다.
+
+        화면을 종료할 때 반드시 위 함수를 호출해야 한다.
+
+        Args:
+            sScnNo: 화면번호 (4자리)
+        """
+        ...
+
+[docs]    def GetRepeatCnt(self, sTrCode: str, sRecordName: str) -> int:
+        """
+        레코드 반복횟수를 반환한다.
+
+        데이터 수신시 멀티데이터의 갯수(반복수)를 얻을수 있습니다.
+        예를 들어 차트조회는 한번에 최대 900개 데이터를 수신할 수 있는데
+        이렇게 수신한 데이터갯수를 얻을때 사용합니다.
+        이 함수는 OnReceiveTRData() 이벤트가 발생될때 그 안에서 사용해야 합니다.
+
+        Args:
+            sTrCode (str): TR 이름
+            sRecordName (str): 레코드 이름
+
+        Returns:
+            int: 레코드의 반복횟수
+        """
+        ...
+
+[docs]    def CommKwRqData(
+        self,
+        sArrCode: str,
+        bNext: int,
+        nCodeCount: int,
+        nTypeFlag: int,
+        sRQName: str,
+        sScreenNo: str,
+    ) -> int:
+        """
+        복수종목조회 요청을 서버로 송신한다.
+
+        한번에 100종목까지 조회할 수 있는 복수종목 조회함수 입니다.
+        함수인자로 사용하는 종목코드 리스트는 조회하려는 종목코드 사이에 구분자 ';' 를 추가해서 만들면 됩니다.
+        수신되는 데이터는 TR목록에서 복수종목정보요청(OPTKWFID) Output을 참고하시면 됩니다.
+
+        ※ OPTKWFID TR은 CommKwRqData() 함수 전용으로, CommRqData 로는 사용할 수 없습니다.
+        ※ OPTKWFID TR은 영웅문4 HTS의 관심종목과는 무관합니다.
+
+        반환 코드 구분:
+            - OP_ERR_NONE(0): 정상처리
+            - OP_ERR_SISE_OVERFLOW(-200): 과도한 시세조회로 인한 통신불가
+            - OP_ERR_RQ_STRUCT_FAIL(-201): 입력 구조체 생성 실패
+            - OP_ERR_RQ_STRING_FAIL(-202): 요청전문 작성 실패
+
+        Args:
+            sArrCode (str): 종목리스트
+            bNext (int): 연속조회 여부 (0:기본값, 1:연속조회(지원안함))
+            nCodeCount (int): 종목개수
+            nTypeFlag (int): 조회구분 (0:주식 종목, 3:선물옵션 종목)
+            sRQName (str): 사용자 구분명
+            sScreenNo (str): 화면번호 (4자리)
+
+        Returns:
+            int: 에러코드, 성공하면 0 을, 실패하면 음수를 반환
+        """
+        ...
+
+[docs]    def GetAPIModulePath(self) -> str:
+        """
+        OpenAPI 모듈의 경로를 반환한다.
+
+        Returns:
+            str: OpenAPI 모듈의 설치 경로
+        """
+        ...
+
+[docs]    def GetCodeListByMarket(self, sMarket: str) -> str:
+        """
+        시장구분에 따른 종목코드를 반환한다.
+
+        주식 시장별 종목코드 리스트를 ';' 로 구분해서 전달합니다.
+        시장구분값을 "" 공백으로 하면 전체시장 코드리스트를 전달합니다.
+
+        로그인 한 후에 사용할 수 있는 함수입니다.
+
+        시장 구분:
+            - 0: 장내
+            - 3: ELW
+            - 4: 뮤추얼펀드
+            - 5: 신주인수권
+            - 6: 리츠
+            - 8: ETF
+            - 9: 하이일드펀드
+            - 10: 코스닥
+            - 30: K-OTC
+            - 50: 코넥스 (KONEX)
+
+        Args:
+            sMarket (str): 시장 구분값
+
+        Returns:
+            str: 종목코드 리스트, 종목간 구분은 ';' 이다.
+        """
+        ...
+
+[docs]    def GetConnectState(self) -> int:
+        """
+        현재 접속상태를 반환한다.
+
+        서버와 현재 접속 상태를 알려줍니다.
+
+        Returns:
+            int: 접속상태, 1:연결, 0:연결안됨
+        """
+        ...
+
+[docs]    def GetMasterCodeName(self, sTrCode: str) -> str:
+        """
+        종목코드의 한글명을 반환한다.
+
+        종목코드에 해당하는 종목명을 전달합니다.
+
+        로그인 한 후에 사용할 수 있는 함수입니다.
+
+        장내외, 지수선옵, 주식선옵 검색 가능.
+
+        Args:
+            sTrCode (str): 종목코드 (4자리)
+
+        Returns:
+            str: 종목 한글명
+        """
+        ...
+
+[docs]    def GetMasterListedStockCnt(self, sTrCode: str) -> int:
+        """
+        종목코드의 상장주식수를 반환한다.
+
+        입력한 종목코드에 해당하는 종목 상장주식수를 전달합니다.
+
+        로그인 한 후에 사용할 수 있는 함수입니다.
+
+        Args:
+            sTrCode (str): 종목코드 (4자리)
+
+        Returns:
+            int: 상장주식수
+        """
+        ...
+
+[docs]    def GetMasterConstruction(self, sTrCode: str) -> str:
+        """
+        종목코드의 감리구분을 반환한다.
+
+        입력한 종목코드에 해당하는 종목의 감리구분을 전달합니다.
+        (정상, 투자주의, 투자경고, 투자위험, 투자주의환기종목)
+
+        로그인 한 후에 사용할 수 있는 함수입니다.
+
+        감리 구분:
+            - 정상
+            - 투자주의
+            - 투자경고
+            - 투자위험
+            - 투자주의환기종목
+
+        Args:
+            sTrCode (str): 종목코드 (4자리)
+
+        Returns:
+            str: 감리구분 (정상, 투자주의, 투자경고, 투자위험, 투자주의환기종목)
+        """
+        ...
+
+[docs]    def GetMasterListedStockDate(self, sTrCode: str) -> str:
+        """
+        종목코드의 상장일을 반환한다.
+
+        입력한 종목의 상장일을 전달합니다.
+
+        로그인 한 후에 사용할 수 있는 함수입니다.
+
+        Args:
+            sTrCode (str): 종목코드 (4자리)
+
+        Returns:
+            str: 상장일 (8자리, YYYYMMDD)
+        """
+        ...
+
+[docs]    def GetMasterLastPrice(self, sTrCode: str) -> str:
+        """
+        종목코드의 전일가를 반환한다.
+
+        입력한 종목의 당일 기준가를 전달합니다.
+
+        로그인 한 후에 사용할 수 있는 함수입니다.
+
+        Args:
+            sTrCode (str): 종목코드 (4자리)
+
+        Returns:
+            str: 전일가
+        """
+        ...
+
+[docs]    def GetMasterStockState(self, sTrCode: str) -> str:
+        """
+        종목코드의 종목상태를 반환한다.
+
+        입력한 종목의 증거금 비율, 거래정지, 관리종목, 감리종목, 투자유의종목, 담보대출, 액면분할, 신용가능 여부를 전달합니다.
+
+        로그인 한 후에 사용할 수 있는 함수입니다.
+
+        Args:
+            sTrCode (str): 종목코드 (4자리)
+
+        Returns:
+            str: 종목상태 (정상, 증거금N%, 거래정지, 관리종목, 감리종목, 투자유의종목, 담보대출, 액면분할, 신용가능)
+        """
+        ...
+
+[docs]    def GetDataCount(self, strRecordName: str) -> int:
+        """
+        레코드의 반복개수를 반환한다.
+
+        ※ 문서상으로만 존재하고 KOAStudio 에서는 확인 안되는 것으로 보아 일반적인 상황에선
+        해당 함수 대신 GetRepeatCnt() 를 사용하는게 더 바람직할 듯
+
+        Args:
+            strRecordName (str): 레코드 명
+
+        Returns:
+            str: 레코드 반복개수
+        """
+        ...
+
+[docs]    def GetOutputValue(self, strRecordName: str, nRepeatIdx: int, nItemIdx: int) -> str:
+        """
+        레코드의 반복순서와 아이템의 출력순서에 따라 수신데이터를 반환한다.
+
+        ※ 문서상으로만 존재하고 KOAStudio 에서는 확인 안되는 것으로 보아 일반적인 상황에선
+        해당 함수 대신 GetCommData() 를 사용하는게 더 바람직할 듯
+
+        Args:
+            strRecordName (str): 레코드 명
+            nRepeatIdx (int): 반복 순서
+            nItemIdx (int): 아이템 순서
+
+        Returns:
+            str: 수신 데이터
+        """
+        ...
+
+[docs]    def GetCommData(
+        self, strTrCode: str, strRecordName: str, nIndex: int, strItemName: str
+    ) -> str:
+        """
+        수신 데이터를 반환한다.
+
+        OnReceiveTRData() 이벤트가 발생될때 수신한 데이터를 얻어오는 함수입니다.
+        이 함수는 OnReceiveTRData() 이벤트가 발생될때 그 안에서 사용해야 합니다.
+
+        Args:
+            strTrCode (str): TR코드
+            strRecordName (str): 레코드명
+            nIndex (int): 복수데이터 인덱스
+            strItemName (str): 아이템명 (TR별 출력항목 이름)
+
+        Returns:
+            str: 수신 데이터
+        """
+        ...
+
+[docs]    def GetCommRealData(self, sTrCode: str, nFid: int) -> str:
+        """
+        실시간 시세 데이터를 반환한다.
+
+        실시간시세 데이터 수신 이벤트인 OnReceiveRealData() 가 발생될때 실시간데이터를 얻어오는 함수입니다.
+        이 함수는 OnReceiveRealData() 이벤트가 발생될때 그 안에서 사용해야 합니다.
+        FID 값은 KOAStudio 의 "실시간목록" 탭에서 확인할 수 있습니다.
+
+        일반적으로 strTrCode 는 OnReceiveRealData() 이벤트 함수의 첫번째 매개변수를 사용한다.
+
+        Args:
+            strTrCode (str): TR코드
+            nFid (int): 실시간 아이템
+
+        Returns:
+            str: 수신 데이터
+        """
+        ...
+
+[docs]    def GetChejanData(self, nFid: int) -> str:
+        """
+        체결잔고 데이터를 반환한다.
+
+        OnReceiveChejan() 이벤트가 발생될때 FID 에 해당되는 값을 구하는 함수입니다.
+        이 함수는 OnReceiveChejan() 이벤트 안에서 사용해야 합니다.
+        Ex) 체결가 = GetChejanData(910)
+
+        Args:
+            nFid (int): 체결잔고 아이템
+
+        Returns:
+            str: 수신 데이터
+        """
+        ...
+
+[docs]    def GetThemeGroupList(self, nType: int) -> str:
+        """
+        테마코드와 테마명을 반환한다.
+
+        반환값의 코드와 코드명 구분은 '|', 코드의 구분은 ';'
+        Ex) 100|태양광_폴리실리콘;152|합성섬유
+
+        Args:
+            nType (int): 정렬순서 (0:코드순, 1:테마순)
+
+        Returns:
+            str: 코드와 코드명 리스트
+        """
+        ...
+
+[docs]    def GetThemeGroupCode(self, strThemeCode: str) -> str:
+        """
+        테마코드에 소속된 종목코드를 반환한다.
+
+        반환값의 종목코드간 구분은 ';'
+        Ex) A000660;A005930
+
+        Args:
+            strThemeCode (str): 테마코드
+
+        Returns:
+            str: 종목코드 리스트
+        """
+        ...
+
+[docs]    def GetFutureList(self) -> str:
+        """
+        지수선물 리스트를 반환한다.
+
+        지수선물 종목코드 리스트를 ';'로 구분해서 전달합니다.
+
+        로그인 한 후에 사용할 수 있는 함수입니다.
+
+        반환값의 종목코드간 구분은 ';'
+        Ex) 101J9000;101JC000
+
+        Returns:
+            str: 종목코드 리스트
+        """
+        ...
+
+[docs]    def GetFutureCodeByIndex(self, nIndex: int) -> str:
+        """
+        지수선물 코드를 반환한다.
+
+        Ex) 최근월선물 = GetFutureCodeByIndex(0)
+            최근월스프레드 = GetFutureCodeByIndex(4)
+
+        Args:
+            nIndex (int): 0 ~ 3: 지수선물코드, 4 ~ 7: 지수스프레드
+
+        Returns:
+            str: 종목코드
+        """
+        ...
+
+[docs]    def GetActPriceList(self) -> str:
+        """
+        지수옵션 행사가 리스트를 반환한다.
+
+        지수옵션 행사가에 100을 곱해서 소수점이 없는 값을 ';' 로 구분해서 전달합니다.
+
+        로그인 한 후에 사용할 수 있는 함수입니다.
+
+        ※ PDF 문서상의 예시에서는 소수점 아래가 존재하는 예시지만, KOAStudio 의 설명과 예시에서는 그렇지 않음.
+        아마도 KOAStudio 의 설명을 따르는게 더 바람직할 듯.
+
+        Returns:
+            str: 행사가
+        """
+        ...
+
+[docs]    def GetMonthList(self) -> str:
+        """
+        지수옵션 월물 리스트를 반환한다.
+
+        지수옵션 월물정보를 ';' 로 구분해서 전달하는데 순서는 콜 11월물 ~ 콜 최근월물 풋 최근월물 ~ 풋 최근월물가 됩니다.
+
+        로그인 한 후에 사용할 수 있는 함수입니다.
+
+        반환값의 월물간 구분은 ';'
+        Ex) 201412;201409;201408;201407;201407;201408;201409;201412
+
+        Returns:
+            str: 월물 (YYYYMM;YYYYMM;...)
+        """
+        ...
+
+[docs]    def GetOptionCode(self, strActPrice: str, nCp: int, strMonth: str) -> str:
+        """
+        행사가와 월물 콜풋으로 종목코드를 구한다.
+
+        인자로 지정한 지수옵션 코드를 전달합니다.
+
+        로그인 한 후에 사용할 수 있는 함수입니다.
+
+        Args:
+            strActPrice (str): 행사가 (소수점 포함)
+            nCp (int): 콜/풋 구분 (2:콜, 3:풋)
+            strMonth (str): 월물 (6자리, YYYYMM)
+
+        Returns:
+            str: 종목코드
+
+        Examples:
+            >>> GetOptionCode("260.00", 2, "201407")
+        """
+        ...
+
+[docs]    def GetOptionCodeByMonth(self, sTrCode: str, nCp: int, strMonth: str) -> str:
+        """
+        입력된 종목코드와 동일한 행사가의 코드중 입력한 월물의 코드를 구한다.
+
+        Args:
+            sTrCode (str): 종목코드
+            nCp (int): 콜/풋 구분 (2:콜, 3:풋)
+            strMonth (str): 월물 (6자리, YYYYMM)
+
+        Returns:
+            str: 종목코드
+
+        Examples:
+            >>> GetOptionCodeByMonth("201J7260", 2, "201412")
+            "201JC260"
+        """
+        ...
+
+[docs]    def GetOptionCodeByActPrice(self, sTrCode: str, nCp: int, nTick: int) -> str:
+        """
+        입력된 종목코드와 동일한 월물의 코드중 입력한 틱만큼 벌어진 코드를 구한다.
+
+        Args:
+            sTrCode (str): 종목코드
+            nCp (int): 콜/풋 구분 (2:콜, 3:풋)
+            nTick (int): 행사가 틱
+
+        Returns:
+            str: 종목코드
+
+        Examples:
+            >>> GetOptionCodeByActPrice("201J7260", 2, -1)
+            "201J7262"
+        """
+        ...
+
+[docs]    def GetSFutureList(self, strBaseAssetCode: str) -> str:
+        """
+        주식선물 코드 리스트를 반환한다.
+
+        출력값의 코드간 구분은 ';' 이다.
+
+        Args:
+            strBaseAssetCode (str): 기초자산코드
+
+        Return:
+            str: 종목코드 리스트
+        """
+        ...
+
+[docs]    def GetSFutureCodeByIndex(self, strBaseAssetCode: str, nIndex: int) -> str:
+        """
+        주식선물 코드를 반환한다.
+
+        Args:
+            strBaseAssetCode (str): 기초자산코드
+            nIndex (int): 0 ~ 3: 지수선물코드, 4 ~ 7: 지수스프레드, 8 ~ 11: 스타 선물, 12 ~ : 스타 스프레드
+
+        Return:
+            str: 종목코드 리스트
+
+        Examples:
+            >>> GetSFutureCodeByIndex("11", 0)
+        """
+        ...
+
+[docs]    def GetSActPriceList(self, strBaseAssetGb: str) -> str:
+        """
+        주식옵션 행사가 리스트를 반환한다.
+
+        Args:
+            strBaseAssetGb (str): 기초자산코드구분
+
+        Return:
+            str: 행사가 리스트, 행사가간 구분은 ';'
+
+        Examples:
+            >>> GetSActPriceList("11")
+        """
+        ...
+
+[docs]    def GetSMonthList(self, strBaseAssetGb: str) -> str:
+        """
+        주식옵션 월물 리스트를 반환한다.
+
+        Args:
+            strBaseAssetGb (str): 기초자산코드구분
+
+        Return:
+            str: 월물 리스트, 월물간 구분은 ';'
+
+        Examples:
+            >>> GetSMonthList("11")
+        """
+        ...
+
+[docs]    def GetSOptionCode(
+        self, strBaseAssetGb: str, strActPrice: str, nCp: int, strMonth: str
+    ) -> str:
+        """
+        주식옵션 코드를 반환한다.
+
+        Args:
+            strBaseAssetGb (str): 기초자산코드구분
+            strActPrice (str): 행사가 (소수점 포함)
+            nCp (int): 콜/풋 구분 (2:콜, 3:풋)
+            strMonth (str): 월물 (6자리, YYYYMM)
+
+        Returns:
+            str: 주식옵션 코드
+
+        Examples:
+            >>> GetSOptionCode("11", "1300000", 2, "1412")
+        """
+        ...
+
+[docs]    def GetSOptionCodeByMonth(
+        self, strBaseAssetGb: str, sTrCode: str, nCp: int, strMonth: str
+    ) -> str:
+        """
+        입력한 주식옵션 코드에서 월물만 변경하여 반환한다.
+
+        Args:
+            strBaseAssetGb (str): 기초자산코드구분
+            sTrCode (str): 종목코드
+            nCp (int): 콜/풋 구분 (2:콜, 3:풋)
+            strMonth (str): 월물 (6자리, YYYYMM)
+
+        Returns:
+            str: 주식옵션 코드
+
+        Examples:
+            >>> GetSOptionCodeByMonth("11", "211J8045", 2, "1412")
+        """
+        ...
+
+[docs]    def GetSOptionCodeByActPrice(
+        self, strBaseAssetGb: str, sTrCode: str, nCp: int, nTick: int
+    ) -> str:
+        """
+        입력한 주식옵션 코드에서 행사가만 변경하여 반환한다.
+
+        Args:
+            strBaseAssetGb (str): 기초자산코드구분
+            sTrCode (str): 종목코드
+            nCp (int): 콜/풋 구분 (2:콜, 3:풋)
+            nTick (int): 행사가 틱
+
+        Returns:
+            str: 주식옵션 코드
+
+        Examples:
+            >>> GetSOptionCodeByActPrice("11", "211J8045", 2, 4);
+        """
+        ...
+
+[docs]    def GetSFOBasisAssetList(self) -> str:
+        """
+        주식선옵 기초자산코드/종목명을 반환한다.
+
+        Returns:
+            str: 기초자산코드/종목명, 코드와 종목명 구분은 '|', 코드간 구분은 ';'
+        """
+        ...
+
+[docs]    def GetOptionATM(self) -> str:
+        """
+        지수옵션 ATM을 반환한다.
+
+        Returns:
+            str: ATM
+        """
+        ...
+
+[docs]    def GetSOptionATM(self, strBaseAssetGb: str) -> str:
+        """
+        주식옵션 ATM을 반환한다.
+
+        Returns:
+            str: ATM
+        """
+        ...
+
+[docs]    def GetBranchCodeName(self) -> str:
+        """
+        회원사 코드와 이름을 반환합니다.
+
+        Returns:
+            str: 회원사코드/회원사명, 코드와 이름 구분은 '|', 코드간 구분은 ';' (회원사코드|회원사명;회원사코드|회원사명;...)
+        """
+        ...
+
+[docs]    def CommInvestRqData(self, sMarketGb: str, sRQName: str, sScreenNo: str) -> int:
+        """
+        지원하지 않는 함수.
+
+        시장 구분:
+            - 001: 코스피
+            - 002: 코스닥
+            - 003: 선물
+            - 004: 콜옵션
+            - 005: 풋옵션
+            - 006: 스타선물
+            - 007: 주식선물
+            - 008: 3년국채
+            - 009: 5년국채
+            - 010: 10년국채
+            - 011: 달러선물
+            - 012: 엔선물
+            - 013: 유로선물
+            - 014: 미니금선물
+            - 015: 금선물
+            - 016: 돈육선물
+            - 017: 달러콜옵션
+            - 018: 달러풋옵션
+
+        Args:
+            sMarketGb (str): 시장구분
+            sRQName (str): 사용자 구분값
+            sScreenNo (str): 화면번호 (4자리)
+
+        Returns:
+            str: 통신결과
+
+        Examples:
+            >>> CommInvestRqData("T00108;T00109", 0, 2, "RQ_1", "0101")
+        """
+        ...
+
+[docs]    def SendOrderCredit(
+        self,
+        sRQName: str,
+        sScreenNo: str,
+        sAccNo: str,
+        nOrderType: int,
+        sCode: str,
+        nQty: int,
+        nPrice: int,
+        sHogaGb: str,
+        sCreditGb: str,
+        sLoanDate: str,
+        sOrgOrderNo: str,
+    ) -> int:
+        """
+        신용주식 주문을 서버로 전송한다.
+
+        서버에 주문을 전송하는 함수 입니다.
+        국내주식 신용주문 전용함수입니다. 대주거래는 지원하지 않습니다.
+
+        거래 구분:
+            - 00: 지정가
+            - 03: 시장가
+            - 05: 조건부지정가
+            - 06: 최유리지정가
+            - 07: 최우선지정가
+            - 10: 지정가IOC
+            - 13: 시장가IOC
+            - 16: 최유리IOC
+            - 20: 지정가FOK
+            - 23: 시장가FOK
+            - 26: 최유리FOK
+            - 61: 장전시간외종가
+            - 62: 시간외단일가매매
+            - 81: 장후시간외종가
+
+        ※ 모의투자에서는 지정가 주문과 시장가 주문만 가능합니다.
+
+        신용거래 구분:
+            - 03: 신용매수 주문 \\- 자기융자
+                - 대출일은 공백 입력
+            - 33: 신용매도 융자상환 주문 \\- 자기융자
+                - 대출일은 종목별 대출일 입력
+                - OPW00005/OPW00004 TR조회로 대출일 조회
+            - 99: 신용매도 자기융자 합
+                - 대출일은 "99991231" 입력
+                - 단, 신용잔고 5개 까지만 융자합 주문 가능
+
+        대출일은 YYYYMMDD 형식입니다.
+        신용매도 - 자기융자 일때는 종목별 대출일을 입력하고 신용매도 - 융자합이면 "99991231"을 입력합니다.
+
+        Args:
+            sRQName (str): 사용자 구분 요청명
+            sScreenNo (str): 화면번호 (4자리)
+            sAccNo (str): 계좌번호 (10자리)
+            nOrderType (int): 주문유형 (1:신규매수, 2:신규매도, 3:매수취소, 4:매도취소, 5:매수정정, 6:매도정정)
+            sCode (str): 종목코드 (6자리)
+            nQty (int): 주문수량
+            nPrice (int): 주문단가
+            sHogaGb (str): 거래구분
+            sCreditGb (str): 신용구분
+            sLoanDate (str): 대출일 (8자리, YYYYMMDD)
+            sOrgOrderNo (str): 원주문번호
+
+        Returns:
+            int: 에러코드, 성공하면 0 을, 실패하면 음수를 반환
+        """
+        ...
+
+[docs]    def KOA_Functions(self, sFunctionName: str, sParam: str) -> str:
+        """
+        OpenAPI 기본 기능 이외의 기능들을 제공하는 헬퍼 함수.
+
+        KOA_Function() 함수는 OpenAPI 기본 기능 이외의 기능을 사용하기 쉽도록 만든 함수입니다.
+        두 개의 인자값을 사용합니다.
+
+        기능 목록:
+
+            1. 계좌 비밀번호 입력창 출력
+
+            >>> KOA_Functions("ShowAccountWindow", "")
+
+            2. 접속 서버 확인 (1:모의투자, 나머지:실서버)
+
+            >>> KOA_Functions("GetServerGubun", "")
+
+            3. 주식종목 시장구분, 종목분류등 정보제공 (구분자는 '|' 와 ';')
+            호출결과는 입력한 종목에 대한 대분류, 중분류, 업종구분값을 구분자로 연결한 문자열입니다.
+
+            >>> KOA_Functions("GetMasterStockInfo", "039490")
+            "시장구분0|거래소;시장구분1|중형주;업종구분|금융업;"
+
+            4. 조건검색 종목코드와 현재가 수신 (실시간 조건검색은 사용할 수 없음)
+            조건검색결과에 종목코드와 그 종목의 현재가를 함께 수신하는 방법이며 실시간 조건검색에서는 사용할 수 없고 오직 조건검색에만 사용할수 있습니다.
+
+            >>> KOA_Functions("SetConditionSearchFlag", "AddPrice") # 현재가 포함하도록 설정
+
+            현재가 포함으로 설정시 OnReceiveTrCondition() 이벤트에 "종목코드1^현재가1;종목코드2^현재가2;...종목코드n^현재가n" 형식으로 전달됨.
+
+            >>> KOA_Functions("SetConditionSearchFlag", "DelPrice") # 현재가 미포함 (원래 상태로 전환)
+
+            현재가 미포함시 기존처럼 "종목코드1^종목코드2...종목코드n" 형식으로 전달므로 설정에 따라 수신데이터 처리방법이 달라져야 하므로 주의하셔야 합니다.
+
+            5. 업종코드목록 획득
+
+            >>> KOA_Functions("GetUpjongCode", "0")
+
+            두번째 인자로 사용할 수 있는 값은 0, 1, 2, 4, 7 입니다.
+            0:코스피, 1: 코스닥, 2:KOSPI200, 4:KOSPI100(KOSPI50), 7:KRX100
+
+            함수반환값은 "시장구분값,업종코드,업종명|시장구분값,업종코드,업종명|...|시장구분값,업종코드,업종명" 형식입니다.
+            즉 하나의 업종코드는 입력한 시장구분값과 업종코드 그리고 그 업종명이 쉼표(,)로 구분되며 각 업종코드는 '|'로 구분됩니다.
+
+            6. 업종이름 획득
+
+            >>> KOA_Functions("GetUpjongNameByCode", "업종코드입력")
+
+            7. ETF 투자유의 종목 여부 (2020/09/17 적용)
+            거래소 제도개선으로 ETF/ETN 종목 중 투자유의 종목을 매수주문하는 경우 경고 메세지 창이 출력되도록 기능이 추가 되었습니다.
+            (경고 창 출력 시 주문을 중지/전송 선택 가능합니다.)
+            주문 함수를 호출하기 전에 특정 종목이 투자유의종목인지 아래와 같은 방법으로 확인할 수 있습니다.
+
+            >>> KOA_Functions("IsOrderWarningETF", "종목코드(6자리)")
+
+            투자유의 종목인 경우 "1" 값이 리턴, 그렇지 않은 경우 "0" 값 리턴. (ETF가 아닌 종목을 입력시 "0" 값 리턴.)
+
+            8. 주식 전종목대상 투자유의 종목 여부 (2020/11/26 적용)
+            거래소 제도개선으로 주식 종목 중 정리매매/단기과열/투자위험/투자경고 종목을 매수주문하는 경우
+            경고 메세지 창이 출력되도록 기능이 추가 되었습니다. (경고 창 출력 시 주문을 중지/전송 선택 가능합니다.)
+            주문 함수를 호출하기 전에 특정 종목이 투자유의종목인지 아래와 같은 방법으로 확인할 수 있습니다.
+
+            >>> KOA_Functions("IsOrderWarningStock", "종목코드(6자리)")
+
+            리턴 값 - "0":해당없음, "2":정리매매, "3":단기과열, "4":투자위험, "5":투자경고
+
+            9. 상장주식수 구하기 (2021/04/08 적용)
+            상장주식수를 구하는 GetMasterListedStockCnt() 기존 함수 사용시 특정 종목 데이터가 long 형을 Overflow 하는 현상이 있습니다.
+            이에, 상장주식수를 구하는 기능을 신규 추가 합니다. 사용법은 아래와 같습니다.
+
+            >>> KOA_Functions("GetMasterListedStockCntEx", "종목코드(6자리)")
+
+        Args:
+            sFunctionName (str): 함수이름 혹은 기능이름
+            sParam (str): 함수 매개변수
+
+        Returns:
+            str: 결과 데이터
+        """
+        ...
+
+[docs]    def SetInfoData(self, sInfoData: str) -> int:
+        """
+        다수의 아이디로 자동로그인이 필요할 때 사용한다.
+
+        Args:
+            sInfoData (str): 아이디
+
+        Returns:
+            int: 통신결과
+
+        Examples:
+            >>> SetInfoData("UserID")
+        """
+        ...
+
+[docs]    def SetRealReg(
+        self, strScreenNo: str, strCodeList: str, strFidList: str, strOptType: str
+    ) -> int:
+        """
+        실시간 등록을 한다.
+
+        종목코드와 FID 리스트를 이용해서 실시간 시세를 등록하는 함수입니다.
+        한번에 등록가능한 종목과 FID갯수는 100종목, 100개 입니다.
+        실시간 등록타입을 0으로 설정하면 등록한 종목들은 실시간 해지되고 등록한 종목만 실시간 시세가 등록됩니다.
+        실시간 등록타입을 1로 설정하면 먼저 등록한 종목들과 함께 실시간 시세가 등록됩니다
+
+        strOptType 이 "0" 으로 하면 같은 화면에서 다른 종목 코드로 실시간 등록을 하게 되면
+        마지막에 사용한 종목코드만 실시간 등록이 되고 기존에 있던 종목은 실시간이 자동 해지됨.
+        "1" 로 하면 같은 화면에서 다른 종목들을 추가하게 되면 기존에 등록한 종목도 함께 실시간 시세를 받을 수 있음.
+        꼭 같은 화면이여야 하고 최초 실시간 등록은 "0" 으로 하고 이후부터 "1" 로 등록해야함.
+
+        Args:
+            strScreenNo (str): 화면번호 (4자리)
+            strCodeList (str): 종목코드 (복수종목가능, ';' 구분자)
+            strFidList (str): FID (';' 구분자)
+            strOptType (str): 등록타입 (0:최초 등록시, 혹은 기존 등록된 종목 해지하고 등록 1:기존 등록된 종목 유지하고 등록)
+
+        Returns:
+            int: 통신결과
+        """
+        ...
+
+[docs]    def GetConditionLoad(self) -> int:
+        """
+        서버에 저장된 사용자 조건식을 조회해서 임시로 파일에 저장.
+
+        서버에 저장된 사용자 조건검색 목록을 요청합니다.
+        조건검색 목록을 모두 수신하면 OnReceiveConditionVer() 이벤트가 발생됩니다.
+        조건검색 목록 요청을 성공하면 1, 아니면 0을 리턴합니다.
+
+        System 폴더에 아이디_NewSaveIndex.dat 파일로 저장된다. OCX 가 종료되면 삭제시킨다.
+        조건검색 사용시 이 함수를 최소 한번은 호출해야 조건검색을 할 수 있다.
+        영웅문에서 사용자 조건을 수정 및 추가하였을 경우에도 최신의 사용자 조건을 받고 싶으면 다시
+        조회해야한다.
+
+        Returns:
+            int: 성공하면 1, 아니면 0을 반환
+        """
+        ...
+
+[docs]    def GetConditionNameList(self) -> str:
+        """
+        조건검색 조건명 리스트를 받아온다.
+
+        서버에서 수신한 사용자 조건식을 조건식의 고유번호와 조건식 이름을 한 쌍으로 하는 문자열들로 전달합니다.
+        조건식 하나는 조건식의 고유번호와 조건식 이름이 구분자 '^' 로 나뉘어져 있으며 각 조건식은 ';' 로 나뉘어져 있습니다.
+        이 함수는 OnReceiveConditionVer() 이벤트에서 사용해야 합니다.
+
+        Returns:
+            str: 조건명 리스트 문자열
+
+        Examples:
+            >>> GetConditionNameList()
+            "1^내조건식1;2^내조건식2;5^내조건식3;..."
+        """
+        ...
+
+[docs]    def SendCondition(
+        self, strScrNo: str, strConditionName: str, nIndex: int, nSearch: int
+    ) -> int:
+        """
+        조건검색 종목조회TR을 송신한다.
+
+        서버에 조건검색을 요청하는 함수입니다.
+        마지막 인자값으로 조건검색만 할것인지 실시간 조건검색도 수신할 것인지를 지정할 수 있습니다.
+        GetConditionNameList() 함수로 얻은 조건식 이름과 고유번호의 쌍을 맞춰서 사용해야 합니다.
+        리턴값 1이면 성공이며, 0이면 실패입니다.
+        요청한 조건식이 없거나 조건 고유번호와 조건명이 서로 안맞거나 조회횟수를 초과하는 경우 실패하게 됩니다.
+
+        단순 조건식에 맞는 종목을 조회하기 위해서는 조회구분을 0으로 하고,
+        실시간 조건검색을 하기 위해서는 조회구분을 1로 한다.
+        OnReceiveTrCondition() 으로 결과값이 온다.
+        연속조회가 필요한 경우에는 응답받는 곳에서 연속조회 여부에 따라 연속조회를 송신하면된다.
+
+        Args:
+            strScrNo (str): 화면번호
+            strConditionName (str): 조건식 이름
+            nIndex (int): 조건식 인덱스
+            nSearch (int): 조회구분 (0:일반조회, 1:실시간조회 (최초 일반조회 + 이후 실시간조회), 2:연속조회)
+
+        Returns:
+            int: 성공하면 1, 아니면 0을 반환
+        """
+        ...
+
+[docs]    def SendConditionStop(
+        self, strScrNo: str, strConditionName: str, nIndex: int
+    ) -> None:
+        """
+        조건검색 실시간 중지TR을 송신한다.
+
+        실시간 조건검색을 중지할 때 사용하는 함수입니다.
+        조건식 조회할때 얻는 조건식 이름과 고유번호의 쌍을 맞춰서 사용해야 합니다.
+
+        해당 조건명의 실시간 조건검색을 중지하거나,
+        다른 조건명으로 바꿀 때 이전 조건명으로 실시간 조건검색을 반드시 중지해야한다.
+        화면 종료시에도 실시간 조건검색을 한 조건명으로 전부 중지해줘야 한다.
+
+        Args:
+            strScrNo (str): 화면번호
+            strConditionName (str): 조건식 이름
+            nIndex (int): 조건식 인덱스
+
+        Returns:
+            None
+        """
+        ...
+
+[docs]    def GetCommDataEx(self, strTrCode: str, strRecordName: str):
+        """
+        차트 조회 데이터를 배열로 받아온다.
+
+        조회 수신데이터 크기가 큰 차트데이터를 한번에 가져올 목적으로 만든 차트조회 전용함수입니다.
+
+        조회 데이터가 많은 차트 경우 GetCommData()로 항목당 하나씩 받아오는 것 보다
+        한번에 데이터 전부를 받아서 사용자가 처리할 수 있도록 배열로 받는다.
+
+        ※ Qt 기준으로 QVariant 타입의 배열을 반환하지만 PySide2 에서는 완전히 똑같이 지원하진 않습니다.
+
+        Args:
+            strTrCode (str): TR코드
+            strRecordName (str): 레코드명
+
+        Returns:
+            QVariant: 조회 데이터 배열
+        """
+        ...
+
+[docs]    def SetRealRemove(self, strScrNo: str, strDelCode: str) -> None:
+        """
+        종목별 실시간 해제.
+
+        실시간시세 해지 함수이며 화면번호와 종목코드를 이용해서 상세하게 설정할 수 있습니다.
+
+        ※ A종목에 대한 실시간이 여러 화면번호로 중복 등록되어 있는 경우 특정 화면번호를 이용한
+        SetRealRemove() 함수호출시 A종목의 실시간시세는 해지되지 않습니다.
+
+        SetRealReg() 함수로 실시간 등록한 종목만 실시간 해제 할 수 있다.
+
+        Args:
+            strScrNo (str): 화면번호 (4자리) 또는 "ALL"
+            strDelCode (str): 종목코드 또는 "ALL"
+
+        Returns:
+            None
+        """
+        ...
+
+[docs]    def GetMarketType(self, sTrCode: str) -> int:
+        """
+        주어진 종목코드의 시장구분값을 가져온다.
+
+        시장 구분:
+            - 0: 장내
+            - 3: ELW
+            - 4: 뮤추얼펀드
+            - 5: 신주인수권
+            - 6: 리츠
+            - 8: ETF
+            - 9: 하이일드펀드
+            - 10: 코스닥
+            - 30: K-OTC
+            - 50: 코넥스 (KONEX)
+
+        Args:
+            sTrCode (str): 종목코드
+
+        Returns:
+            int: 시장 구분값
+        """
+        ...
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusDispatchSignature.html b/_modules/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusDispatchSignature.html new file mode 100644 index 00000000..b10d4b71 --- /dev/null +++ b/_modules/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusDispatchSignature.html @@ -0,0 +1,208 @@ + + + + + + + + koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusDispatchSignature — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusDispatchSignature

+from __future__ import annotations
+
+from typing import Dict, List
+
+import pythoncom
+
+from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusDispatchFunctions import (
+    KiwoomOpenApiPlusDispatchFunctions,
+)
+from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusSignature import (
+    KiwoomOpenApiPlusSignature,
+)
+from koapy.utils.builtin import dir_public
+
+
+[docs]class KiwoomOpenApiPlusDispatchSignature(KiwoomOpenApiPlusSignature):
+
+[docs]    DISPATCH_SIGNATURES_BY_NAME: Dict[str, KiwoomOpenApiPlusDispatchSignature] = {}
+
+    @classmethod
+[docs]    def from_name(cls, name: str) -> KiwoomOpenApiPlusDispatchSignature:
+        signature = cls.DISPATCH_SIGNATURES_BY_NAME[name]
+        return signature
+
+    @classmethod
+[docs]    def names(cls) -> List[str]:
+        names = cls.DISPATCH_SIGNATURES_BY_NAME.keys()
+        names = list(names)
+        if not names:
+            _names = dir_public(KiwoomOpenApiPlusDispatchFunctions)
+        return names
+
+    @classmethod
+    def _make_dispatch_signatures_by_name(
+        cls,
+    ) -> Dict[str, KiwoomOpenApiPlusDispatchSignature]:
+        from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusTypeLib import (
+            DISPATCH_OLE_ITEM,
+        )
+
+        dispatch = DISPATCH_OLE_ITEM
+        dispatch_signatures_by_name: Dict[str, KiwoomOpenApiPlusDispatchSignature] = {}
+        if dispatch:
+            dispatch_funcs = [
+                (name, entry)
+                for name, entry in dispatch.mapFuncs.items()
+                if not any(
+                    [
+                        entry.desc[9] & pythoncom.FUNCFLAG_FRESTRICTED
+                        and entry.desc[0] != pythoncom.DISPID_NEWENUM,
+                        entry.desc[3] != pythoncom.FUNC_DISPATCH,
+                        entry.desc[0] == pythoncom.DISPID_NEWENUM,
+                    ]
+                )
+            ]
+            for func_name, entry in dispatch_funcs:
+                signature = cls._from_entry(func_name, entry)
+                dispatch_signatures_by_name[func_name] = signature
+        return dispatch_signatures_by_name
+
+    @classmethod
+    def _initialize(cls):
+        cls.DISPATCH_SIGNATURES_BY_NAME = cls._make_dispatch_signatures_by_name()
+
+
+KiwoomOpenApiPlusDispatchSignature._initialize()  # pylint: disable=protected-access
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusDynamicCallable.html b/_modules/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusDynamicCallable.html new file mode 100644 index 00000000..7f3b5dea --- /dev/null +++ b/_modules/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusDynamicCallable.html @@ -0,0 +1,273 @@ + + + + + + + + koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusDynamicCallable — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusDynamicCallable

+from __future__ import annotations
+
+from concurrent.futures import Future
+from inspect import Signature
+from typing import Any, Callable, Generic, List, Optional, Sequence, TypeVar
+
+try:
+    from typing import ParamSpec
+except ImportError:
+    from typing_extensions import ParamSpec
+
+from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusDispatchSignature import (
+    KiwoomOpenApiPlusDispatchSignature,
+)
+from koapy.compat.pyside2.QtAxContainer import QAxWidget
+from koapy.compat.pyside2.QtCore import QObject, Qt, Signal
+
+[docs]P = ParamSpec("P")
+[docs]R = TypeVar("R")
+
+
+[docs]class KiwoomOpenApiPlusDynamicCallableRunnable:
+    def __init__(
+        self,
+        future: Future,
+        fn: Callable[..., Any],
+        args: Sequence[Any],
+    ):
+        self._future = future
+        self._fn = fn
+        self._args = args
+
+[docs]    def run(self):
+        if not self._future.set_running_or_notify_cancel():
+            return
+        try:
+            result = self._fn(self._args)
+        except BaseException as exc:  # pylint: disable=broad-except
+            self._future.set_exception(exc)
+            # break a reference cycle with the exception 'exc'
+            self = None  # pylint: disable=self-cls-assignment
+        else:
+            self._future.set_result(result)
+
+[docs]    def cancel(self):
+        return self._future.cancel()
+
+
+[docs]class KiwoomOpenApiPlusDynamicCallable(QObject, Generic[P, R]):
+
+[docs]    ready_runnable = Signal(KiwoomOpenApiPlusDynamicCallableRunnable)
+
+    def __init__(
+        self,
+        control: QAxWidget,
+        name: str,
+        parent: Optional[QObject] = None,
+    ):
+        super().__init__(parent)
+
+        self._control = control
+        self._name = name
+
+        self._signature = KiwoomOpenApiPlusDispatchSignature.from_name(self._name)
+        self._function = self._signature.to_pyside2_function_prototype()
+        self._has_return_value = (
+            self._signature.return_annotation is not Signature.empty
+        )
+
+        self.ready_runnable.connect(self.on_ready_runnable, Qt.QueuedConnection)
+
+        self.__name__ = self._name
+        self.__signature__ = self._signature
+
+[docs]    def bind_dynamic_call_args(self, *args, **kwargs) -> List[Any]:
+        try:
+            ba = self._signature.bind(*args, **kwargs)
+        except TypeError as e:
+            raise TypeError(
+                "Exception while binding arguments for function: %s" % self._name
+            ) from e
+        ba.apply_defaults()
+        args = list(ba.args)
+        return args
+
+[docs]    def is_valid_return_type(self, result: Any) -> bool:
+        is_valid = True
+        if self._has_return_value:
+            if not isinstance(result, self._signature.return_annotation):
+                is_valid = False
+        return is_valid
+
+[docs]    def check_return_value(self, result: Any):
+        if not self.is_valid_return_type(result):
+            raise TypeError(
+                "Return type of %s was expected for function call %s(...), but %s was found"
+                % (
+                    self._signature.return_annotation,
+                    self._name,
+                    type(result),
+                )
+            )
+        return result
+
+[docs]    def dynamic_call(self, args: Sequence[Any]) -> R:
+        return self._control.dynamicCall(self._function, args)
+
+[docs]    def dynamic_call_and_check(self, args: Sequence[Any]) -> R:
+        result = self.dynamic_call(args)
+        self.check_return_value(result)
+        return result
+
+[docs]    def call(self, *args: P.args, **kwargs: P.kwargs) -> R:
+        args = self.bind_dynamic_call_args(*args, **kwargs)
+        result = self.dynamic_call_and_check(args)
+        return result
+
+[docs]    def async_call(self, *args: P.args, **kwargs: P.kwargs) -> Future:
+        args = self.bind_dynamic_call_args(*args, **kwargs)
+        future = Future()
+        runnable = KiwoomOpenApiPlusDynamicCallableRunnable(
+            future, self.dynamic_call_and_check, args
+        )
+        self.ready_runnable.emit(runnable)
+        return future
+
+[docs]    def on_ready_runnable(self, runnable: KiwoomOpenApiPlusDynamicCallableRunnable):
+        runnable.run()
+
+    def __call__(self, *args: P.args, **kwargs: P.kwargs) -> R:
+        return self.call(*args, **kwargs)
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusEntrypoint.html b/_modules/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusEntrypoint.html new file mode 100644 index 00000000..1380d06e --- /dev/null +++ b/_modules/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusEntrypoint.html @@ -0,0 +1,240 @@ + + + + + + + + koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusEntrypoint — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusEntrypoint

+import threading
+
+from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusEntrypointMixin import (
+    KiwoomOpenApiPlusEntrypointMixin,
+)
+from koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusServiceClient import (
+    KiwoomOpenApiPlusServiceClient,
+)
+from koapy.config import config, get_32bit_executable
+from koapy.utils.logging import get_verbosity
+from koapy.utils.logging.Logging import Logging
+from koapy.utils.networking import get_free_localhost_port
+from koapy.utils.subprocess import Popen
+
+
+[docs]class KiwoomOpenApiPlusEntrypoint(KiwoomOpenApiPlusEntrypointMixin, Logging):
+    def __init__(
+        self,
+        port=None,
+        client_check_timeout=None,
+    ):
+        if port is None:
+            port = (
+                config.get("koapy.backend.kiwoom_open_api_plus.grpc.port", 0)
+                or get_free_localhost_port()
+            )
+
+        self._port = port
+        self._client_check_timeout = client_check_timeout
+
+        self._server_executable = get_32bit_executable()
+        self._server_proc_args = [self._server_executable, "-m", "koapy.cli", "serve"]
+        if self._port is not None:
+            self._server_proc_args.extend(["-p", str(self._port)])
+
+        self._verbosity = get_verbosity()
+        self._server_proc_args.extend(["-" + "v" * self._verbosity])
+
+        self._server_proc = None
+        self._server_proc_start_timeout = 30
+        self._server_proc_terminate_timeout = 30
+
+        self._client = KiwoomOpenApiPlusServiceClient(port=self._port)
+
+        self.logger.debug("Testing if client is ready...")
+        if not self._client.is_ready(self._client_check_timeout):
+            self.logger.debug("Client is not ready")
+            self.logger.debug("Creating a new server...")
+            self._server_proc = Popen(self._server_proc_args)
+            assert self._client.is_ready(
+                self._server_proc_start_timeout
+            ), "Failed to create server"
+            self._stub = self._client.get_stub()
+        else:
+            self.logger.debug("Client is ready, using existing server")
+            self._stub = self._client.get_stub()
+
+        self._context_lock = threading.RLock()
+        self._enter_count = 0
+
+    def __del__(self):
+        self.close()
+
+    def __enter__(self):
+        with self._context_lock:
+            self._enter_count += 1
+            return self
+
+    def __exit__(self, exc_type, exc_value, traceback):
+        with self._context_lock:
+            if self._enter_count > 0:
+                self._enter_count -= 1
+                if self._enter_count == 0:
+                    self.close()
+
+[docs]    def get_stub(self):
+        return self._stub
+
+[docs]    def close_client(self):
+        self._client.close()
+
+[docs]    def close_server_proc(self):
+        if self._server_proc is not None:
+            self._server_proc.terminate()  # maybe soft termination available via grpc? rather than hard termination
+            self._server_proc.wait(self._server_proc_terminate_timeout)
+            self._server_proc = None
+
+[docs]    def close(self):
+        self.close_client()
+        self.close_server_proc()
+
+    def __getattr__(self, name):
+        try:
+            stub = self.__getattribute__("_stub")
+        except AttributeError:
+            return self.__getattribute__(name)
+        else:
+            return getattr(stub, name)
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusEntrypointMixin.html b/_modules/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusEntrypointMixin.html new file mode 100644 index 00000000..7df5072f --- /dev/null +++ b/_modules/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusEntrypointMixin.html @@ -0,0 +1,144 @@ + + + + + + + + koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusEntrypointMixin — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusEntrypointMixin

+[docs]class KiwoomOpenApiPlusEntrypointMixin:
+    pass
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusError.html b/_modules/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusError.html new file mode 100644 index 00000000..5875398a --- /dev/null +++ b/_modules/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusError.html @@ -0,0 +1,489 @@ + + + + + + + + koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusError — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusError

+from concurrent.futures import Future
+from functools import wraps
+from typing import Callable, Optional, TypeVar, Union
+
+[docs]CallableReturnsInt = Callable[..., int]
+
+[docs]IntOrBool = TypeVar(
+    "IntOrBool",
+    int,
+    bool,
+)
+
+[docs]CallableReturnsIntOrBool = TypeVar(
+    "CallableReturnsIntOrBool",
+    Callable[..., int],
+    Callable[..., bool],
+)
+
+[docs]IntCompatible = TypeVar(
+    "IntCompatible",
+    int,
+    Callable[..., int],
+    Future,
+)
+
+[docs]BoolCompatible = TypeVar(
+    "BoolCompatible",
+    int,
+    bool,
+    Callable[..., int],
+    Callable[..., bool],
+    Future,
+)
+
+
+[docs]class KiwoomOpenApiPlusError(Exception):
+    def __init__(self, message: Optional[str] = None):
+        if message is not None:
+            super().__init__(message)
+        else:
+            super().__init__()
+
+        self._message = message
+
+    @property
+[docs]    def message(self):
+        return self._message
+
+    @classmethod
+[docs]    def try_or_raise(
+        cls,
+        arg: IntCompatible,
+        message: Optional[str] = None,
+        except_callback: Optional[Callable] = None,
+    ) -> IntCompatible:
+        return KiwoomOpenApiPlusNegativeReturnCodeError.try_or_raise(
+            arg, message, except_callback
+        )
+
+    @classmethod
+[docs]    def try_or_raise_boolean(
+        cls,
+        arg: BoolCompatible,
+        message: str,
+        except_callback: Optional[Callable] = None,
+    ) -> BoolCompatible:
+        return KiwoomOpenApiPlusBooleanReturnCodeError.try_or_raise(
+            arg, message, except_callback
+        )
+
+    @classmethod
+[docs]    def get_error_message_by_code(cls, code: int, default: Optional[str] = None):
+        return KiwoomOpenApiPlusNegativeReturnCodeError.get_error_message_by_code(
+            code, default
+        )
+
+
+[docs]class KiwoomOpenApiPlusNegativeReturnCodeError(KiwoomOpenApiPlusError):
+
+[docs]    OP_ERR_NONE = 0
+[docs]    OP_ERR_FAIL = -10
+[docs]    OP_ERR_COND_NOTFOUND = -11
+[docs]    OP_ERR_COND_MISMATCH = -12
+[docs]    OP_ERR_COND_OVERFLOW = -13
+[docs]    OP_ERR_TR_FAIL = -22
+[docs]    OP_ERR_LOGIN = -100
+[docs]    OP_ERR_CONNECT = -101
+[docs]    OP_ERR_VERSION = -102
+[docs]    OP_ERR_FIREWALL = -103
+[docs]    OP_ERR_MEMORY = -104
+[docs]    OP_ERR_INPUT = -105
+[docs]    OP_ERR_SOCKET_CLOSED = -106
+[docs]    OP_ERR_SISE_OVERFLOW = -200
+[docs]    OP_ERR_RQ_STRUCT_FAIL = -201
+[docs]    OP_ERR_RQ_STRING_FAIL = -202
+[docs]    OP_ERR_NO_DATA = -203
+[docs]    OP_ERR_OVER_MAX_DATA = -204
+[docs]    OP_ERR_DATA_RCV_FAIL = -205
+[docs]    OP_ERR_OVER_MAX_FID = -206
+[docs]    OP_ERR_REAL_CANCEL = -207
+[docs]    OP_ERR_ORD_WRONG_INPUT = -300
+[docs]    OP_ERR_ORD_WRONG_ACCTNO = -301
+[docs]    OP_ERR_OTHER_ACC_USE = -302
+[docs]    OP_ERR_MIS_2BILL_EXC = -303
+[docs]    OP_ERR_MIS_5BILL_EXC = -304
+[docs]    OP_ERR_MIS_1PER_EXC = -305
+[docs]    OP_ERR_MIS_3PER_EXC = -306
+[docs]    OP_ERR_SEND_FAIL = -307
+[docs]    OP_ERR_ORD_OVERFLOW = -308
+[docs]    OP_ERR_ORD_OVERFLOW2 = -311
+[docs]    OP_ERR_MIS_300CNT_EXC = -309
+[docs]    OP_ERR_MIS_500CNT_EXC = -310
+[docs]    OP_ERR_ORD_WRONG_ACCTINFO = -340
+[docs]    OP_ERR_ORD_SYMCODE_EMPTY = -500
+
+[docs]    MSG_ERR_NONE = "정상처리"
+[docs]    MSG_ERR_FAIL = "실패"
+[docs]    MSG_ERR_COND_NOTFOUND = "조건번호 없음"
+[docs]    MSG_ERR_COND_MISMATCH = "조건번호와 조건식 틀림"
+[docs]    MSG_ERR_COND_OVERFLOW = "조건검색 조회요청 초과"
+[docs]    MSG_ERR_TR_FAIL = "전문 처리 실패"
+[docs]    MSG_ERR_LOGIN = "사용자정보 교환 실패"
+[docs]    MSG_ERR_CONNECT = "서버접속 실패"
+[docs]    MSG_ERR_VERSION = "버전처리 실패"
+[docs]    MSG_ERR_FIREWALL = "개인방화벽 실패"
+[docs]    MSG_ERR_MEMORY = "메모리보호 실패"
+[docs]    MSG_ERR_INPUT = "함수입력값 오류"
+[docs]    MSG_ERR_SOCKET_CLOSED = "통신 연결종료"
+[docs]    MSG_ERR_SISE_OVERFLOW = "시세조회 과부하"
+[docs]    MSG_ERR_RQ_STRUCT_FAIL = "전문작성 초기화 실패"
+[docs]    MSG_ERR_RQ_STRING_FAIL = "전문작성 입력값 오류"
+[docs]    MSG_ERR_NO_DATA = "데이터 없음"
+[docs]    MSG_ERR_OVER_MAX_DATA = "조회 가능한 종목수 초과"
+[docs]    MSG_ERR_DATA_RCV_FAIL = "데이터수신 실패"
+[docs]    MSG_ERR_OVER_MAX_FID = "조회 가능한 FID수 초과"
+[docs]    MSG_ERR_REAL_CANCEL = "실시간 해제 오류"
+[docs]    MSG_ERR_ORD_WRONG_INPUT = "입력값 오류"
+[docs]    MSG_ERR_ORD_WRONG_ACCTNO = "계좌 비밀번호 없음"
+[docs]    MSG_ERR_OTHER_ACC_USE = "타인계좌사용 오류"
+[docs]    MSG_ERR_MIS_2BILL_EXC = "주문가격이 20억원을 초과"
+[docs]    MSG_ERR_MIS_5BILL_EXC = "주문가격이 50억원을 초과"
+[docs]    MSG_ERR_MIS_1PER_EXC = "주문수량이 총발행주수의 1%초과오류"
+[docs]    MSG_ERR_MIS_3PER_EXC = "주문수량이 총발행주수의 3%초과오류"
+[docs]    MSG_ERR_SEND_FAIL = "주문전송 실패"
+[docs]    MSG_ERR_ORD_OVERFLOW = "주문전송 과부하"
+[docs]    MSG_ERR_ORD_OVERFLOW2 = "주문전송 과부하"
+[docs]    MSG_ERR_MIS_300CNT_EXC = "주문수량 300계약 초과"
+[docs]    MSG_ERR_MIS_500CNT_EXC = "주문수량 500계약 초과"
+[docs]    MSG_ERR_ORD_WRONG_ACCTINFO = "계좌정보없음"
+[docs]    MSG_ERR_ORD_SYMCODE_EMPTY = "종목코드없음"
+
+[docs]    ERROR_MESSAGE_BY_CODE = {
+        OP_ERR_NONE: MSG_ERR_NONE,
+        OP_ERR_FAIL: MSG_ERR_FAIL,
+        OP_ERR_COND_NOTFOUND: MSG_ERR_COND_NOTFOUND,
+        OP_ERR_COND_MISMATCH: MSG_ERR_COND_MISMATCH,
+        OP_ERR_COND_OVERFLOW: MSG_ERR_COND_OVERFLOW,
+        OP_ERR_TR_FAIL: MSG_ERR_TR_FAIL,
+        OP_ERR_LOGIN: MSG_ERR_LOGIN,
+        OP_ERR_CONNECT: MSG_ERR_CONNECT,
+        OP_ERR_VERSION: MSG_ERR_VERSION,
+        OP_ERR_FIREWALL: MSG_ERR_FIREWALL,
+        OP_ERR_MEMORY: MSG_ERR_MEMORY,
+        OP_ERR_INPUT: MSG_ERR_INPUT,
+        OP_ERR_SOCKET_CLOSED: MSG_ERR_SOCKET_CLOSED,
+        OP_ERR_SISE_OVERFLOW: MSG_ERR_SISE_OVERFLOW,
+        OP_ERR_RQ_STRUCT_FAIL: MSG_ERR_RQ_STRUCT_FAIL,
+        OP_ERR_RQ_STRING_FAIL: MSG_ERR_RQ_STRING_FAIL,
+        OP_ERR_NO_DATA: MSG_ERR_NO_DATA,
+        OP_ERR_OVER_MAX_DATA: MSG_ERR_OVER_MAX_DATA,
+        OP_ERR_DATA_RCV_FAIL: MSG_ERR_DATA_RCV_FAIL,
+        OP_ERR_OVER_MAX_FID: MSG_ERR_OVER_MAX_FID,
+        OP_ERR_REAL_CANCEL: MSG_ERR_REAL_CANCEL,
+        OP_ERR_ORD_WRONG_INPUT: MSG_ERR_ORD_WRONG_INPUT,
+        OP_ERR_ORD_WRONG_ACCTNO: MSG_ERR_ORD_WRONG_ACCTNO,
+        OP_ERR_OTHER_ACC_USE: MSG_ERR_OTHER_ACC_USE,
+        OP_ERR_MIS_2BILL_EXC: MSG_ERR_MIS_2BILL_EXC,
+        OP_ERR_MIS_5BILL_EXC: MSG_ERR_MIS_5BILL_EXC,
+        OP_ERR_MIS_1PER_EXC: MSG_ERR_MIS_1PER_EXC,
+        OP_ERR_MIS_3PER_EXC: MSG_ERR_MIS_3PER_EXC,
+        OP_ERR_SEND_FAIL: MSG_ERR_SEND_FAIL,
+        OP_ERR_ORD_OVERFLOW: MSG_ERR_ORD_OVERFLOW,
+        OP_ERR_ORD_OVERFLOW2: MSG_ERR_ORD_OVERFLOW2,
+        OP_ERR_MIS_300CNT_EXC: MSG_ERR_MIS_300CNT_EXC,
+        OP_ERR_MIS_500CNT_EXC: MSG_ERR_MIS_500CNT_EXC,
+        OP_ERR_ORD_WRONG_ACCTINFO: MSG_ERR_ORD_WRONG_ACCTINFO,
+        OP_ERR_ORD_SYMCODE_EMPTY: MSG_ERR_ORD_SYMCODE_EMPTY,
+    }
+
+    @classmethod
+[docs]    def get_error_message_by_code(cls, code: int, default: Optional[str] = None):
+        return cls.ERROR_MESSAGE_BY_CODE.get(code, default)
+
+    @classmethod
+[docs]    def check_code_or_raise(cls, code: int):
+        if code < 0:
+            raise cls(code)
+        return code
+
+    @classmethod
+[docs]    def wrap_to_check_code_or_raise(
+        cls, func: CallableReturnsInt
+    ) -> CallableReturnsInt:
+        @wraps(func)
+        def wrapper(*args, **kwargs):
+            return cls.check_code_or_raise(func(*args, **kwargs))
+
+        return wrapper
+
+    @classmethod
+[docs]    def try_or_raise(
+        cls,
+        arg: IntCompatible,
+        message: Optional[str] = None,
+        except_callback: Optional[Callable] = None,
+    ) -> IntCompatible:
+        if isinstance(arg, Future):
+
+            def callback(future):
+                exc = future.exception()
+                if exc:
+                    if except_callback:
+                        except_callback(exc)
+                    else:
+                        raise exc
+                result = future.result()
+                try:
+                    cls.try_or_raise(result, message)
+                except cls as e:
+                    if except_callback:
+                        except_callback(e)
+                    else:
+                        raise
+
+            arg.add_done_callback(callback)
+            return arg
+        elif isinstance(arg, int):
+            return cls.check_code_or_raise(arg)
+        elif callable(arg):
+            return cls.wrap_to_check_code_or_raise(arg)
+        else:
+            raise TypeError(
+                "Expected 'int', 'callable' or 'Future' but %s found" % type(arg)
+            )
+
+    def __init__(self, code: int, message: Optional[str] = None):
+        if message is None:
+            message = self.get_error_message_by_code(code)
+
+        super().__init__(message)
+
+        self._code = code
+        self._message = message
+
+    def __str__(self):
+        return self._message
+
+    def __repr__(self):
+        return "{}({!r}, {!r})".format(
+            self.__class__.__name__, self._code, self._message
+        )
+
+    @property
+[docs]    def code(self):
+        return self._code
+
+
+[docs]class KiwoomOpenApiPlusBooleanReturnCodeError(KiwoomOpenApiPlusError):
+
+[docs]    OP_ERR_SUCCESS = 1
+[docs]    OP_ERR_FAILURE = 0
+
+    @classmethod
+[docs]    def check_code_or_raise(
+        cls, code: IntOrBool, message: Optional[str] = None
+    ) -> IntOrBool:
+        if not code:
+            raise cls(code, message)
+        return code
+
+    @classmethod
+[docs]    def wrap_to_check_code_or_raise(
+        cls, func: CallableReturnsIntOrBool, message: Optional[str] = None
+    ) -> CallableReturnsIntOrBool:
+        @wraps(func)
+        def wrapper(*args, **kwargs):
+            return cls.check_code_or_raise(func(*args, **kwargs), message)
+
+        return wrapper
+
+    @classmethod
+[docs]    def try_or_raise(
+        cls,
+        arg: BoolCompatible,
+        message: Optional[str] = None,
+        except_callback: Optional[Callable] = None,
+    ) -> BoolCompatible:
+        if isinstance(arg, Future):
+
+            def callback(future):
+                exc = future.exception()
+                if exc:
+                    if except_callback:
+                        except_callback(exc)
+                    else:
+                        raise exc
+                result = future.result()
+                try:
+                    cls.try_or_raise(result, message)
+                except cls as e:
+                    if except_callback:
+                        except_callback(e)
+                    else:
+                        raise
+
+            arg.add_done_callback(callback)
+            return arg
+        elif isinstance(arg, (int, bool)):
+            return cls.check_code_or_raise(arg, message)
+        elif callable(arg):
+            return cls.wrap_to_check_code_or_raise(arg, message)
+        else:
+            raise TypeError(
+                "Expected 'int', 'bool', 'callable' or 'Future' but %s found"
+                % type(arg)
+            )
+
+    def __init__(self, code: Union[int, bool], message: Optional[str] = None):
+        super().__init__(message)
+
+        self._code = code
+        self._message = message
+
+    def __str__(self):
+        if self._message:
+            return self._message
+        else:
+            return self.__repr__()
+
+    def __repr__(self):
+        return "{}({!r}, {!r})".format(
+            self.__class__.__name__, self._code, self._message
+        )
+
+    @property
+[docs]    def code(self):
+        return self._code
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusEventFunctions.html b/_modules/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusEventFunctions.html new file mode 100644 index 00000000..5dad2d91 --- /dev/null +++ b/_modules/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusEventFunctions.html @@ -0,0 +1,330 @@ + + + + + + + + koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusEventFunctions — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusEventFunctions

+[docs]class KiwoomOpenApiPlusEventFunctions:
+[docs]    def OnReceiveTrData(
+        self,
+        sScrNo: str,
+        sRQName: str,
+        sTrCode: str,
+        sRecordName: str,
+        sPrevNext: str,
+        nDataLength: int,
+        sErrorCode: str,
+        sMessage: str,
+        sSplmMsg: str,
+    ) -> None:
+        """
+        서버통신 후 데이터를 받은 시점을 알려준다.
+
+        요청했던 조회데이터를 수신했을때 발생됩니다.
+        수신된 데이터는 이 이벤트내부에서 GetCommData() 함수를 이용해서 얻어올 수 있습니다.
+
+        파라미터 매핑:
+            - sRQName = CommRqData() 의 sRQName과 매핑되는 이름이다.
+            - sTrCode = CommRqData() 의 sTrCode과 매핑되는 이름이다.
+
+        Args:
+            sScrNo (str): 화면번호
+            sRQName (str): 사용자 구분명
+            sTrCode (str): TR 코드
+            sRecordName (str): 레코드 명
+            sPrevNext (str): 연속조회 유무 (0:추가조회 데이터 없음, 2:추가조회 데이터 있음)
+            nDataLength (str): 사용안함
+            sErrorCode (str): 사용안함
+            sMessage (str): 사용안함
+            sSplmMsg (str): 사용안함
+
+        Returns:
+            None
+        """
+        ...
+
+[docs]    def OnReceiveRealData(self, sRealKey: str, sRealType: str, sRealData: str) -> None:
+        """
+        실시간데이터를 받은 시점을 알려준다.
+
+        실시간시세 데이터가 수신될때마다 종목단위로 발생됩니다.
+        SetRealReg() 함수로 등록한 실시간 데이터도 이 이벤트로 전달됩니다.
+        GetCommRealData() 함수를 이용해서 수신된 데이터를 얻을수 있습니다.
+
+        Args:
+            sRealKey (str): 종목코드
+            sRealType (str): 실시간 타입
+            sRealData (str): 실시간 데이터전문 (사용불가)
+
+        Returns:
+            None
+        """
+        ...
+
+[docs]    def OnReceiveMsg(self, sScrNo: str, sRQName: str, sTrCode: str, sMsg: str) -> None:
+        """
+        서버통신 후 메시지를 받은 시점을 알려준다.
+
+        주문전송 또는 데이터 조회요청 후 서버 메시지가 수신됩니다.
+        ※ 메시지에 포함된 6자리 코드번호는 변경될 수 있으니, 여기에 수신된 코드번호를 특정 용도로 사용하지 마시기 바랍니다.
+
+        파라미터 매핑:
+            - sScrNo = CommRqData() 의 sScrNo와 매핑된다.
+            - sRQName = CommRqData() 의 sRQName 와 매핑된다.
+            - sTrCode = CommRqData() 의 sTrCode 와 매핑된다.
+
+        메시지 예시:
+            - "조회가 완료되었습니다."
+            - "증거금 부족으로 주문이 거부되었습니다."
+            - "정정할 원주문 내역이 없습니다."
+            - "비밀번호 입력을 확인해주시기 바랍니다."
+
+        Args:
+            sScrNo: str, sRQName: str, sTrCode: str, sMsg: str
+
+        Returns:
+            None
+        """
+        ...
+
+[docs]    def OnReceiveChejanData(self, sGubun: str, nItemCnt: int, sFIdList: str) -> None:
+        """
+        체결데이터를 받은 시점을 알려준다.
+
+        주문전송 후 주문접수, 체결통보, 잔고통보를 수신할 때 마다 발생됩니다.
+        GetChejanData() 함수를 이용해서 FID 항목별 값을 얻을수 있습니다.
+
+        Args:
+            sGubun (str): 체결구분 (0:주문체결통보, 1:국내주식 잔고통보, 4:파생상품 잔고통보)
+            nItemCnt (int): 아이템 개수
+            sFIdList (str): 데이터 리스트 (';' 구분자)
+
+        Returns:
+            None
+        """
+        ...
+
+[docs]    def OnEventConnect(self, nErrCode: int) -> None:
+        """
+        서버 접속 관련 이벤트.
+
+        로그인 처리 이벤트입니다. 성공이면 인자값 nErrCode가 0이며 에러는 다음과 같은 값이 전달됩니다.
+
+        에러코드 구분:
+            - OP_ERR_LOGIN(-100): 사용자 정보교환 실패
+            - OP_ERR_CONNECT(-101): 서버접속 실패
+            - OP_ERR_VERSION(-102): 버전처리 실패
+
+        Args:
+            nErrCode (int): 에러코드 (0:로그인 성공, 음수:실패)
+
+        Returns:
+            None
+        """
+        ...
+
+[docs]    def OnReceiveInvestRealData(self, sRealKey: str) -> None:
+        """
+        더 이상 지원하지 않는 함수.
+        """
+        ...
+
+[docs]    def OnReceiveRealCondition(
+        self, sTrCode: str, strType: str, strConditionName: str, strConditionIndex: str
+    ) -> None:
+        """
+        조건검색 실시간 편입,이탈 종목을 받을 시점을 알려준다.
+
+        실시간 조건검색 요청으로 신규종목이 편입되거나 기존 종목이 이탈될때 마다 발생됩니다.
+        ※ 편입되었다가 순간적으로 다시 이탈되는 종목에대한 신호는 조건검색 서버마다 차이가 발생할 수 있습니다.
+
+        strConditionName 에 해당하는 종목이 실시간으로 들어옴.
+        strType 으로 편입된 종목인지 이탈된 종목인지 구분한다.
+
+        Args:
+            sTrCode (str): 종목코드
+            strType (str): 편입/이탈 구분 (I:편입, D:이탈)
+            strConditionName (str): 조건식 이름
+            strConditionIndex (str): 조건식 인덱스
+
+        Returns:
+            None
+        """
+        ...
+
+[docs]    def OnReceiveTrCondition(
+        self,
+        sScrNo: str,
+        strCodeList: str,
+        strConditionName: str,
+        nIndex: int,
+        nNext: int,
+    ) -> None:
+        """
+        조건검색 조회응답으로 종목리스트를 받는 시점.
+
+        조건검색 요청에대한 서버 응답 수신시 발생하는 이벤트입니다.
+        종목코드 리스트는 각 종목코드가 ';' 로 구분되서 전달됩니다.
+
+        Args:
+            sScrNo (str): 화면번호
+            strCodeList (str): 종목리스트 (';' 구분자)
+            strConditionName (str): 조건식 이름
+            nIndex (int): 조건식 인덱스
+            nNext (int): 연속조회 여부 (2:연속조회, 0:연속조회 없음)
+
+        Returns:
+            None
+        """
+        ...
+
+[docs]    def OnReceiveConditionVer(self, lRet: int, sMsg: str) -> None:
+        """
+        로컬에 사용자 조건식 저장 성공 여부를 확인하는 시점.
+
+        저장된 사용자 조건식 불러오기 요청에 대한 응답 수신시 발생되는 이벤트입니다.
+
+        Args:
+            lRet (int): 사용자 조건식 저장 성공여부 (1:성공, 나머지:실패)
+            sMsg (str): 호출결과 메시지
+
+        Returns:
+            None
+        """
+        ...
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusEventHandler.html b/_modules/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusEventHandler.html new file mode 100644 index 00000000..dd2f41c8 --- /dev/null +++ b/_modules/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusEventHandler.html @@ -0,0 +1,248 @@ + + + + + + + + koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusEventHandler — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusEventHandler

+from contextlib import ExitStack
+from threading import RLock
+
+from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusEventHandlerFunctions import (
+    KiwoomOpenApiPlusEventHandlerFunctions,
+)
+from koapy.backend.kiwoom_open_api_plus.utils.queue.QueueBasedIterableObserver import (
+    QueueBasedIterableObserver,
+)
+from koapy.utils.notimplemented import isimplemented
+
+
+[docs]class KiwoomOpenApiPlusEventHandler(KiwoomOpenApiPlusEventHandlerFunctions):
+    # pylint: disable=abstract-method
+
+    def __init__(self, control):
+        self._control = control
+        self._observer = QueueBasedIterableObserver()
+        self._enter_count = 0
+        self._should_exit = False
+        self._stack = ExitStack()
+        self._lock = RLock()
+
+    @property
+[docs]    def control(self):
+        return self._control
+
+    @property
+[docs]    def observer(self):
+        return self._observer
+
+    @classmethod
+[docs]    def names(cls):
+        names = [
+            name
+            for name in dir(KiwoomOpenApiPlusEventHandlerFunctions)
+            if name.startswith("On")
+        ]
+        return names
+
+[docs]    def slots(self):
+        names = self.names()
+        slots = [getattr(self, name) for name in names]
+        names_and_slots_implemented = [
+            (name, slot) for name, slot in zip(names, slots) if isimplemented(slot)
+        ]
+        return names_and_slots_implemented
+
+[docs]    def connect(self):
+        for name, slot in self.slots():
+            getattr(self.control, name).connect(slot)
+
+[docs]    def disconnect(self):
+        for name, slot in self.slots():
+            getattr(self.control, name).disconnect(slot)
+
+[docs]    def on_enter(self):
+        pass
+
+[docs]    def on_exit(self, exc_type=None, exc_value=None, traceback=None):
+        pass
+
+[docs]    def add_callback(self, callback, *args, **kwargs):
+        self._stack.callback(callback, *args, **kwargs)
+
+[docs]    def enter(self):
+        with self._lock:
+            self.connect()
+            self.on_enter()
+            self._should_exit = True
+
+[docs]    def exit(self, exc_type=None, exc_value=None, traceback=None):
+        with self._lock:
+            if self._should_exit:
+                self.disconnect()
+                self.on_exit(exc_type, exc_value, traceback)
+                self._stack.__exit__(exc_type, exc_value, traceback)
+                self._should_exit = False
+
+[docs]    def stop(self):
+        return self.observer.stop()
+
+[docs]    def close(self):
+        self.exit()
+        self.stop()
+
+    def __enter__(self):
+        with self._lock:
+            if self._enter_count == 0:
+                self.enter()
+            self._enter_count += 1
+            return self
+
+    def __exit__(self, exc_type, exc_value, traceback):
+        if exc_type is not None:
+            return self.exit(exc_type, exc_value, traceback)
+        with self._lock:
+            if self._enter_count > 0:
+                self._enter_count -= 1
+            if self._enter_count == 0:
+                return self.exit(exc_type, exc_value, traceback)
+        return
+
+    def __iter__(self):
+        with self:
+            return iter(self.observer)
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusEventHandlerFunctions.html b/_modules/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusEventHandlerFunctions.html new file mode 100644 index 00000000..fa18f28c --- /dev/null +++ b/_modules/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusEventHandlerFunctions.html @@ -0,0 +1,192 @@ + + + + + + + + koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusEventHandlerFunctions — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusEventHandlerFunctions

+from koapy.utils.notimplemented import notimplemented
+
+
+[docs]class KiwoomOpenApiPlusEventHandlerFunctions:
+    @notimplemented
+[docs]    def OnEventConnect(self, errcode):
+        raise NotImplementedError
+
+    @notimplemented
+[docs]    def OnReceiveMsg(self, scrnno, rqname, trcode, msg):
+        raise NotImplementedError
+
+    @notimplemented
+[docs]    def OnReceiveTrData(
+        self,
+        scrnno,
+        rqname,
+        trcode,
+        recordname,
+        prevnext,
+        datalength,
+        errorcode,
+        message,
+        splmmsg,
+    ):
+        raise NotImplementedError
+
+    @notimplemented
+[docs]    def OnReceiveRealData(self, code, realtype, realdata):
+        raise NotImplementedError
+
+    @notimplemented
+[docs]    def OnReceiveChejanData(self, gubun, itemcnt, fidlist):
+        raise NotImplementedError
+
+    @notimplemented
+[docs]    def OnReceiveConditionVer(self, ret, msg):
+        raise NotImplementedError
+
+    @notimplemented
+[docs]    def OnReceiveTrCondition(
+        self, scrnno, codelist, condition_name, condition_index, prevnext
+    ):
+        raise NotImplementedError
+
+    @notimplemented
+[docs]    def OnReceiveRealCondition(
+        self, code, condition_type, condition_name, condition_index
+    ):
+        raise NotImplementedError
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusEventHandlerSignature.html b/_modules/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusEventHandlerSignature.html new file mode 100644 index 00000000..420794ff --- /dev/null +++ b/_modules/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusEventHandlerSignature.html @@ -0,0 +1,202 @@ + + + + + + + + koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusEventHandlerSignature — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusEventHandlerSignature

+from __future__ import annotations
+
+from typing import Dict, List
+
+from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusEventFunctions import (
+    KiwoomOpenApiPlusEventFunctions,
+)
+from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusSignature import (
+    KiwoomOpenApiPlusSignature,
+)
+from koapy.utils.builtin import dir_public
+
+
+[docs]class KiwoomOpenApiPlusEventHandlerSignature(KiwoomOpenApiPlusSignature):
+
+[docs]    EVENT_HANDLER_SIGNATURES_BY_NAME: Dict[
+        str, KiwoomOpenApiPlusEventHandlerSignature
+    ] = {}
+
+    @classmethod
+[docs]    def from_name(cls, name: str) -> KiwoomOpenApiPlusEventHandlerSignature:
+        signature = cls.EVENT_HANDLER_SIGNATURES_BY_NAME[name]
+        return signature
+
+    @classmethod
+[docs]    def names(cls) -> List[str]:
+        names = cls.EVENT_HANDLER_SIGNATURES_BY_NAME.keys()
+        names = list(names)
+        if not names:
+            _names = dir_public(KiwoomOpenApiPlusEventFunctions)
+        return names
+
+    @classmethod
+    def _make_event_handler_signatures_by_name(
+        cls,
+    ) -> Dict[str, KiwoomOpenApiPlusEventHandlerSignature]:
+        from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusTypeLib import (
+            EVENT_OLE_ITEM,
+        )
+
+        event = EVENT_OLE_ITEM
+        event_handler_signatures_by_name: Dict[
+            str, KiwoomOpenApiPlusEventHandlerSignature
+        ] = {}
+        if event:
+            event_funcs = event.mapFuncs.items()
+            event_handler_signatures_by_name = {}
+            for func_name, entry in event_funcs:
+                signature = cls._from_entry(func_name, entry)
+                event_handler_signatures_by_name[func_name] = signature
+        return event_handler_signatures_by_name
+
+    @classmethod
+    def _initialize(cls):
+        cls.EVENT_HANDLER_SIGNATURES_BY_NAME = (
+            cls._make_event_handler_signatures_by_name()
+        )
+
+
+KiwoomOpenApiPlusEventHandlerSignature._initialize()  # pylint: disable=protected-access
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusLoggingEventHandler.html b/_modules/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusLoggingEventHandler.html new file mode 100644 index 00000000..7ebc0f13 --- /dev/null +++ b/_modules/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusLoggingEventHandler.html @@ -0,0 +1,257 @@ + + + + + + + + koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusLoggingEventHandler — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusLoggingEventHandler

+import datetime
+
+from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusEventHandler import (
+    KiwoomOpenApiPlusEventHandler,
+)
+from koapy.utils.logging.Logging import Logging
+
+
+[docs]class KiwoomOpenApiPlusLoggingEventHandler(KiwoomOpenApiPlusEventHandler, Logging):
+[docs]    def OnReceiveTrData(
+        self,
+        scrnno,
+        rqname,
+        trcode,
+        recordname,
+        prevnext,
+        _datalength,
+        _errorcode,
+        _message,
+        _splmmsg,
+    ):
+        self.logger.debug(
+            "OnReceiveTrData(%r, %r, %r, %r, %r)",
+            scrnno,
+            rqname,
+            trcode,
+            recordname,
+            prevnext,
+        )
+
+[docs]    def OnReceiveRealData(self, code, realtype, realdata):
+        self.logger.debug("OnReceiveRealData(%r, %r, %r)", code, realtype, realdata)
+        if code == "09" and realtype == "장시작시간":
+            signal_type = self.control.GetCommRealData(code, 215)
+            current_time = self.control.GetCommRealData(code, 20)
+            estimated_remaining_time = self.control.GetCommRealData(code, 214)
+            signal_type_msg = {
+                # 아래는 문서에서 확인 가능
+                "0": "장시작전(동시호가시작,이후1분단위)",
+                "2": "장종료전(동시호가시작,이후1분단위)",
+                "3": "장시작(동시호가종료)",
+                "4": "장종료(동시호가종료)",
+                "8": "장종료(시간내용없음)",
+                "9": "장마감(시간내용없음)",
+                # 이후는 추정
+                "s": "선물옵션장종료전(동시호가시작)",  # 17번반복
+                "a": "장후시간외종가시작",
+                "e": "선물옵션장종료(동시호가종료)",  # 17번반복
+                "b": "장후시간외종가종료",
+                "c": "시간외단일가시작",
+                "d": "시간외단일가종료",
+            }.get(signal_type, "알수없음")
+            if signal_type not in ["8", "9"]:
+                current_time = datetime.datetime.strptime(current_time, "%H%M%S")
+            else:
+                current_time = datetime.datetime.now()
+            ert = datetime.datetime.strptime(estimated_remaining_time, "%H%M%S")
+            estimated_remaining_time = datetime.timedelta(
+                hours=ert.hour, minutes=ert.minute, seconds=ert.second
+            )
+            self.logger.debug(
+                "%s, %s remaining", signal_type_msg, estimated_remaining_time
+            )
+
+[docs]    def OnReceiveMsg(self, scrnno, rqname, trcode, msg):
+        """
+        [OnReceiveMsg()이벤트]
+
+          OnReceiveMsg(
+          BSTR sScrNo,   // 화면번호
+          BSTR sRQName,  // 사용자 구분명
+          BSTR sTrCode,  // TR이름
+          BSTR sMsg     // 서버에서 전달하는 메시지
+          )
+
+          서버통신 후 수신한 메시지를 알려줍니다.
+          메시지에는 6자리 코드번호가 포함되는데 이 코드번호는 통보없이 수시로 변경될 수 있습니다. 따라서 주문이나 오류관련처리를
+          이 코드번호로 분류하시면 안됩니다.
+        """
+        self.logger.debug("OnReceiveMsg(%r, %r, %r, %r)", scrnno, rqname, trcode, msg)
+
+        if msg == "전문 처리 실패(-22)":
+            self.logger.warning("Server might have ended connection abruptly")
+
+[docs]    def OnReceiveChejanData(self, gubun, itemcnt, fidlist):
+        self.logger.debug("OnReceiveChejanData(%r, %r, %r)", gubun, itemcnt, fidlist)
+
+[docs]    def OnEventConnect(self, errcode):
+        self.logger.debug("OnEventConnect(%r)", errcode)
+
+[docs]    def OnReceiveRealCondition(
+        self, code, condition_type, condition_name, condition_index
+    ):
+        self.logger.debug(
+            "OnReceiveRealCondition(%r, %r, %r, %r)",
+            code,
+            condition_type,
+            condition_name,
+            condition_index,
+        )
+
+[docs]    def OnReceiveTrCondition(
+        self, scrnno, codelist, condition_name, condition_index, prevnext
+    ):
+        self.logger.debug(
+            "OnReceiveTrCondition(%r, %r, %r, %r, %r)",
+            scrnno,
+            codelist,
+            condition_name,
+            condition_index,
+            prevnext,
+        )
+
+[docs]    def OnReceiveConditionVer(self, ret, msg):
+        self.logger.debug("OnReceiveConditionVer(%r, %r)", ret, msg)
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusQAxWidget.html b/_modules/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusQAxWidget.html new file mode 100644 index 00000000..d0ff1336 --- /dev/null +++ b/_modules/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusQAxWidget.html @@ -0,0 +1,301 @@ + + + + + + + + koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusQAxWidget — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusQAxWidget

+from typing import Optional, overload
+
+from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusDispatchSignature import (
+    KiwoomOpenApiPlusDispatchSignature,
+)
+from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusDynamicCallable import (
+    KiwoomOpenApiPlusDynamicCallable,
+)
+from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusEventHandlerSignature import (
+    KiwoomOpenApiPlusEventHandlerSignature,
+)
+from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusLoggingEventHandler import (
+    KiwoomOpenApiPlusLoggingEventHandler,
+)
+from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusQAxWidgetMixin import (
+    KiwoomOpenApiPlusQAxWidgetMixin,
+)
+from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusSignalConnector import (
+    KiwoomOpenApiPlusSignalConnector,
+)
+from koapy.compat.pyside2.QtAxContainer import QAxWidget
+from koapy.compat.pyside2.QtCore import QEvent, Qt
+from koapy.compat.pyside2.QtWidgets import QWidget
+from koapy.utils.logging.pyside2.QWidgetLogging import QWidgetLogging
+from koapy.utils.platform import is_32bit
+
+
+[docs]class KiwoomOpenApiPlusQAxWidget(
+    QWidgetLogging,
+    KiwoomOpenApiPlusQAxWidgetMixin,
+):
+
+[docs]    CLSID = "{A1574A0D-6BFA-4BD7-9020-DED88711818D}"
+[docs]    PROGID = "KHOPENAPI.KHOpenApiCtrl.1"
+
+[docs]    METHOD_NAMES = KiwoomOpenApiPlusDispatchSignature.names()
+[docs]    EVENT_NAMES = KiwoomOpenApiPlusEventHandlerSignature.names()
+
+    @overload
+    def __init__(
+        self,
+        c: Optional[str] = None,
+        parent: Optional[QWidget] = None,
+        f: Qt.WindowFlags = Qt.WindowFlags(),
+    ):
+        ...
+
+    @overload
+    def __init__(
+        self,
+        parent: Optional[QWidget] = None,
+        f: Qt.WindowFlags = Qt.WindowFlags(),
+    ):
+        ...
+
+    def __init__(self, *args, **kwargs):
+        # Check 32bit requirement
+        assert is_32bit(), "Control object should be created in 32bit environment"
+
+        # Process arguments
+        control: Optional[str] = None
+        parent: Optional[QWidget] = None  # pylint: disable=unused-variable
+        window_flags: Optional[Qt.WindowFlags] = None  # pylint: disable=unused-variable
+
+        # Copy args before modification
+        args = list(args)
+        kwargs = dict(kwargs)
+
+        # Pop control argument for QWidget init
+        if len(args) > 0 and isinstance(args[0], str):
+            control = args.pop(0)
+        elif "c" in kwargs:
+            control = kwargs.pop("c")
+
+        # Preserve others
+        if len(args) > 0 and (args[0] is None or isinstance(args[0], QWidget)):
+            parent = args[0]
+        elif "parent" in kwargs:
+            parent = kwargs["parent"]
+
+        if len(args) > 1:
+            window_flags = args[1]
+        elif "f" in kwargs:
+            window_flags = kwargs["f"]
+
+        # Use default control if not set
+        if control is None:
+            control = self.CLSID
+
+        # Call super init
+        QWidgetLogging.__init__(self, *args, **kwargs)
+
+        # Create QAxWidget
+        self._control = control
+        self._ax = QAxWidget(self._control, self)
+
+        # Check if instantiation of the QAxWidget was successful
+        successful = not self._ax.isNull()
+        if not successful:
+            raise RuntimeError(
+                "Requested control {} could not be instantiated".format(self._control)
+            )
+
+        # Set methods as attributes
+        for method_name in self.METHOD_NAMES:
+            dynamic_callable = KiwoomOpenApiPlusDynamicCallable(
+                self._ax, method_name, parent=self
+            )
+            setattr(self, method_name, dynamic_callable)
+
+        # Set signals as attributes
+        for event_name in self.EVENT_NAMES:
+            signal_connector = KiwoomOpenApiPlusSignalConnector(event_name)
+            signal_connector.connect_to(self._ax)
+            setattr(self, event_name, signal_connector)
+
+        # Call mixin init here, after method attributes are set
+        KiwoomOpenApiPlusQAxWidgetMixin.__init__(self)
+
+        # Enable logging for QAxWidget exceptions
+        self._ax.exception.connect(self._onException)  # pylint: disable=no-member
+
+        # Enable logging for OpenAPI events
+        self._event_logger = KiwoomOpenApiPlusLoggingEventHandler(self)
+        self._event_logger.connect()
+
+        # Other misc flags
+        self.hideOnMinimize = True
+        self.hideOnClose = True
+
+    def _onException(
+        self, code, source, desc, help
+    ):  # pylint: disable=redefined-builtin
+        self.logger.error("QAxBaseException(%r, %r, %r, %r)", code, source, desc, help)
+
+    def __getattr__(self, name):
+        try:
+            # Fallback to AxObject for attrs such as 'self.dynamicCall(...)'
+            return getattr(self._ax, name)
+        except AttributeError as e:
+            raise AttributeError(
+                "'{}' object has no attribute '{}'".format(
+                    self.__class__.__name__, name
+                )
+            ) from e
+
+[docs]    def changeEvent(self, event):
+        if event.type() == QEvent.WindowStateChange:
+            if self.windowState() & Qt.WindowMinimized:
+                if self.hideOnMinimize:
+                    self.hide()
+                    return event.ignore()
+        return event.accept()
+
+[docs]    def closeEvent(self, event):
+        if self.hideOnClose:
+            self.hide()
+            return event.ignore()
+        return event.accept()
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusQAxWidgetMixin.html b/_modules/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusQAxWidgetMixin.html new file mode 100644 index 00000000..3bec6316 --- /dev/null +++ b/_modules/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusQAxWidgetMixin.html @@ -0,0 +1,1419 @@ + + + + + + + + koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusQAxWidgetMixin — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusQAxWidgetMixin

+import json
+import os
+import queue
+import subprocess
+
+from concurrent.futures import ThreadPoolExecutor
+from pathlib import Path
+from typing import Any, Callable, Dict, Mapping, Optional, Union, overload
+
+from wrapt import synchronized
+
+from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusDispatchFunctions import (
+    KiwoomOpenApiPlusDispatchFunctions,
+)
+from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusError import (
+    KiwoomOpenApiPlusError,
+)
+from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusRateLimiter import (
+    KiwoomOpenApiPlusCommRqDataRateLimiter,
+    KiwoomOpenApiPlusSendConditionRateLimiter,
+    KiwoomOpenApiPlusSendOrderRateLimiter,
+)
+from koapy.backend.kiwoom_open_api_plus.utils.list_conversion import string_to_list
+from koapy.config import config
+from koapy.utils.ctypes import is_admin
+from koapy.utils.logging import get_verbosity
+from koapy.utils.logging.Logging import Logging
+from koapy.utils.rate_limiting.pyside2.QRateLimitedExecutor import QRateLimitedExecutor
+from koapy.utils.subprocess import Popen, function_to_subprocess_args
+
+
+[docs]class KiwoomOpenApiPlusQAxWidgetUniversalMixin(KiwoomOpenApiPlusDispatchFunctions):
+    """
+    일차적으로 KiwoomOpenApiPlusQAxWidget 객체에 대해 사용될 수 있는 Mixin 이지만,
+    넓게는 다른 KiwoomOpenApiPlusDispatchFunctions 인터페이스를 지원하는 모든 객체에서 사용될 수 있는,
+    단순하면서도 유니버셜한 메소드들이 구현되어 있는 Mixin 입니다.
+    """
+
+[docs]    def IsConnected(self):
+        """
+        키움증권 서버에 접속되었는지 여부를 반환합니다.
+        """
+        return self.GetConnectState() == 1
+
+[docs]    def ShowAccountWindow(self):
+        """
+        계좌 비밀번호 및 자동 로그인 처리 관련 설정창을 표시합니다.
+        """
+        return self.KOA_Functions("ShowAccountWindow", "")
+
+[docs]    def GetServerGubun(self):
+        """
+        접속된 서버의 종류를 확인해 구분값을 반환합니다.
+        """
+        gubun = self.KOA_Functions("GetServerGubun", "")
+        if not gubun:
+            gubun = self.GetLoginInfo("GetServerGubun")
+        return gubun
+
+[docs]    def IsSimulationServer(self):
+        """
+        모의투자 서버 접속 여부를 확인해 반환합니다.
+        """
+        gubun = self.GetServerGubun()
+        return gubun == "1"
+
+[docs]    def IsRealServer(self):
+        """
+        실 서버 접속 여부를 확인해 반환합니다.
+        """
+        return not self.IsSimulationServer()
+
+[docs]    def GetMasterStockInfo(self, code):
+        """
+        주식의 종목분류, 시장구분등의 정보를 제공합니다.
+        """
+        return self.KOA_Functions("GetMasterStockInfo", code)
+
+[docs]    def GetMasterStockInfoAsDict(self, code):
+        """
+        주식의 종목분류, 시장구분등의 정보를 딕셔너리 형태로 가공하여 제공합니다.
+        """
+        result = self.GetMasterStockInfo(code)
+        items = string_to_list(result, sep=";")
+        items = [string_to_list(item, sep="|") for item in items]
+        info = dict(items)
+        return info
+
+[docs]    def SetConditionSearchFlag(self, flag):
+        """
+        조건 검색시 동작과 관련된 플래그를 설정합니다.
+        """
+        return self.KOA_Functions("SetConditionSearchFlag", flag)
+
+[docs]    def AddPriceToConditionSearchResult(self):
+        """
+        조건 검색시 현재가를 함께 수신하도록 설정합니다.
+        """
+        return self.SetConditionSearchFlag("AddPrice")
+
+[docs]    def DelPriceFromConditionSearchResult(self):
+        """
+        조건 검색시 현재가를 함께 수신하지 않도록 설정합니다.
+        """
+        return self.SetConditionSearchFlag("DelPrice")
+
+[docs]    def GetUpjongCode(self, code):
+        """
+        업종코드 목록을 반환합니다.
+
+        인자로 사용할 수 있는 값은 0, 1, 2, 4, 7 입니다.
+        0:코스피, 1: 코스닥, 2:KOSPI200, 4:KOSPI100(KOSPI50), 7:KRX100
+        """
+        code = str(code)
+        return self.KOA_Functions("GetUpjongCode", code)
+
+[docs]    def GetUpjongCodeAsList(self, code):
+        """
+        업종코드 목록을 리스트 형태로 가공하여 반환합니다.
+
+        인자로 사용할 수 있는 값은 0, 1, 2, 4, 7 입니다.
+        0:코스피, 1: 코스닥, 2:KOSPI200, 4:KOSPI100(KOSPI50), 7:KRX100
+        """
+        result = self.GetUpjongCode(code)
+        items = string_to_list(result, sep="|")
+        items = [string_to_list(item, sep=",") for item in items]
+        items = [tuple(item) for item in items]
+        return items
+
+[docs]    def GetUpjongNameByCode(self, code):
+        """
+        주어진 업종코드의 이름을 반환합니다.
+        """
+        return self.KOA_Functions("GetUpjongNameByCode", code)
+
+[docs]    def IsOrderWarningETF(self, code):
+        """
+        ETF 의 투자유의 종목 여부를 반환합니다.
+
+        투자유의 종목인 경우 "1" 값이 리턴,
+        그렇지 않은 경우 "0" 값 리턴.
+        ETF가 아닌 종목을 입력시 "0" 값 리턴.
+        """
+        return self.KOA_Functions("IsOrderWarningETF", code)
+
+[docs]    def IsOrderWarningETFAsBoolean(self, code):
+        """
+        ETF 의 투자유의 종목 여부를 불리언 형태로 변환하여 반환합니다.
+        """
+        return_code = self.IsOrderWarningETF(code)
+        return_code = int(return_code)
+        return_code = bool(return_code)
+        return return_code
+
+[docs]    def IsOrderWarningStock(self, code):
+        """
+        주식 전종목 대상 투자유의 종목 여부를 반환합니다.
+
+        리턴 값 - "0":해당없음, "2":정리매매, "3":단기과열, "4":투자위험, "5":투자경고
+        """
+        return self.KOA_Functions("IsOrderWarningStock", code)
+
+[docs]    def IsOrderWarningStockAsBoolean(self, code):
+        """
+        주식 전종목 대상 투자유의 종목 여부를 불리언 형태로 변환하여 반환합니다.
+        """
+        return_code = self.IsOrderWarningStock(code)
+        return_code = int(return_code)
+        return_code = bool(return_code)
+        return return_code
+
+[docs]    def GetMasterListedStockCntEx(self, code):
+        """
+        종목의 상장 주식수를 반환합니다.
+
+        기존의 GetMasterListedStockCnt() 함수 사용시 발생할 수 있는 오버플로우 문제를 해결합니다.
+        """
+        return self.KOA_Functions("GetMasterListedStockCntEx", code)
+
+[docs]    def GetMasterListedStockCntExAsInt(self, code):
+        """
+        종목의 상장 주식수를 정수 형태로 변환하여 반환합니다.
+        """
+        count = self.GetMasterListedStockCntEx(code)
+        count = int(count)
+        return count
+
+[docs]    def GetCodeListByMarketAsList(self, market: Optional[Union[str, int]] = None):
+        """
+        시장의 종목 코드 목록를 리스트 형태로 가공하여 반환합니다.
+        """
+        if market is None:
+            market = ""
+        market = str(market)
+        result = self.GetCodeListByMarket(market)
+        result = string_to_list(result)
+        return result
+
+[docs]    def GetNameListByMarketAsList(self, market: Optional[Union[str, int]] = None):
+        """
+        시장의 종목 이름 목록를 리스트 형태로 가공하여 반환합니다.
+        """
+        codes = self.GetCodeListByMarketAsList(market)
+        names = [self.GetMasterCodeName(code) for code in codes]
+        return names
+
+[docs]    def GetUserId(self):
+        """
+        사용자 ID 를 반환합니다.
+        """
+        userid = self.GetLoginInfo("USER_ID")
+        return userid
+
+[docs]    def GetUserName(self):
+        """
+        사용자 이름을 반환합니다.
+        """
+        username = self.GetLoginInfo("USER_NAME")
+        return username
+
+[docs]    def GetAccountCount(self):
+        """
+        계좌 개수를 반환합니다.
+        """
+        account_count = self.GetLoginInfo("ACCOUNT_CNT")
+        account_count = int(account_count)
+        return account_count
+
+[docs]    def GetAccountList(self):
+        """
+        계좌 목록을 리스트 형태로 가공하여 반환합니다.
+        """
+        accounts = self.GetLoginInfo("ACCLIST")
+        accounts = string_to_list(accounts)
+        return accounts
+
+[docs]    def GetKeyboardSecurityStatus(self):
+        """
+        키보드 보안 설정 상태를 반환합니다.
+        """
+        return self.GetLoginInfo("KEY_BSECGB")
+
+[docs]    def IsKeyboardSecurityEnabled(self):
+        """
+        키보드 보안 설정 상태를 불리언 형태로 변환하여 반환합니다.
+        """
+        gubun = self.GetKeyboardSecurityStatus()
+        return gubun == "0"
+
+[docs]    def GetFirewallStatus(self):
+        """
+        방화벽 설정 상태를 반환합니다.
+        """
+        return self.GetLoginInfo("FIREW_SECGB")
+
+[docs]    def IsFirewallEnabled(self):
+        """
+        방화벽 설정 상태를 불리언 형태로 변환하여 반환합니다.
+        """
+        gubun = self.GetFirewallStatus()
+        return gubun == "1"
+
+[docs]    def GetFirstAvailableAccount(self):
+        """
+        확인 가능한 첫번째 계좌번호를 반환합니다.
+        """
+        account = None
+        accounts = self.GetAccountList()
+        if len(accounts) > 0:
+            account = accounts[0]
+        return account
+
+[docs]    def GetMasterStockStateAsList(self, code: str):
+        """
+        입력한 종목의 증거금 비율, 거래정지, 관리종목, 감리종목, 투자융의종목, 담보대출, 액면분할, 신용가능 여부를
+        리스트 형태로 가공하여 전달합니다.
+        """
+        states = self.GetMasterStockState(code).strip()
+        states = string_to_list(states, sep="|")
+        return states
+
+[docs]    def GetKospiCodeList(self):
+        """
+        장내 종목 코드 목록을 반환합니다.
+        """
+        codes = self.GetCodeListByMarketAsList("0")
+        codes = sorted(codes)
+        return codes
+
+[docs]    def GetKosdaqCodeList(self):
+        """
+        코스닥 시장내 종목 코드 목록을 반환합니다.
+        """
+        codes = self.GetCodeListByMarketAsList("10")
+        codes = sorted(codes)
+        return codes
+
+[docs]    def GetGeneralCodeList(
+        self,
+        include_preferred_stock: bool = False,
+        include_etn: bool = False,
+        include_etf: bool = False,
+        include_mutual_fund: bool = False,
+        include_reits: bool = False,
+        include_kosdaq: bool = False,
+    ):
+        """
+        장내 종목 코드 목록중 특정 그룹을 포함시키고 혹은 제거하고 반환합니다.
+        """
+
+        """
+        [시장구분값]
+          0 : 장내
+          10 : 코스닥
+          3 : ELW
+          8 : ETF
+          50 : KONEX
+          4 : 뮤추얼펀드
+          5 : 신주인수권
+          6 : 리츠
+          9 : 하이얼펀드
+          30 : K-OTC
+        """
+
+        codes = self.GetKospiCodeList()
+
+        # 코드 마지막 자리가 0 이 아니면 우선주일 가능성이 있다고 보고 제외
+        if not include_preferred_stock:
+            codes = [code for code in codes if code.endswith("0")]
+
+        # 장내 시장에서 ETN 이 섞여 있는데 시장구분값으로 뺄 수가 없어서 이름을 보고 대충 제외
+        if not include_etn:
+            names = [self.GetMasterCodeName(code) for code in codes]
+            etn_suffixes = ["ETN", "ETN(H)", "ETN B", "ETN(H) B"]
+            is_not_etn_name = [
+                not any(name.endswith(suffix) for suffix in etn_suffixes)
+                for name in names
+            ]
+            codes = [code for code, cond in zip(codes, is_not_etn_name) if cond]
+
+        # 코드값 기준 제외 준비
+        codes = set(codes)
+
+        # 나머지는 혹시나 겹치는 애들이 나올 수 있는 시장에서 코드기준 제외
+        if not include_kosdaq:
+            codes = codes - set(self.GetCodeListByMarketAsList("10"))  # 코스닥
+        if not include_etf:
+            codes = codes - set(self.GetCodeListByMarketAsList("8"))  # ETF
+        if not include_mutual_fund:
+            codes = codes - set(self.GetCodeListByMarketAsList("4"))  # 뮤추얼펀드
+        if not include_reits:
+            codes = codes - set(self.GetCodeListByMarketAsList("6"))  # 리츠
+
+        # 정렬된 리스트 형태로 제공
+        codes = sorted(list(codes))
+
+        return codes
+
+[docs]    def GetStockStates(self, code: str):
+        """
+        입력한 종목의 증거금 비율, 거래정지, 관리종목, 감리종목, 투자유의종목, 담보대출, 액면분할, 신용가능 여부를 전달합니다.
+        """
+        return self.GetMasterStockStateAsList(code)
+
+[docs]    def GetSurveillanceFlag(self, code: str):
+        """
+        입력한 종목코드에 해당하는 종목의 감리구분을 전달합니다. (정상, 투자주의, 투자경고, 투자위험, 투자주의환기종목)
+        """
+        return self.GetMasterConstruction(code)
+
+[docs]    def IsSuspended(self, code: str):
+        """
+        거래정지 여부를 반환합니다.
+        """
+        return "거래정지" in self.GetMasterStockStateAsList(code)
+
+[docs]    def IsUnderSurveillance(self, code: str):
+        """
+        감리종목 여부를 반환합니다.
+        """
+        return "감리종목" in self.GetMasterStockStateAsList(code)
+
+[docs]    def IsUnderAdministration(self, code: str):
+        """
+        관리종목 여부를 반환합니다.
+        """
+        return "관리종목" in self.GetMasterStockStateAsList(code)
+
+[docs]    def IsFlaggedForCaution(self, code: str):
+        """
+        감리구분이 정상이 아니거나 상태값중 투자유의종목으로 지정된 경우 참을 반환합니다.
+        """
+        flag = self.GetSurveillanceFlag(code)
+        states = self.GetMasterStockStateAsList(code)
+        flag_is_not_normal = flag != "정상"
+        has_caution_state = "투자유의종목" in states
+        return flag_is_not_normal or has_caution_state
+
+[docs]    def IsNotNormal(self, code: str):
+        """
+        감리구분이 정상이 아니거나 상태값중 거래정지, 감리종목, 관리종목, 투자유의종목 등으로 지정된 경우 참을 반환합니다.
+        """
+        flag = self.GetSurveillanceFlag(code)
+        states = self.GetMasterStockStateAsList(code)
+        flag_is_not_normal = flag != "정상"
+        bad_states = ["거래정지", "감리종목", "관리종목", "투자유의종목"]
+        has_any_bad_state = any(state in states for state in bad_states)
+        return flag_is_not_normal or has_any_bad_state
+
+[docs]    def IsNormal(self, code: str):
+        """
+        감리구분이 정상이고 별다른 이상 상태값이 없는 경우 참을 반환합니다.
+        """
+        return not self.IsNotNormal(code)
+
+[docs]    def GetConditionFilePath(self):
+        """
+        조건식 데이터를 로드한 후 생성되는 조건검색 관련 데이터 파일의 경로를 반환합니다.
+        """
+        module_path = self.GetAPIModulePath()
+        module_path = Path(module_path)
+        userid = self.GetUserId()
+        condition_filepath = module_path / "system" / f"{userid}_NewSaveIndex.dat"
+        condition_filepath = str(condition_filepath)
+        return condition_filepath
+
+[docs]    def GetConditionNameListAsList(self):
+        """
+        조건식 데이터를 로드한 후 확인 가능한 조건식 목록을 리스트 형태로 가공하여 반환합니다.
+        """
+        self.EnsureConditionLoaded()
+        conditions = self.GetConditionNameList()
+        conditions = string_to_list(conditions)
+        conditions = [string_to_list(cond, sep="^") for cond in conditions]
+        conditions = [(int(cond[0]), cond[1]) for cond in conditions]
+        return conditions
+
+[docs]    def GetAutoLoginDatPath(self):
+        """
+        자동 로그인 설정시 생성되는 자동 로그인 관련 데이터 파일의 경로를 반환합니다.
+        """
+        module_path = self.GetAPIModulePath()
+        module_path = Path(module_path)
+        autologin_dat = module_path / "system" / "Autologin.dat"
+        autologin_dat = str(autologin_dat)
+        return autologin_dat
+
+[docs]    def IsAutoLoginEnabled(self):
+        """
+        자동 로그인 설정 여부를 반환합니다.
+
+        자동 로그인 설정시 생성되는 자동 로그인 관련 데이터 파일 경로에 파일이 존재하는지의 여부를 확인합니다.
+        """
+        autologin_dat = self.GetAutoLoginDatPath()
+        return os.path.exists(autologin_dat)
+
+[docs]    def DisableAutoLogin(self):
+        """
+        자동 로그인 설정을 해제합니다.
+
+        자동 로그인 설정시 생성되는 자동 로그인 관련 데이터 파일 경로에 파일이 존재하는 경우 해당 파일을 삭제합니다.
+        """
+        autologin_dat = self.GetAutoLoginDatPath()
+        if os.path.exists(autologin_dat):
+            os.remove(autologin_dat)
+
+    # ======================================================================
+
+    @classmethod
+[docs]    def RunScriptInSubprocess_WithData(
+        cls,
+        main: Callable[..., Any],
+        data: Optional[Mapping[str, Any]] = None,
+        wait: bool = False,
+        timeout: bool = None,
+        check: bool = False,
+        stdin: Optional[int] = subprocess.PIPE,
+        stdout: Optional[int] = None,
+    ):
+        args = function_to_subprocess_args(main)
+        process = Popen(args, stdin=stdin, stdout=stdout, text=True)
+        json.dump(data, process.stdin)
+
+        if wait:
+            try:
+                stdout, stderr = process.communicate(timeout=timeout)
+            except subprocess.TimeoutExpired as exc:
+                process.kill()
+                exc.stdout, exc.stderr = process.communicate()
+                raise exc
+            except:
+                process.kill()
+                raise
+            retcode = process.poll()
+            completed = subprocess.CompletedProcess(
+                process.args, retcode, stdout, stderr
+            )
+            if check:
+                completed.check_returncode()
+            return completed
+
+        return process
+
+    @classmethod
+[docs]    def LoginUsingPywinauto_Impl(cls, credentials: Optional[Mapping[str, Any]] = None):
+        import pywinauto
+
+        if credentials is None:
+            credentials = config.get("koapy.backend.kiwoom_open_api_plus.credentials")
+
+        is_in_development = False
+        use_set_text = False
+
+        userid = credentials.get("user_id")
+        password = credentials.get("user_password")
+        cert = credentials.get("cert_password")
+
+        is_save_userid = True
+        is_simulation = credentials.get("is_simulation")
+
+        desktop = pywinauto.Desktop(allow_magic_lookup=False)
+        login_window = desktop.window(title="Open API Login")
+
+        try:
+            cls.logger.info("Waiting for login screen")
+            timeout_login_screen_ready = 30
+            login_window.wait("ready", timeout_login_screen_ready)
+        except pywinauto.timings.TimeoutError:
+            cls.logger.info("Cannot find login screen")
+            raise
+        else:
+            cls.logger.info("Login screen found")
+            if is_in_development:
+                login_window.print_control_identifiers()
+
+            if userid:
+                cls.logger.info("Putting userid")
+                if use_set_text:
+                    login_window["Edit1"].set_text(userid)
+                else:
+                    login_window["Edit1"].set_focus()
+                    pywinauto.keyboard.send_keys(userid)
+                    pywinauto.keyboard.send_keys("{TAB}")
+            if password:
+                cls.logger.info("Putting password")
+                if use_set_text:
+                    login_window["Edit2"].set_text(password)
+                else:
+                    login_window["Edit2"].set_focus()
+                    pywinauto.keyboard.send_keys(password)
+                    pywinauto.keyboard.send_keys("{TAB}")
+            else:
+                raise RuntimeError("'user_password' not set, please check credentials")
+
+            if is_save_userid:
+                cls.logger.info("Checking to save userid")
+                login_window["Button6"].check()  # check doesn't work
+            else:
+                cls.logger.info("Unchecking to save userid")
+                login_window["Button6"].uncheck()  # uncheck doesn't work
+
+            if not is_simulation:
+                if not login_window["Edit3"].is_enabled():
+                    cls.logger.info("Unchecking to use simulation server")
+                    login_window["Button5"].uncheck_by_click()
+                if cert:
+                    cls.logger.info("Putting cert password")
+                    if use_set_text:
+                        login_window["Edit3"].set_text(cert)
+                    else:
+                        login_window["Edit3"].set_focus()
+                        pywinauto.keyboard.send_keys(cert)
+                        pywinauto.keyboard.send_keys("{TAB}")
+                else:
+                    raise RuntimeError(
+                        "'cert_password' not set, please check credentials"
+                    )
+            else:
+                if login_window["Edit3"].is_enabled():
+                    cls.logger.info("Checking to use simulation server")
+                    login_window["Button5"].check_by_click()
+
+            cls.logger.info("Logging in")
+            login_window["Button1"].click()
+
+    @classmethod
+[docs]    def LoginUsingPywinauto_RunScriptInSubprocess(
+        cls,
+        credentials: Optional[Mapping[str, Any]] = None,
+        wait: bool = False,
+        timeout: bool = None,
+        check: bool = False,
+    ):
+        def main():
+            # pylint: disable=redefined-outer-name,reimported,import-self
+            import json
+            import sys
+
+            from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusQAxWidgetMixin import (
+                KiwoomOpenApiPlusQAxWidgetMixin,
+            )
+            from koapy.utils.logging import set_verbosity
+
+            data = json.load(sys.stdin)
+            credentials = data["credentials"]
+            verbosity = data["verbosity"]
+            set_verbosity(verbosity)
+            KiwoomOpenApiPlusQAxWidgetMixin.LoginUsingPywinauto_Impl(credentials)
+
+        verbosity = get_verbosity()
+        data = {
+            "credentials": credentials,
+            "verbosity": verbosity,
+        }
+
+        return cls.RunScriptInSubprocess_WithData(
+            main,
+            data,
+            wait=wait,
+            timeout=timeout,
+            check=check,
+        )
+
+[docs]    def LoginUsingPywinauto(
+        self,
+        credentials: Optional[Mapping[str, Any]] = None,
+        wait: bool = True,
+        timeout: bool = None,
+        check: bool = True,
+    ):
+        """
+        자식 프로세스 내에서 pywinauto 를 사용해 로그인 처리를 자동으로 진행합니다.
+        """
+        assert is_admin(), "Using pywinauto requires administrator permission"
+        return self.LoginUsingPywinauto_RunScriptInSubprocess(
+            credentials,
+            wait=wait,
+            timeout=timeout,
+            check=check,
+        )
+
+    @overload
+[docs]    def CommConnectAndThen(
+        self,
+        credentials: Mapping[str, Any],
+        callback: Callable[[int], Any],
+    ) -> int:
+        ...
+
+    @overload
+    def CommConnectAndThen(self, credentials: Mapping[str, Any]) -> int:
+        ...
+
+    @overload
+    def CommConnectAndThen(self, callback: Callable[[int], Any]) -> int:
+        ...
+
+    @overload
+    def CommConnectAndThen(self) -> int:
+        ...
+
+    def CommConnectAndThen(
+        self,
+        credentials_or_callback=None,
+        callback_or_none=None,
+    ) -> int:
+        """
+        로그인 처리를 진행하고 이후 발생하는 이벤트 함수내에서 특정 콜백 함수를 실행합니다.
+        """
+        credentials = credentials_or_callback
+        callback = callback_or_none
+
+        if (
+            callback is None
+            and credentials is not None
+            and not isinstance(credentials, dict)
+            and callable(credentials)
+        ):
+            callback = credentials
+            credentials = None
+
+        can_use_pywinauto = is_admin()
+        should_use_pywinauto = credentials is not None
+
+        if should_use_pywinauto:
+            assert (
+                can_use_pywinauto
+            ), "CommConnectAndThen() method requires to be run as administrator if credentials argument was given explicitly"
+
+        if should_use_pywinauto:
+            self.DisableAutoLogin()
+
+        if credentials is None and not self.IsAutoLoginEnabled() and can_use_pywinauto:
+            credentials = config.get(
+                key="koapy.backend.kiwoom_open_api_plus.credentials",
+                default=None,
+            )
+            should_use_pywinauto = credentials is not None
+
+        def OnEventConnect(errcode):
+            self.OnEventConnect.disconnect(OnEventConnect)
+            if callable(callback):
+                callback(errcode)
+
+        self.OnEventConnect.connect(OnEventConnect)
+        errcode = KiwoomOpenApiPlusError.try_or_raise(self.CommConnect())
+
+        if should_use_pywinauto and not self.IsAutoLoginEnabled():
+            process = self.LoginUsingPywinauto(credentials, wait=False)
+
+        return errcode
+
+[docs]    def Connect(self, credentials: Optional[Mapping[str, Any]] = None) -> int:
+        """
+        로그인 처리를 진행하고 이후 발생하는 이벤트 함수내에서 확인 가능한 에러코드 값을 반환합니다.
+        """
+        q = queue.Queue()
+
+        def OnEventConnect(errcode):
+            q.put(errcode)
+
+        errcode = self.CommConnectAndThen(credentials, OnEventConnect)
+        errcode = KiwoomOpenApiPlusError.try_or_raise(q.get())
+
+        return errcode
+
+    @overload
+[docs]    def EnsureConnectedAndThen(
+        self,
+        credentials: Mapping[str, Any],
+        callback: Callable[[int], Any],
+    ) -> bool:
+        ...
+
+    @overload
+    def EnsureConnectedAndThen(self, credentials: Mapping[str, Any]) -> bool:
+        ...
+
+    @overload
+    def EnsureConnectedAndThen(self, callback: Callable[[int], Any]) -> bool:
+        ...
+
+    @overload
+    def EnsureConnectedAndThen(self) -> bool:
+        ...
+
+    def EnsureConnectedAndThen(
+        self,
+        credentials_or_callback=None,
+        callback_or_none=None,
+    ) -> bool:
+        """
+        로그인 여부를 확인하고 로그인 상태를 보장한 뒤에 주어진 콜백 함수를 실행합니다.
+
+        로그인 여부 확인시 로그인 되어있지 않다면 로그인을 진행한 뒤 주어진 콜백 함수를 실행합니다.
+        이미 로그인이 되어있다면 즉시 주어진 콜백 함수를 실행합니다.
+        """
+        credentials = credentials_or_callback
+        callback = callback_or_none
+
+        if (
+            callback is None
+            and credentials is not None
+            and not isinstance(credentials, dict)
+            and callable(credentials)
+        ):
+            callback = credentials
+            credentials = None
+
+        is_connected = self.IsConnected()
+
+        if not is_connected:
+
+            def OnEventConnect(errcode):
+                if errcode == 0:
+                    if callable(callback):
+                        callback(errcode)
+
+            errcode = self.CommConnectAndThen(credentials, OnEventConnect)
+        else:
+            if callable(callback):
+                errcode = 0
+                callback(errcode)
+
+        return is_connected
+
+[docs]    def EnsureConnected(self, credentials: Optional[Mapping[str, Any]] = None) -> bool:
+        """
+        로그인 상태를 보장하도록 합니다.
+
+        이미 로그인이 되어있는 경우 별다른 처리를 하지 않습니다.
+        로그인이 되어있지 않다면 로그인을 수행합니다.
+        """
+        is_connected = self.IsConnected()
+        if not is_connected:
+            self.Connect(credentials)
+            is_connected = self.IsConnected()
+            assert is_connected, "Could not ensure connected"
+        return is_connected
+
+    @classmethod
+[docs]    def EnableAutoLoginUsingPywinauto_Impl(
+        cls, account_passwords: Optional[Mapping[str, Any]] = None
+    ):
+        import pywinauto
+
+        if account_passwords is None:
+            credentials = config.get("koapy.backend.kiwoom_open_api_plus.credentials")
+            account_passwords = credentials.get("account_passwords")
+
+        is_in_development = False
+
+        desktop = pywinauto.Desktop(allow_magic_lookup=False)
+        account_window = desktop.window(title_re=r"계좌비밀번호 입력 \(버전: [0-9]+.+[0-9]+\)")
+
+        try:
+            cls.logger.info("Waiting for account window to show up")
+            timeout_account_window_ready = 15
+            account_window.wait("ready", timeout_account_window_ready)
+        except pywinauto.timings.TimeoutError:
+            cls.logger.info("Cannot find account window")
+            raise
+        else:
+            cls.logger.info("Account window found")
+            if is_in_development:
+                account_window.print_control_identifiers()
+
+            cls.logger.info("Enabling auto login")
+            account_window["CheckBox"].check()
+
+            account_combo = account_window["ComboBox"]
+            account_cnt = account_combo.item_count()
+
+            cls.logger.info("Putting account passwords")
+            for i in range(account_cnt):
+                account_combo.select(i)
+                account_no = account_combo.selected_text().split()[0]
+                if account_no in account_passwords:
+                    account_window["Edit"].set_text(account_passwords[account_no])
+                elif "0000000000" in account_passwords:
+                    account_window["Edit"].set_text(account_passwords["0000000000"])
+                account_window["등록"].click()
+
+            cls.logger.info("Closing account window")
+            account_window["닫기"].click()
+
+            try:
+                cls.logger.info("Waiting account window to be closed")
+                timeout_account_window_done = 5
+                account_window.wait_not("visible", timeout_account_window_done)
+            except pywinauto.timings.TimeoutError as e:
+                cls.logger.info("Cannot sure account window is closed")
+                raise RuntimeError("Cannot sure account window is closed") from e
+            else:
+                cls.logger.info("Account window closed")
+
+    @classmethod
+[docs]    def EnableAutoLoginUsingPywinauto_RunScriptInSubprocess(
+        cls,
+        account_passwords: Optional[Mapping[str, Any]] = None,
+        wait: bool = False,
+        timeout: bool = None,
+        check: bool = False,
+    ):
+        def main():
+            # pylint: disable=redefined-outer-name,reimported,import-self
+            import json
+            import sys
+
+            from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusQAxWidgetMixin import (
+                KiwoomOpenApiPlusQAxWidgetMixin,
+            )
+            from koapy.utils.logging import set_verbosity
+
+            data = json.load(sys.stdin)
+            account_passwords = data["account_passwords"]
+            verbosity = data["verbosity"]
+            set_verbosity(verbosity)
+            KiwoomOpenApiPlusQAxWidgetMixin.EnableAutoLoginUsingPywinauto_Impl(
+                account_passwords
+            )
+
+        verbosity = get_verbosity()
+        data = {
+            "account_passwords": account_passwords,
+            "verbosity": verbosity,
+        }
+
+        return cls.RunScriptInSubprocess_WithData(
+            main,
+            data,
+            wait=wait,
+            timeout=timeout,
+            check=check,
+        )
+
+[docs]    def EnableAutoLoginUsingPywinauto(
+        self,
+        credentials: Optional[Mapping[str, Any]] = None,
+        wait: bool = True,
+        timeout: bool = None,
+        check: bool = True,
+    ):
+        """
+        자식 프로세스 내에서 pywinauto 를 사용해 자동 로그인 설정을 자동으로 진행합니다.
+        """
+        assert is_admin(), "Using pywinauto requires administrator permission"
+        return self.EnableAutoLoginUsingPywinauto_RunScriptInSubprocess(
+            credentials,
+            wait=wait,
+            timeout=timeout,
+            check=check,
+        )
+
+[docs]    def EnableAutoLogin(self, credentials: Optional[Mapping[str, Any]] = None):
+        """
+        자동 로그인을 설정합니다.
+        """
+        q = queue.Queue()
+
+        def callback(errcode):
+            with ThreadPoolExecutor(1) as executor:
+                future = executor.submit(self.ShowAccountWindow)
+                self.EnableAutoLoginUsingPywinauto(credentials)
+                future.result()
+                q.put(errcode)
+
+        self.EnsureConnectedAndThen(credentials, callback)
+        errcode = KiwoomOpenApiPlusError.try_or_raise(q.get())
+        is_enabled = self.IsAutoLoginEnabled()
+        return is_enabled
+
+[docs]    def EnsureAutoLoginEnabled(
+        self, credentials: Optional[Mapping[str, Any]] = None
+    ) -> bool:
+        """
+        자동 로그인이 설정되어 있음을 보장하도록 합니다.
+
+        이미 자동 로그인이 설정 되어있는 경우 별다른 처리를 하지 않습니다.
+        자동 로그인이 설정되어 있지 않다면 자동 로그인을 설정을 처리합니다.
+        """
+        is_enabled = self.IsAutoLoginEnabled()
+        if not is_enabled:
+            self.EnableAutoLogin(credentials)
+            is_enabled = self.IsAutoLoginEnabled()
+            assert is_enabled, "Could not ensure auto login enabled"
+        return is_enabled
+
+    @classmethod
+[docs]    def HandleVersionUpgradeUsingPywinauto_Impl(cls, pid):
+        import psutil
+        import pywinauto
+
+        desktop = pywinauto.Desktop(allow_magic_lookup=False)
+        login_window = desktop.window(title="Open API Login")
+
+        timeout_login_successful = 4
+        timeout_version_check = 1
+        timeout_per_trial = timeout_login_successful + timeout_version_check
+
+        trial_timeout = 180
+        trial_count = trial_timeout / timeout_per_trial
+
+        while trial_count > 0:
+            try:
+                cls.logger.info(
+                    "Login in progress ... timeout after %d sec",
+                    trial_count * timeout_per_trial,
+                )
+                trial_count -= 1
+                login_window.wait_not("exists", timeout_login_successful)
+                if login_window.exists():
+                    # make sure that login_window control does not exist.
+                    continue
+            except pywinauto.timings.TimeoutError as e:
+                version_window = desktop.window(title="opstarter")
+                try:
+                    version_window.wait("ready", timeout_version_check)
+                except pywinauto.timings.TimeoutError:
+                    continue
+                else:
+                    cls.logger.info("Version update required")
+
+                    cls.logger.info("Closing login app")
+                    login_window_proc = psutil.Process(pid)
+                    login_window_proc.kill()
+                    login_window_proc.wait()
+                    cls.logger.info("Killed login app process")
+                    timeout_login_screen_closed = 30
+                    login_window.close(timeout_login_screen_closed)
+                    try:
+                        login_window.wait_not("visible", timeout_login_screen_closed)
+                    except pywinauto.timings.TimeoutError as e:
+                        cls.logger.warning("Cannot close login window")
+                        raise RuntimeError("Cannot close login window") from e
+                    else:
+                        cls.logger.info("Closed login window")
+
+                        cls.logger.info("Starting to update version")
+                        version_window["Button"].click()
+
+                        versionup_window = desktop.window(title="opversionup")
+                        confirm_window = desktop.window(title="업그레이드 확인")
+
+                        try:
+                            cls.logger.info("Waiting for possible failure")
+                            timeout_confirm_update = 10
+                            versionup_window.wait("ready", timeout_confirm_update)
+                        except pywinauto.timings.TimeoutError:
+                            cls.logger.info("Cannot find failure confirmation popup")
+                        else:
+                            cls.logger.warning("Failed to update")
+                            raise RuntimeError("Failed to update") from e
+
+                        try:
+                            cls.logger.info(
+                                "Waiting for confirmation popup after update"
+                            )
+                            timeout_confirm_update = 10
+                            confirm_window.wait("ready", timeout_confirm_update)
+                        except pywinauto.timings.TimeoutError as e:
+                            cls.logger.warning("Cannot find confirmation popup")
+                            raise RuntimeError("Cannot find confirmation popup") from e
+                        else:
+                            cls.logger.info("Confirming update")
+                            confirm_window["Button"].click()
+
+                        cls.logger.info("Done update")
+                        return True
+            else:
+                cls.logger.info("Login ended successfully")
+                cls.logger.info("No version update required")
+                return False
+        return False
+
+    @classmethod
+[docs]    def HandleVersionUpgradeUsingPywinauto_RunScriptInSubprocess(
+        cls,
+        pid: int,
+        wait: bool = False,
+        timeout: bool = None,
+        check: bool = False,
+    ):
+        def main():
+            # pylint: disable=redefined-outer-name,reimported,import-self
+            import json
+            import sys
+
+            from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusQAxWidgetMixin import (
+                KiwoomOpenApiPlusQAxWidgetMixin,
+            )
+            from koapy.utils.logging import set_verbosity
+
+            data = json.load(sys.stdin)
+            pid = data["pid"]
+            verbosity = data["verbosity"]
+            set_verbosity(verbosity)
+            is_updated = (
+                KiwoomOpenApiPlusQAxWidgetMixin.HandleVersionUpgradeUsingPywinauto_Impl(
+                    pid
+                )
+            )
+            result = {"is_updated": is_updated}
+            json.dump(result, sys.stdout)
+
+        verbosity = get_verbosity()
+        data = {
+            "pid": pid,
+            "verbosity": verbosity,
+        }
+
+        completed = cls.RunScriptInSubprocess_WithData(
+            main,
+            data,
+            wait=wait,
+            timeout=timeout,
+            check=check,
+            stdout=subprocess.PIPE,
+        )
+        result = json.loads(completed.stdout)
+        is_updated = result["is_updated"]
+        return is_updated
+
+[docs]    def HandleVersionUpgradeUsingPywinauto(
+        self,
+        pid: int,
+        wait: bool = True,
+        timeout: bool = None,
+        check: bool = True,
+    ):
+        """
+        자식 프로세스 내에서 pywinauto 를 사용해 버전 업그레이드 처리를 자동으로 진행합니다.
+        """
+        assert is_admin(), "Using pywinauto requires administrator permission"
+        return self.HandleVersionUpgradeUsingPywinauto_RunScriptInSubprocess(
+            pid,
+            wait=wait,
+            timeout=timeout,
+            check=check,
+        )
+
+
+[docs]class KiwoomOpenApiPlusQAxWidgetServerSideMixin(
+    KiwoomOpenApiPlusDispatchFunctions, Logging
+):
+    """
+    KiwoomOpenApiPlusQAxWidget 객체에 대해 Server-Side 에서만 사용되는 Mixin 입니다.
+
+    주로 서버 환경에서만 확인하거나 처리가 가능한 아래 기능들을 커버합니다:
+
+        - 조건검색식 로드
+        - 조회 횟수 제한 회피 기능
+    """
+
+    def __init__(self):
+        """
+        조건검색식 로드 및 조회 횟수 제한 회피 기능 관련 초기화를 진행합니다.
+        """
+
+        """
+        [OpenAPI 게시판]
+          https://bbn.kiwoom.com/bbn.openAPIQnaBbsList.do
+
+        [조회횟수 제한 관련 가이드]
+          - 1초당 5회 조회를 1번 발생시킨 경우 : 17초대기
+          - 1초당 5회 조회를 5연속 발생시킨 경우 : 90초대기
+          - 1초당 5회 조회를 10연속 발생시킨 경우 : 3분(180초)대기
+        """
+
+        """
+        [조회제한]
+          OpenAPI 조회는 1초당 5회로 제한되며 복수종목 조회와 조건검색 조회 횟수가 합산됩니다.
+          가령 1초 동안 시세조회2회 관심종목 1회 조건검색 2회 순서로 조회를 했다면 모두 합쳐서 5회이므로 모두 조회성공하겠지만
+          조건검색을 3회 조회하면 맨 마지막 조건검색 조회는 실패하게 됩니다.
+
+        [조건검색 제한]
+          조건검색(실시간 조건검색 포함)은 시세조회와 관심종목조회와 합산해서 1초에 5회만 요청 가능하며 1분에 1회로 조건검색 제한됩니다.
+        """
+
+        self._comm_rate_limiter = KiwoomOpenApiPlusCommRqDataRateLimiter()
+        self._cond_rate_limiter = KiwoomOpenApiPlusSendConditionRateLimiter(
+            self._comm_rate_limiter
+        )
+        self._order_rate_limiter = KiwoomOpenApiPlusSendOrderRateLimiter()
+
+        self._comm_rate_limited_executor = QRateLimitedExecutor(
+            self._comm_rate_limiter, self
+        )
+        self._cond_rate_limited_executor = QRateLimitedExecutor(
+            self._cond_rate_limiter, self
+        )
+        self._order_rate_limited_executor = QRateLimitedExecutor(
+            self._order_rate_limiter, self
+        )
+
+        self.RateLimitedCommRqData = self._comm_rate_limited_executor.wrap(
+            self.CommRqDataWithInputs
+        )
+        self.RateLimitedCommKwRqData = self._comm_rate_limited_executor.wrap(
+            self.CommKwRqData
+        )
+        self.RateLimitedSendCondition = self._cond_rate_limited_executor.wrap(
+            self.SendCondition
+        )
+        self.RateLimitedSendOrder = self._order_rate_limited_executor.wrap(
+            self.SendOrder
+        )
+
+        self._is_condition_loaded = False
+
+        self._comm_rate_limited_executor.start()
+        self._cond_rate_limited_executor.start()
+        self._order_rate_limited_executor.start()
+
+        self.destroyed.connect(self._comm_rate_limited_executor.shutdown)
+        self.destroyed.connect(self._cond_rate_limited_executor.shutdown)
+        self.destroyed.connect(self._order_rate_limited_executor.shutdown)
+
+[docs]    def LoadCondition(self) -> int:
+        """
+        조건검색 관련 조건식을 불러옵니다.
+        """
+        q = queue.Queue()
+
+        def OnReceiveConditionVer(ret, msg):
+            if not ret:
+                q.put(KiwoomOpenApiPlusError(msg))
+            else:
+                q.put((ret, msg))
+
+        self.OnReceiveConditionVer.connect(OnReceiveConditionVer)
+        try:
+            return_code = KiwoomOpenApiPlusError.try_or_raise_boolean(
+                self.GetConditionLoad(), "Failed to load condition"
+            )
+            res = q.get()
+            if isinstance(res, KiwoomOpenApiPlusError):
+                raise res
+        except:  # pylint: disable=try-except-raise
+            raise
+        else:
+            if return_code == 1:
+                self._is_condition_loaded = True
+        finally:
+            self.OnReceiveConditionVer.disconnect(OnReceiveConditionVer)
+        return return_code
+
+[docs]    def IsConditionLoaded(self) -> bool:
+        """
+        조건식이 로드 되었는지 여부를 반환합니다.
+        """
+        # the original implementation of this function was like the following:
+        #   condition_filepath = self.GetConditionFilePath()
+        #   return os.path.exists(condition_filepath)
+        # this implementation was based on the description of `GetConditionLoad()` function in the official documentation
+        # which was like, "the temporary condition file would be deleted on after OCX program exits".
+        # but actually it turned out that existence of this file could not guarantee that the condition is actually loaded or not
+        # so here we are using entrypoint-wide member variable to remember once the condition is loaded
+        return self._is_condition_loaded
+
+[docs]    def EnsureConditionLoaded(self, force: bool = False) -> int:
+        """
+        조건식이 로드됨을 보장하도록 합니다.
+
+        이미 조건식을 불러온 경우 별다른 처리를 하지 않습니다.
+        조건식을 불러오지 않았다면 조건식을 불러오도록 처리합니다.
+        """
+        return_code = 0
+        is_condition_loaded = self.IsConditionLoaded()
+        if not is_condition_loaded or force:
+            return_code = self.LoadCondition()
+        else:
+            return_code = 1
+        assert return_code == 1, "Could not ensure condition loaded"
+        return return_code
+
+[docs]    def CommRqDataWithInputs(
+        self,
+        rqname: str,
+        trcode: str,
+        prevnext: Union[str, int],
+        scrnno: str,
+        inputs: Optional[Dict[str, str]] = None,
+    ) -> int:
+        """
+        CommRqData() 호출 이전에 주어진 입력값을로 SetInputValue() 호출을 통한 입력값 설정을 진행합니다.
+        이후 CommRqData() 를 호출합니다.
+        """
+        if inputs:
+            for k, v in inputs.items():
+                self.SetInputValue(k, v)
+        prevnext = int(prevnext)  # ensure prevnext is int
+        code = self.CommRqData(rqname, trcode, prevnext, scrnno)
+        return code
+
+    @synchronized
+[docs]    def AtomicCommRqData(
+        self,
+        rqname: str,
+        trcode: str,
+        prevnext: Union[str, int],
+        scrnno: str,
+        inputs: Optional[Dict[str, str]] = None,
+    ) -> int:
+        """
+        SetInputValue() 호출을 통한 입력값 설정 및 CommRqData() 호출을 하나의 단위로 처리할 수 있도록 Lock 을 걸고 처리합니다.
+        """
+        return self.CommRqDataWithInputs(rqname, trcode, prevnext, scrnno, inputs)
+
+
+[docs]class KiwoomOpenApiPlusQAxWidgetMixin(
+    KiwoomOpenApiPlusQAxWidgetUniversalMixin, KiwoomOpenApiPlusQAxWidgetServerSideMixin
+):
+    """
+    KiwoomOpenApiPlusQAxWidgetUniversalMixin, KiwoomOpenApiPlusQAxWidgetServerSideMixin 구현이 포함된
+    KiwoomOpenApiPlusQAxWidget 객체를 위한 Mixin 입니다.
+    """
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusRateLimiter.html b/_modules/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusRateLimiter.html new file mode 100644 index 00000000..d714b65e --- /dev/null +++ b/_modules/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusRateLimiter.html @@ -0,0 +1,245 @@ + + + + + + + + koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusRateLimiter — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusRateLimiter

+import threading
+import time
+
+from koapy.utils.rate_limiting.RateLimiter import (
+    CompositeTimeWindowRateLimiter,
+    RateLimiter,
+    TimeWindowRateLimiter,
+)
+
+
+[docs]class KiwoomOpenApiPlusCommRqDataRateLimiter(CompositeTimeWindowRateLimiter):
+
+    # [조회횟수 제한 관련]
+    # 단순하게 1초당 5회로 날리다보면 장기적으로 결국 막히기 때문에 기존에는 4초당 1회로 제한했었음 (3초당 1회부턴 제한걸림)
+    # 이후 1시간에 1000회로 제한한다는 추측이 있는데 일리 있어 보여서 도입 (http://blog.quantylab.com/htsapi.html)
+    # 1초당 1회로 계산했을때 1시간이면 3600 회, 주기를 1초씩 늘려보면
+    # 2초당 1회 => 1800 > 1000, 3초당 1회 => 1200 > 1000, 4초당 1회 => 900 < 1000
+
+    """
+    [조회횟수 제한 관련 가이드]
+      - 1초당 5회 조회를 1번 발생시킨 경우 : 17초대기
+      - 1초당 5회 조회를 5연속 발생시킨 경우 : 90초대기
+      - 1초당 5회 조회를 10연속 발생시킨 경우 : 3분(180초)대기
+    """
+
+    def __init__(self):
+        limiters = [
+            TimeWindowRateLimiter(18, 5),
+            TimeWindowRateLimiter(90, 25),
+            TimeWindowRateLimiter(180, 50),
+            TimeWindowRateLimiter(3600, 1000),
+        ]
+        super().__init__(limiters)
+
+
+[docs]class KiwoomOpenApiPlusSendOrderRateLimiter(TimeWindowRateLimiter):
+    def __init__(self):
+        super().__init__(1, 5)
+
+
+[docs]class KiwoomOpenApiPlusSendConditionRateLimiter(RateLimiter):
+    # pylint: disable=arguments-differ
+
+    """
+    [조건검색 제한]
+      - 조건검색(실시간 조건검색 포함)은 시세조회와 관심종목조회와 합산해서 1초에 5회만 요청 가능하며 1분에 1회로 조건검색 제한됩니다.
+
+    [조건검색 제한]
+        조건검색 요청은 1초당 5회 조회횟수 제한에 포함됩니다.
+        동일 조건식에 대한 조건검색 요청은 1분에 1회로 제한됩니다.
+        조건검색 결과가 100종목을 넘게 되면 해당조건은 실시간 조건검색 신호를 수신할 수 없습니다.
+        실시간 조건검색은 최대 10개까지 사용 가능합니다.
+    """
+
+    def __init__(self, comm_rate_limiter):
+        self._lock = threading.RLock()
+
+        self._comm_rate_limiter = comm_rate_limiter
+        self._limiters_per_condition = {}
+
+[docs]    def get_limiter_per_condition(self, condition_name, condition_index):
+        limiter_key = (condition_name, condition_index)
+        if limiter_key not in self._limiters_per_condition:
+            self._limiters_per_condition[limiter_key] = TimeWindowRateLimiter(60, 1)
+        limiter_per_condition = self._limiters_per_condition[limiter_key]
+        return limiter_per_condition
+
+[docs]    def check_sleep_seconds(self, fn, *args, **kwargs):
+        condition_name = None
+        condition_index = None
+        if fn.__name__ == "SendCondition":
+            condition_name = kwargs.get("condition_name", args[1])
+            condition_index = kwargs.get("condition_index", args[2])
+        with self._lock:
+            sleep_seconds = self._comm_rate_limiter.check_sleep_seconds()
+            if condition_name is not None and condition_index is not None:
+                limiter_per_condition = self.get_limiter_per_condition(
+                    condition_name, condition_index
+                )
+                sleep_seconds = max(
+                    sleep_seconds, limiter_per_condition.check_sleep_seconds()
+                )
+            return sleep_seconds
+
+[docs]    def add_call_history(self, fn, *args, **kwargs):
+        condition_name = None
+        condition_index = None
+        if fn.__name__ == "SendCondition":
+            condition_name = kwargs.get("condition_name", args[1])
+            condition_index = kwargs.get("condition_index", args[2])
+        with self._lock:
+            self._comm_rate_limiter.add_call_history()
+            if condition_name is not None and condition_index is not None:
+                limiter_per_condition = self.get_limiter_per_condition(
+                    condition_name, condition_index
+                )
+                limiter_per_condition.add_call_history()
+
+[docs]    def sleep_if_necessary(self, fn, *args, **kwargs):
+        with self._lock:
+            sleep_seconds = self.check_sleep_seconds(fn, *args, **kwargs)
+            if sleep_seconds > 0:
+                time.sleep(sleep_seconds)
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusRealType.html b/_modules/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusRealType.html new file mode 100644 index 00000000..8e1cfbd4 --- /dev/null +++ b/_modules/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusRealType.html @@ -0,0 +1,480 @@ + + + + + + + + koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusRealType — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusRealType

+from __future__ import annotations
+
+import contextlib
+import json
+
+from os import PathLike
+from pathlib import Path
+from typing import BinaryIO, Dict, List, Optional, TextIO, Union
+
+import pandas as pd
+
+from koapy.config import debug, default_encoding
+from koapy.utils.logging.Logging import Logging
+from koapy.utils.serialization import JsonSerializable
+
+
+[docs]class KiwoomOpenApiPlusRealType(JsonSerializable, Logging):
+[docs]    class Fid(JsonSerializable):
+
+        __outer_class__ = None
+
+[docs]        FID_DUMP_FILEDIR = Path(__file__).parent.parent / "data/metadata"
+[docs]        FID_DUMP_FILENAME = "fid.csv"
+[docs]        FID_DUMP_FILEPATH = FID_DUMP_FILEDIR / FID_DUMP_FILENAME
+[docs]        FID_DUMP_PROCESSOR = pd.read_csv
+
+[docs]        FID_BY_FID: Dict[int, KiwoomOpenApiPlusRealType.Fid] = {}
+[docs]        FID_BY_NAME: Dict[str, KiwoomOpenApiPlusRealType.Fid] = {}
+
+        def __init__(self, fid: Optional[int] = None, name: Optional[str] = None):
+            if fid is not None and name is None:
+                name = self.get_name_by_fid(fid)
+            self.fid = fid
+            self.name = name
+
+        def __repr__(self):
+            return "{}.{}({!r}, {!r})".format(
+                self.__outer_class__.__name__,
+                self.__class__.__name__,
+                self.fid,
+                self.name,
+            )
+
+        def __eq__(self, other):
+            if isinstance(other, type(self)):
+                return self.fid == other.fid and self.name == other.name
+            return False
+
+        @classmethod
+[docs]        def fids_from_dump_file(
+            cls,
+            dump_file: Optional[Union[str, PathLike]] = None,
+            encoding: Optional[str] = None,
+        ) -> Dict[int, str]:
+            if dump_file is None:
+                dump_file = cls.FID_DUMP_FILEPATH
+            if encoding is None:
+                encoding = "utf-8"
+            df = cls.FID_DUMP_PROCESSOR(dump_file, encoding=encoding)
+            fids = [cls(pair[0], pair[1]) for pair in zip(df["fid"], df["name"])]
+            return fids
+
+        @classmethod
+[docs]        def load_from_dump_file(cls, dump_file: Optional[Union[str, PathLike]] = None):
+            fids = cls.fids_from_dump_file(dump_file)
+            cls.FID_BY_FID = {fid.fid: fid for fid in fids}
+            cls.FID_BY_NAME = {fid.name: fid for fid in fids}
+
+        @classmethod
+[docs]        def from_fid(
+            cls, fid: Union[str, int]
+        ) -> Optional[KiwoomOpenApiPlusRealType.Fid]:
+            fid = int(fid)
+            fid = cls.FID_BY_FID.get(fid)
+            return fid
+
+        @classmethod
+[docs]        def from_name(cls, name: str) -> Optional[KiwoomOpenApiPlusRealType.Fid]:
+            fid = cls.FID_BY_NAME.get(name)
+            return fid
+
+        @classmethod
+[docs]        def get_name_by_fid(
+            cls, fid: Union[str, int], default: Optional[str] = None
+        ) -> Optional[str]:
+            fid = cls.from_fid(fid)
+            return fid.name if fid else default
+
+[docs]    REALTYPE_BY_DESC_DUMP_FILEDIR = Path(__file__).parent.parent / "data/metadata"
+[docs]    REALTYPE_BY_DESC_DUMP_FILENAME = "realtype_by_desc.json"
+[docs]    REALTYPE_BY_DESC_DUMP_FILEPATH = (
+        REALTYPE_BY_DESC_DUMP_FILEDIR / REALTYPE_BY_DESC_DUMP_FILENAME
+    )
+
+[docs]    REALTYPE_BY_DESC: Dict[str, KiwoomOpenApiPlusRealType] = {}
+
+    def __init__(
+        self,
+        gidc: Optional[str] = None,
+        desc: Optional[str] = None,
+        nfid: Optional[int] = None,
+        fids: Optional[List[int]] = None,
+    ):
+        self.gidc = gidc
+        self.desc = desc
+        self.nfid = nfid
+        self.fids = fids
+
+    def __repr__(self):
+        return "{}({!r}, {!r}, {!r}, {!r})".format(
+            self.__class__.__name__,
+            self.gidc,
+            self.desc,
+            self.nfid,
+            self.fids,
+        )
+
+    def __eq__(self, other):
+        if isinstance(other, type(self)):
+            return (
+                self.gidc == other.gidc
+                and self.desc == other.desc
+                and self.nfid == other.nfid
+                and self.fids == other.fids
+            )
+        return False
+
+    @classmethod
+[docs]    def get_realtype_name_list(cls):
+        return list(cls.REALTYPE_BY_DESC.keys())
+
+    @classmethod
+[docs]    def get_realtype_info_list(cls):
+        return list(cls.REALTYPE_BY_DESC.values())
+
+    @classmethod
+[docs]    def get_realtype_info_by_desc(
+        cls, desc: str
+    ) -> Optional[KiwoomOpenApiPlusRealType]:
+        return cls.REALTYPE_BY_DESC.get(desc)
+
+    @classmethod
+[docs]    def get_realtype_info_by_name(
+        cls, name: str
+    ) -> Optional[KiwoomOpenApiPlusRealType]:
+        return cls.get_realtype_info_by_desc(name)
+
+    @classmethod
+[docs]    def get_realtype_info_by_realtype_name(
+        cls, name: str
+    ) -> Optional[KiwoomOpenApiPlusRealType]:
+        return cls.get_realtype_info_by_name(name)
+
+    @classmethod
+[docs]    def from_name(cls, name: str) -> Optional[KiwoomOpenApiPlusRealType]:
+        return cls.get_realtype_info_by_name(name)
+
+    @classmethod
+[docs]    def get_fids_by_realtype_name(cls, name: str) -> Optional[List[int]]:
+        result = cls.get_realtype_info_by_realtype_name(name)
+        if result is not None:
+            return result.fids
+        return None
+
+    @classmethod
+[docs]    def get_fids_by_realtype_name_as_string(cls, name: str) -> Optional[str]:
+        fids = cls.get_fids_by_realtype_name(name)
+        if fids is not None:
+            fids = [str(fid) for fid in fids]
+            fids = ";".join(fids)
+        return fids
+
+    @classmethod
+[docs]    def get_field_names_by_realtype_name(cls, name: str) -> Optional[List[str]]:
+        fids = cls.get_fids_by_realtype_name(name)
+        names = None
+        if fids is not None:
+            names = [cls.Fid.get_name_by_fid(fid, str(fid)) for fid in fids]
+        return names
+
+    @classmethod
+[docs]    def realtypes_from_datfile(
+        cls,
+        dat_file: Optional[Union[str, PathLike, BinaryIO]] = None,
+        encoding: Optional[str] = None,
+        module_path: Optional[str] = None,
+    ) -> List[KiwoomOpenApiPlusRealType]:
+        if dat_file is None:
+            if module_path is None:
+                from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusTypeLibSpec import (
+                    API_MODULE_PATH,
+                )
+
+                module_path = API_MODULE_PATH
+            dat_file = module_path / "data" / "nkrealtime.dat"
+
+        if isinstance(dat_file, str):
+            dat_file = Path(dat_file)
+
+        if encoding is None:
+            encoding = "euc-kr"
+
+        gidc_width = 2
+        desc_width = 20
+        nfid_width = 3
+        fid_width = 5
+
+        with contextlib.ExitStack() as stack:
+            if isinstance(dat_file, Path):
+                if debug:
+                    cls.logger.debug("Reading file %s", dat_file)
+                dat_file = open(dat_file, "rb")
+                dat_file = stack.enter_context(dat_file)
+            lines = iter(dat_file)
+            lines = map(lambda line: line.rstrip(b"\r\n"), lines)
+            lines = filter(lambda line: not line.startswith(b";"), lines)
+            realtypes = []
+            for line in lines:
+                gidc = line[:gidc_width]
+                line = line[gidc_width:]
+                gidc = gidc.decode(encoding).strip()
+                desc = line[:desc_width]
+                line = line[desc_width:]
+                desc = desc.decode(encoding).strip()
+                nfid = line[:nfid_width]
+                nfid = nfid.strip()
+                line = line[nfid_width:]
+                if len(nfid) > 0:
+                    nfid = int(nfid)
+                else:
+                    nfid = 0
+                fids = []
+                for _ in range(nfid):
+                    fid = line[:fid_width]
+                    line = line[fid_width:]
+                    fid = int(fid)
+                    fids.append(fid)
+                assert len(line.rstrip(b"^M ")) == 0
+                realtypes.append(cls(gidc, desc, nfid, fids))
+            return realtypes
+
+    @classmethod
+[docs]    def realtype_by_desc_from_datfile(
+        cls, dat_file: Optional[Union[str, PathLike, BinaryIO]] = None
+    ) -> Dict[str, KiwoomOpenApiPlusRealType]:
+        realtypes = cls.realtypes_from_datfile(dat_file)
+        result = {realtype.desc: realtype for realtype in realtypes}
+        return result
+
+    @classmethod
+[docs]    def dump_realtype_by_desc(
+        cls,
+        dump_file: Optional[Union[str, PathLike, TextIO]] = None,
+        dat_file: Optional[Union[str, PathLike, BinaryIO]] = None,
+        encoding: Optional[str] = None,
+    ):
+        if dump_file is None:
+            dump_file = cls.REALTYPE_BY_DESC_DUMP_FILEPATH
+        if isinstance(dump_file, str):
+            dump_file = Path(dump_file)
+        with contextlib.ExitStack() as stack:
+            if isinstance(dump_file, PathLike):
+                dump_filename = dump_file
+                if encoding is None:
+                    encoding = default_encoding
+                dump_file = open(dump_file, "w", encoding=encoding)
+                dump_file = stack.enter_context(dump_file)
+            else:
+                dump_filename = None
+            result = cls.realtype_by_desc_from_datfile(dat_file)
+            for tr_code in result:
+                result[tr_code] = result[tr_code].to_dict()
+            if dump_filename is not None:
+                cls.logger.debug("Saving realtype to %s", dump_filename)
+            return json.dump(
+                result,
+                dump_file,
+                indent=4,
+                sort_keys=True,
+                ensure_ascii=False,
+            )
+
+    @classmethod
+[docs]    def realtype_by_desc_from_dump_file(
+        cls,
+        dump_file: Optional[Union[str, PathLike, TextIO]] = None,
+        encoding: Optional[str] = None,
+    ) -> Dict[str, KiwoomOpenApiPlusRealType]:
+        if dump_file is None:
+            dump_file = cls.REALTYPE_BY_DESC_DUMP_FILEPATH
+        if isinstance(dump_file, str):
+            dump_file = Path(dump_file)
+        with contextlib.ExitStack() as stack:
+            if isinstance(dump_file, PathLike):
+                if dump_file.exists() and dump_file.stat().st_size > 0:
+                    if encoding is None:
+                        encoding = default_encoding
+                    dump_file = open(dump_file, "r", encoding=encoding)
+                    dump_file = stack.enter_context(dump_file)
+                else:
+                    return {}
+            result = json.load(dump_file)
+        for desc in result:
+            result[desc] = cls.from_dict(result[desc])
+        return result
+
+    @classmethod
+[docs]    def load_from_dump_file(
+        cls, dump_file: Optional[Union[str, PathLike, TextIO]] = None
+    ):
+        cls.REALTYPE_BY_DESC = cls.realtype_by_desc_from_dump_file(dump_file)
+        cls.Fid.load_from_dump_file()
+
+    @classmethod
+[docs]    def load_from_datfile(
+        cls, dat_file: Optional[Union[str, PathLike, BinaryIO]] = None
+    ):
+        cls.REALTYPE_BY_DESC = cls.realtype_by_desc_from_datfile(dat_file)
+        cls.Fid.load_from_dump_file()
+
+    @classmethod
+[docs]    def load(cls):
+        try:
+            cls.load_from_datfile()
+        except FileNotFoundError:
+            cls.load_from_dump_file()
+
+
+KiwoomOpenApiPlusRealType.Fid.__outer_class__ = KiwoomOpenApiPlusRealType
+KiwoomOpenApiPlusRealType.load()
+
+
+[docs]def main():
+    KiwoomOpenApiPlusRealType.dump_realtype_by_desc()
+
+
+if __name__ == "__main__":
+    main()
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusScreenManager.html b/_modules/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusScreenManager.html new file mode 100644 index 00000000..cda3230c --- /dev/null +++ b/_modules/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusScreenManager.html @@ -0,0 +1,262 @@ + + + + + + + + koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusScreenManager — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusScreenManager

+import collections
+import random
+import threading
+
+from typing import Collection, List, Optional, Union
+
+from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusDispatchFunctions import (
+    KiwoomOpenApiPlusDispatchFunctions,
+)
+from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusError import (
+    KiwoomOpenApiPlusError,
+)
+from koapy.utils.logging.Logging import Logging
+
+
+[docs]class KiwoomOpenApiPlusScreenManager(Logging):
+
+[docs]    MAXIMUM_NUMBER_OF_SCREENS = 200
+
+    def __init__(self, control: Optional[KiwoomOpenApiPlusDispatchFunctions] = None):
+        self._control = control
+        self._lock = threading.RLock()
+        self._occupied_screen_nos = collections.deque(
+            maxlen=self.MAXIMUM_NUMBER_OF_SCREENS
+        )
+        self._borrow_count_by_screen_no = {}
+
+    @staticmethod
+[docs]    def number_to_screen_no(number: int) -> str:
+        return str(number).zfill(4)
+
+    @staticmethod
+[docs]    def screen_no_to_number(screen_no: str) -> int:
+        return int(screen_no)
+
+[docs]    def is_inuse(self, screen_no: str) -> bool:
+        return (
+            screen_no is not None
+            and self.screen_no_to_number(screen_no) in self._occupied_screen_nos
+        )
+
+[docs]    def get_single_free_screen(self, exclude: Optional[Collection[str]] = None) -> str:
+        if exclude is None:
+            exclude = []
+        else:
+            exclude = [self.screen_no_to_number(scrnno) for scrnno in exclude]
+        exclude = set(exclude)
+        with self._lock:
+            if len(self._occupied_screen_nos) == self.MAXIMUM_NUMBER_OF_SCREENS:
+                self.logger.warning(
+                    "Requesting free screen, but already using maximum number of screens."
+                )
+            screen_no = random.choice(
+                [
+                    i
+                    for i in range(1, 10000)
+                    if i not in self._occupied_screen_nos and i not in exclude
+                ]
+            )
+            screen_no = self.number_to_screen_no(screen_no)
+            return screen_no
+
+[docs]    def get_multiple_free_screens(self, count: int) -> List[str]:
+        screens = []
+        for _ in range(count):
+            screens.append(self.get_single_free_screen(exclude=screens))
+        return screens
+
+[docs]    def get_free_screen(self, count: Optional[int] = None) -> Union[str, List[str]]:
+        if count is None:
+            return self.get_single_free_screen()
+        else:
+            return self.get_multiple_free_screens(count)
+
+[docs]    def borrow_screen(
+        self, screen_no: Optional[str] = None, reuse: bool = True, pop: bool = True
+    ) -> str:
+        with self._lock:
+            if screen_no is None or screen_no == "":
+                screen_no = self.get_single_free_screen()
+            if not reuse:
+                if self.is_inuse(screen_no):
+                    raise KiwoomOpenApiPlusError(
+                        "Borrowing screen %s, but it's already is use." % screen_no
+                    )
+                if len(self._occupied_screen_nos) == self.MAXIMUM_NUMBER_OF_SCREENS:
+                    self.logger.warning(
+                        "Borrowing a screen, but already using maximum number of screens."
+                    )
+                    if pop:
+                        oldest = self._occupied_screen_nos.popleft()
+                        del self._borrow_count_by_screen_no[oldest]
+                        self.logger.warning(
+                            "Oldest screen %s popped.",
+                            self.number_to_screen_no(oldest),
+                        )
+                    else:
+                        raise KiwoomOpenApiPlusError("Cannot allocate more screen")
+            screen_no_int = self.screen_no_to_number(screen_no)
+            if not self.is_inuse(screen_no):
+                self._occupied_screen_nos.append(screen_no_int)
+            self._borrow_count_by_screen_no[screen_no_int] = (
+                self._borrow_count_by_screen_no.get(screen_no_int, 0) + 1
+            )
+            if len(self._occupied_screen_nos) == self.MAXIMUM_NUMBER_OF_SCREENS:
+                self.logger.warning("Maximum number of screens reached.")
+            return screen_no
+
+[docs]    def return_screen(self, screen_no: str) -> bool:
+        try:
+            with self._lock:
+                screen_no_int = self.screen_no_to_number(screen_no)
+                self._borrow_count_by_screen_no[screen_no_int] -= 1
+                if self._borrow_count_by_screen_no[screen_no_int] == 0:
+                    self._occupied_screen_nos.remove(screen_no_int)
+                    del self._borrow_count_by_screen_no[screen_no_int]
+            return True
+        except (KeyError, ValueError):
+            self.logger.warning("Returned screen %s, but not found.", screen_no)
+            return False
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusSignalConnector.html b/_modules/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusSignalConnector.html new file mode 100644 index 00000000..019f7034 --- /dev/null +++ b/_modules/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusSignalConnector.html @@ -0,0 +1,234 @@ + + + + + + + + koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusSignalConnector — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusSignalConnector

+from __future__ import annotations
+
+import inspect
+import threading
+
+from typing import Any, Callable, Generic, List, Optional, TypeVar
+
+try:
+    from typing import ParamSpec
+except ImportError:
+    from typing_extensions import ParamSpec
+
+from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusEventHandlerSignature import (
+    KiwoomOpenApiPlusEventHandlerSignature,
+)
+from koapy.compat.pyside2 import PYQT5, PYSIDE2, PythonQtError
+from koapy.compat.pyside2.QtAxContainer import QAxWidget
+from koapy.utils.logging.Logging import Logging
+
+[docs]P = ParamSpec("P")
+[docs]R = TypeVar("R")
+
+
+[docs]class KiwoomOpenApiPlusSignalConnector(Logging, Generic[P, R]):
+    def __init__(self, name: str):
+        super().__init__()
+
+        self._name = name
+        self._lock = threading.RLock()
+        self._slots: List[Callable[P, R]] = []
+
+        self._signature = KiwoomOpenApiPlusEventHandlerSignature.from_name(self._name)
+        self._param_types = [
+            (p.annotation) for p in self._signature.parameters.values()
+        ]
+
+        if PYSIDE2:
+            self._signal = self._signature.to_pyside2_event_signal()
+
+        self.__name__ = self._name
+        self.__signature__ = self._signature
+
+[docs]    def is_valid_slot(self, slot: Callable[..., Any]) -> bool:
+        slot_signature = inspect.signature(slot)
+        slot_types = [(p.annotation) for p in slot_signature.parameters.values()]
+        condition = len(self._param_types) == len(
+            slot_types
+        )  # currently only check parameter length
+        return condition
+
+[docs]    def connect_to(self, control: QAxWidget):
+        if PYSIDE2:
+            return control.connect(self._signal, self)
+        elif PYQT5:
+            return getattr(control, self._name).connect(self)
+        else:
+            raise PythonQtError("Unsupported Qt bindings")
+
+[docs]    def disconnect_from(self, control: QAxWidget):
+        if PYSIDE2:
+            return control.disconnect(self._signal, self)
+        elif PYQT5:
+            return getattr(control, self._name).disconnect(self)
+        else:
+            raise PythonQtError("Unsupported Qt bindings")
+
+[docs]    def connect(self, slot: Callable[..., Any]):
+        if not self.is_valid_slot(slot):
+            raise ValueError("Tried to connect invalid slot: %s" % slot)
+        with self._lock:
+            if slot not in self._slots:
+                self._slots.append(slot)
+
+[docs]    def disconnect(self, slot: Optional[Callable[..., Any]] = None):
+        with self._lock:
+            if slot is None:
+                self._slots.clear()
+            elif slot in self._slots:
+                self._slots.remove(slot)
+            else:
+                self.logger.warning("Tried to disconnect a slot that doesn't exist")
+
+[docs]    def call(self, *args: P.args, **kwargs: P.kwargs) -> R:
+        # make a copy in order to prevent modification during iteration problem
+        with self._lock:
+            slots = list(self._slots)
+        # use Thread with await/join for concurrency?
+        for slot in slots:
+            slot(*args, **kwargs)
+
+    def __call__(self, *args: P.args, **kwargs: P.kwargs) -> R:
+        return self.call(*args, **kwargs)
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusSignature.html b/_modules/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusSignature.html new file mode 100644 index 00000000..881e3e1a --- /dev/null +++ b/_modules/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusSignature.html @@ -0,0 +1,226 @@ + + + + + + + + koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusSignature — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusSignature

+from inspect import Parameter, Signature
+from typing import Dict
+
+import pythoncom
+
+from koapy.compat.pyside2 import PYSIDE2
+
+if PYSIDE2:
+    from koapy.compat.pyside2.QtCore import SIGNAL
+
+try:
+    from types import NoneType
+except ImportError:
+[docs]    NoneType = type(None)
+
+
+[docs]class KiwoomOpenApiPlusSignature(Signature):
+
+[docs]    PYTHONTYPE_TO_QTTYPE = {
+        int: "int",
+        str: "const QString&",
+    }
+
+[docs]    COMTYPE_TO_PYTHONTYPE = {
+        pythoncom.VT_I4: int,
+        pythoncom.VT_BSTR: str,
+        pythoncom.VT_VARIANT: Parameter.empty,
+        pythoncom.VT_VOID: NoneType,
+    }
+
+    def __init__(
+        self,
+        name: str,
+        parameters: Dict[str, Parameter] = None,
+        return_annotation=Signature.empty,
+    ):
+        self._name = name
+        super().__init__(parameters, return_annotation=return_annotation)
+
+    @property
+[docs]    def name(self) -> str:
+        return self._name
+
+    @classmethod
+    def _pythontype_to_qttype(cls, typ):
+        return cls.PYTHONTYPE_TO_QTTYPE[typ]
+
+[docs]    def to_pyside2_function_prototype(self) -> str:
+        name = self._name
+        parameters = self.parameters
+        parameters = parameters.values()
+        parameters = [self._pythontype_to_qttype(p.annotation) for p in parameters]
+        prototype = "{}({})".format(name, ", ".join(parameters))
+        return prototype
+
+    if PYSIDE2:
+
+        def to_pyside2_event_signal(self) -> str:
+            return SIGNAL(self.to_pyside2_function_prototype())
+
+    @classmethod
+    def _comtype_to_pythontype(cls, typ):
+        return cls.COMTYPE_TO_PYTHONTYPE.get(typ, Parameter.empty)
+
+    @classmethod
+    def _from_entry(cls, name, entry):
+        arg_names = entry.names[1:]
+        arg_types = [typ[0] for typ in entry.desc[2]]
+        return_type = entry.desc[8][0]
+        parameters = [
+            Parameter(
+                name=arg_name,
+                kind=Parameter.POSITIONAL_OR_KEYWORD,
+                annotation=cls._comtype_to_pythontype(arg_type),
+            )
+            for arg_name, arg_type in zip(arg_names, arg_types)
+        ]
+        return_annotation = cls._comtype_to_pythontype(return_type)
+        signature = cls(
+            name=name,
+            parameters=parameters,
+            return_annotation=return_annotation,
+        )
+        return signature
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusTrInfo.html b/_modules/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusTrInfo.html new file mode 100644 index 00000000..277aedeb --- /dev/null +++ b/_modules/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusTrInfo.html @@ -0,0 +1,612 @@ + + + + + + + + koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusTrInfo — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusTrInfo

+from __future__ import annotations
+
+import contextlib
+import io
+import json
+import zipfile
+
+from os import PathLike
+from pathlib import Path
+from typing import Any, Dict, List, Optional, Sequence, TextIO, Union
+
+from koapy.config import debug, default_encoding
+from koapy.utils.logging.Logging import Logging
+from koapy.utils.serialization import JsonSerializable
+
+
+[docs]class KiwoomOpenApiPlusTrInfo(JsonSerializable, Logging):
+
+[docs]    TRINFO_BY_CODE_DUMP_FILEDIR = Path(__file__).parent.parent / "data/metadata"
+[docs]    TRINFO_BY_CODE_DUMP_FILENAME = "trinfo_by_code.json"
+[docs]    TRINFO_BY_CODE_DUMP_FILEPATH = (
+        TRINFO_BY_CODE_DUMP_FILEDIR / TRINFO_BY_CODE_DUMP_FILENAME
+    )
+
+[docs]    TRINFO_BY_CODE: Dict[str, KiwoomOpenApiPlusTrInfo] = {}
+
+[docs]    class Field(JsonSerializable):
+
+        __outer_class__ = None
+
+        def __init__(
+            self,
+            name: Optional[str] = None,
+            start: Optional[int] = None,
+            offset: Optional[int] = None,
+            fid: Optional[int] = None,
+        ):
+            self.name = name
+            self.start = start
+            self.offset = offset
+            self.fid = fid
+
+        def __repr__(self):
+            return "{}.{}({!r}, {!r}, {!r}, {!r})".format(
+                self.__outer_class__.__name__,
+                self.__class__.__name__,
+                self.name,
+                self.start,
+                self.offset,
+                self.fid,
+            )
+
+        def __eq__(self, other):
+            if isinstance(other, type(self)):
+                return (
+                    self.name == other.name
+                    and self.start == other.start
+                    and self.offset == other.offset
+                    and self.fid == other.fid
+                )
+            return False
+
+    def __init__(
+        self,
+        tr_code: Optional[str] = None,
+        name: Optional[str] = None,
+        tr_name: Optional[str] = None,
+        tr_names_svr: Optional[str] = None,
+        tr_type: Optional[str] = None,
+        gfid: Optional[str] = None,
+        inputs: Optional[Sequence[Field]] = None,
+        single_outputs_name: Optional[str] = None,
+        single_outputs: Optional[Sequence[Field]] = None,
+        multi_outputs_name: Optional[str] = None,
+        multi_outputs: Optional[Sequence[Field]] = None,
+    ):
+        self.tr_code = tr_code
+        self.name = name
+        self.tr_name = tr_name
+        self.tr_names_svr = tr_names_svr
+        self.tr_type = tr_type
+        self.gfid = gfid
+        self.inputs = inputs
+        self.single_outputs_name = single_outputs_name
+        self.single_outputs = single_outputs
+        self.multi_outputs_name = multi_outputs_name
+        self.multi_outputs = multi_outputs
+
+    def __repr__(self):
+        return "{}({!r}, {!r}, {!r}, {!r}, {!r}, {!r}, {!r}, {!r}, {!r}, {!r}, {!r})".format(
+            self.__class__.__name__,
+            self.tr_code,
+            self.name,
+            self.tr_name,
+            self.tr_names_svr,
+            self.tr_type,
+            self.gfid,
+            self.inputs,
+            self.single_outputs_name,
+            self.single_outputs,
+            self.multi_outputs_name,
+            self.multi_outputs,
+        )
+
+    def __eq__(self, other):
+        if isinstance(other, type(self)):
+            return (
+                self.tr_code.lower() == other.tr_code.lower()
+                and self.name == other.name
+                and self.tr_name == other.tr_name
+                and self.tr_names_svr == other.tr_names_svr
+                and self.tr_type == other.tr_type
+                and self.gfid == other.gfid
+                and self.inputs == other.inputs
+                and self.single_outputs_name == other.single_outputs_name
+                and self.single_outputs == other.single_outputs
+                and self.multi_outputs_name == other.multi_outputs_name
+                and self.multi_outputs == other.multi_outputs
+            )
+        return False
+
+[docs]    def to_dict(self) -> Dict[str, Any]:
+        dic = dict(self.__dict__)
+        for attr in dic:
+            if isinstance(dic[attr], list):
+                dic[attr] = [field.to_dict() for field in dic[attr]]
+        return dic
+
+    @classmethod
+[docs]    def from_dict(cls, dic: Dict[str, Any]) -> KiwoomOpenApiPlusTrInfo:
+        output = cls()
+        for name in output.__dict__:
+            value = dic.get(name)
+            if isinstance(value, list):
+                fields = [cls.Field.from_dict(d) for d in value]
+                setattr(output, name, fields)
+            else:
+                setattr(output, name, value)
+        return output
+
+[docs]    def get_input_names(self) -> List[str]:
+        return [input_.name for input_ in self.inputs]
+
+[docs]    def get_single_output_names(self) -> List[str]:
+        return [output.name for output in self.single_outputs]
+
+[docs]    def get_multi_output_names(self) -> List[str]:
+        return [output.name for output in self.multi_outputs]
+
+    @classmethod
+[docs]    def get_trcode_list(cls) -> List[str]:
+        return list(cls.TRINFO_BY_CODE.keys())
+
+    @classmethod
+[docs]    def get_trinfo_list(cls) -> List[KiwoomOpenApiPlusTrInfo]:
+        return list(cls.TRINFO_BY_CODE.values())
+
+    @classmethod
+[docs]    def get_trinfo_by_code(cls, trcode: str) -> Optional[KiwoomOpenApiPlusTrInfo]:
+        return cls.TRINFO_BY_CODE.get(trcode.lower())
+
+    @classmethod
+[docs]    def from_code(cls, trcode: str) -> Optional[KiwoomOpenApiPlusTrInfo]:
+        return cls.get_trinfo_by_code(trcode)
+
+    @classmethod
+[docs]    def from_encfile(
+        cls,
+        f: Union[str, PathLike, TextIO],
+        tr_code: Optional[str] = None,
+        encoding: Optional[str] = None,
+    ) -> KiwoomOpenApiPlusTrInfo:
+        with contextlib.ExitStack() as stack:
+            if isinstance(f, str):
+                f = Path(f)
+            if isinstance(f, PathLike):
+                filename = f
+                if encoding is None:
+                    encoding = "euc-kr"
+                f = open(filename, "r", encoding=encoding)
+                f = stack.enter_context(f)
+                tr_code = filename.stem.lower()
+            elif tr_code is None:
+                raise ValueError("Argument tr_code should be given.")
+
+            lines = iter(f)
+            lines = map(lambda line: line.rstrip("\n"), lines)
+            lines = filter(lambda line: len(line.strip()) > 0, lines)
+
+            single_outputs_name = ""
+            single_outputs = []
+            multi_outputs_name = ""
+            multi_outputs = []
+
+            tr_names_svr = ""
+            gfid = ""
+
+            line = next(lines)
+            assert line == "[TRINFO]"
+            line = next(lines)
+            assert line.startswith("TRName=")
+            tr_name = line.split("=", 2)[1]
+            line = next(lines)
+            if line.startswith("TRNameSVR="):
+                tr_names_svr = line.split("=", 2)[1]
+                line = next(lines)
+            assert line.startswith("TRType=")
+            tr_type = line.split("=", 2)[1]
+            line = next(lines)
+            if line.startswith("GFID="):
+                gfid = line.split("=", 2)[1]
+                line = next(lines)
+            assert line == "[INPUT]"
+            line = next(lines)
+            assert line.startswith("@START_")
+            tr_name_readable = line.split("_", 2)[1].split("=", 2)[0]
+            line = next(lines)
+            inputs = []
+            while not line.startswith("@END_"):
+                input_name, triple = [
+                    item.strip() for item in line.strip().split("=", 2)
+                ]
+                triple = [item.strip() for item in triple.split(",")]
+                start, offset, fid = [int(item) for item in triple]
+                inputs.append(cls.Field(input_name, start, offset, fid))
+                line = next(lines)
+            line = next(lines)
+            assert line == "[OUTPUT]"
+            line = next(lines)
+            assert line.startswith("@START_")
+            single_outputs_name = line.split("_", 2)[1].split("=", 2)[0]
+            line = next(lines)
+            while not line.startswith("@END_"):
+                output_name, triple = [
+                    item.strip() for item in line.strip().split("=", 2)
+                ]
+                triple = [item.strip() for item in triple.split(",")]
+                start, offset, fid = [int(item) if item else 0 for item in triple]
+                single_outputs.append(cls.Field(output_name, start, offset, fid))
+                line = next(lines)
+            try:
+                line = next(lines)
+            except StopIteration:
+                pass
+            else:
+                if line.startswith("@START_"):
+                    multi_outputs_name = line.split("_", 2)[1].split("=", 2)[0]
+                    line = next(lines)
+                    while not line.startswith("@END_"):
+                        output_name, triple = [
+                            item.strip() for item in line.strip().split("=", 2)
+                        ]
+                        triple = [item.strip() for item in triple.split(",")]
+                        start, offset, fid = [
+                            int(item) if item else 0 for item in triple
+                        ]
+                        multi_outputs.append(cls.Field(output_name, start, offset, fid))
+                        line = next(lines)
+            return cls(
+                tr_code,
+                tr_name_readable,
+                tr_name,
+                tr_names_svr,
+                tr_type,
+                gfid,
+                inputs,
+                single_outputs_name,
+                single_outputs,
+                multi_outputs_name,
+                multi_outputs,
+            )
+
+    @classmethod
+[docs]    def infos_from_data_dir(
+        cls,
+        data_dir: Optional[Union[str, PathLike]] = None,
+        encoding: Optional[str] = None,
+        module_path: Optional[str] = None,
+    ) -> List[KiwoomOpenApiPlusTrInfo]:
+        if data_dir is None:
+            if module_path is None:
+                from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusTypeLibSpec import (
+                    API_MODULE_PATH,
+                )
+
+                module_path = API_MODULE_PATH
+            data_dir = module_path / "data"
+
+        if isinstance(data_dir, str):
+            data_dir = Path(data_dir)
+
+        if encoding is None:
+            encoding = "euc-kr"
+
+        if debug:
+            cls.logger.debug("Reading files under %s", data_dir)
+
+        enc_filenames = [filename.name.lower() for filename in data_dir.iterdir()]
+        enc_filenames = [
+            filename
+            for filename in enc_filenames
+            if filename.startswith("o") and filename.endswith(".enc")
+        ]
+        results = []
+        for filename in enc_filenames:
+            full_filename = data_dir / filename
+            with zipfile.ZipFile(full_filename) as z:
+                for info in z.infolist():
+                    inner_filename = info.filename
+                    tr_code = Path(inner_filename).stem.lower()
+                    if debug:
+                        cls.logger.debug(
+                            "Reading file %s inside %s", inner_filename, full_filename
+                        )
+                    with z.open(info) as b:
+                        with io.TextIOWrapper(b, encoding=encoding) as f:
+                            results.append(cls.from_encfile(f, tr_code))
+        return results
+
+[docs]    SINGLE_TO_MULTI_TRCODES = [
+        "opt10072",
+        "opt10073",
+        "opt10075",
+        "opt10076",
+        "opt10085",
+        "optkwfid",
+        "optkwinv",
+        "optkwpro",
+    ]
+
+    @classmethod
+[docs]    def swap_output_types(
+        cls, item: KiwoomOpenApiPlusTrInfo
+    ) -> KiwoomOpenApiPlusTrInfo:
+        multi_outputs_name = item.multi_outputs_name
+        multi_outputs = item.multi_outputs
+        item.multi_outputs_name = item.single_outputs_name
+        item.multi_outputs = item.single_outputs
+        item.single_outputs_name = multi_outputs_name
+        item.single_outputs = multi_outputs
+        return item
+
+    @classmethod
+[docs]    def trinfo_by_code_from_data_dir(
+        cls, data_dir: Optional[Union[str, PathLike]] = None, post_process: bool = True
+    ) -> Dict[str, KiwoomOpenApiPlusTrInfo]:
+        infos = cls.infos_from_data_dir(data_dir)
+        result = {info.tr_code: info for info in infos}
+        if post_process:
+            for tr_code in result:
+                if tr_code in cls.SINGLE_TO_MULTI_TRCODES:
+                    item = result[tr_code]
+                    item = cls.swap_output_types(item)
+                    result[tr_code] = item
+        return result
+
+    @classmethod
+[docs]    def dump_trinfo_by_code(
+        cls,
+        dump_file: Optional[Union[str, PathLike, TextIO]] = None,
+        data_dir: Optional[str] = None,
+        encoding: Optional[str] = None,
+    ):
+        if dump_file is None:
+            dump_file = cls.TRINFO_BY_CODE_DUMP_FILEPATH
+        with contextlib.ExitStack() as stack:
+            if isinstance(dump_file, str):
+                dump_file = Path(dump_file)
+            if isinstance(dump_file, PathLike):
+                dump_filename = dump_file
+                if encoding is None:
+                    encoding = default_encoding
+                dump_file = open(dump_file, "w", encoding=encoding)
+                dump_file = stack.enter_context(dump_file)
+            else:
+                dump_filename = None
+            result = cls.trinfo_by_code_from_data_dir(data_dir)
+            for tr_code in result:
+                result[tr_code] = result[tr_code].to_dict()
+            if dump_filename is not None:
+                cls.logger.debug("Saving trinfo to %s", dump_filename)
+            return json.dump(
+                result,
+                dump_file,
+                indent=4,
+                sort_keys=True,
+                ensure_ascii=False,
+            )
+
+    @classmethod
+[docs]    def trinfo_by_code_from_dump_file(
+        cls,
+        dump_file: Optional[Union[str, PathLike, TextIO]] = None,
+        encoding: Optional[str] = None,
+    ) -> Dict[str, KiwoomOpenApiPlusTrInfo]:
+        if dump_file is None:
+            dump_file = cls.TRINFO_BY_CODE_DUMP_FILEPATH
+        with contextlib.ExitStack() as stack:
+            if isinstance(dump_file, str):
+                dump_file = Path(dump_file)
+            if isinstance(dump_file, PathLike):
+                if dump_file.exists() and dump_file.stat().st_size > 0:
+                    if encoding is None:
+                        encoding = default_encoding
+                    dump_file = open(dump_file, "r", encoding=encoding)
+                    dump_file = stack.enter_context(dump_file)
+                else:
+                    return {}
+            result = json.load(dump_file)
+        for tr_code in result:
+            item = cls.from_dict(result[tr_code])
+            result[tr_code] = item
+        return result
+
+    @classmethod
+[docs]    def load_from_dump_file(
+        cls, dump_file: Optional[Union[str, PathLike, TextIO]] = None
+    ):
+        cls.TRINFO_BY_CODE = cls.trinfo_by_code_from_dump_file(dump_file)
+
+    @classmethod
+[docs]    def load_from_data_dir(cls, data_dir: Optional[Union[str, PathLike]] = None):
+        cls.TRINFO_BY_CODE = cls.trinfo_by_code_from_data_dir(data_dir)
+
+    @classmethod
+[docs]    def load(cls):
+        try:
+            cls.load_from_data_dir()
+        except FileNotFoundError:
+            cls.load_from_dump_file()
+
+
+KiwoomOpenApiPlusTrInfo.Field.__outer_class__ = KiwoomOpenApiPlusTrInfo
+KiwoomOpenApiPlusTrInfo.load()
+
+
+[docs]def main():
+    KiwoomOpenApiPlusTrInfo.dump_trinfo_by_code()
+
+
+[docs]def infer_fids_by_tr_outputs(output_filename=None):
+    if output_filename is None:
+        output_filename = "fid.xlsx"
+    infos = KiwoomOpenApiPlusTrInfo.infos_from_data_dir()
+    fields = []
+    for info in infos:
+        for field in info.single_outputs:
+            fields.append(field)
+        for field in info.multi_outputs:
+            fields.append(field)
+    pairs = [[field.fid, field.name] for field in fields if field.fid != -1]
+    import string  # pylint: disable=import-outside-toplevel
+
+    for pair in pairs:
+        if pair[1].startswith("풋_"):
+            pair[1] = pair[1][2:]
+        if not pair[1][0] in string.ascii_letters and pair[1][-1] in "ns":
+            pair[1] = pair[1][:-1]
+        pair[1] = pair[1].upper()
+    pairs = [tuple(pair) for pair in pairs]
+    pairs = list(set(pairs))
+    pairs = sorted(pairs, key=lambda item: item[0])
+    import pandas as pd  # pylint: disable=import-outside-toplevel
+
+    df = pd.DataFrame.from_records(pairs)
+    df.to_excel(output_filename, header=False, index=False)
+
+
+if __name__ == "__main__":
+    main()
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusTypeLib.html b/_modules/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusTypeLib.html new file mode 100644 index 00000000..679195a5 --- /dev/null +++ b/_modules/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusTypeLib.html @@ -0,0 +1,155 @@ + + + + + + + + koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusTypeLib — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusTypeLib

+from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusTypeLibSpec import (
+    DISPATCH_CLSID,
+    EVENT_CLSID,
+    TYPELIB_SPEC,
+)
+from koapy.utils.pywin32 import BuildOleItems, LoadTypeLib
+
+[docs]TYPELIB = LoadTypeLib(TYPELIB_SPEC)
+
+OLE_ITEMS, ENUM_ITEMS, RECORD_ITEMS, VTABLE_ITEMS = BuildOleItems(TYPELIB_SPEC, TYPELIB)
+
+[docs]DISPATCH_OLE_ITEM = OLE_ITEMS.get(DISPATCH_CLSID)
+[docs]EVENT_OLE_ITEM = OLE_ITEMS.get(EVENT_CLSID)
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusTypeLibSpec.html b/_modules/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusTypeLibSpec.html new file mode 100644 index 00000000..29b8dcba --- /dev/null +++ b/_modules/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusTypeLibSpec.html @@ -0,0 +1,165 @@ + + + + + + + + koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusTypeLibSpec — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusTypeLibSpec

+from pathlib import Path
+
+from pywintypes import IID
+
+from koapy.utils.pywin32 import GetLatestTypelibSpec, GetTypelibSpecs
+
+[docs]CONTROL_PROGID = "KHOPENAPI.KHOpenApiCtrl.1"
+
+[docs]CONTROL_CLSID = IID("{A1574A0D-6BFA-4BD7-9020-DED88711818D}")
+[docs]DISPATCH_CLSID = IID("{CF20FBB6-EDD4-4BE5-A473-FEF91977DEB6}")
+[docs]EVENT_CLSID = IID("{7335F12D-8973-4BD5-B7F0-12DF03D175B7}")
+[docs]MODULE_CLSID = IID("{6D8C2B4D-EF41-4750-8AD4-C299033833FB}")
+
+[docs]TYPELIB_SPECS = GetTypelibSpecs(MODULE_CLSID)
+[docs]TYPELIB_SPEC = GetLatestTypelibSpec(TYPELIB_SPECS)
+
+[docs]TYPELIB_DLL_PATH = TYPELIB_SPEC and TYPELIB_SPEC.dll and Path(TYPELIB_SPEC.dll)
+
+[docs]API_MODULE_PATH_FROM_DEFAULT_INSTALLATION = Path("C:\\OpenAPI")
+[docs]API_MODULE_PATH_FROM_TYPELIB_DLL = TYPELIB_DLL_PATH and TYPELIB_DLL_PATH.parent
+[docs]API_MODULE_PATH = (
+    API_MODULE_PATH_FROM_TYPELIB_DLL or API_MODULE_PATH_FROM_DEFAULT_INSTALLATION
+)
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusVersionUpdater.html b/_modules/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusVersionUpdater.html new file mode 100644 index 00000000..d796b0fa --- /dev/null +++ b/_modules/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusVersionUpdater.html @@ -0,0 +1,367 @@ + + + + + + + + koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusVersionUpdater — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusVersionUpdater

+import os
+import subprocess
+import sys
+
+from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusQAxWidgetMixin import (
+    KiwoomOpenApiPlusQAxWidgetMixin,
+)
+from koapy.utils.ctypes import is_admin
+from koapy.utils.logging.Logging import Logging
+from koapy.utils.platform import is_32bit
+from koapy.utils.subprocess import Popen, function_to_subprocess_args
+
+
+[docs]class KiwoomOpenApiPlusVersionUpdater(Logging):
+    def __init__(self, credentials):
+        self._credentials = credentials
+
+[docs]    def get_api_module_path(self):
+        from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusTypeLibSpec import (
+            API_MODULE_PATH,
+        )
+
+        module_path = API_MODULE_PATH
+        return module_path
+
+[docs]    def get_autologin_dat(self):
+        module_path = self.get_api_module_path()
+        autologin_dat = module_path / "system" / "Autologin.dat"
+        return autologin_dat
+
+[docs]    def is_autologin_enabled(self):
+        autologin_dat = self.get_autologin_dat()
+        return autologin_dat.exists()
+
+[docs]    def disable_autologin(self):
+        self.logger.info("Disabling auto login")
+        autologin_dat = self.get_autologin_dat()
+        if autologin_dat.exists():
+            self.logger.info("Removing %s", autologin_dat)
+            os.remove(autologin_dat)
+            self.logger.info("Disabled auto login")
+            return True
+        else:
+            self.logger.info("Autologin is already disabled")
+            return False
+
+    @classmethod
+[docs]    def open_login_window_impl(cls):
+        from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusError import (
+            KiwoomOpenApiPlusError,
+        )
+        from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusQAxWidget import (
+            KiwoomOpenApiPlusQAxWidget,
+        )
+        from koapy.compat.pyside2.QtWidgets import QApplication
+
+        cls.logger.info("Opening login window")
+        app = QApplication(sys.argv)
+        control = KiwoomOpenApiPlusQAxWidget()
+        if control.GetConnectState() == 0:
+
+            def OnEventConnect(errcode):
+                control.OnEventConnect.disconnect(OnEventConnect)
+                KiwoomOpenApiPlusError.try_or_raise(errcode)
+                app.exit(errcode)
+
+            control.OnEventConnect.connect(OnEventConnect)
+            KiwoomOpenApiPlusError.try_or_raise(control.CommConnect())
+        return app.exec_()
+
+[docs]    def open_login_window(self):
+        # opening login window is a blocking process. (`app.exec_()` is the blocking process and will wait for `app.exit()`)
+        # also it's hard to use both PySide2/PyQt5 and pywinauto at the same time in the same process due to compatibility issue.
+        #
+        # in order to avoid the issues mentioned above we are creating login window in a separate process.
+        # and then will do login using pywinauto in another process using `login_using_pywinauto()` function.
+        #
+        # this process will stay alive until `OnEventConnect` event happens, hopefully a successful login.
+        #
+        # for more information about the compatibility issue between PySide2/PyQt5 and pywinauto, check the following link:
+        #   https://github.com/pywinauto/pywinauto/issues/472
+
+        def main():
+            # pylint: disable=redefined-outer-name,import-self
+            from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusVersionUpdater import (
+                KiwoomOpenApiPlusVersionUpdater,
+            )
+
+            KiwoomOpenApiPlusVersionUpdater.open_login_window_impl()
+
+        cmd = function_to_subprocess_args(main)
+        creationflags = subprocess.CREATE_NEW_PROCESS_GROUP
+        proc = Popen(cmd, creationflags=creationflags)
+        return proc
+
+    @classmethod
+[docs]    def show_account_window_impl(cls):
+        from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusError import (
+            KiwoomOpenApiPlusError,
+        )
+        from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusQAxWidget import (
+            KiwoomOpenApiPlusQAxWidget,
+        )
+        from koapy.compat.pyside2.QtWidgets import QApplication
+
+        cls.logger.info("Showing account window")
+        app = QApplication(sys.argv)
+        control = KiwoomOpenApiPlusQAxWidget()
+        if control.GetConnectState() == 0:
+
+            def OnEventConnect(errcode):
+                control.OnEventConnect.disconnect(OnEventConnect)
+                KiwoomOpenApiPlusError.try_or_raise(errcode)
+                control.KOA_Functions("ShowAccountWindow", "")
+                app.exit(errcode)
+
+            control.OnEventConnect.connect(OnEventConnect)
+            KiwoomOpenApiPlusError.try_or_raise(control.CommConnect())
+        return app.exec_()
+
+[docs]    def show_account_window(self):
+        # this function does pretty much the same job like the `open_login_window()` function.
+        # but the difference is that it will show up the account setting window after successful login,
+        # so that we can (re-)enable the auto login functionality provided by the OpenAPI itself.
+        #
+        # this process will stay live until the account window is closed in the `OnEventConnect` event,
+        # hopefully after successfully enabling the auto login functionality.
+        #
+        # note that the `control.KOA_Functions('ShowAccountWindow', '')` line is also blocking process.
+        # so it will block until the account window is closed after enabling the auto login.
+
+        def main():
+            # pylint: disable=redefined-outer-name,import-self
+            from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusVersionUpdater import (
+                KiwoomOpenApiPlusVersionUpdater,
+            )
+
+            KiwoomOpenApiPlusVersionUpdater.show_account_window_impl()
+
+        cmd = function_to_subprocess_args(main)
+        creationflags = subprocess.CREATE_NEW_PROCESS_GROUP
+        proc = Popen(cmd, creationflags=creationflags)
+        return proc
+
+    @classmethod
+[docs]    def check_apply_simulation_window(cls):
+        import pywinauto
+
+        desktop = pywinauto.Desktop(allow_magic_lookup=False)
+        apply_simulation_window = desktop.window(title="모의투자 참가신청")
+
+        try:
+            timeout_apply_simulation = 5
+            apply_simulation_window.wait("ready", timeout_apply_simulation)
+        except pywinauto.timings.TimeoutError:
+            pass
+        else:
+            cls.logger.warning("Please apply for simulation server before using it")
+            raise RuntimeError("Please apply for simulation server before using it")
+
+    @classmethod
+[docs]    def login_using_pywinauto(cls, credentials):
+        # reusing the implementation in the mixin
+        KiwoomOpenApiPlusQAxWidgetMixin.LoginUsingPywinauto_Impl(credentials)
+        cls.check_apply_simulation_window()
+
+    @classmethod
+[docs]    def enable_autologin_using_pywinauto(cls, credentials):
+        # reusing the implementation in the mixin
+        account_passwords = credentials.get("account_passwords")
+        KiwoomOpenApiPlusQAxWidgetMixin.EnableAutoLoginUsingPywinauto_Impl(
+            account_passwords
+        )
+
+[docs]    def enable_autologin(self):
+        self.logger.info("Start enabling auto login")
+
+        # pylint: disable=unused-variable
+        account_window_proc = self.show_account_window()
+
+        credentials = self._credentials
+
+        self.login_using_pywinauto(credentials)
+        self.enable_autologin_using_pywinauto(credentials)
+
+    @classmethod
+[docs]    def handle_version_upgrade_using_pywinauto(cls, pid):
+        return KiwoomOpenApiPlusQAxWidgetMixin.HandleVersionUpgradeUsingPywinauto_Impl(
+            pid
+        )
+
+[docs]    def try_version_update_using_pywinauto(self):
+        self.logger.info("Trying version update")
+
+        is_autologin_enabled = self.is_autologin_enabled()
+
+        if is_autologin_enabled:
+            self.disable_autologin()
+
+        login_window_proc = self.open_login_window()
+
+        credentials = self._credentials
+
+        self.login_using_pywinauto(credentials)
+
+        is_updated = self.handle_version_upgrade_using_pywinauto(login_window_proc.pid)
+
+        if is_autologin_enabled:
+            self.logger.info("Enabling auto login back")
+            self.enable_autologin()
+            if is_updated:
+                self.logger.info("Done update, enabled auto login")
+            else:
+                self.logger.info("There was no version update, enabled auto login")
+
+        return is_updated
+
+[docs]    def update_version_if_necessary(self):
+        assert (
+            is_32bit()
+        ), "Automatic version update requires to be run in 32bit environment"
+        assert (
+            is_admin()
+        ), "Automatic version update requires to be run as administrator"
+        return self.try_version_update_using_pywinauto()
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/kiwoom_open_api_plus/core/tools/generate_python_stubs.html b/_modules/koapy/backend/kiwoom_open_api_plus/core/tools/generate_python_stubs.html new file mode 100644 index 00000000..aae17c1d --- /dev/null +++ b/_modules/koapy/backend/kiwoom_open_api_plus/core/tools/generate_python_stubs.html @@ -0,0 +1,263 @@ + + + + + + + + koapy.backend.kiwoom_open_api_plus.core.tools.generate_python_stubs — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.kiwoom_open_api_plus.core.tools.generate_python_stubs

+import ast
+
+from pathlib import Path
+
+import pythoncom
+
+from koapy.config import default_encoding
+
+try:
+    from ast import unparse
+except ImportError:
+    from astunparse import unparse
+
+
+[docs]def generate_python_stubs(
+    dispatch_class_name=None,
+    dispatch_file_path=None,
+    event_class_name=None,
+    event_file_path=None,
+    encoding=None,
+    force_overwrite=False,
+):
+    if dispatch_class_name is None:
+        dispatch_class_name = "KiwoomOpenApiPlusDispatchFunctionsGenerated"
+    if dispatch_file_path is None:
+        dispatch_file_path = dispatch_class_name + ".py"
+
+    if event_class_name is None:
+        event_class_name = "KiwoomOpenApiPlusEventFunctionsGenerated"
+    if event_file_path is None:
+        event_file_path = event_class_name + ".py"
+
+    if encoding is None:
+        encoding = default_encoding
+
+    from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusTypeLib import (
+        DISPATCH_OLE_ITEM,
+        EVENT_OLE_ITEM,
+    )
+
+    dispatch_item = DISPATCH_OLE_ITEM
+    event_item = EVENT_OLE_ITEM
+
+    ellipsis_function_body = [ast.Expr(ast.Constant(Ellipsis))]
+    comtype_to_annotation = {
+        pythoncom.VT_I4: int.__name__,
+        pythoncom.VT_BSTR: str.__name__,
+        pythoncom.VT_VARIANT: str(None),
+        pythoncom.VT_VOID: str(None),
+    }
+
+    dispatch_func_defs = []
+    for _name, entry in dispatch_item.mapFuncs.items():
+        func_name = entry.names[0]
+        arg_names = entry.names[1:]
+        arg_descs = entry.desc.args
+        args = [ast.arg("self", None)]
+        for arg_name, (arg_type, _arg_flag, _arg_default, _arg_crap) in zip(
+            arg_names, arg_descs
+        ):
+            arg_type = comtype_to_annotation[arg_type]
+            arg_annotation = ast.Name(arg_type, ast.Load())
+            arg = ast.arg(arg_name, arg_annotation)
+            arg.lineno = None
+            arg.col_offset = None
+            args.append(arg)
+        args = ast.arguments([], args, None, [], [], None, [])
+        return_type = entry.desc.rettype[0]
+        return_type = comtype_to_annotation[return_type]
+        returns = ast.Name(return_type, ast.Load())
+        func_def = ast.FunctionDef(func_name, args, ellipsis_function_body, [], returns)
+        func_def.lineno = None
+        func_def.col_offset = None
+        dispatch_func_defs.append(func_def)
+    dispatch_class_def = ast.ClassDef(
+        dispatch_class_name, [], [], dispatch_func_defs, []
+    )
+
+    event_func_defs = []
+    for _name, entry in event_item.mapFuncs.items():
+        func_name = entry.names[0]
+        arg_names = entry.names[1:]
+        arg_descs = entry.desc.args
+        args = [ast.arg("self", None)]
+        for arg_name, (arg_type, _arg_flag, _arg_default, _arg_crap) in zip(
+            arg_names, arg_descs
+        ):
+            arg_type = comtype_to_annotation[arg_type]
+            arg_annotation = ast.Name(arg_type, ast.Load())
+            arg = ast.arg(arg_name, arg_annotation)
+            arg.lineno = None
+            arg.col_offset = None
+            args.append(arg)
+        args = ast.arguments([], args, None, [], [], None, [])
+        return_type = entry.desc.rettype[0]
+        return_type = comtype_to_annotation[return_type]
+        returns = ast.Name(return_type, ast.Load())
+        func_def = ast.FunctionDef(func_name, args, ellipsis_function_body, [], returns)
+        func_def.lineno = None
+        func_def.col_offset = None
+        event_func_defs.append(func_def)
+
+    event_class_def = ast.ClassDef(event_class_name, [], [], event_func_defs, [])
+
+    dispatch_file_path = Path(dispatch_file_path)
+    if not dispatch_file_path.exists() or force_overwrite:
+        with open(dispatch_file_path, "w", encoding=encoding) as f:
+            mod = ast.Module([dispatch_class_def], [])
+            code = unparse(mod)
+            f.write(code)
+
+    event_file_path = Path(event_file_path)
+    if not event_file_path.exists() or force_overwrite:
+        with open(event_file_path, "w", encoding=encoding) as f:
+            mod = ast.Module([event_class_def], [])
+            code = unparse(mod)
+            f.write(code)
+
+
+if __name__ == "__main__":
+    generate_python_stubs()
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/kiwoom_open_api_plus/grpc/KiwoomOpenApiPlusServiceClient.html b/_modules/koapy/backend/kiwoom_open_api_plus/grpc/KiwoomOpenApiPlusServiceClient.html new file mode 100644 index 00000000..368dfe72 --- /dev/null +++ b/_modules/koapy/backend/kiwoom_open_api_plus/grpc/KiwoomOpenApiPlusServiceClient.html @@ -0,0 +1,272 @@ + + + + + + + + koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusServiceClient — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusServiceClient

+import inspect
+
+from concurrent.futures import ThreadPoolExecutor
+
+import grpc
+
+from koapy.backend.kiwoom_open_api_plus.grpc import KiwoomOpenApiPlusService_pb2_grpc
+from koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusServiceClientStubWrapper import (
+    KiwoomOpenApiPlusServiceClientStubWrapper,
+)
+from koapy.config import config
+
+
+[docs]class KiwoomOpenApiPlusServiceClient:
+    def __init__(
+        self,
+        host=None,
+        port=None,
+        credentials=None,
+        thread_pool=None,
+        check_timeout=None,
+        **kwargs,
+    ):
+        if host is None:
+            host = config.get_string(
+                "koapy.backend.kiwoom_open_api_plus.grpc.host", "localhost"
+            )
+            host = config.get_string(
+                "koapy.backend.kiwoom_open_api_plus.grpc.client.host", host
+            )
+        if port is None:
+            port = config.get_int("koapy.backend.kiwoom_open_api_plus.grpc.port")
+            port = config.get_int(
+                "koapy.backend.kiwoom_open_api_plus.grpc.client.port", port
+            )
+
+        if check_timeout is None:
+            check_timeout = config.get_int(
+                "koapy.backend.kiwoom_open_api_plus.grpc.client.is_ready.timeout", 10
+            )
+
+        self._host = host
+        self._port = port
+        self._credentials = credentials
+        self._thread_pool = thread_pool
+        self._check_timeout = check_timeout
+        self._kwargs = kwargs
+
+        self._target = self._host + ":" + str(self._port)
+
+        if self._credentials is None:
+            channel_signature = inspect.signature(grpc.insecure_channel)
+            channel_params = list(channel_signature.parameters.keys())
+            channel_kwargs = {
+                k: v for k, v in self._kwargs.items() if k in channel_params
+            }
+            channel_bound_arguments = channel_signature.bind_partial(**channel_kwargs)
+            channel_bound_arguments.arguments["target"] = self._target
+            self._channel = grpc.insecure_channel(
+                *channel_bound_arguments.args,
+                **channel_bound_arguments.kwargs,
+            )
+        else:
+            channel_signature = inspect.signature(grpc.secure_channel)
+            channel_params = list(channel_signature.parameters.keys())
+            channel_kwargs = {
+                k: v for k, v in self._kwargs.items() if k in channel_params
+            }
+            channel_bound_arguments = channel_signature.bind_partial(**channel_kwargs)
+            channel_bound_arguments.arguments["target"] = self._target
+            channel_bound_arguments.arguments["credentials"] = self._credentials
+            self._channel = grpc.secure_channel(
+                *channel_bound_arguments.args,
+                **channel_bound_arguments.kwargs,
+            )
+
+        if self._thread_pool is None:
+            thread_pool_signature = inspect.signature(ThreadPoolExecutor)
+            thread_pool_params = list(thread_pool_signature.parameters.keys())
+            thread_pool_kwargs = {
+                k: v for k, v in self._kwargs.items() if k in thread_pool_params
+            }
+            thread_pool_bound_arguments = thread_pool_signature.bind(
+                **thread_pool_kwargs
+            )
+            if thread_pool_bound_arguments.arguments.get("max_workers") is None:
+                max_workers = config.get_int(
+                    "koapy.backend.kiwoom_open_api_plus.grpc.client.max_workers",
+                    8,
+                )
+                thread_pool_bound_arguments.arguments["max_workers"] = max_workers
+            self._thread_pool = ThreadPoolExecutor(
+                *thread_pool_bound_arguments.args,
+                **thread_pool_bound_arguments.kwargs,
+            )
+
+        self._stub = KiwoomOpenApiPlusService_pb2_grpc.KiwoomOpenApiPlusServiceStub(
+            self._channel
+        )
+        self._stub_wrapped = KiwoomOpenApiPlusServiceClientStubWrapper(
+            self._stub, self._thread_pool
+        )
+
+[docs]    def is_ready(self, timeout=None):
+        if timeout is None:
+            timeout = self._check_timeout
+        try:
+            grpc.channel_ready_future(self._channel).result(timeout=timeout)
+            return True
+        except grpc.FutureTimeoutError:
+            return False
+
+[docs]    def get_grpc_stub(self):
+        return self._stub
+
+[docs]    def get_stub(self):
+        return self._stub_wrapped
+
+[docs]    def close(self):
+        return self._channel.close()
+
+    def __getattr__(self, name):
+        return getattr(self._stub_wrapped, name)
+
+    def __enter__(self):
+        assert self.is_ready(), "Client is not ready"
+        return self
+
+    def __exit__(self, exc_type, exc_value, traceback):
+        self.close()
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/kiwoom_open_api_plus/grpc/KiwoomOpenApiPlusServiceClientSideDynamicCallable.html b/_modules/koapy/backend/kiwoom_open_api_plus/grpc/KiwoomOpenApiPlusServiceClientSideDynamicCallable.html new file mode 100644 index 00000000..c3c73c99 --- /dev/null +++ b/_modules/koapy/backend/kiwoom_open_api_plus/grpc/KiwoomOpenApiPlusServiceClientSideDynamicCallable.html @@ -0,0 +1,178 @@ + + + + + + + + koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusServiceClientSideDynamicCallable — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusServiceClientSideDynamicCallable

+from koapy.backend.kiwoom_open_api_plus.grpc import KiwoomOpenApiPlusService_pb2
+from koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusServiceMessageUtils import (
+    convert_arguments_from_python_to_protobuf,
+)
+
+
+[docs]class KiwoomOpenApiPlusServiceClientSideDynamicCallable:
+    def __init__(self, stub, name):
+        self._stub = stub
+        self._name = name
+
+    @classmethod
+    def _create_call_request(cls, name, args):
+        request = KiwoomOpenApiPlusService_pb2.CallRequest()
+        request.name = name
+        convert_arguments_from_python_to_protobuf(
+            args, request.arguments
+        )  # pylint: disable=no-member
+        return request
+
+    @classmethod
+    def _unpack_response(cls, response):
+        if response.return_value.HasField("string_value"):
+            return response.return_value.string_value
+        elif response.return_value.HasField("bool_value"):
+            return response.return_value.bool_value
+        elif response.return_value.HasField("long_value"):
+            return response.return_value.long_value
+        else:
+            return None
+
+    def __call__(self, *args):
+        request = self._create_call_request(self._name, args)
+        response = self._stub.Call(request)
+        result = self._unpack_response(response)
+        return result
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/kiwoom_open_api_plus/grpc/KiwoomOpenApiPlusServiceClientSideSignalConnector.html b/_modules/koapy/backend/kiwoom_open_api_plus/grpc/KiwoomOpenApiPlusServiceClientSideSignalConnector.html new file mode 100644 index 00000000..9c305418 --- /dev/null +++ b/_modules/koapy/backend/kiwoom_open_api_plus/grpc/KiwoomOpenApiPlusServiceClientSideSignalConnector.html @@ -0,0 +1,220 @@ + + + + + + + + koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusServiceClientSideSignalConnector — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusServiceClientSideSignalConnector

+import atexit
+import threading
+import time
+
+from koapy.backend.kiwoom_open_api_plus.grpc import KiwoomOpenApiPlusService_pb2
+from koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusServiceMessageUtils import (
+    convert_arguments_from_protobuf_to_python,
+)
+from koapy.backend.kiwoom_open_api_plus.utils.queue.QueueBasedIterableObserver import (
+    QueueBasedIterableObserver,
+)
+
+
+[docs]class KiwoomOpenApiPlusServiceClientSideSignalConnector:
+    def __init__(self, stub, name, executor):
+        self._stub = stub
+        self._name = name
+        self._executor = executor
+        self._lock = threading.RLock()
+        self._observers = {}
+
+        atexit.register(self.shutdown)
+
+    def __del__(self):
+        atexit.unregister(self.shutdown)
+
+    def _stop_observer(self, observer):
+        request = KiwoomOpenApiPlusService_pb2.BidirectionalListenRequest()
+        request.stop_listen_request.time = time.time()
+        observer.on_next(request)
+        observer.on_completed()
+
+    def _get_observer(self, callback, default=None):
+        return self._observers.setdefault(self._name, {}).get(callback, default)
+
+    def _remove_observer(self, callback):
+        with self._lock:
+            observer = self._get_observer(callback)
+            if observer:
+                self._stop_observer(observer)
+                del self._observers[self._name][callback]
+            return observer
+
+    def _add_observer(self, callback):
+        with self._lock:
+            self._remove_observer(callback)
+            observer = QueueBasedIterableObserver()
+            self._observers[self._name][callback] = observer
+            return observer
+
+[docs]    def shutdown(self):
+        with self._lock:
+            for _name, observers in self._observers.items():
+                for _callback, observer in observers.items():
+                    self._stop_observer(observer)
+
+[docs]    def connect(self, callback):
+        with self._lock:
+            observer = self._add_observer(callback)
+
+            def fn():
+                request = KiwoomOpenApiPlusService_pb2.BidirectionalListenRequest()
+                request.listen_request.slots.append(self._name)
+                observer.on_next(request)
+                observer_iterator = iter(observer)
+                response_iterator = self._stub.BidirectionalListen(observer_iterator)
+                for response in response_iterator:
+                    args = convert_arguments_from_protobuf_to_python(response.arguments)
+                    callback(*args)
+                    request = KiwoomOpenApiPlusService_pb2.BidirectionalListenRequest()
+                    request.handled_request.time = time.time()
+                    observer.on_next(request)
+
+            _future = self._executor.submit(fn)
+
+[docs]    def disconnect(self, callback):
+        with self._lock:
+            self._remove_observer(callback)
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/kiwoom_open_api_plus/grpc/KiwoomOpenApiPlusServiceClientStubWrapper.html b/_modules/koapy/backend/kiwoom_open_api_plus/grpc/KiwoomOpenApiPlusServiceClientStubWrapper.html new file mode 100644 index 00000000..7147afdb --- /dev/null +++ b/_modules/koapy/backend/kiwoom_open_api_plus/grpc/KiwoomOpenApiPlusServiceClientStubWrapper.html @@ -0,0 +1,1602 @@ + + + + + + + + koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusServiceClientStubWrapper — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusServiceClientStubWrapper

+import datetime
+import logging
+import re
+
+import pandas as pd
+
+from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusDispatchSignature import (
+    KiwoomOpenApiPlusDispatchSignature,
+)
+from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusEventHandlerSignature import (
+    KiwoomOpenApiPlusEventHandlerSignature,
+)
+from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusQAxWidgetMixin import (
+    KiwoomOpenApiPlusQAxWidgetUniversalMixin,
+)
+from koapy.backend.kiwoom_open_api_plus.grpc import KiwoomOpenApiPlusService_pb2
+from koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusServiceClientSideDynamicCallable import (
+    KiwoomOpenApiPlusServiceClientSideDynamicCallable,
+)
+from koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusServiceClientSideSignalConnector import (
+    KiwoomOpenApiPlusServiceClientSideSignalConnector,
+)
+from koapy.backend.kiwoom_open_api_plus.utils.grpc.PipeableMultiThreadedRendezvous import (
+    PipeableMultiThreadedRendezvous,
+)
+from koapy.utils.logging.Logging import Logging
+
+
+[docs]class KiwoomOpenApiPlusServiceClientStubCoreWrapper(
+    KiwoomOpenApiPlusQAxWidgetUniversalMixin
+):
+    """
+    KiwoomOpenApiPlusServiceServicer 에서 구현되어 이후 Stub 을 통해 제공되는
+    RPC 들을 클라이언트에서 좀 더 쉽게 사용하기 위한 래퍼 함수들을 제공합니다.
+    """
+
+[docs]    METHOD_NAMES = KiwoomOpenApiPlusDispatchSignature.names()
+[docs]    EVENT_NAMES = KiwoomOpenApiPlusEventHandlerSignature.names()
+
+    def __init__(self, stub, executor):
+        self._stub = stub
+        self._executor = executor
+
+        # Set methods as attributes
+        for method_name in self.METHOD_NAMES:
+            dynamic_callable = KiwoomOpenApiPlusServiceClientSideDynamicCallable(
+                self._stub, method_name
+            )
+            setattr(self, method_name, dynamic_callable)
+
+        # Set signals as attributes
+        for event_name in self.EVENT_NAMES:
+            signal_connector = KiwoomOpenApiPlusServiceClientSideSignalConnector(
+                self._stub, event_name, self._executor
+            )
+            setattr(self, event_name, signal_connector)
+
+    def __getattr__(self, name):
+        return getattr(self._stub, name)
+
+[docs]    def Call(self, name, *args):
+        """
+        임의의 함수 호출을 위한 RPC 입니다.
+
+        함수의 이름과 파라미터를 요청 메시지를 통해 전달받아 서버측에서 해당 함수를 호출하고
+        호출결과를 응답 메시지를 통해 전달합니다.
+
+        함수의 파라미터와 리턴값은 문자열/숫자/불리언 등의 단순한 타입만 지원합니다.
+        """
+        return KiwoomOpenApiPlusServiceClientSideDynamicCallable(self._stub, name)(
+            *args
+        )
+
+[docs]    def LoginCall(self, credentials=None):
+        """
+        키움증권 서버 연결 시나리오에 해당하는 RPC 입니다.
+
+        CommConnect() 메소드 호출 이후 발생하는 OnEventConnect() 이벤트를 처리하고
+        클라이언트에도 해당 이벤트 내용을 전달합니다.
+        """
+        request = KiwoomOpenApiPlusService_pb2.LoginRequest()
+        if credentials is not None:
+            request.credentials.user_id = credentials.get("user_id")
+            request.credentials.user_password = credentials.get("user_password")
+            request.credentials.cert_password = credentials.get("cert_password")
+            request.credentials.is_simulation = credentials.get("is_simulation")
+            account_passwords = credentials.get("account_passwords")
+            for account_no, account_password in account_passwords.items():
+                request.credentials.account_passwords[account_no] = account_password
+        for response in self._stub.LoginCall(request):
+            errcode = response.arguments[0].long_value
+        return errcode
+
+[docs]    def TransactionCall(self, rqname, trcode, scrno, inputs, stop_condition=None):
+        """
+        TR 요청에 해당하는 RPC 입니다.
+
+        CommRqData() 메소드 호출 이후 발생하는 OnReceiveTrData() 이벤트를 처리하고
+        클라이언트에도 해당 이벤트 내용을 전달합니다.
+
+        OnReceiveTrData() 이벤트 핸들러 함수 내부에서 요청받은 TR 에 따라 관련된 데이터를
+        추가로 읽어 들인 뒤 알맞은 응답형태로 가공하여 클라이언트에 반환합니다.
+        해당 과정에서 GetRepeatCnt() 및 GetCommData() 메소드를 내부적으로 호출합니다.
+
+        경우에 따라 연속조회가 필요하다면 OnReceiveTrData() 이벤트 핸들러 함수 내부에서
+        추가적인 SetInputValue() 및 CommRqData() 호출이 발생할 수 있습니다.
+
+        일반적인 TR 이 아닌 관심종목 관련 TR 의 경우 CommRqData() 대신 CommKwRqData() 가
+        내부적으로 호출됩니다.
+
+        서버측에서 CommRqData() 혹은 CommKwRqData() 호출시 내부적으로 호출제한 회피를 위한
+        대기시간이 발생할 수 있습니다.
+
+        최초 TR 요청 이후 특정 TR 들에서는 그와 관련된 실시간 데이터가 (OpenAPI+ 레벨에서) 자동으로 등록될 수 있습니다.
+        몇몇 상황에서는 해당 실시간 데이터가 유용할 수 있으나 현재 KOAPY 에서는 별도로 사용하진 않고 있으며,
+        TR 에 대한 응답처리가 모두 완료된 이후에는 해당 실시간 데이터를 등록 해제하도록 처리하고 있습니다.
+        """
+        request = KiwoomOpenApiPlusService_pb2.TransactionRequest()
+        request.request_name = rqname
+        request.transaction_code = trcode
+        request.screen_no = scrno or ""
+        for k, v in inputs.items():
+            request.inputs[k] = v
+        if stop_condition:
+            request.stop_condition.name = stop_condition.get("name", "")
+            request.stop_condition.value = str(stop_condition.get("value", ""))
+            request.stop_condition.comparator = {
+                "<=": KiwoomOpenApiPlusService_pb2.TransactionStopConditionCompartor.LESS_THAN_OR_EQUAL_TO,
+                "<": KiwoomOpenApiPlusService_pb2.TransactionStopConditionCompartor.LESS_THAN,
+                ">=": KiwoomOpenApiPlusService_pb2.TransactionStopConditionCompartor.GREATER_THAN_OR_EQUAL_TO,
+                ">": KiwoomOpenApiPlusService_pb2.TransactionStopConditionCompartor.GREATER_THAN,
+                "==": KiwoomOpenApiPlusService_pb2.TransactionStopConditionCompartor.EQUAL_TO,
+                "!=": KiwoomOpenApiPlusService_pb2.TransactionStopConditionCompartor.NOT_EQUAL_TO,
+            }.get(stop_condition.get("comparator", "<="))
+        return self._stub.TransactionCall(request)
+
+[docs]    def OrderCall(
+        self,
+        rqname,
+        scrno,
+        account,
+        order_type,
+        code,
+        quantity,
+        price,
+        quote_type,
+        original_order_no=None,
+    ):
+        """
+        주문 요청에 해당하는 RPC 입니다.
+
+        SendOrder() 메소드 호출 이후 발생하는 OnReceiveTrData() 및 OnReceiveChejanData() 이벤트를 처리하고
+        클라이언트에도 해당 이벤트 내용을 전달합니다.
+
+        SendOrder() 메소드 호출 이후 발생하는 OnReceiveTrData() 이벤트에서
+        주문번호가 확인 가능해야지만 정상주문으로 처리하고 그렇지 않다면 에러를 발생시킵니다.
+
+        일반적으로는 OnReceiveTrData() 이벤트가 먼저 발생하고 이후 OnReceiveChejanData() 이벤트가 접수/체결/잔고확인에 각각 발생합니다.
+        다만 주문건수가 폭증하는 경우 OnReceiveChejan() 이벤트가 OnReceiveTrData() 이벤트보다 앞서 수신될 수 있습니다.
+
+        이외에 주문거부등의 케이스에서 주문거부 사유 등이 OnReceiveMsg() 이벤트로 반환됩니다.
+
+        기본적으로 매수/매도 주문의 경우 주문받은 수량이 모두 체결될때까지 이벤트를 처리해 전달합니다.
+
+        거래 구분:
+            - 00: 지정가
+            - 03: 시장가
+            - 05: 조건부지정가
+            - 06: 최유리지정가
+            - 07: 최우선지정가
+            - 10: 지정가IOC
+            - 13: 시장가IOC
+            - 16: 최유리IOC
+            - 20: 지정가FOK
+            - 23: 시장가FOK
+            - 26: 최유리FOK
+            - 61: 장전시간외종가
+            - 62: 시간외단일가매매
+            - 81: 장후시간외종가
+
+        ※ 모의투자에서는 지정가 주문과 시장가 주문만 가능합니다.
+
+        주문 유형:
+            - 1: 신규매수
+            - 2: 신규매도
+            - 3: 매수취소
+            - 4: 매도취소
+            - 5: 매수정정
+            - 6: 매도정정
+
+        Args:
+            rqname (str): 사용자 구분 요청명
+            scrno (str): 화면번호 (4자리)
+            account (str): 계좌번호 (10자리)
+            order_type (int): 주문유형 (1:신규매수, 2:신규매도, 3:매수취소, 4:매도취소, 5:매수정정, 6:매도정정)
+            code (str): 종목코드 (6자리)
+            quantity (int): 주문수량
+            price (int): 주문단가
+            quote_type (str): 거래구분 (혹은 호가구분)
+            original_order_no (str): 원주문번호, 신규주문에는 공백 입력, 정정/취소시 입력합니다.
+        """
+        request = KiwoomOpenApiPlusService_pb2.OrderRequest()
+        request.request_name = rqname or ""
+        request.screen_no = str(scrno).zfill(4) if scrno else ""
+        request.account_no = str(account) if account else ""
+        request.order_type = int(order_type) if order_type else 0
+        request.code = code or ""
+        request.quantity = int(quantity) if quantity else 0
+        request.price = int(price) if price else 0
+        request.quote_type = quote_type or ""
+        request.original_order_no = original_order_no or ""
+        return self._stub.OrderCall(request)
+
+[docs]    def RealCall(
+        self,
+        scrno,
+        codes,
+        fids,
+        opt_type=None,
+        infer_fids=False,
+        readable_names=False,
+        fast_parse=False,
+    ):
+        """
+        실시간 데이터 요청에 해당하는 RPC 입니다.
+
+        SetRealReg() 메소드 호출 이후 발생하는 OnReceiveRealData() 이벤트를 처리하고
+        클라이언트에도 해당 이벤트 내용을 전달합니다.
+
+        OnReceiveRealData() 이벤트 핸들러 함수 내부에서 앞서 요청받은 실시간 데이터 FID 목록 혹은
+        직접 이벤트 핸들러 함수에서 확인 가능한 FID 목록에 따라 관련된 데이터를
+        추가로 읽어 들인 뒤 알맞은 응답형태로 가공하여 클라이언트에 반환합니다.
+        해당 과정에서 GetCommRealData() 메소드를 내부적으로 호출합니다.
+
+        해당 RPC 는 별도의 이벤트 종료 상황이 존재하지 않기 때문에 더이상 사용하지 않는 경우
+        클라이언트 측에서 해당 RPC 연결을 해제하는 식으로 더 이상 이벤트를 받지 않을 수 있습니다.
+        이 경우 서버에서는 내부적으로 기 등록된 실시간 데이터에 대해 SetRealRemove() 가 호출됩니다.
+        """
+        request = KiwoomOpenApiPlusService_pb2.RealRequest()
+        if scrno is None:
+            scrnos = []
+        elif isinstance(scrno, str):
+            scrnos = [scrno]
+        else:
+            scrnos = scrno
+        fids = [int(fid) for fid in fids]
+        if opt_type is None:
+            opt_type = "0"
+        request.screen_no.extend(scrnos)
+        request.code_list.extend(codes)
+        request.fid_list.extend(fids)
+        request.opt_type = opt_type
+        request.flags.infer_fids = infer_fids
+        request.flags.readable_names = readable_names
+        request.flags.fast_parse = fast_parse
+        return self._stub.RealCall(request)
+
+[docs]    def LoadConditionCall(self):
+        """
+        조건검색 기능 활용 이전에 먼저 조건식 목록을 불러오는데 사용할 수 있는 RPC 입니다.
+
+        GetConditionLoad() 메소드 호출 이후 발생하는 OnReceiveConditionVer() 이벤트를 처리하고
+        클라이언트에도 해당 이벤트 내용을 전달합니다.
+        """
+        request = KiwoomOpenApiPlusService_pb2.LoadConditionRequest()
+        for response in self._stub.LoadConditionCall(request):
+            ret = response.arguments[0].long_value
+            msg = response.arguments[1].string_value
+        return (ret, msg)
+
+[docs]    def ConditionCall(
+        self,
+        scrno,
+        condition_name,
+        condition_index,
+        search_type,
+        with_info=False,
+        is_future_option=False,
+        request_name=None,
+    ):
+        """
+        조건검색 기능에 해당하는 RPC 입니다.
+
+        SendCondition() 메소드 호출 이후 발생하는 OnReceiveTrCondition() 혹은 OnReceiveRealCondition() 이벤트를
+        처리하고 클라이언트에도 해당 이벤트 내용을 전달합니다.
+        """
+        request = request = KiwoomOpenApiPlusService_pb2.ConditionRequest()
+        request.screen_no = scrno or ""
+        request.condition_name = condition_name
+        request.condition_index = condition_index
+        request.search_type = search_type
+        request.flags.with_info = with_info
+        request.flags.is_future_option = is_future_option
+        if request_name is not None:
+            request.request_name = request_name
+        return self._stub.ConditionCall(request)
+
+[docs]    def SetLogLevel(self, level, logger=""):
+        """
+        서버에 존재하는 특정 로거의 로그레벨을 설정합니다.
+        """
+        request = KiwoomOpenApiPlusService_pb2.SetLogLevelRequest()
+        request.level = level
+        request.logger = logger
+        return self._stub.SetLogLevel(request)
+
+    def _LoadConditionUsingCall(self):
+        return self.Call("LoadCondition")
+
+[docs]    def LoadCondition(self):
+        """
+        조건검색 관련 조건식을 불러옵니다.
+        """
+        return self._LoadConditionUsingCall()
+
+    def _IsConditionLoadedUsingCall(self):
+        return self.Call("IsConditionLoaded")
+
+[docs]    def IsConditionLoaded(self):
+        """
+        조건식이 로드 되었는지 여부를 반환합니다.
+        """
+        return self._IsConditionLoadedUsingCall()
+
+    def _EnsureConditionLoadedUsingCall(self, force=False):
+        return self.Call("EnsureConditionLoaded", force)
+
+[docs]    def EnsureConditionLoaded(self, force=False):
+        """
+        조건식이 로드됨을 보장하도록 합니다.
+
+        이미 조건식을 불러온 경우 별다른 처리를 하지 않습니다.
+        조건식을 불러오지 않았다면 조건식을 불러오도록 처리합니다.
+        """
+        return self._EnsureConditionLoadedUsingCall(force)
+
+    def _RateLimitedCommRqDataUsingCall(
+        self, rqname, trcode, prevnext, scrno, inputs=None
+    ):
+        return self.Call(
+            "RateLimitedCommRqData", rqname, trcode, prevnext, scrno, inputs
+        )
+
+[docs]    def RateLimitedCommRqData(self, rqname, trcode, prevnext, scrno, inputs=None):
+        """
+        CommRqData() 와 동일하지만 호출제한 회피를 위한 함수입니다.
+        필요에 따라 호출제한을 회피하기 위해 실제 호출 전 대기할 수 있습니다.
+        """
+        self._RateLimitedCommRqDataUsingCall(rqname, trcode, prevnext, scrno, inputs)
+
+    def _RateLimitedSendConditionUsingCall(
+        self, scrno, condition_name, condition_index, search_type
+    ):
+        return self.Call(
+            "RateLimitedSendCondition",
+            scrno,
+            condition_name,
+            condition_index,
+            search_type,
+        )
+
+[docs]    def RateLimitedSendCondition(
+        self, scrno, condition_name, condition_index, search_type
+    ):
+        """
+        SendCondition() 과 동일하지만 호출제한 회피를 위한 함수입니다.
+        필요에 따라 호출제한을 회피하기 위해 실제 호출 전 대기할 수 있습니다.
+        """
+        return self._RateLimitedSendConditionUsingCall(
+            scrno, condition_name, condition_index, search_type
+        )
+
+
+[docs]class KiwoomOpenApiPlusServiceClientStubExtendedWrapper(
+    KiwoomOpenApiPlusServiceClientStubCoreWrapper, Logging
+):
+    """
+    제공되는 RPC 들을 활용한 여러 사용 케이스들을 구현합니다.
+    """
+
+    def _RemoveLeadingZerosForNumber(self, value, width=0):
+        remove = False
+        if width is None:
+            remove = False
+        elif isinstance(width, int) and (width == 0 or len(value) == width):
+            remove = True
+        elif hasattr(width, "__contains__") and len(value) in width:
+            remove = True
+        if remove:
+            return re.sub(r"^\s*([+-]?)[0]+([0-9]+(.[0-9]+)?)\s*$", r"\1\2", value)
+        return value
+
+    def _RemoveLeadingZerosForNumbersInValues(self, values, width=0):
+        return [self._RemoveLeadingZerosForNumber(value, width) for value in values]
+
+    def _ParseTransactionCallResponses(self, responses, remove_zeros_width=None):
+        single_output = None
+        columns = []
+        records = []
+        for response in responses:
+            if single_output is None:
+                single_output = dict(
+                    zip(
+                        response.single_data.names,
+                        self._RemoveLeadingZerosForNumbersInValues(
+                            response.single_data.values, remove_zeros_width
+                        ),
+                    )
+                )
+            if not columns:
+                columns = response.multi_data.names
+            for values in response.multi_data.values:
+                records.append(
+                    self._RemoveLeadingZerosForNumbersInValues(
+                        values.values, remove_zeros_width
+                    )
+                )
+        single = pd.Series(single_output, dtype=object)
+        multi = pd.DataFrame.from_records(records, columns=columns)
+        return single, multi
+
+[docs]    def GetStockBasicInfoAsDict(self, code, rqname=None, scrno=None):
+        """
+        주식 종목의 기본정보를 딕셔너리 형태로 반환합니다.
+
+        TR: OPT10001
+        """
+        if rqname is None:
+            rqname = "주식기본정보요청"
+        trcode = "opt10001"
+        inputs = {"종목코드": code}
+        for response in self.TransactionCall(rqname, trcode, scrno, inputs):
+            names = response.single_data.names
+            values = response.single_data.values
+            result = dict(zip(names, values))
+        return result
+
+[docs]    def GetStockBasicInfoAsSeries(self, code, rqname=None, scrno=None):
+        """
+        주식 종목의 기본정보를 pd.Series 형태로 반환합니다.
+
+        TR: OPT10001
+        """
+        dic = self.GetStockBasicInfoAsDict(code, rqname, scrno)
+        series = pd.Series(dic)
+        return series
+
+[docs]    def GetStockQuoteInfoAsDataFrame(self, codes=None, rqname=None, scrno=None):
+        """
+        복수개의 주식 종목들의 기본정보를 pd.DataFrame 형태로 반환합니다.
+
+        TR: OPTKWFID
+        """
+        if codes is None:
+            codes = self.GetGeneralCodeList()
+        elif isinstance(codes, str):
+            codes = [codes]
+        if rqname is None:
+            rqname = "관심종목정보요청"
+        trcode = "OPTKWFID"
+        columns = []
+        records = []
+        inputs = {"종목코드": ";".join(codes)}
+        for response in self.TransactionCall(rqname, trcode, scrno, inputs):
+            if not columns:
+                columns = response.multi_data.names
+            for values in response.multi_data.values:
+                records.append(values.values)
+        df = pd.DataFrame.from_records(records, columns=columns)
+        return df
+
+[docs]    def GetTickStockDataAsDataFrame(
+        self,
+        code,
+        interval,
+        start_date=None,
+        end_date=None,
+        include_end=False,
+        adjusted_price=False,
+        rqname=None,
+        scrno=None,
+    ):
+        """
+        틱 단위 차트 데이터를 pd.DataFrame 형태로 반환합니다.
+
+        TR: OPT10079
+        """
+        if interval is not None:
+            interval = int(interval)
+            interval = str(interval)
+
+        date_format = "%Y%m%d%H%M%S"
+        date_column_name = "체결시간"
+
+        if isinstance(start_date, datetime.datetime):
+            start_date = start_date.strftime(date_format)
+
+        if end_date is not None:
+            if isinstance(end_date, datetime.datetime):
+                end_date = end_date.strftime(date_format)
+            stop_condition = {
+                "name": date_column_name,
+                "value": end_date,
+            }
+            if include_end:
+                stop_condition["comparator"] = "<"
+        else:
+            stop_condition = None
+
+        if rqname is None:
+            rqname = "주식틱차트조회요청"
+        trcode = "opt10079"
+        inputs = {
+            "종목코드": code,
+            "틱범위": interval,
+            "수정주가구분": "1" if adjusted_price else "0",
+        }
+
+        columns = []
+        records = []
+
+        date_column_index = None
+        should_compare_start = start_date is not None
+
+        for response in self.TransactionCall(
+            rqname, trcode, scrno, inputs, stop_condition=stop_condition
+        ):
+            if not columns:
+                columns = list(response.multi_data.names)
+                if date_column_name in columns:
+                    date_column_index = columns.index(date_column_name)
+            for values in response.multi_data.values:
+                if should_compare_start and date_column_index is not None:
+                    date = values.values[date_column_index]
+                    if date > start_date:
+                        # 해당 TR 은 기준일자를 INPUT 으로 설정할 수 없는 이유로
+                        # 일단 가장 최근부터 차례대로 가져오고 클라이언트에서 요청보다 최근 데이터는 버림
+                        # 클라이언트 말고 서버에서 미리 처리해서 데이터를 보내지조차 않아야 할지??
+                        continue
+                    else:
+                        should_compare_start = False
+                records.append(values.values)
+
+            if self.logger.isEnabledFor(logging.DEBUG):
+                nrows = len(response.multi_data.values)
+                if nrows > 0:
+                    from_date = response.multi_data.values[0].values[date_column_index]
+                    to_date = response.multi_data.values[-1].values[date_column_index]
+                    from_date = datetime.datetime.strptime(from_date, date_format)
+                    to_date = datetime.datetime.strptime(to_date, date_format)
+                    self.logger.debug(
+                        "Received %d records from %s to %s for code %s",
+                        nrows,
+                        from_date,
+                        to_date,
+                        code,
+                    )
+
+        df = pd.DataFrame.from_records(records, columns=columns)
+        return df
+
+[docs]    def GetMinuteStockDataAsDataFrame(
+        self,
+        code,
+        interval,
+        start_date=None,
+        end_date=None,
+        include_end=False,
+        adjusted_price=False,
+        rqname=None,
+        scrno=None,
+    ):
+        """
+        분 단위 차트 데이터를 pd.DataFrame 형태로 반환합니다.
+
+        TR: OPT10080
+        """
+        if interval is not None:
+            interval = int(interval)
+            interval = str(interval)
+
+        date_format = "%Y%m%d%H%M%S"
+        date_column_name = "체결시간"
+
+        if isinstance(start_date, datetime.datetime):
+            start_date = start_date.strftime(date_format)
+
+        if end_date is not None:
+            if isinstance(end_date, datetime.datetime):
+                end_date = end_date.strftime(date_format)
+            stop_condition = {
+                "name": date_column_name,
+                "value": end_date,
+            }
+            if include_end:
+                stop_condition["comparator"] = "<"
+        else:
+            stop_condition = None
+
+        if rqname is None:
+            rqname = "주식분봉차트조회요청"
+        trcode = "opt10080"
+        inputs = {
+            "종목코드": code,
+            "틱범위": interval,
+            "수정주가구분": "1" if adjusted_price else "0",
+        }
+
+        columns = []
+        records = []
+
+        date_column_index = None
+        should_compare_start = start_date is not None
+
+        for response in self.TransactionCall(
+            rqname, trcode, scrno, inputs, stop_condition=stop_condition
+        ):
+            if not columns:
+                columns = list(response.multi_data.names)
+                if date_column_name in columns:
+                    date_column_index = columns.index(date_column_name)
+            for values in response.multi_data.values:
+                if should_compare_start and date_column_index is not None:
+                    date = values.values[date_column_index]
+                    if date > start_date:
+                        # 해당 TR 은 기준일자를 INPUT 으로 설정할 수 없는 이유로
+                        # 일단 가장 최근부터 차례대로 가져오고 클라이언트에서 요청보다 최근 데이터는 버림
+                        # 클라이언트 말고 서버에서 미리 처리해서 데이터를 보내지조차 않아야 할지??
+                        continue
+                    else:
+                        should_compare_start = False
+                records.append(values.values)
+
+            if self.logger.isEnabledFor(logging.DEBUG):
+                nrows = len(response.multi_data.values)
+                if nrows > 0:
+                    from_date = response.multi_data.values[0].values[date_column_index]
+                    to_date = response.multi_data.values[-1].values[date_column_index]
+                    from_date = datetime.datetime.strptime(from_date, date_format)
+                    to_date = datetime.datetime.strptime(to_date, date_format)
+                    self.logger.debug(
+                        "Received %d records from %s to %s for code %s",
+                        nrows,
+                        from_date,
+                        to_date,
+                        code,
+                    )
+
+        df = pd.DataFrame.from_records(records, columns=columns)
+        return df
+
+[docs]    def GetDailyStockDataAsDataFrame(
+        self,
+        code,
+        start_date=None,
+        end_date=None,
+        include_end=False,
+        adjusted_price=False,
+        rqname=None,
+        scrno=None,
+    ):
+        """
+        일 단위 차트 데이터를 pd.DataFrame 형태로 반환합니다.
+
+        TR: OPT10081
+        """
+        date_format = "%Y%m%d"
+        date_column_name = "일자"
+
+        if isinstance(start_date, datetime.datetime):
+            start_date = start_date.strftime(date_format)
+
+        if end_date is not None:
+            if isinstance(end_date, datetime.datetime):
+                end_date = end_date.strftime(date_format)
+            stop_condition = {
+                "name": date_column_name,
+                "value": end_date,
+            }
+            if include_end:
+                stop_condition["comparator"] = "<"
+        else:
+            stop_condition = None
+
+        if rqname is None:
+            rqname = "주식일봉차트조회요청"
+
+        trcode = "opt10081"
+        inputs = {
+            "종목코드": code,
+            "수정주가구분": "1" if adjusted_price else "0",
+        }
+        if start_date is not None:
+            inputs["기준일자"] = start_date
+
+        columns = []
+        records = []
+
+        date_column_index = None
+
+        for response in self.TransactionCall(
+            rqname, trcode, scrno, inputs, stop_condition=stop_condition
+        ):
+            if not columns:
+                columns = list(response.multi_data.names)
+                if date_column_name in columns:
+                    date_column_index = columns.index(date_column_name)
+            for values in response.multi_data.values:
+                records.append(values.values)
+
+            if self.logger.isEnabledFor(logging.DEBUG):
+                nrows = len(response.multi_data.values)
+                if nrows > 0:
+                    from_date = response.multi_data.values[0].values[date_column_index]
+                    to_date = response.multi_data.values[-1].values[date_column_index]
+                    from_date = datetime.datetime.strptime(from_date, date_format)
+                    to_date = datetime.datetime.strptime(to_date, date_format)
+                    self.logger.debug(
+                        "Received %d records from %s to %s for code %s",
+                        nrows,
+                        from_date,
+                        to_date,
+                        code,
+                    )
+
+        df = pd.DataFrame.from_records(records, columns=columns)
+        return df
+
+[docs]    def GetWeeklyStockDataAsDataFrame(
+        self,
+        code,
+        start_date=None,
+        end_date=None,
+        include_end=False,
+        adjusted_price=False,
+        rqname=None,
+        scrno=None,
+    ):
+        """
+        주 단위 차트 데이터를 pd.DataFrame 형태로 반환합니다.
+
+        TR: OPT10082
+        """
+        date_format = "%Y%m%d"
+        date_column_name = "일자"
+
+        if isinstance(start_date, datetime.datetime):
+            start_date = start_date.strftime(date_format)
+
+        if end_date is not None:
+            if isinstance(end_date, datetime.datetime):
+                end_date = end_date.strftime(date_format)
+            stop_condition = {
+                "name": date_column_name,
+                "value": end_date,
+            }
+            if include_end:
+                stop_condition["comparator"] = "<"
+        else:
+            stop_condition = None
+
+        if rqname is None:
+            rqname = "주식주봉차트조회요청"
+
+        trcode = "opt10082"
+        inputs = {
+            "종목코드": code,
+            "수정주가구분": "1" if adjusted_price else "0",
+        }
+        if start_date is not None:
+            inputs["기준일자"] = start_date
+        if end_date is not None:
+            inputs["끝일자"] = end_date  # 딱히 끝일자가 생각하는대로 안먹히는듯...
+
+        columns = []
+        records = []
+        date_column_index = None
+
+        for response in self.TransactionCall(
+            rqname, trcode, scrno, inputs, stop_condition=stop_condition
+        ):
+            if not columns:
+                columns = list(response.multi_data.names)
+                if date_column_name in columns:
+                    date_column_index = columns.index(date_column_name)
+            for values in response.multi_data.values:
+                records.append(values.values)
+
+            if self.logger.isEnabledFor(logging.DEBUG):
+                nrows = len(response.multi_data.values)
+                if nrows > 0:
+                    from_date = response.multi_data.values[0].values[date_column_index]
+                    to_date = response.multi_data.values[-1].values[date_column_index]
+                    from_date = datetime.datetime.strptime(from_date, date_format)
+                    to_date = datetime.datetime.strptime(to_date, date_format)
+                    self.logger.debug(
+                        "Received %d records from %s to %s for code %s",
+                        nrows,
+                        from_date,
+                        to_date,
+                        code,
+                    )
+
+        df = pd.DataFrame.from_records(records, columns=columns)
+        return df
+
+[docs]    def GetMonthlyStockDataAsDataFrame(
+        self,
+        code,
+        start_date=None,
+        end_date=None,
+        include_end=False,
+        adjusted_price=False,
+        rqname=None,
+        scrno=None,
+    ):
+        """
+        월 단위 차트 데이터를 pd.DataFrame 형태로 반환합니다.
+
+        TR: OPT10083
+        """
+        date_format = "%Y%m%d"
+        date_column_name = "일자"
+
+        if isinstance(start_date, datetime.datetime):
+            start_date = start_date.strftime(date_format)
+
+        if end_date is not None:
+            if isinstance(end_date, datetime.datetime):
+                end_date = end_date.strftime(date_format)
+            stop_condition = {
+                "name": date_column_name,
+                "value": end_date,
+            }
+            if include_end:
+                stop_condition["comparator"] = "<"
+        else:
+            stop_condition = None
+
+        if rqname is None:
+            rqname = "주식월봉차트조회요청"
+
+        trcode = "opt10083"
+        inputs = {
+            "종목코드": code,
+            "수정주가구분": "1" if adjusted_price else "0",
+        }
+        if start_date is not None:
+            inputs["기준일자"] = start_date
+        if end_date is not None:
+            inputs["끝일자"] = end_date  # 딱히 끝일자가 생각하는대로 안먹히는듯...
+
+        columns = []
+        records = []
+        date_column_index = None
+
+        for response in self.TransactionCall(
+            rqname, trcode, scrno, inputs, stop_condition=stop_condition
+        ):
+            if not columns:
+                columns = list(response.multi_data.names)
+                if date_column_name in columns:
+                    date_column_index = columns.index(date_column_name)
+            for values in response.multi_data.values:
+                records.append(values.values)
+
+            if self.logger.isEnabledFor(logging.DEBUG):
+                nrows = len(response.multi_data.values)
+                if nrows > 0:
+                    from_date = response.multi_data.values[0].values[date_column_index]
+                    to_date = response.multi_data.values[-1].values[date_column_index]
+                    from_date = datetime.datetime.strptime(from_date, date_format)
+                    to_date = datetime.datetime.strptime(to_date, date_format)
+                    self.logger.debug(
+                        "Received %d records from %s to %s for code %s",
+                        nrows,
+                        from_date,
+                        to_date,
+                        code,
+                    )
+
+        df = pd.DataFrame.from_records(records, columns=columns)
+        return df
+
+[docs]    def GetYearlyStockDataAsDataFrame(
+        self,
+        code,
+        start_date=None,
+        end_date=None,
+        include_end=False,
+        adjusted_price=False,
+        rqname=None,
+        scrno=None,
+    ):
+        """
+        년 단위 차트 데이터를 pd.DataFrame 형태로 반환합니다.
+
+        TR: OPT10094
+        """
+        date_format = "%Y%m%d"
+        date_column_name = "일자"
+
+        if isinstance(start_date, datetime.datetime):
+            start_date = start_date.strftime(date_format)
+
+        if end_date is not None:
+            if isinstance(end_date, datetime.datetime):
+                end_date = end_date.strftime(date_format)
+            stop_condition = {
+                "name": date_column_name,
+                "value": end_date,
+            }
+            if include_end:
+                stop_condition["comparator"] = "<"
+        else:
+            stop_condition = None
+
+        if rqname is None:
+            rqname = "주식년봉차트조회요청"
+
+        trcode = "opt10094"
+        inputs = {
+            "종목코드": code,
+            "수정주가구분": "1" if adjusted_price else "0",
+        }
+        if start_date is not None:
+            inputs["기준일자"] = start_date
+        if end_date is not None:
+            inputs["끝일자"] = end_date  # 딱히 끝일자가 생각하는대로 안먹히는듯...
+
+        columns = []
+        records = []
+        date_column_index = None
+
+        for response in self.TransactionCall(
+            rqname, trcode, scrno, inputs, stop_condition=stop_condition
+        ):
+            if not columns:
+                columns = list(response.multi_data.names)
+                if date_column_name in columns:
+                    date_column_index = columns.index(date_column_name)
+            for values in response.multi_data.values:
+                records.append(values.values)
+
+            if self.logger.isEnabledFor(logging.DEBUG):
+                nrows = len(response.multi_data.values)
+                if nrows > 0:
+                    from_date = response.multi_data.values[0].values[date_column_index]
+                    to_date = response.multi_data.values[-1].values[date_column_index]
+                    from_date = datetime.datetime.strptime(from_date, date_format)
+                    to_date = datetime.datetime.strptime(to_date, date_format)
+                    self.logger.debug(
+                        "Received %d records from %s to %s for code %s",
+                        nrows,
+                        from_date,
+                        to_date,
+                        code,
+                    )
+
+        df = pd.DataFrame.from_records(records, columns=columns)
+        return df
+
+[docs]    def GetDepositInfo(
+        self, account_no, lookup_type=None, with_multi=False, rqname=None, scrno=None
+    ):
+        """
+        계좌의 예수금 정보를 반환합니다.
+
+        TR: OPW00001
+
+        조회구분 = 3:추정조회, 2:일반조회
+        """
+        if rqname is None:
+            rqname = "예수금상세현황요청"
+        trcode = "opw00001"
+        inputs = {
+            "계좌번호": account_no,
+            "비밀번호": "",
+            "비밀번호입력매체구분": "00",
+            "조회구분": "2" if lookup_type is None else lookup_type,
+        }
+        responses = self.TransactionCall(rqname, trcode, scrno, inputs)
+        single, multi = self._ParseTransactionCallResponses(responses, [12, 15])
+        if with_multi:
+            return single, multi
+        else:
+            return single
+
+[docs]    def GetStockQuotes(self, code, rqname=None, scrno=None):
+        """
+        주식의 호가정보를 반환합니다.
+
+        TR: OPT10004
+        """
+        if rqname is None:
+            rqname = "주식호가요청"
+        trcode = "opt10004"
+        inputs = {
+            "종목코드": code,
+        }
+        responses = self.TransactionCall(rqname, trcode, scrno, inputs)
+        single, _multi = self._ParseTransactionCallResponses(responses, [12, 15])
+        return single
+
+[docs]    def GetOrderLogAsDataFrame1(
+        self,
+        account_no,
+        order_type=None,
+        status_type=None,
+        code=None,
+        rqname=None,
+        scrno=None,
+    ):
+        """
+        미체결 주문 정보를 반환합니다.
+
+        TR: OPT10075
+
+        계좌번호 = 전문 조회할 보유계좌번호
+        전체종목구분 = 0:전체, 1:종목
+        매매구분 = 0:전체, 1:매도, 2:매수
+        종목코드 = 전문 조회할 종목코드
+        체결구분 = 0:전체, 2:체결, 1:미체결
+        """
+
+        if rqname is None:
+            rqname = "실시간미체결요청"
+        trcode = "opt10075"
+        inputs = {
+            "계좌번호": account_no,
+            "전체종목구분": "0" if code is None else "1",
+            "매매구분": "0" if order_type is None else order_type,
+            "종목코드": "" if code is None else code,
+            "체결구분": "0" if status_type is None else status_type,
+        }
+        responses = self.TransactionCall(rqname, trcode, scrno, inputs)
+        _single, multi = self._ParseTransactionCallResponses(responses)
+        return multi
+
+[docs]    def GetOrderLogAsDataFrame2(
+        self,
+        account_no,
+        order_type=None,
+        status_type=None,
+        code=None,
+        order_no=None,
+        rqname=None,
+        scrno=None,
+    ):
+        """
+        주문 체결 정보를 반환합니다.
+
+        TR: OPT10076
+
+        종목코드 = 전문 조회할 종목코드
+        조회구분 = 0:전체, 1:종목
+        매도수구분 = 0:전체, 1:매도, 2:매수
+        계좌번호 = 전문 조회할 보유계좌번호
+        비밀번호 = 사용안함(공백)
+        주문번호 = 조회할 주문번호
+        체결구분 = 0:전체, 2:체결, 1:미체결
+        """
+
+        if rqname is None:
+            rqname = "실시간체결요청"
+        trcode = "opt10076"
+        inputs = {
+            "종목코드": "" if code is None else code,
+            "조회구분": "0" if code is None else "1",
+            "매도수구분": "0" if order_type is None else order_type,
+            "계좌번호": account_no,
+            "비밀번호": "",
+            "주문번호": "" if order_no is None else order_no,
+            "체결구분": "0" if status_type is None else status_type,
+        }
+        responses = self.TransactionCall(rqname, trcode, scrno, inputs)
+        _single, multi = self._ParseTransactionCallResponses(responses)
+        return multi
+
+[docs]    def GetOrderLogAsDataFrame3(
+        self,
+        account_no,
+        date=None,
+        sort_type=None,
+        asset_type=None,
+        order_type=None,
+        code=None,
+        starting_order_no=None,
+        rqname=None,
+        scrno=None,
+    ):
+        """
+        계좌별 주문 체결 내역을 반환합니다.
+
+        TR: OPW00007
+
+        주문일자 = YYYYMMDD (20170101 연도4자리, 월 2자리, 일 2자리 형식)
+        계좌번호 = 전문 조회할 보유계좌번호
+        비밀번호 = 사용안함(공백)
+        비밀번호입력매체구분 = 00
+        조회구분 = 1:주문순, 2:역순, 3:미체결, 4:체결내역만
+        주식채권구분 = 0:전체, 1:주식, 2:채권
+        매도수구분 = 0:전체, 1:매도, 2:매수
+        종목코드
+        시작주문번호
+        """
+
+        if rqname is None:
+            rqname = "계좌별주문체결내역상세요청"
+        trcode = "opw00007"
+        if date is None:
+            now = datetime.datetime.now()
+            market_start_time = now.replace(hour=8, minute=20, second=0, microsecond=0)
+            if now < market_start_time:
+                now = now - datetime.timedelta(days=1)
+            date = now.strftime("%Y%m%d")
+        inputs = {
+            "주문일자": date,
+            "계좌번호": account_no,
+            "비밀번호": "",
+            "비밀번호입력매체구분": "00",
+            "조회구분": "1" if sort_type is None else sort_type,
+            "주식채권구분": "0" if asset_type is None else asset_type,
+            "매도수구분": "0" if order_type is None else order_type,
+            "종목코드": "" if code is None else code,
+            "시작주문번호": "" if starting_order_no is None else starting_order_no,
+        }
+        responses = self.TransactionCall(rqname, trcode, scrno, inputs)
+        _single, multi = self._ParseTransactionCallResponses(responses, 10)
+        return multi
+
+[docs]    def GetAccountRateOfReturnAsDataFrame(self, account_no, rqname=None, scrno=None):
+        """
+        계좌별 수익률 정보를 반환합니다.
+
+        TR: OPT10085
+        """
+        if rqname is None:
+            rqname = "계좌수익률요청"
+        trcode = "opt10085"
+        inputs = {
+            "계좌번호": account_no,
+        }
+        responses = self.TransactionCall(rqname, trcode, scrno, inputs)
+        _single, multi = self._ParseTransactionCallResponses(responses, 10)
+        return multi
+
+[docs]    def GetAccountEvaluationStatusAsSeriesAndDataFrame(
+        self, account_no, include_delisted=True, rqname=None, scrno=None
+    ):
+        """
+        계좌의 평가 현황 정보를 반환합니다.
+
+        TR: OPW00004
+        """
+        if rqname is None:
+            rqname = "계좌평가현황요청"
+        trcode = "opw00004"
+        inputs = {
+            "계좌번호": account_no,
+            "비밀번호": "",
+            "상장폐지조회구분": "0" if include_delisted else "1",
+            "비밀번호입력매체구분": "00",
+        }
+        responses = self.TransactionCall(rqname, trcode, scrno, inputs)
+        single, multi = self._ParseTransactionCallResponses(responses, 12)
+        return single, multi
+
+[docs]    def GetAccountExecutionBalanceAsSeriesAndDataFrame(
+        self, account_no, rqname=None, scrno=None
+    ):
+        """
+        계좌의 체결 잔고 정보를 반환합니다.
+
+        TR: OPW00005
+
+        모의투자에서는 지원하지 않는 TR 입니다.
+        """
+        server = self.GetServerGubun()
+        if server == "1":
+            self.logger.warning("Not supported for simulated investment")
+        if rqname is None:
+            rqname = "체결잔고요청"
+        if scrno is None:
+            scrno = "1010"
+        trcode = "opw00005"  # 모의투자에서 지원하지 않는 TR
+        inputs = {
+            "계좌번호": account_no,
+            "비밀번호": "",
+            "비밀번호입력매체구분": "00",
+        }
+        responses = self.TransactionCall(rqname, trcode, scrno, inputs)
+        single, multi = self._ParseTransactionCallResponses(responses, 0)
+        return single, multi
+
+[docs]    def GetAccountEvaluationBalanceAsSeriesAndDataFrame(
+        self, account_no, lookup_type=None, rqname=None, scrno=None
+    ):
+        """
+        계좌의 평가 잔고 내역 정보를 반환합니다.
+
+        TR: OPW00018
+
+        조회구분 = 1:합산, 2:개별
+
+        [ 주의 ]
+        "수익률%" 데이터는 모의투자에서는 소숫점표현, 실거래서버에서는 소숫점으로 변환 필요 합니다.
+        """
+        if rqname is None:
+            rqname = "계좌평가잔고내역요청"
+        trcode = "opw00018"
+        inputs = {
+            "계좌번호": account_no,
+            "비밀번호": "",
+            "비밀번호입력매체구분": "00",
+            "조회구분": "2" if lookup_type is None else str(lookup_type),
+        }
+        responses = self.TransactionCall(rqname, trcode, scrno, inputs)
+        single, multi = self._ParseTransactionCallResponses(responses, [12, 15])
+        return single, multi
+
+[docs]    def GetMarketPriceInfo(self, code, rqname=None, scrno=None):
+        """
+        종목의 시세표성 정보를 반환합니다.
+
+        TR: OPT10007
+        """
+        if rqname is None:
+            rqname = "시세표성정보요청"
+        trcode = "opt10007"
+        inputs = {
+            "종목코드": code,
+        }
+        responses = self.TransactionCall(rqname, trcode, scrno, inputs)
+        single, _multi = self._ParseTransactionCallResponses(responses)
+        return single
+
+[docs]    def GetRealDataForCodesAsStream(
+        self,
+        codes,
+        fids=None,
+        opt_type=None,
+        screen_no=None,
+        infer_fids=False,
+        readable_names=False,
+        fast_parse=False,
+    ):
+        """
+        실시간 데이터를 요청하고 스트림 형태로 반환받습니다.
+        """
+        if isinstance(codes, str):
+            codes = [codes]
+        if fids is None:
+            from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusRealType import (
+                KiwoomOpenApiPlusRealType,
+            )
+
+            fids = KiwoomOpenApiPlusRealType.get_fids_by_realtype_name("주식시세")
+        if opt_type is None:
+            opt_type = "0"
+        assert opt_type in ["0", "1"], "opt_type should be either 0 or 1"
+        responses = self.RealCall(
+            screen_no, codes, fids, opt_type, infer_fids, readable_names, fast_parse
+        )
+        return responses
+
+[docs]    def GetCodeListByCondition(
+        self,
+        condition_name,
+        condition_index=None,
+        with_info=False,
+        is_future_option=False,
+        request_name=None,
+        screen_no=None,
+    ):
+        """
+        주어진 조건식으로 조건검색을 수행하고
+        검색된 종목의 종목코드를 리스트로 반환받습니다.
+
+        파라미터 중 with_info 가 True 로 설정된 경우,
+        검색된 종목들에 대한 기본 정보도 추가로 같이 반환됩니다.
+        """
+        search_type = 0
+
+        if condition_index is None:
+            condition_names = self.GetConditionNameListAsList()
+            condition_indices = {item[1]: item[0] for item in condition_names}
+            condition_index = condition_indices[condition_name]
+
+        codes = []
+
+        single_output = None
+        columns = []
+        records = []
+        remove_zeros_width = None
+
+        for response in self.ConditionCall(
+            screen_no,
+            condition_name,
+            condition_index,
+            search_type,
+            with_info,
+            is_future_option,
+            request_name,
+        ):
+            if response.name == "OnReceiveTrCondition":
+                code_list = response.arguments[1].string_value
+                code_list = code_list.rstrip(";").split(";") if code_list else []
+                codes.extend(code_list)
+            elif response.name == "OnReceiveTrData":
+                if single_output is None:
+                    single_output = dict(
+                        zip(
+                            response.single_data.names,
+                            self._RemoveLeadingZerosForNumbersInValues(
+                                response.single_data.values, remove_zeros_width
+                            ),
+                        )
+                    )
+                if not columns:
+                    columns = response.multi_data.names
+                for values in response.multi_data.values:
+                    records.append(
+                        self._RemoveLeadingZerosForNumbersInValues(
+                            values.values, remove_zeros_width
+                        )
+                    )
+            else:
+                raise ValueError("Unexpected event handler name %s" % response.name)
+
+        _single = pd.Series(single_output, dtype=object)
+        multi = pd.DataFrame.from_records(records, columns=columns)
+
+        if with_info:
+            return codes, multi
+        else:
+            return codes
+
+    def _GetCodeListByConditionAsStream_GeneratorFunc(self, responses, with_info=False):
+        for response in responses:
+            if response.name == "OnReceiveTrCondition":
+                code_list = response.arguments[1].string_value
+                code_list = code_list.rstrip(";").split(";") if code_list else []
+                inserted = code_list
+                deleted = []
+                if with_info:
+                    info = None
+                    yield inserted, deleted, info
+                else:
+                    yield inserted, deleted
+            elif response.name == "OnReceiveRealCondition":
+                code = response.arguments[0].string_value
+                condition_type = response.arguments[1].string_value
+                inserted = []
+                deleted = []
+                if condition_type == "I":
+                    inserted.append(code)
+                elif condition_type == "D":
+                    deleted.append(code)
+                else:
+                    raise ValueError("Unexpected condition type %s" % condition_type)
+                if with_info:
+                    info = None
+                    yield inserted, deleted, info
+                else:
+                    yield inserted, deleted
+            elif response.name == "OnReceiveTrData":
+                single_output = None
+                columns = []
+                records = []
+                remove_zeros_width = None
+                if single_output is None:
+                    single_output = dict(
+                        zip(
+                            response.single_data.names,
+                            self._RemoveLeadingZerosForNumbersInValues(
+                                response.single_data.values, remove_zeros_width
+                            ),
+                        )
+                    )
+                if not columns:
+                    columns = response.multi_data.names
+                for values in response.multi_data.values:
+                    records.append(
+                        self._RemoveLeadingZerosForNumbersInValues(
+                            values.values, remove_zeros_width
+                        )
+                    )
+                _single = pd.Series(single_output, dtype=object)
+                multi = pd.DataFrame.from_records(records, columns=columns)
+                inserted = []
+                deleted = []
+                if with_info:
+                    info = multi
+                    yield inserted, deleted, info
+                else:
+                    raise RuntimeError(
+                        "Unexpected, OnReceiveTrData event with with_info=False ???"
+                    )
+            else:
+                raise ValueError("Unexpected event handler name %s" % response.name)
+
+[docs]    def GetCodeListByConditionAsStream(
+        self,
+        condition_name,
+        condition_index=None,
+        with_info=False,
+        is_future_option=False,
+        request_name=None,
+        screen_no=None,
+        old_behavior=False,
+    ):
+        """
+        주어진 조건식을 실시간 조건검색으로 등록합니다.
+        이후 발생하는 이벤트들을 스트림 형태로 제공합니다.
+
+        최초 검색결과는 OnReceiveTrCondition() 이벤트로 반환되며
+        이후 종목의 추가/제외는 OnReceiveRealCondition() 이벤트로 반환됩니다.
+
+        만약 with_info 가 True 로 설정된 경우,
+        검색된 종목마다 추가적인 정보가 OnReceiveTrData() 이벤트를 통해 반환됩니다.
+        """
+        search_type = 1
+
+        if condition_index is None:
+            condition_names = self.GetConditionNameListAsList()
+            condition_indices = {item[1]: item[0] for item in condition_names}
+            condition_index = condition_indices[condition_name]
+
+        responses = self.ConditionCall(
+            screen_no,
+            condition_name,
+            condition_index,
+            search_type,
+            with_info,
+            is_future_option,
+            request_name,
+        )
+
+        if not old_behavior:
+            return responses
+
+        stream = PipeableMultiThreadedRendezvous(responses)
+        stream = stream.pipe(
+            lambda responses: self._GetCodeListByConditionAsStream_GeneratorFunc(
+                responses, with_info=with_info
+            )
+        )
+
+        return stream
+
+
+[docs]class KiwoomOpenApiPlusServiceClientStubWrapper(
+    KiwoomOpenApiPlusServiceClientStubExtendedWrapper
+):
+    """
+    KiwoomOpenApiPlusServiceClientStubCoreWrapper, KiwoomOpenApiPlusServiceClientStubExtendedWrapper 의 구현 및
+    KiwoomOpenApiPlusQAxWidgetUniversalMixin 의 구현들까지 최종적으로 포함된
+    KiwoomOpenApiPlusServiceClientStub 객체를 위한 Mixin 래퍼 클래스 입니다.
+    """
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/kiwoom_open_api_plus/grpc/KiwoomOpenApiPlusServiceMessageUtils.html b/_modules/koapy/backend/kiwoom_open_api_plus/grpc/KiwoomOpenApiPlusServiceMessageUtils.html new file mode 100644 index 00000000..dd6550b8 --- /dev/null +++ b/_modules/koapy/backend/kiwoom_open_api_plus/grpc/KiwoomOpenApiPlusServiceMessageUtils.html @@ -0,0 +1,167 @@ + + + + + + + + koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusServiceMessageUtils — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusServiceMessageUtils

+[docs]def convert_arguments_from_protobuf_to_python(arguments):
+    args = []
+    for argument in arguments:
+        if argument.HasField("string_value"):
+            args.append(argument.string_value)
+        elif argument.HasField("bool_value"):
+            args.append(argument.bool_value)
+        elif argument.HasField("long_value"):
+            args.append(argument.long_value)
+        else:
+            raise ValueError("No expecting field found.")
+    return args
+
+
+[docs]def convert_arguments_from_python_to_protobuf(arguments, arguments_message):
+    for i, arg in enumerate(arguments):
+        if isinstance(arg, str):
+            arguments_message.add().string_value = arg
+        elif isinstance(arg, bool):
+            arguments_message.add().bool_value = arg
+        elif isinstance(arg, int):
+            arguments_message.add().long_value = arg
+        else:
+            raise TypeError("Unexpected type for argument %d: %s" % (i, type(arg)))
+    return arguments_message
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/kiwoom_open_api_plus/grpc/KiwoomOpenApiPlusServiceServer.html b/_modules/koapy/backend/kiwoom_open_api_plus/grpc/KiwoomOpenApiPlusServiceServer.html new file mode 100644 index 00000000..f4a01a69 --- /dev/null +++ b/_modules/koapy/backend/kiwoom_open_api_plus/grpc/KiwoomOpenApiPlusServiceServer.html @@ -0,0 +1,293 @@ + + + + + + + + koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusServiceServer — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusServiceServer

+import inspect
+
+from concurrent.futures import ThreadPoolExecutor
+
+import grpc
+
+from koapy.backend.kiwoom_open_api_plus.grpc import KiwoomOpenApiPlusService_pb2_grpc
+from koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusServiceServicer import (
+    KiwoomOpenApiPlusServiceServicer,
+)
+from koapy.config import config
+from koapy.utils.logging.Logging import Logging
+from koapy.utils.networking import find_free_port_for_host, is_in_private_network
+
+
+[docs]class KiwoomOpenApiPlusServiceServer(Logging):
+    def __init__(
+        self,
+        control,
+        host=None,
+        port=None,
+        credentials=None,
+        **kwargs,
+    ):
+        if host is None:
+            host = config.get_string(
+                "koapy.backend.kiwoom_open_api_plus.grpc.host", "localhost"
+            )
+            host = config.get_string(
+                "koapy.backend.kiwoom_open_api_plus.grpc.server.host", host
+            )
+        if port is None:
+            port = config.get_int("koapy.backend.kiwoom_open_api_plus.grpc.port", 0)
+            port = config.get_int(
+                "koapy.backend.kiwoom_open_api_plus.grpc.server.port", port
+            )
+
+        if port == 0:
+            port = find_free_port_for_host(host)
+            self.logger.info(
+                "Using one of the free ports, final address would be %s:%d", host, port
+            )
+
+        self._control = control
+        self._host = host
+        self._port = port
+        self._credentials = credentials
+        self._kwargs = dict(kwargs)
+
+        self._servicer = KiwoomOpenApiPlusServiceServicer(self._control)
+        self._address = self._host + ":" + str(self._port)
+
+        grpc_server_signature = inspect.signature(grpc.server)
+        grpc_server_params = list(grpc_server_signature.parameters.keys())
+        grpc_server_kwargs = {
+            k: v for k, v in self._kwargs.items() if k in grpc_server_params
+        }
+        grpc_server_bound_arguments = grpc_server_signature.bind_partial(
+            **grpc_server_kwargs
+        )
+        if grpc_server_bound_arguments.arguments.get("thread_pool") is None:
+            thread_pool_signature = inspect.signature(ThreadPoolExecutor)
+            thread_pool_params = list(thread_pool_signature.parameters.keys())
+            thread_pool_kwargs = {
+                k: v for k, v in self._kwargs.items() if k in thread_pool_params
+            }
+            thread_pool_bound_arguments = thread_pool_signature.bind(
+                **thread_pool_kwargs
+            )
+            if thread_pool_bound_arguments.arguments.get("max_workers") is None:
+                max_workers = config.get_int(
+                    "koapy.backend.kiwoom_open_api_plus.grpc.server.max_workers", 8
+                )
+                thread_pool_bound_arguments.arguments["max_workers"] = max_workers
+            thread_pool = ThreadPoolExecutor(
+                *thread_pool_bound_arguments.args,
+                **thread_pool_bound_arguments.kwargs,
+            )
+            grpc_server_bound_arguments.arguments["thread_pool"] = thread_pool
+            self._thread_pool = thread_pool
+        else:
+            self._thread_pool = grpc_server_bound_arguments.arguments["thread_pool"]
+
+        self._grpc_server_bound_arguments = grpc_server_bound_arguments
+
+        self._server = None
+        self._server_started = False
+        self._server_stopped = False
+
+        self.reinitialize_server()
+
+[docs]    def reinitialize_server(self):
+        if self._server is not None:
+            self.stop()
+            self.wait_for_termination()
+
+        self._server = grpc.server(
+            *self._grpc_server_bound_arguments.args,
+            **self._grpc_server_bound_arguments.kwargs,
+        )
+        self._server_started = False
+        self._server_stopped = False
+
+        KiwoomOpenApiPlusService_pb2_grpc.add_KiwoomOpenApiPlusServiceServicer_to_server(
+            self._servicer, self._server
+        )
+
+        if self._credentials is None:
+            if not is_in_private_network(self._host):
+                self.logger.warning(
+                    "Adding insecure port %s to server, but the address is not private.",
+                    self._address,
+                )
+            self._server.add_insecure_port(self._address)
+        else:
+            self._server.add_secure_port(self._address, self._credentials)
+
+[docs]    def get_host(self):
+        return self._host
+
+[docs]    def get_port(self):
+        return self._port
+
+[docs]    def start(self):
+        if self._server_started and self._server_stopped:
+            self.reinitialize_server()
+        if not self._server_started:
+            self._server.start()
+            self._server_started = True
+
+[docs]    def wait_for_termination(self, timeout=None):
+        return self._server.wait_for_termination(timeout)
+
+[docs]    def is_running(self):
+        return self.wait_for_termination(1)
+
+[docs]    def stop(self, grace=None):
+        event = self._server.stop(grace)
+        self._server_stopped = True
+        return event
+
+    def __getattr__(self, name):
+        return getattr(self._server, name)
+
+    def __enter__(self):
+        self.start()
+        return self
+
+    def __exit__(self, exc_type, exc_value, traceback):
+        self.stop()
+        self.wait_for_termination()
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/kiwoom_open_api_plus/grpc/KiwoomOpenApiPlusServiceServicer.html b/_modules/koapy/backend/kiwoom_open_api_plus/grpc/KiwoomOpenApiPlusServiceServicer.html new file mode 100644 index 00000000..fd60f211 --- /dev/null +++ b/_modules/koapy/backend/kiwoom_open_api_plus/grpc/KiwoomOpenApiPlusServiceServicer.html @@ -0,0 +1,514 @@ + + + + + + + + koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusServiceServicer — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusServiceServicer

+import logging
+
+from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusEventHandler import (
+    KiwoomOpenApiPlusEventHandler,
+)
+from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusScreenManager import (
+    KiwoomOpenApiPlusScreenManager,
+)
+from koapy.backend.kiwoom_open_api_plus.grpc import (
+    KiwoomOpenApiPlusService_pb2,
+    KiwoomOpenApiPlusService_pb2_grpc,
+)
+from koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusConditionEventHandler import (
+    KiwoomOpenApiPlusConditionEventHandler,
+)
+from koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusEventHandlers import (
+    KiwoomOpenApiPlusAllEventHandler,
+    KiwoomOpenApiPlusSomeBidirectionalEventHandler,
+    KiwoomOpenApiPlusSomeEventHandler,
+)
+from koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusKwTrEventHandler import (
+    KiwoomOpenApiPlusKwTrEventHandler,
+)
+from koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusLoadConditionEventHandler import (
+    KiwoomOpenApiPlusLoadConditionEventHandler,
+)
+from koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusLoginEventHandler import (
+    KiwoomOpenApiPlusLoginEventHandler,
+)
+from koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusOrderEventHandler import (
+    KiwoomOpenApiPlusAllOrderEventHandler,
+    KiwoomOpenApiPlusOrderEventHandler,
+)
+from koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusRealEventHandler import (
+    KiwoomOpenApiPlusBidirectionalRealEventHandler,
+    KiwoomOpenApiPlusRealEventHandler,
+)
+from koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusTrEventHandler import (
+    KiwoomOpenApiPlusTrEventHandler,
+)
+from koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusServiceMessageUtils import (
+    convert_arguments_from_protobuf_to_python,
+)
+
+
+[docs]class KiwoomOpenApiPlusServiceServicer(
+    KiwoomOpenApiPlusService_pb2_grpc.KiwoomOpenApiPlusServiceServicer
+):
+    """
+    KiwoomOpenApiPlusService RPC 의 구현체 입니다.
+    """
+
+    def __init__(self, control):
+        super().__init__()
+
+        self._control = control
+        self._screen_manager = KiwoomOpenApiPlusScreenManager(self._control)
+
+    @property
+[docs]    def control(self):
+        return self._control
+
+    @property
+[docs]    def screen_manager(self):
+        return self._screen_manager
+
+    # 1. rpcs for general function calls
+
+[docs]    def Call(self, request, context):
+        """
+        임의의 함수 호출을 위한 RPC 입니다.
+
+        함수의 이름과 파라미터를 요청 메시지를 통해 전달받아 서버측에서 해당 함수를 호출하고
+        호출결과를 응답 메시지를 통해 전달합니다.
+
+        함수의 파라미터와 리턴값은 문자열/숫자/불리언 등의 단순한 타입만 지원합니다.
+        """
+        name = request.name
+        arguments = convert_arguments_from_protobuf_to_python(request.arguments)
+        function = getattr(self.control, name)
+        result = function(*arguments)
+        response = KiwoomOpenApiPlusService_pb2.CallResponse()
+        if isinstance(result, str):
+            response.return_value.string_value = result
+        elif isinstance(result, bool):
+            response.return_value.bool_value = result
+        elif isinstance(result, int):
+            response.return_value.long_value = result
+        elif result is None:
+            pass
+        else:
+            raise TypeError(
+                "Unexpected return value type from server side dynamicCall(): %s"
+                % type(result)
+            )
+        return response
+
+    # 2. rpcs for listening and handling events
+
+[docs]    def Listen(self, request, context):
+        """
+        단일 혹은 복수개의 이벤트에 대해 이벤트 발생시 해당 이벤트 내용을 전달하는 RPC 입니다.
+
+        전달받고자 하는 이벤트 이름 목록을 요청 메시지를 통해 전달받습니다.
+        이후 서버에서 목록에 포함되는 이벤트가 발생하면 해당 이벤트의 내용을 응답 메세지를 통해 전달합니다.
+
+        서버측의 이벤트 핸들러 함수는 해당 이벤트를 클라이언트에 전송한 이후 즉시 종료됩니다.
+        """
+        with KiwoomOpenApiPlusSomeEventHandler(
+            self.control, request, context
+        ) as handler:
+            for response in handler:
+                yield response
+
+[docs]    def BidirectionalListen(self, request_iterator, context):
+        """
+        단일 혹은 복수개의 이벤트에 대해 이벤트 발생시 해당 이벤트 내용을 전달하는 RPC 입니다.
+
+        전달받고자 하는 이벤트 이름 목록을 요청 메시지를 통해 전달받습니다.
+        이후 서버에서 목록에 포함되는 이벤트가 발생하면 해당 이벤트의 내용을 응답 메세지를 통해 전달합니다.
+
+        앞선 Listen() RPC 와 다르게 해당 RPC 는 이벤트 발생시 서버측에서는 이벤트 내용을 응답 메시지로 전달한 다음
+        다시 클라이언트 측에서 ACK 요청을 줄 때 까지 서버측 이벤트 핸들러 함수 내에서 대기합니다.
+        따라서 클라이언트는 서버측 이벤트 핸들러 함수 컨텍스트 내에서 이벤트를 처리할 수 있고
+        처리를 완료하면 다시 서버측으로 ACK 요청을 보내 서버측 이벤트 핸들러가 완료될 수 있도록 해야 합니다.
+        """
+        with KiwoomOpenApiPlusSomeBidirectionalEventHandler(
+            self.control, request_iterator, context
+        ) as handler:
+            for response in handler:
+                yield response
+
+    # 3. rpcs for simple use cases that can be categorized into serveral distinct usage patterns
+
+[docs]    def LoginCall(self, request, context):
+        """
+        키움증권 서버 연결 시나리오에 해당하는 RPC 입니다.
+
+        CommConnect() 메소드 호출 이후 발생하는 OnEventConnect() 이벤트를 처리하고
+        클라이언트에도 해당 이벤트 내용을 전달합니다.
+        """
+        with KiwoomOpenApiPlusLoginEventHandler(
+            self.control, request, context
+        ) as handler:
+            for response in handler:
+                yield response
+
+[docs]    def TransactionCall(self, request, context):
+        """
+        TR 요청에 해당하는 RPC 입니다.
+
+        CommRqData() 메소드 호출 이후 발생하는 OnReceiveTrData() 이벤트를 처리하고
+        클라이언트에도 해당 이벤트 내용을 전달합니다.
+
+        OnReceiveTrData() 이벤트 핸들러 함수 내부에서 요청받은 TR 에 따라 관련된 데이터를
+        추가로 읽어 들인 뒤 알맞은 응답형태로 가공하여 클라이언트에 반환합니다.
+        해당 과정에서 GetRepeatCnt() 및 GetCommData() 메소드를 내부적으로 호출합니다.
+
+        경우에 따라 연속조회가 필요하다면 OnReceiveTrData() 이벤트 핸들러 함수 내부에서
+        추가적인 SetInputValue() 및 CommRqData() 호출이 발생할 수 있습니다.
+
+        일반적인 TR 이 아닌 관심종목 관련 TR 의 경우 CommRqData() 대신 CommKwRqData() 가
+        내부적으로 호출됩니다.
+
+        서버측에서 CommRqData() 혹은 CommKwRqData() 호출시 내부적으로 호출제한 회피를 위한
+        대기시간이 발생할 수 있습니다.
+
+        최초 TR 요청 이후 특정 TR 들에서는 그와 관련된 실시간 데이터가 (OpenAPI+ 레벨에서) 자동으로 등록될 수 있습니다.
+        몇몇 상황에서는 해당 실시간 데이터가 유용할 수 있으나 현재 KOAPY 에서는 별도로 사용하진 않고 있으며,
+        TR 에 대한 응답처리가 모두 완료된 이후에는 해당 실시간 데이터를 등록 해제하도록 처리하고 있습니다.
+        """
+        trcode = request.transaction_code.upper()
+
+        if trcode in ["OPTKWFID", "OPTFOFID"]:
+            handler = KiwoomOpenApiPlusKwTrEventHandler(
+                self.control, request, context, self.screen_manager
+            )
+        else:
+            handler = KiwoomOpenApiPlusTrEventHandler(
+                self.control, request, context, self.screen_manager
+            )
+
+        with handler:
+            for response in handler:
+                yield response
+
+[docs]    def OrderCall(self, request, context):
+        """
+        주문 요청에 해당하는 RPC 입니다.
+
+        SendOrder() 메소드 호출 이후 발생하는 OnReceiveTrData() 및 OnReceiveChejanData() 이벤트를 처리하고
+        클라이언트에도 해당 이벤트 내용을 전달합니다.
+
+        SendOrder() 메소드 호출 이후 발생하는 OnReceiveTrData() 이벤트에서
+        주문번호가 확인 가능해야지만 정상주문으로 처리하고 그렇지 않다면 에러를 발생시킵니다.
+
+        일반적으로는 OnReceiveTrData() 이벤트가 먼저 발생하고 이후 OnReceiveChejanData() 이벤트가 접수/체결/잔고확인에 각각 발생합니다.
+        다만 주문건수가 폭증하는 경우 OnReceiveChejan() 이벤트가 OnReceiveTrData() 이벤트보다 앞서 수신될 수 있습니다.
+
+        이외에 주문거부등의 케이스에서 주문거부 사유 등이 OnReceiveMsg() 이벤트로 반환됩니다.
+
+        기본적으로 매수/매도 주문의 경우 주문받은 수량이 모두 체결될때까지 이벤트를 처리해 전달합니다.
+        """
+        with KiwoomOpenApiPlusOrderEventHandler(
+            self.control, request, context, self.screen_manager
+        ) as handler:
+            for response in handler:
+                yield response
+
+[docs]    def RealCall(self, request, context):
+        """
+        실시간 데이터 요청에 해당하는 RPC 입니다.
+
+        SetRealReg() 메소드 호출 이후 발생하는 OnReceiveRealData() 이벤트를 처리하고
+        클라이언트에도 해당 이벤트 내용을 전달합니다.
+
+        OnReceiveRealData() 이벤트 핸들러 함수 내부에서 앞서 요청받은 실시간 데이터 FID 목록 혹은
+        직접 이벤트 핸들러 함수에서 확인 가능한 FID 목록에 따라 관련된 데이터를
+        추가로 읽어 들인 뒤 알맞은 응답형태로 가공하여 클라이언트에 반환합니다.
+        해당 과정에서 GetCommRealData() 메소드를 내부적으로 호출합니다.
+
+        해당 RPC 는 별도의 이벤트 종료 상황이 존재하지 않기 때문에 더이상 사용하지 않는 경우
+        클라이언트 측에서 해당 RPC 연결을 해제하는 식으로 더 이상 이벤트를 받지 않을 수 있습니다.
+        이 경우 서버에서는 내부적으로 기 등록된 실시간 데이터에 대해 SetRealRemove() 가 호출됩니다.
+        """
+        with KiwoomOpenApiPlusRealEventHandler(
+            self.control, request, context, self.screen_manager
+        ) as handler:
+            for response in handler:
+                yield response
+
+[docs]    def LoadConditionCall(self, request, context):
+        """
+        조건검색 기능 활용 이전에 먼저 조건식 목록을 불러오는데 사용할 수 있는 RPC 입니다.
+
+        GetConditionLoad() 메소드 호출 이후 발생하는 OnReceiveConditionVer() 이벤트를 처리하고
+        클라이언트에도 해당 이벤트 내용을 전달합니다.
+        """
+        with KiwoomOpenApiPlusLoadConditionEventHandler(
+            self.control, request, context
+        ) as handler:
+            for response in handler:
+                yield response
+
+[docs]    def ConditionCall(self, request, context):
+        """
+        조건검색 기능에 해당하는 RPC 입니다.
+
+        SendCondition() 메소드 호출 이후 발생하는 OnReceiveTrCondition() 혹은 OnReceiveRealCondition() 이벤트를
+        처리하고 클라이언트에도 해당 이벤트 내용을 전달합니다.
+        """
+        with KiwoomOpenApiPlusConditionEventHandler(
+            self.control, request, context, self.screen_manager
+        ) as handler:
+            for response in handler:
+                yield response
+
+    # 4. rpcs for more complex use cases based on the previously categorized simple cases above
+
+[docs]    def BidirectionalRealCall(self, request_iterator, context):
+        """
+        실시간 데이터 요청에 해당하는 RPC 입니다.
+
+        기존의 RealCall() RPC 는 최초 실시간 데이터 등록 이후 이벤트를 듣는 것만 가능했다면
+        새로운 BidirectionalRealCall() 에서는 최초 설정된 이벤트 스트림을 계속 유지하면서
+        신규 실시간 데이터 등록 혹은 해지를 추가로 요청해 반영할 수 있습니다.
+        """
+        with KiwoomOpenApiPlusBidirectionalRealEventHandler(
+            self.control, request_iterator, context, self.screen_manager
+        ) as handler:
+            for response in handler:
+                yield response
+
+[docs]    def OrderListen(self, request, context):
+        """
+        주문 이벤트를 듣고 싶을때 사용할 수 있는 RPC 입니다.
+
+        기존의 OrderCall() RPC 는 특정 주문을 수행하고 해당 주문과 관련된 이벤트들만 반환했다면
+        해당 RPC 는 특정 주문 수행 없이 모든 주문관련 이벤트를 듣고 싶을때 사용할 수 있습니다.
+        """
+        with KiwoomOpenApiPlusAllOrderEventHandler(self.control, context) as handler:
+            for response in handler:
+                yield response
+
+    # 5. rpcs for customized usage scenario (when there is no proper predefined interface to utilize)
+
+[docs]    def CustomListen(self, request, context):
+        """
+        이벤트 처리와 관련해 특정 코드를 서버측에 실행시켜 그 로직에 따라 처리하도록 요청할 수 있습니다.
+
+        해당 코드에서는 KiwoomOpenApiPlusEventHandler 클래스를 구현해야하며,
+        클래스 인스턴스 생성시 control, request, context 세가지 인자를 받아 처리할 수 있어야 합니다.
+
+        내부적으로 exec() 및 eval() 을 사용하기 때문에 실행될 코드의 보안 및 안정성에 주의가 필요합니다.
+        """
+        code = request.code
+        class_name = request.class_name
+        if code and class_name:
+            global_vars = {}
+            local_vars = {}
+            exec(code, global_vars, local_vars)  # pylint: disable=exec-used
+            handler = eval(class_name, global_vars, local_vars)(
+                self.control, request, context
+            )  # pylint: disable=eval-used
+            assert isinstance(handler, KiwoomOpenApiPlusEventHandler)
+        else:
+            handler = KiwoomOpenApiPlusAllEventHandler(self.control, context)
+        with handler:
+            for response in handler:
+                yield response
+
+[docs]    def CustomCallAndListen(self, request, context):
+        """
+        이벤트 처리와 관련해 특정 코드를 서버측에 실행시켜 그 로직에 따라 처리하도록 요청할 수 있습니다.
+
+        앞선 CustomListen() 과의 차이점은 요청시 특정 함수를 최초 1회 호출하고 이후 들어오는 이벤트를 처리한다는 점입니다.
+
+        해당 코드에서는 KiwoomOpenApiPlusEventHandler 클래스를 구현해야하며,
+        클래스 인스턴스 생성시 control, request, context 세가지 인자를 받아 처리할 수 있어야 합니다.
+
+        내부적으로 exec() 및 eval() 을 사용하기 때문에 실행될 코드의 보안 및 안정성에 주의가 필요합니다.
+        """
+        name = request.name
+        arguments = convert_arguments_from_protobuf_to_python(request.arguments)
+        function = getattr(self.control, name)
+        code = request.listen_request.code
+        class_name = request.listen_request.class_name
+        if code and class_name:
+            global_vars = {}
+            local_vars = {}
+            exec(code, global_vars, local_vars)  # pylint: disable=exec-used
+            handler = eval(class_name, global_vars, local_vars)(
+                self.control, request, context
+            )  # pylint: disable=eval-used
+            assert isinstance(handler, KiwoomOpenApiPlusEventHandler)
+        else:
+            handler = KiwoomOpenApiPlusAllEventHandler(self.control, context)
+        with handler:
+            result = function(*arguments)
+            response = KiwoomOpenApiPlusService_pb2.CallAndListenResponse()
+            if isinstance(result, str):
+                response.call_response.return_value.string_value = (
+                    result  # pylint: disable=no-member
+                )
+            elif isinstance(result, int):
+                response.call_response.return_value.long_value = (
+                    result  # pylint: disable=no-member
+                )
+            elif result is None:
+                pass
+            else:
+                raise TypeError(
+                    "Unexpected return value type from server side dynamicCall(): %s"
+                    % type(result)
+                )
+            yield response
+            for listen_response in handler:
+                response = KiwoomOpenApiPlusService_pb2.CallAndListenResponse()
+                response.listen_response = listen_response
+                yield response
+
+    # 6. rpcs for other mics scenarios
+
+[docs]    def SetLogLevel(self, request, context):
+        """
+        서버에 존재하는 특정 로거의 로그레벨을 설정합니다.
+        """
+        level = request.level
+        logger = request.logger
+        logging.getLogger(logger).setLevel(level)
+        response = KiwoomOpenApiPlusService_pb2.SetLogLevelResponse()
+        return response
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/kiwoom_open_api_plus/grpc/KiwoomOpenApiPlusService_pb2.html b/_modules/koapy/backend/kiwoom_open_api_plus/grpc/KiwoomOpenApiPlusService_pb2.html new file mode 100644 index 00000000..0c2fdf6c --- /dev/null +++ b/_modules/koapy/backend/kiwoom_open_api_plus/grpc/KiwoomOpenApiPlusService_pb2.html @@ -0,0 +1,2247 @@ + + + + + + + + koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService_pb2 — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService_pb2

+# -*- coding: utf-8 -*-
+# Generated by the protocol buffer compiler.  DO NOT EDIT!
+# source: koapy/backend/kiwoom_open_api_plus/grpc/KiwoomOpenApiPlusService.proto
+"""Generated protocol buffer code."""
+from google.protobuf.internal import enum_type_wrapper
+from google.protobuf import descriptor as _descriptor
+from google.protobuf import message as _message
+from google.protobuf import reflection as _reflection
+from google.protobuf import symbol_database as _symbol_database
+# @@protoc_insertion_point(imports)
+
+_sym_db = _symbol_database.Default()
+
+
+
+
+[docs]DESCRIPTOR = _descriptor.FileDescriptor(
+  name='koapy/backend/kiwoom_open_api_plus/grpc/KiwoomOpenApiPlusService.proto',
+  package='koapy.backend.kiwoom_open_api_plus.grpc',
+  syntax='proto3',
+  serialized_options=None,
+  create_key=_descriptor._internal_create_key,
+  serialized_pb=b'\nFkoapy/backend/kiwoom_open_api_plus/grpc/KiwoomOpenApiPlusService.proto\x12\'koapy.backend.kiwoom_open_api_plus.grpc\"W\n\x08\x41rgument\x12\x16\n\x0cstring_value\x18\x01 \x01(\tH\x00\x12\x14\n\nlong_value\x18\x02 \x01(\x03H\x00\x12\x14\n\nbool_value\x18\x03 \x01(\x08H\x00\x42\x07\n\x05value\"a\n\x0b\x43\x61llRequest\x12\x0c\n\x04name\x18\x01 \x01(\t\x12\x44\n\targuments\x18\x02 \x03(\x0b\x32\x31.koapy.backend.kiwoom_open_api_plus.grpc.Argument\"Z\n\x0bReturnValue\x12\x16\n\x0cstring_value\x18\x01 \x01(\tH\x00\x12\x14\n\nlong_value\x18\x02 \x01(\x03H\x00\x12\x14\n\nbool_value\x18\x03 \x01(\x08H\x00\x42\x07\n\x05value\"Z\n\x0c\x43\x61llResponse\x12J\n\x0creturn_value\x18\x01 \x01(\x0b\x32\x34.koapy.backend.kiwoom_open_api_plus.grpc.ReturnValue\"L\n\rListenRequest\x12\n\n\x02id\x18\x01 \x01(\t\x12\r\n\x05slots\x18\x02 \x03(\t\x12\x0c\n\x04\x63ode\x18\x03 \x01(\t\x12\x12\n\nclass_name\x18\x04 \x01(\t\"\x1e\n\x0eHandledRequest\x12\x0c\n\x04time\x18\x01 \x01(\x02\"!\n\x11StopListenRequest\x12\x0c\n\x04time\x18\x01 \x01(\x02\"\xa8\x02\n\x1a\x42idirectionalListenRequest\x12P\n\x0elisten_request\x18\x01 \x01(\x0b\x32\x36.koapy.backend.kiwoom_open_api_plus.grpc.ListenRequestH\x00\x12R\n\x0fhandled_request\x18\x02 \x01(\x0b\x32\x37.koapy.backend.kiwoom_open_api_plus.grpc.HandledRequestH\x00\x12Y\n\x13stop_listen_request\x18\x03 \x01(\x0b\x32:.koapy.backend.kiwoom_open_api_plus.grpc.StopListenRequestH\x00\x42\t\n\x07request\"+\n\nSingleData\x12\r\n\x05names\x18\x01 \x03(\t\x12\x0e\n\x06values\x18\x02 \x03(\t\" \n\x0eRepeatedString\x12\x0e\n\x06values\x18\x01 \x03(\t\"c\n\tMultiData\x12\r\n\x05names\x18\x01 \x03(\t\x12G\n\x06values\x18\x02 \x03(\x0b\x32\x37.koapy.backend.kiwoom_open_api_plus.grpc.RepeatedString\"\xf6\x01\n\x0eListenResponse\x12\x0c\n\x04name\x18\x01 \x01(\t\x12\x44\n\targuments\x18\x02 \x03(\x0b\x32\x31.koapy.backend.kiwoom_open_api_plus.grpc.Argument\x12H\n\x0bsingle_data\x18\x03 \x01(\x0b\x32\x33.koapy.backend.kiwoom_open_api_plus.grpc.SingleData\x12\x46\n\nmulti_data\x18\x04 \x01(\x0b\x32\x32.koapy.backend.kiwoom_open_api_plus.grpc.MultiData\"\xb2\x01\n\x14\x43\x61llAndListenRequest\x12J\n\x0c\x63\x61ll_request\x18\x01 \x01(\x0b\x32\x34.koapy.backend.kiwoom_open_api_plus.grpc.CallRequest\x12N\n\x0elisten_request\x18\x02 \x01(\x0b\x32\x36.koapy.backend.kiwoom_open_api_plus.grpc.ListenRequest\"\xc7\x01\n\x15\x43\x61llAndListenResponse\x12N\n\rcall_response\x18\x01 \x01(\x0b\x32\x35.koapy.backend.kiwoom_open_api_plus.grpc.CallResponseH\x00\x12R\n\x0flisten_response\x18\x02 \x01(\x0b\x32\x37.koapy.backend.kiwoom_open_api_plus.grpc.ListenResponseH\x00\x42\n\n\x08response\"\x8d\x02\n\x10LoginCredentials\x12\x0f\n\x07user_id\x18\x01 \x01(\t\x12\x15\n\ruser_password\x18\x02 \x01(\t\x12\x15\n\rcert_password\x18\x03 \x01(\t\x12\x15\n\ris_simulation\x18\x04 \x01(\x08\x12j\n\x11\x61\x63\x63ount_passwords\x18\x05 \x03(\x0b\x32O.koapy.backend.kiwoom_open_api_plus.grpc.LoginCredentials.AccountPasswordsEntry\x1a\x37\n\x15\x41\x63\x63ountPasswordsEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\r\n\x05value\x18\x02 \x01(\t:\x02\x38\x01\"^\n\x0cLoginRequest\x12N\n\x0b\x63redentials\x18\x01 \x01(\x0b\x32\x39.koapy.backend.kiwoom_open_api_plus.grpc.LoginCredentials\"R\n\x10RealRequestFlags\x12\x12\n\ninfer_fids\x18\x01 \x01(\x08\x12\x16\n\x0ereadable_names\x18\x02 \x01(\x08\x12\x12\n\nfast_parse\x18\x03 \x01(\x08\"\xa1\x01\n\x0bRealRequest\x12\x11\n\tscreen_no\x18\x01 \x03(\t\x12\x11\n\tcode_list\x18\x02 \x03(\t\x12\x10\n\x08\x66id_list\x18\x03 \x03(\x05\x12\x10\n\x08opt_type\x18\x04 \x01(\t\x12H\n\x05\x66lags\x18\x05 \x01(\x0b\x32\x39.koapy.backend.kiwoom_open_api_plus.grpc.RealRequestFlags\"\x97\x01\n\x18TransactionStopCondition\x12\x0c\n\x04name\x18\x01 \x01(\t\x12\r\n\x05value\x18\x02 \x01(\t\x12^\n\ncomparator\x18\x03 \x01(\x0e\x32J.koapy.backend.kiwoom_open_api_plus.grpc.TransactionStopConditionCompartor\"\x84\x03\n\x12TransactionRequest\x12\x14\n\x0crequest_name\x18\x01 \x01(\t\x12\x18\n\x10transaction_code\x18\x02 \x01(\t\x12\x11\n\tscreen_no\x18\x03 \x01(\t\x12W\n\x06inputs\x18\x04 \x03(\x0b\x32G.koapy.backend.kiwoom_open_api_plus.grpc.TransactionRequest.InputsEntry\x12Y\n\x0estop_condition\x18\x05 \x01(\x0b\x32\x41.koapy.backend.kiwoom_open_api_plus.grpc.TransactionStopCondition\x12H\n\x05\x66lags\x18\x06 \x01(\x0b\x32\x39.koapy.backend.kiwoom_open_api_plus.grpc.RealRequestFlags\x1a-\n\x0bInputsEntry\x12\x0b\n\x03key\x18\x01 \x01(\t\x12\r\n\x05value\x18\x02 \x01(\t:\x02\x38\x01\"]\n\x17OrderSubscriptionTarget\x12\x0b\n\x03RET\x18\x01 \x01(\x08\x12\n\n\x02TR\x18\x02 \x01(\x08\x12\x0c\n\x04REAL\x18\x03 \x01(\x08\x12\x0b\n\x03MSG\x18\x04 \x01(\x08\x12\x0e\n\x06\x43HEJAN\x18\x05 \x01(\x08\"\x8f\x02\n\x0cOrderRequest\x12\x14\n\x0crequest_name\x18\x01 \x01(\t\x12\x11\n\tscreen_no\x18\x02 \x01(\t\x12\x12\n\naccount_no\x18\x03 \x01(\t\x12\x12\n\norder_type\x18\x04 \x01(\x03\x12\x0c\n\x04\x63ode\x18\x05 \x01(\t\x12\x10\n\x08quantity\x18\x06 \x01(\x03\x12\r\n\x05price\x18\x07 \x01(\x03\x12\x12\n\nquote_type\x18\x08 \x01(\t\x12\x19\n\x11original_order_no\x18\t \x01(\t\x12P\n\x06target\x18\n \x01(\x0b\x32@.koapy.backend.kiwoom_open_api_plus.grpc.OrderSubscriptionTarget\"\x16\n\x14LoadConditionRequest\"D\n\x15\x43onditionRequestFlags\x12\x11\n\twith_info\x18\x01 \x01(\x08\x12\x18\n\x10is_future_option\x18\x02 \x01(\x08\"\xd0\x01\n\x10\x43onditionRequest\x12\x11\n\tscreen_no\x18\x01 \x01(\t\x12\x16\n\x0e\x63ondition_name\x18\x02 \x01(\t\x12\x17\n\x0f\x63ondition_index\x18\x03 \x01(\x05\x12\x13\n\x0bsearch_type\x18\x04 \x01(\x05\x12\x14\n\x0crequest_name\x18\x05 \x01(\t\x12M\n\x05\x66lags\x18\x06 \x01(\x0b\x32>.koapy.backend.kiwoom_open_api_plus.grpc.ConditionRequestFlags\"3\n\x12SetLogLevelRequest\x12\r\n\x05level\x18\x01 \x01(\x05\x12\x0e\n\x06logger\x18\x02 \x01(\t\"\x15\n\x13SetLogLevelResponse\"\x80\x01\n\"BidirectionalRealInitializeRequest\x12\x10\n\x08\x66id_list\x18\x01 \x03(\x05\x12H\n\x05\x66lags\x18\x02 \x01(\x0b\x32\x39.koapy.backend.kiwoom_open_api_plus.grpc.RealRequestFlags\"G\n BidirectionalRealRegisterRequest\x12\x11\n\tcode_list\x18\x01 \x03(\t\x12\x10\n\x08\x66id_list\x18\x02 \x03(\x05\"3\n\x1e\x42idirectionalRealRemoveRequest\x12\x11\n\tcode_list\x18\x01 \x03(\t\"\x1e\n\x1c\x42idirectionalRealStopRequest\"\xb9\x03\n\x18\x42idirectionalRealRequest\x12i\n\x12initialize_request\x18\x01 \x01(\x0b\x32K.koapy.backend.kiwoom_open_api_plus.grpc.BidirectionalRealInitializeRequestH\x00\x12\x65\n\x10register_request\x18\x02 \x01(\x0b\x32I.koapy.backend.kiwoom_open_api_plus.grpc.BidirectionalRealRegisterRequestH\x00\x12\x61\n\x0eremove_request\x18\x03 \x01(\x0b\x32G.koapy.backend.kiwoom_open_api_plus.grpc.BidirectionalRealRemoveRequestH\x00\x12]\n\x0cstop_request\x18\x04 \x01(\x0b\x32\x45.koapy.backend.kiwoom_open_api_plus.grpc.BidirectionalRealStopRequestH\x00\x42\t\n\x07request*\x9d\x01\n!TransactionStopConditionCompartor\x12\x19\n\x15LESS_THAN_OR_EQUAL_TO\x10\x00\x12\r\n\tLESS_THAN\x10\x01\x12\x1c\n\x18GREATER_THAN_OR_EQUAL_TO\x10\x02\x12\x10\n\x0cGREATER_THAN\x10\x03\x12\x0c\n\x08\x45QUAL_TO\x10\x04\x12\x10\n\x0cNOT_EQUAL_TO\x10\x05\x32\xa6\x0f\n\x18KiwoomOpenApiPlusService\x12u\n\x04\x43\x61ll\x12\x34.koapy.backend.kiwoom_open_api_plus.grpc.CallRequest\x1a\x35.koapy.backend.kiwoom_open_api_plus.grpc.CallResponse\"\x00\x12}\n\x06Listen\x12\x36.koapy.backend.kiwoom_open_api_plus.grpc.ListenRequest\x1a\x37.koapy.backend.kiwoom_open_api_plus.grpc.ListenResponse\"\x00\x30\x01\x12\x99\x01\n\x13\x42idirectionalListen\x12\x43.koapy.backend.kiwoom_open_api_plus.grpc.BidirectionalListenRequest\x1a\x37.koapy.backend.kiwoom_open_api_plus.grpc.ListenResponse\"\x00(\x01\x30\x01\x12\x7f\n\tLoginCall\x12\x35.koapy.backend.kiwoom_open_api_plus.grpc.LoginRequest\x1a\x37.koapy.backend.kiwoom_open_api_plus.grpc.ListenResponse\"\x00\x30\x01\x12\x8b\x01\n\x0fTransactionCall\x12;.koapy.backend.kiwoom_open_api_plus.grpc.TransactionRequest\x1a\x37.koapy.backend.kiwoom_open_api_plus.grpc.ListenResponse\"\x00\x30\x01\x12\x7f\n\tOrderCall\x12\x35.koapy.backend.kiwoom_open_api_plus.grpc.OrderRequest\x1a\x37.koapy.backend.kiwoom_open_api_plus.grpc.ListenResponse\"\x00\x30\x01\x12}\n\x08RealCall\x12\x34.koapy.backend.kiwoom_open_api_plus.grpc.RealRequest\x1a\x37.koapy.backend.kiwoom_open_api_plus.grpc.ListenResponse\"\x00\x30\x01\x12\x8f\x01\n\x11LoadConditionCall\x12=.koapy.backend.kiwoom_open_api_plus.grpc.LoadConditionRequest\x1a\x37.koapy.backend.kiwoom_open_api_plus.grpc.ListenResponse\"\x00\x30\x01\x12\x87\x01\n\rConditionCall\x12\x39.koapy.backend.kiwoom_open_api_plus.grpc.ConditionRequest\x1a\x37.koapy.backend.kiwoom_open_api_plus.grpc.ListenResponse\"\x00\x30\x01\x12\x99\x01\n\x15\x42idirectionalRealCall\x12\x41.koapy.backend.kiwoom_open_api_plus.grpc.BidirectionalRealRequest\x1a\x37.koapy.backend.kiwoom_open_api_plus.grpc.ListenResponse\"\x00(\x01\x30\x01\x12\x82\x01\n\x0bOrderListen\x12\x36.koapy.backend.kiwoom_open_api_plus.grpc.ListenRequest\x1a\x37.koapy.backend.kiwoom_open_api_plus.grpc.ListenResponse\"\x00\x30\x01\x12\x83\x01\n\x0c\x43ustomListen\x12\x36.koapy.backend.kiwoom_open_api_plus.grpc.ListenRequest\x1a\x37.koapy.backend.kiwoom_open_api_plus.grpc.ListenResponse\"\x00\x30\x01\x12\x98\x01\n\x13\x43ustomCallAndListen\x12=.koapy.backend.kiwoom_open_api_plus.grpc.CallAndListenRequest\x1a>.koapy.backend.kiwoom_open_api_plus.grpc.CallAndListenResponse\"\x00\x30\x01\x12\x8a\x01\n\x0bSetLogLevel\x12;.koapy.backend.kiwoom_open_api_plus.grpc.SetLogLevelRequest\x1a<.koapy.backend.kiwoom_open_api_plus.grpc.SetLogLevelResponse\"\x00\x62\x06proto3'
+)
+
+_TRANSACTIONSTOPCONDITIONCOMPARTOR = _descriptor.EnumDescriptor(
+  name='TransactionStopConditionCompartor',
+  full_name='koapy.backend.kiwoom_open_api_plus.grpc.TransactionStopConditionCompartor',
+  filename=None,
+  file=DESCRIPTOR,
+  create_key=_descriptor._internal_create_key,
+  values=[
+    _descriptor.EnumValueDescriptor(
+      name='LESS_THAN_OR_EQUAL_TO', index=0, number=0,
+      serialized_options=None,
+      type=None,
+      create_key=_descriptor._internal_create_key),
+    _descriptor.EnumValueDescriptor(
+      name='LESS_THAN', index=1, number=1,
+      serialized_options=None,
+      type=None,
+      create_key=_descriptor._internal_create_key),
+    _descriptor.EnumValueDescriptor(
+      name='GREATER_THAN_OR_EQUAL_TO', index=2, number=2,
+      serialized_options=None,
+      type=None,
+      create_key=_descriptor._internal_create_key),
+    _descriptor.EnumValueDescriptor(
+      name='GREATER_THAN', index=3, number=3,
+      serialized_options=None,
+      type=None,
+      create_key=_descriptor._internal_create_key),
+    _descriptor.EnumValueDescriptor(
+      name='EQUAL_TO', index=4, number=4,
+      serialized_options=None,
+      type=None,
+      create_key=_descriptor._internal_create_key),
+    _descriptor.EnumValueDescriptor(
+      name='NOT_EQUAL_TO', index=5, number=5,
+      serialized_options=None,
+      type=None,
+      create_key=_descriptor._internal_create_key),
+  ],
+  containing_type=None,
+  serialized_options=None,
+  serialized_start=4388,
+  serialized_end=4545,
+)
+_sym_db.RegisterEnumDescriptor(_TRANSACTIONSTOPCONDITIONCOMPARTOR)
+
+[docs]TransactionStopConditionCompartor = enum_type_wrapper.EnumTypeWrapper(_TRANSACTIONSTOPCONDITIONCOMPARTOR)
+[docs]LESS_THAN_OR_EQUAL_TO = 0
+[docs]LESS_THAN = 1
+[docs]GREATER_THAN_OR_EQUAL_TO = 2
+[docs]GREATER_THAN = 3
+[docs]EQUAL_TO = 4
+[docs]NOT_EQUAL_TO = 5
+
+
+
+_ARGUMENT = _descriptor.Descriptor(
+  name='Argument',
+  full_name='koapy.backend.kiwoom_open_api_plus.grpc.Argument',
+  filename=None,
+  file=DESCRIPTOR,
+  containing_type=None,
+  create_key=_descriptor._internal_create_key,
+  fields=[
+    _descriptor.FieldDescriptor(
+      name='string_value', full_name='koapy.backend.kiwoom_open_api_plus.grpc.Argument.string_value', index=0,
+      number=1, type=9, cpp_type=9, label=1,
+      has_default_value=False, default_value=b"".decode('utf-8'),
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+    _descriptor.FieldDescriptor(
+      name='long_value', full_name='koapy.backend.kiwoom_open_api_plus.grpc.Argument.long_value', index=1,
+      number=2, type=3, cpp_type=2, label=1,
+      has_default_value=False, default_value=0,
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+    _descriptor.FieldDescriptor(
+      name='bool_value', full_name='koapy.backend.kiwoom_open_api_plus.grpc.Argument.bool_value', index=2,
+      number=3, type=8, cpp_type=7, label=1,
+      has_default_value=False, default_value=False,
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+  ],
+  extensions=[
+  ],
+  nested_types=[],
+  enum_types=[
+  ],
+  serialized_options=None,
+  is_extendable=False,
+  syntax='proto3',
+  extension_ranges=[],
+  oneofs=[
+    _descriptor.OneofDescriptor(
+      name='value', full_name='koapy.backend.kiwoom_open_api_plus.grpc.Argument.value',
+      index=0, containing_type=None,
+      create_key=_descriptor._internal_create_key,
+    fields=[]),
+  ],
+  serialized_start=115,
+  serialized_end=202,
+)
+
+
+_CALLREQUEST = _descriptor.Descriptor(
+  name='CallRequest',
+  full_name='koapy.backend.kiwoom_open_api_plus.grpc.CallRequest',
+  filename=None,
+  file=DESCRIPTOR,
+  containing_type=None,
+  create_key=_descriptor._internal_create_key,
+  fields=[
+    _descriptor.FieldDescriptor(
+      name='name', full_name='koapy.backend.kiwoom_open_api_plus.grpc.CallRequest.name', index=0,
+      number=1, type=9, cpp_type=9, label=1,
+      has_default_value=False, default_value=b"".decode('utf-8'),
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+    _descriptor.FieldDescriptor(
+      name='arguments', full_name='koapy.backend.kiwoom_open_api_plus.grpc.CallRequest.arguments', index=1,
+      number=2, type=11, cpp_type=10, label=3,
+      has_default_value=False, default_value=[],
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+  ],
+  extensions=[
+  ],
+  nested_types=[],
+  enum_types=[
+  ],
+  serialized_options=None,
+  is_extendable=False,
+  syntax='proto3',
+  extension_ranges=[],
+  oneofs=[
+  ],
+  serialized_start=204,
+  serialized_end=301,
+)
+
+
+_RETURNVALUE = _descriptor.Descriptor(
+  name='ReturnValue',
+  full_name='koapy.backend.kiwoom_open_api_plus.grpc.ReturnValue',
+  filename=None,
+  file=DESCRIPTOR,
+  containing_type=None,
+  create_key=_descriptor._internal_create_key,
+  fields=[
+    _descriptor.FieldDescriptor(
+      name='string_value', full_name='koapy.backend.kiwoom_open_api_plus.grpc.ReturnValue.string_value', index=0,
+      number=1, type=9, cpp_type=9, label=1,
+      has_default_value=False, default_value=b"".decode('utf-8'),
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+    _descriptor.FieldDescriptor(
+      name='long_value', full_name='koapy.backend.kiwoom_open_api_plus.grpc.ReturnValue.long_value', index=1,
+      number=2, type=3, cpp_type=2, label=1,
+      has_default_value=False, default_value=0,
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+    _descriptor.FieldDescriptor(
+      name='bool_value', full_name='koapy.backend.kiwoom_open_api_plus.grpc.ReturnValue.bool_value', index=2,
+      number=3, type=8, cpp_type=7, label=1,
+      has_default_value=False, default_value=False,
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+  ],
+  extensions=[
+  ],
+  nested_types=[],
+  enum_types=[
+  ],
+  serialized_options=None,
+  is_extendable=False,
+  syntax='proto3',
+  extension_ranges=[],
+  oneofs=[
+    _descriptor.OneofDescriptor(
+      name='value', full_name='koapy.backend.kiwoom_open_api_plus.grpc.ReturnValue.value',
+      index=0, containing_type=None,
+      create_key=_descriptor._internal_create_key,
+    fields=[]),
+  ],
+  serialized_start=303,
+  serialized_end=393,
+)
+
+
+_CALLRESPONSE = _descriptor.Descriptor(
+  name='CallResponse',
+  full_name='koapy.backend.kiwoom_open_api_plus.grpc.CallResponse',
+  filename=None,
+  file=DESCRIPTOR,
+  containing_type=None,
+  create_key=_descriptor._internal_create_key,
+  fields=[
+    _descriptor.FieldDescriptor(
+      name='return_value', full_name='koapy.backend.kiwoom_open_api_plus.grpc.CallResponse.return_value', index=0,
+      number=1, type=11, cpp_type=10, label=1,
+      has_default_value=False, default_value=None,
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+  ],
+  extensions=[
+  ],
+  nested_types=[],
+  enum_types=[
+  ],
+  serialized_options=None,
+  is_extendable=False,
+  syntax='proto3',
+  extension_ranges=[],
+  oneofs=[
+  ],
+  serialized_start=395,
+  serialized_end=485,
+)
+
+
+_LISTENREQUEST = _descriptor.Descriptor(
+  name='ListenRequest',
+  full_name='koapy.backend.kiwoom_open_api_plus.grpc.ListenRequest',
+  filename=None,
+  file=DESCRIPTOR,
+  containing_type=None,
+  create_key=_descriptor._internal_create_key,
+  fields=[
+    _descriptor.FieldDescriptor(
+      name='id', full_name='koapy.backend.kiwoom_open_api_plus.grpc.ListenRequest.id', index=0,
+      number=1, type=9, cpp_type=9, label=1,
+      has_default_value=False, default_value=b"".decode('utf-8'),
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+    _descriptor.FieldDescriptor(
+      name='slots', full_name='koapy.backend.kiwoom_open_api_plus.grpc.ListenRequest.slots', index=1,
+      number=2, type=9, cpp_type=9, label=3,
+      has_default_value=False, default_value=[],
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+    _descriptor.FieldDescriptor(
+      name='code', full_name='koapy.backend.kiwoom_open_api_plus.grpc.ListenRequest.code', index=2,
+      number=3, type=9, cpp_type=9, label=1,
+      has_default_value=False, default_value=b"".decode('utf-8'),
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+    _descriptor.FieldDescriptor(
+      name='class_name', full_name='koapy.backend.kiwoom_open_api_plus.grpc.ListenRequest.class_name', index=3,
+      number=4, type=9, cpp_type=9, label=1,
+      has_default_value=False, default_value=b"".decode('utf-8'),
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+  ],
+  extensions=[
+  ],
+  nested_types=[],
+  enum_types=[
+  ],
+  serialized_options=None,
+  is_extendable=False,
+  syntax='proto3',
+  extension_ranges=[],
+  oneofs=[
+  ],
+  serialized_start=487,
+  serialized_end=563,
+)
+
+
+_HANDLEDREQUEST = _descriptor.Descriptor(
+  name='HandledRequest',
+  full_name='koapy.backend.kiwoom_open_api_plus.grpc.HandledRequest',
+  filename=None,
+  file=DESCRIPTOR,
+  containing_type=None,
+  create_key=_descriptor._internal_create_key,
+  fields=[
+    _descriptor.FieldDescriptor(
+      name='time', full_name='koapy.backend.kiwoom_open_api_plus.grpc.HandledRequest.time', index=0,
+      number=1, type=2, cpp_type=6, label=1,
+      has_default_value=False, default_value=float(0),
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+  ],
+  extensions=[
+  ],
+  nested_types=[],
+  enum_types=[
+  ],
+  serialized_options=None,
+  is_extendable=False,
+  syntax='proto3',
+  extension_ranges=[],
+  oneofs=[
+  ],
+  serialized_start=565,
+  serialized_end=595,
+)
+
+
+_STOPLISTENREQUEST = _descriptor.Descriptor(
+  name='StopListenRequest',
+  full_name='koapy.backend.kiwoom_open_api_plus.grpc.StopListenRequest',
+  filename=None,
+  file=DESCRIPTOR,
+  containing_type=None,
+  create_key=_descriptor._internal_create_key,
+  fields=[
+    _descriptor.FieldDescriptor(
+      name='time', full_name='koapy.backend.kiwoom_open_api_plus.grpc.StopListenRequest.time', index=0,
+      number=1, type=2, cpp_type=6, label=1,
+      has_default_value=False, default_value=float(0),
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+  ],
+  extensions=[
+  ],
+  nested_types=[],
+  enum_types=[
+  ],
+  serialized_options=None,
+  is_extendable=False,
+  syntax='proto3',
+  extension_ranges=[],
+  oneofs=[
+  ],
+  serialized_start=597,
+  serialized_end=630,
+)
+
+
+_BIDIRECTIONALLISTENREQUEST = _descriptor.Descriptor(
+  name='BidirectionalListenRequest',
+  full_name='koapy.backend.kiwoom_open_api_plus.grpc.BidirectionalListenRequest',
+  filename=None,
+  file=DESCRIPTOR,
+  containing_type=None,
+  create_key=_descriptor._internal_create_key,
+  fields=[
+    _descriptor.FieldDescriptor(
+      name='listen_request', full_name='koapy.backend.kiwoom_open_api_plus.grpc.BidirectionalListenRequest.listen_request', index=0,
+      number=1, type=11, cpp_type=10, label=1,
+      has_default_value=False, default_value=None,
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+    _descriptor.FieldDescriptor(
+      name='handled_request', full_name='koapy.backend.kiwoom_open_api_plus.grpc.BidirectionalListenRequest.handled_request', index=1,
+      number=2, type=11, cpp_type=10, label=1,
+      has_default_value=False, default_value=None,
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+    _descriptor.FieldDescriptor(
+      name='stop_listen_request', full_name='koapy.backend.kiwoom_open_api_plus.grpc.BidirectionalListenRequest.stop_listen_request', index=2,
+      number=3, type=11, cpp_type=10, label=1,
+      has_default_value=False, default_value=None,
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+  ],
+  extensions=[
+  ],
+  nested_types=[],
+  enum_types=[
+  ],
+  serialized_options=None,
+  is_extendable=False,
+  syntax='proto3',
+  extension_ranges=[],
+  oneofs=[
+    _descriptor.OneofDescriptor(
+      name='request', full_name='koapy.backend.kiwoom_open_api_plus.grpc.BidirectionalListenRequest.request',
+      index=0, containing_type=None,
+      create_key=_descriptor._internal_create_key,
+    fields=[]),
+  ],
+  serialized_start=633,
+  serialized_end=929,
+)
+
+
+_SINGLEDATA = _descriptor.Descriptor(
+  name='SingleData',
+  full_name='koapy.backend.kiwoom_open_api_plus.grpc.SingleData',
+  filename=None,
+  file=DESCRIPTOR,
+  containing_type=None,
+  create_key=_descriptor._internal_create_key,
+  fields=[
+    _descriptor.FieldDescriptor(
+      name='names', full_name='koapy.backend.kiwoom_open_api_plus.grpc.SingleData.names', index=0,
+      number=1, type=9, cpp_type=9, label=3,
+      has_default_value=False, default_value=[],
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+    _descriptor.FieldDescriptor(
+      name='values', full_name='koapy.backend.kiwoom_open_api_plus.grpc.SingleData.values', index=1,
+      number=2, type=9, cpp_type=9, label=3,
+      has_default_value=False, default_value=[],
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+  ],
+  extensions=[
+  ],
+  nested_types=[],
+  enum_types=[
+  ],
+  serialized_options=None,
+  is_extendable=False,
+  syntax='proto3',
+  extension_ranges=[],
+  oneofs=[
+  ],
+  serialized_start=931,
+  serialized_end=974,
+)
+
+
+_REPEATEDSTRING = _descriptor.Descriptor(
+  name='RepeatedString',
+  full_name='koapy.backend.kiwoom_open_api_plus.grpc.RepeatedString',
+  filename=None,
+  file=DESCRIPTOR,
+  containing_type=None,
+  create_key=_descriptor._internal_create_key,
+  fields=[
+    _descriptor.FieldDescriptor(
+      name='values', full_name='koapy.backend.kiwoom_open_api_plus.grpc.RepeatedString.values', index=0,
+      number=1, type=9, cpp_type=9, label=3,
+      has_default_value=False, default_value=[],
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+  ],
+  extensions=[
+  ],
+  nested_types=[],
+  enum_types=[
+  ],
+  serialized_options=None,
+  is_extendable=False,
+  syntax='proto3',
+  extension_ranges=[],
+  oneofs=[
+  ],
+  serialized_start=976,
+  serialized_end=1008,
+)
+
+
+_MULTIDATA = _descriptor.Descriptor(
+  name='MultiData',
+  full_name='koapy.backend.kiwoom_open_api_plus.grpc.MultiData',
+  filename=None,
+  file=DESCRIPTOR,
+  containing_type=None,
+  create_key=_descriptor._internal_create_key,
+  fields=[
+    _descriptor.FieldDescriptor(
+      name='names', full_name='koapy.backend.kiwoom_open_api_plus.grpc.MultiData.names', index=0,
+      number=1, type=9, cpp_type=9, label=3,
+      has_default_value=False, default_value=[],
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+    _descriptor.FieldDescriptor(
+      name='values', full_name='koapy.backend.kiwoom_open_api_plus.grpc.MultiData.values', index=1,
+      number=2, type=11, cpp_type=10, label=3,
+      has_default_value=False, default_value=[],
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+  ],
+  extensions=[
+  ],
+  nested_types=[],
+  enum_types=[
+  ],
+  serialized_options=None,
+  is_extendable=False,
+  syntax='proto3',
+  extension_ranges=[],
+  oneofs=[
+  ],
+  serialized_start=1010,
+  serialized_end=1109,
+)
+
+
+_LISTENRESPONSE = _descriptor.Descriptor(
+  name='ListenResponse',
+  full_name='koapy.backend.kiwoom_open_api_plus.grpc.ListenResponse',
+  filename=None,
+  file=DESCRIPTOR,
+  containing_type=None,
+  create_key=_descriptor._internal_create_key,
+  fields=[
+    _descriptor.FieldDescriptor(
+      name='name', full_name='koapy.backend.kiwoom_open_api_plus.grpc.ListenResponse.name', index=0,
+      number=1, type=9, cpp_type=9, label=1,
+      has_default_value=False, default_value=b"".decode('utf-8'),
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+    _descriptor.FieldDescriptor(
+      name='arguments', full_name='koapy.backend.kiwoom_open_api_plus.grpc.ListenResponse.arguments', index=1,
+      number=2, type=11, cpp_type=10, label=3,
+      has_default_value=False, default_value=[],
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+    _descriptor.FieldDescriptor(
+      name='single_data', full_name='koapy.backend.kiwoom_open_api_plus.grpc.ListenResponse.single_data', index=2,
+      number=3, type=11, cpp_type=10, label=1,
+      has_default_value=False, default_value=None,
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+    _descriptor.FieldDescriptor(
+      name='multi_data', full_name='koapy.backend.kiwoom_open_api_plus.grpc.ListenResponse.multi_data', index=3,
+      number=4, type=11, cpp_type=10, label=1,
+      has_default_value=False, default_value=None,
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+  ],
+  extensions=[
+  ],
+  nested_types=[],
+  enum_types=[
+  ],
+  serialized_options=None,
+  is_extendable=False,
+  syntax='proto3',
+  extension_ranges=[],
+  oneofs=[
+  ],
+  serialized_start=1112,
+  serialized_end=1358,
+)
+
+
+_CALLANDLISTENREQUEST = _descriptor.Descriptor(
+  name='CallAndListenRequest',
+  full_name='koapy.backend.kiwoom_open_api_plus.grpc.CallAndListenRequest',
+  filename=None,
+  file=DESCRIPTOR,
+  containing_type=None,
+  create_key=_descriptor._internal_create_key,
+  fields=[
+    _descriptor.FieldDescriptor(
+      name='call_request', full_name='koapy.backend.kiwoom_open_api_plus.grpc.CallAndListenRequest.call_request', index=0,
+      number=1, type=11, cpp_type=10, label=1,
+      has_default_value=False, default_value=None,
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+    _descriptor.FieldDescriptor(
+      name='listen_request', full_name='koapy.backend.kiwoom_open_api_plus.grpc.CallAndListenRequest.listen_request', index=1,
+      number=2, type=11, cpp_type=10, label=1,
+      has_default_value=False, default_value=None,
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+  ],
+  extensions=[
+  ],
+  nested_types=[],
+  enum_types=[
+  ],
+  serialized_options=None,
+  is_extendable=False,
+  syntax='proto3',
+  extension_ranges=[],
+  oneofs=[
+  ],
+  serialized_start=1361,
+  serialized_end=1539,
+)
+
+
+_CALLANDLISTENRESPONSE = _descriptor.Descriptor(
+  name='CallAndListenResponse',
+  full_name='koapy.backend.kiwoom_open_api_plus.grpc.CallAndListenResponse',
+  filename=None,
+  file=DESCRIPTOR,
+  containing_type=None,
+  create_key=_descriptor._internal_create_key,
+  fields=[
+    _descriptor.FieldDescriptor(
+      name='call_response', full_name='koapy.backend.kiwoom_open_api_plus.grpc.CallAndListenResponse.call_response', index=0,
+      number=1, type=11, cpp_type=10, label=1,
+      has_default_value=False, default_value=None,
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+    _descriptor.FieldDescriptor(
+      name='listen_response', full_name='koapy.backend.kiwoom_open_api_plus.grpc.CallAndListenResponse.listen_response', index=1,
+      number=2, type=11, cpp_type=10, label=1,
+      has_default_value=False, default_value=None,
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+  ],
+  extensions=[
+  ],
+  nested_types=[],
+  enum_types=[
+  ],
+  serialized_options=None,
+  is_extendable=False,
+  syntax='proto3',
+  extension_ranges=[],
+  oneofs=[
+    _descriptor.OneofDescriptor(
+      name='response', full_name='koapy.backend.kiwoom_open_api_plus.grpc.CallAndListenResponse.response',
+      index=0, containing_type=None,
+      create_key=_descriptor._internal_create_key,
+    fields=[]),
+  ],
+  serialized_start=1542,
+  serialized_end=1741,
+)
+
+
+_LOGINCREDENTIALS_ACCOUNTPASSWORDSENTRY = _descriptor.Descriptor(
+  name='AccountPasswordsEntry',
+  full_name='koapy.backend.kiwoom_open_api_plus.grpc.LoginCredentials.AccountPasswordsEntry',
+  filename=None,
+  file=DESCRIPTOR,
+  containing_type=None,
+  create_key=_descriptor._internal_create_key,
+  fields=[
+    _descriptor.FieldDescriptor(
+      name='key', full_name='koapy.backend.kiwoom_open_api_plus.grpc.LoginCredentials.AccountPasswordsEntry.key', index=0,
+      number=1, type=9, cpp_type=9, label=1,
+      has_default_value=False, default_value=b"".decode('utf-8'),
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+    _descriptor.FieldDescriptor(
+      name='value', full_name='koapy.backend.kiwoom_open_api_plus.grpc.LoginCredentials.AccountPasswordsEntry.value', index=1,
+      number=2, type=9, cpp_type=9, label=1,
+      has_default_value=False, default_value=b"".decode('utf-8'),
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+  ],
+  extensions=[
+  ],
+  nested_types=[],
+  enum_types=[
+  ],
+  serialized_options=b'8\001',
+  is_extendable=False,
+  syntax='proto3',
+  extension_ranges=[],
+  oneofs=[
+  ],
+  serialized_start=1958,
+  serialized_end=2013,
+)
+
+_LOGINCREDENTIALS = _descriptor.Descriptor(
+  name='LoginCredentials',
+  full_name='koapy.backend.kiwoom_open_api_plus.grpc.LoginCredentials',
+  filename=None,
+  file=DESCRIPTOR,
+  containing_type=None,
+  create_key=_descriptor._internal_create_key,
+  fields=[
+    _descriptor.FieldDescriptor(
+      name='user_id', full_name='koapy.backend.kiwoom_open_api_plus.grpc.LoginCredentials.user_id', index=0,
+      number=1, type=9, cpp_type=9, label=1,
+      has_default_value=False, default_value=b"".decode('utf-8'),
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+    _descriptor.FieldDescriptor(
+      name='user_password', full_name='koapy.backend.kiwoom_open_api_plus.grpc.LoginCredentials.user_password', index=1,
+      number=2, type=9, cpp_type=9, label=1,
+      has_default_value=False, default_value=b"".decode('utf-8'),
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+    _descriptor.FieldDescriptor(
+      name='cert_password', full_name='koapy.backend.kiwoom_open_api_plus.grpc.LoginCredentials.cert_password', index=2,
+      number=3, type=9, cpp_type=9, label=1,
+      has_default_value=False, default_value=b"".decode('utf-8'),
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+    _descriptor.FieldDescriptor(
+      name='is_simulation', full_name='koapy.backend.kiwoom_open_api_plus.grpc.LoginCredentials.is_simulation', index=3,
+      number=4, type=8, cpp_type=7, label=1,
+      has_default_value=False, default_value=False,
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+    _descriptor.FieldDescriptor(
+      name='account_passwords', full_name='koapy.backend.kiwoom_open_api_plus.grpc.LoginCredentials.account_passwords', index=4,
+      number=5, type=11, cpp_type=10, label=3,
+      has_default_value=False, default_value=[],
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+  ],
+  extensions=[
+  ],
+  nested_types=[_LOGINCREDENTIALS_ACCOUNTPASSWORDSENTRY, ],
+  enum_types=[
+  ],
+  serialized_options=None,
+  is_extendable=False,
+  syntax='proto3',
+  extension_ranges=[],
+  oneofs=[
+  ],
+  serialized_start=1744,
+  serialized_end=2013,
+)
+
+
+_LOGINREQUEST = _descriptor.Descriptor(
+  name='LoginRequest',
+  full_name='koapy.backend.kiwoom_open_api_plus.grpc.LoginRequest',
+  filename=None,
+  file=DESCRIPTOR,
+  containing_type=None,
+  create_key=_descriptor._internal_create_key,
+  fields=[
+    _descriptor.FieldDescriptor(
+      name='credentials', full_name='koapy.backend.kiwoom_open_api_plus.grpc.LoginRequest.credentials', index=0,
+      number=1, type=11, cpp_type=10, label=1,
+      has_default_value=False, default_value=None,
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+  ],
+  extensions=[
+  ],
+  nested_types=[],
+  enum_types=[
+  ],
+  serialized_options=None,
+  is_extendable=False,
+  syntax='proto3',
+  extension_ranges=[],
+  oneofs=[
+  ],
+  serialized_start=2015,
+  serialized_end=2109,
+)
+
+
+_REALREQUESTFLAGS = _descriptor.Descriptor(
+  name='RealRequestFlags',
+  full_name='koapy.backend.kiwoom_open_api_plus.grpc.RealRequestFlags',
+  filename=None,
+  file=DESCRIPTOR,
+  containing_type=None,
+  create_key=_descriptor._internal_create_key,
+  fields=[
+    _descriptor.FieldDescriptor(
+      name='infer_fids', full_name='koapy.backend.kiwoom_open_api_plus.grpc.RealRequestFlags.infer_fids', index=0,
+      number=1, type=8, cpp_type=7, label=1,
+      has_default_value=False, default_value=False,
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+    _descriptor.FieldDescriptor(
+      name='readable_names', full_name='koapy.backend.kiwoom_open_api_plus.grpc.RealRequestFlags.readable_names', index=1,
+      number=2, type=8, cpp_type=7, label=1,
+      has_default_value=False, default_value=False,
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+    _descriptor.FieldDescriptor(
+      name='fast_parse', full_name='koapy.backend.kiwoom_open_api_plus.grpc.RealRequestFlags.fast_parse', index=2,
+      number=3, type=8, cpp_type=7, label=1,
+      has_default_value=False, default_value=False,
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+  ],
+  extensions=[
+  ],
+  nested_types=[],
+  enum_types=[
+  ],
+  serialized_options=None,
+  is_extendable=False,
+  syntax='proto3',
+  extension_ranges=[],
+  oneofs=[
+  ],
+  serialized_start=2111,
+  serialized_end=2193,
+)
+
+
+_REALREQUEST = _descriptor.Descriptor(
+  name='RealRequest',
+  full_name='koapy.backend.kiwoom_open_api_plus.grpc.RealRequest',
+  filename=None,
+  file=DESCRIPTOR,
+  containing_type=None,
+  create_key=_descriptor._internal_create_key,
+  fields=[
+    _descriptor.FieldDescriptor(
+      name='screen_no', full_name='koapy.backend.kiwoom_open_api_plus.grpc.RealRequest.screen_no', index=0,
+      number=1, type=9, cpp_type=9, label=3,
+      has_default_value=False, default_value=[],
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+    _descriptor.FieldDescriptor(
+      name='code_list', full_name='koapy.backend.kiwoom_open_api_plus.grpc.RealRequest.code_list', index=1,
+      number=2, type=9, cpp_type=9, label=3,
+      has_default_value=False, default_value=[],
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+    _descriptor.FieldDescriptor(
+      name='fid_list', full_name='koapy.backend.kiwoom_open_api_plus.grpc.RealRequest.fid_list', index=2,
+      number=3, type=5, cpp_type=1, label=3,
+      has_default_value=False, default_value=[],
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+    _descriptor.FieldDescriptor(
+      name='opt_type', full_name='koapy.backend.kiwoom_open_api_plus.grpc.RealRequest.opt_type', index=3,
+      number=4, type=9, cpp_type=9, label=1,
+      has_default_value=False, default_value=b"".decode('utf-8'),
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+    _descriptor.FieldDescriptor(
+      name='flags', full_name='koapy.backend.kiwoom_open_api_plus.grpc.RealRequest.flags', index=4,
+      number=5, type=11, cpp_type=10, label=1,
+      has_default_value=False, default_value=None,
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+  ],
+  extensions=[
+  ],
+  nested_types=[],
+  enum_types=[
+  ],
+  serialized_options=None,
+  is_extendable=False,
+  syntax='proto3',
+  extension_ranges=[],
+  oneofs=[
+  ],
+  serialized_start=2196,
+  serialized_end=2357,
+)
+
+
+_TRANSACTIONSTOPCONDITION = _descriptor.Descriptor(
+  name='TransactionStopCondition',
+  full_name='koapy.backend.kiwoom_open_api_plus.grpc.TransactionStopCondition',
+  filename=None,
+  file=DESCRIPTOR,
+  containing_type=None,
+  create_key=_descriptor._internal_create_key,
+  fields=[
+    _descriptor.FieldDescriptor(
+      name='name', full_name='koapy.backend.kiwoom_open_api_plus.grpc.TransactionStopCondition.name', index=0,
+      number=1, type=9, cpp_type=9, label=1,
+      has_default_value=False, default_value=b"".decode('utf-8'),
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+    _descriptor.FieldDescriptor(
+      name='value', full_name='koapy.backend.kiwoom_open_api_plus.grpc.TransactionStopCondition.value', index=1,
+      number=2, type=9, cpp_type=9, label=1,
+      has_default_value=False, default_value=b"".decode('utf-8'),
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+    _descriptor.FieldDescriptor(
+      name='comparator', full_name='koapy.backend.kiwoom_open_api_plus.grpc.TransactionStopCondition.comparator', index=2,
+      number=3, type=14, cpp_type=8, label=1,
+      has_default_value=False, default_value=0,
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+  ],
+  extensions=[
+  ],
+  nested_types=[],
+  enum_types=[
+  ],
+  serialized_options=None,
+  is_extendable=False,
+  syntax='proto3',
+  extension_ranges=[],
+  oneofs=[
+  ],
+  serialized_start=2360,
+  serialized_end=2511,
+)
+
+
+_TRANSACTIONREQUEST_INPUTSENTRY = _descriptor.Descriptor(
+  name='InputsEntry',
+  full_name='koapy.backend.kiwoom_open_api_plus.grpc.TransactionRequest.InputsEntry',
+  filename=None,
+  file=DESCRIPTOR,
+  containing_type=None,
+  create_key=_descriptor._internal_create_key,
+  fields=[
+    _descriptor.FieldDescriptor(
+      name='key', full_name='koapy.backend.kiwoom_open_api_plus.grpc.TransactionRequest.InputsEntry.key', index=0,
+      number=1, type=9, cpp_type=9, label=1,
+      has_default_value=False, default_value=b"".decode('utf-8'),
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+    _descriptor.FieldDescriptor(
+      name='value', full_name='koapy.backend.kiwoom_open_api_plus.grpc.TransactionRequest.InputsEntry.value', index=1,
+      number=2, type=9, cpp_type=9, label=1,
+      has_default_value=False, default_value=b"".decode('utf-8'),
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+  ],
+  extensions=[
+  ],
+  nested_types=[],
+  enum_types=[
+  ],
+  serialized_options=b'8\001',
+  is_extendable=False,
+  syntax='proto3',
+  extension_ranges=[],
+  oneofs=[
+  ],
+  serialized_start=2857,
+  serialized_end=2902,
+)
+
+_TRANSACTIONREQUEST = _descriptor.Descriptor(
+  name='TransactionRequest',
+  full_name='koapy.backend.kiwoom_open_api_plus.grpc.TransactionRequest',
+  filename=None,
+  file=DESCRIPTOR,
+  containing_type=None,
+  create_key=_descriptor._internal_create_key,
+  fields=[
+    _descriptor.FieldDescriptor(
+      name='request_name', full_name='koapy.backend.kiwoom_open_api_plus.grpc.TransactionRequest.request_name', index=0,
+      number=1, type=9, cpp_type=9, label=1,
+      has_default_value=False, default_value=b"".decode('utf-8'),
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+    _descriptor.FieldDescriptor(
+      name='transaction_code', full_name='koapy.backend.kiwoom_open_api_plus.grpc.TransactionRequest.transaction_code', index=1,
+      number=2, type=9, cpp_type=9, label=1,
+      has_default_value=False, default_value=b"".decode('utf-8'),
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+    _descriptor.FieldDescriptor(
+      name='screen_no', full_name='koapy.backend.kiwoom_open_api_plus.grpc.TransactionRequest.screen_no', index=2,
+      number=3, type=9, cpp_type=9, label=1,
+      has_default_value=False, default_value=b"".decode('utf-8'),
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+    _descriptor.FieldDescriptor(
+      name='inputs', full_name='koapy.backend.kiwoom_open_api_plus.grpc.TransactionRequest.inputs', index=3,
+      number=4, type=11, cpp_type=10, label=3,
+      has_default_value=False, default_value=[],
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+    _descriptor.FieldDescriptor(
+      name='stop_condition', full_name='koapy.backend.kiwoom_open_api_plus.grpc.TransactionRequest.stop_condition', index=4,
+      number=5, type=11, cpp_type=10, label=1,
+      has_default_value=False, default_value=None,
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+    _descriptor.FieldDescriptor(
+      name='flags', full_name='koapy.backend.kiwoom_open_api_plus.grpc.TransactionRequest.flags', index=5,
+      number=6, type=11, cpp_type=10, label=1,
+      has_default_value=False, default_value=None,
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+  ],
+  extensions=[
+  ],
+  nested_types=[_TRANSACTIONREQUEST_INPUTSENTRY, ],
+  enum_types=[
+  ],
+  serialized_options=None,
+  is_extendable=False,
+  syntax='proto3',
+  extension_ranges=[],
+  oneofs=[
+  ],
+  serialized_start=2514,
+  serialized_end=2902,
+)
+
+
+_ORDERSUBSCRIPTIONTARGET = _descriptor.Descriptor(
+  name='OrderSubscriptionTarget',
+  full_name='koapy.backend.kiwoom_open_api_plus.grpc.OrderSubscriptionTarget',
+  filename=None,
+  file=DESCRIPTOR,
+  containing_type=None,
+  create_key=_descriptor._internal_create_key,
+  fields=[
+    _descriptor.FieldDescriptor(
+      name='RET', full_name='koapy.backend.kiwoom_open_api_plus.grpc.OrderSubscriptionTarget.RET', index=0,
+      number=1, type=8, cpp_type=7, label=1,
+      has_default_value=False, default_value=False,
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+    _descriptor.FieldDescriptor(
+      name='TR', full_name='koapy.backend.kiwoom_open_api_plus.grpc.OrderSubscriptionTarget.TR', index=1,
+      number=2, type=8, cpp_type=7, label=1,
+      has_default_value=False, default_value=False,
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+    _descriptor.FieldDescriptor(
+      name='REAL', full_name='koapy.backend.kiwoom_open_api_plus.grpc.OrderSubscriptionTarget.REAL', index=2,
+      number=3, type=8, cpp_type=7, label=1,
+      has_default_value=False, default_value=False,
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+    _descriptor.FieldDescriptor(
+      name='MSG', full_name='koapy.backend.kiwoom_open_api_plus.grpc.OrderSubscriptionTarget.MSG', index=3,
+      number=4, type=8, cpp_type=7, label=1,
+      has_default_value=False, default_value=False,
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+    _descriptor.FieldDescriptor(
+      name='CHEJAN', full_name='koapy.backend.kiwoom_open_api_plus.grpc.OrderSubscriptionTarget.CHEJAN', index=4,
+      number=5, type=8, cpp_type=7, label=1,
+      has_default_value=False, default_value=False,
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+  ],
+  extensions=[
+  ],
+  nested_types=[],
+  enum_types=[
+  ],
+  serialized_options=None,
+  is_extendable=False,
+  syntax='proto3',
+  extension_ranges=[],
+  oneofs=[
+  ],
+  serialized_start=2904,
+  serialized_end=2997,
+)
+
+
+_ORDERREQUEST = _descriptor.Descriptor(
+  name='OrderRequest',
+  full_name='koapy.backend.kiwoom_open_api_plus.grpc.OrderRequest',
+  filename=None,
+  file=DESCRIPTOR,
+  containing_type=None,
+  create_key=_descriptor._internal_create_key,
+  fields=[
+    _descriptor.FieldDescriptor(
+      name='request_name', full_name='koapy.backend.kiwoom_open_api_plus.grpc.OrderRequest.request_name', index=0,
+      number=1, type=9, cpp_type=9, label=1,
+      has_default_value=False, default_value=b"".decode('utf-8'),
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+    _descriptor.FieldDescriptor(
+      name='screen_no', full_name='koapy.backend.kiwoom_open_api_plus.grpc.OrderRequest.screen_no', index=1,
+      number=2, type=9, cpp_type=9, label=1,
+      has_default_value=False, default_value=b"".decode('utf-8'),
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+    _descriptor.FieldDescriptor(
+      name='account_no', full_name='koapy.backend.kiwoom_open_api_plus.grpc.OrderRequest.account_no', index=2,
+      number=3, type=9, cpp_type=9, label=1,
+      has_default_value=False, default_value=b"".decode('utf-8'),
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+    _descriptor.FieldDescriptor(
+      name='order_type', full_name='koapy.backend.kiwoom_open_api_plus.grpc.OrderRequest.order_type', index=3,
+      number=4, type=3, cpp_type=2, label=1,
+      has_default_value=False, default_value=0,
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+    _descriptor.FieldDescriptor(
+      name='code', full_name='koapy.backend.kiwoom_open_api_plus.grpc.OrderRequest.code', index=4,
+      number=5, type=9, cpp_type=9, label=1,
+      has_default_value=False, default_value=b"".decode('utf-8'),
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+    _descriptor.FieldDescriptor(
+      name='quantity', full_name='koapy.backend.kiwoom_open_api_plus.grpc.OrderRequest.quantity', index=5,
+      number=6, type=3, cpp_type=2, label=1,
+      has_default_value=False, default_value=0,
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+    _descriptor.FieldDescriptor(
+      name='price', full_name='koapy.backend.kiwoom_open_api_plus.grpc.OrderRequest.price', index=6,
+      number=7, type=3, cpp_type=2, label=1,
+      has_default_value=False, default_value=0,
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+    _descriptor.FieldDescriptor(
+      name='quote_type', full_name='koapy.backend.kiwoom_open_api_plus.grpc.OrderRequest.quote_type', index=7,
+      number=8, type=9, cpp_type=9, label=1,
+      has_default_value=False, default_value=b"".decode('utf-8'),
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+    _descriptor.FieldDescriptor(
+      name='original_order_no', full_name='koapy.backend.kiwoom_open_api_plus.grpc.OrderRequest.original_order_no', index=8,
+      number=9, type=9, cpp_type=9, label=1,
+      has_default_value=False, default_value=b"".decode('utf-8'),
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+    _descriptor.FieldDescriptor(
+      name='target', full_name='koapy.backend.kiwoom_open_api_plus.grpc.OrderRequest.target', index=9,
+      number=10, type=11, cpp_type=10, label=1,
+      has_default_value=False, default_value=None,
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+  ],
+  extensions=[
+  ],
+  nested_types=[],
+  enum_types=[
+  ],
+  serialized_options=None,
+  is_extendable=False,
+  syntax='proto3',
+  extension_ranges=[],
+  oneofs=[
+  ],
+  serialized_start=3000,
+  serialized_end=3271,
+)
+
+
+_LOADCONDITIONREQUEST = _descriptor.Descriptor(
+  name='LoadConditionRequest',
+  full_name='koapy.backend.kiwoom_open_api_plus.grpc.LoadConditionRequest',
+  filename=None,
+  file=DESCRIPTOR,
+  containing_type=None,
+  create_key=_descriptor._internal_create_key,
+  fields=[
+  ],
+  extensions=[
+  ],
+  nested_types=[],
+  enum_types=[
+  ],
+  serialized_options=None,
+  is_extendable=False,
+  syntax='proto3',
+  extension_ranges=[],
+  oneofs=[
+  ],
+  serialized_start=3273,
+  serialized_end=3295,
+)
+
+
+_CONDITIONREQUESTFLAGS = _descriptor.Descriptor(
+  name='ConditionRequestFlags',
+  full_name='koapy.backend.kiwoom_open_api_plus.grpc.ConditionRequestFlags',
+  filename=None,
+  file=DESCRIPTOR,
+  containing_type=None,
+  create_key=_descriptor._internal_create_key,
+  fields=[
+    _descriptor.FieldDescriptor(
+      name='with_info', full_name='koapy.backend.kiwoom_open_api_plus.grpc.ConditionRequestFlags.with_info', index=0,
+      number=1, type=8, cpp_type=7, label=1,
+      has_default_value=False, default_value=False,
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+    _descriptor.FieldDescriptor(
+      name='is_future_option', full_name='koapy.backend.kiwoom_open_api_plus.grpc.ConditionRequestFlags.is_future_option', index=1,
+      number=2, type=8, cpp_type=7, label=1,
+      has_default_value=False, default_value=False,
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+  ],
+  extensions=[
+  ],
+  nested_types=[],
+  enum_types=[
+  ],
+  serialized_options=None,
+  is_extendable=False,
+  syntax='proto3',
+  extension_ranges=[],
+  oneofs=[
+  ],
+  serialized_start=3297,
+  serialized_end=3365,
+)
+
+
+_CONDITIONREQUEST = _descriptor.Descriptor(
+  name='ConditionRequest',
+  full_name='koapy.backend.kiwoom_open_api_plus.grpc.ConditionRequest',
+  filename=None,
+  file=DESCRIPTOR,
+  containing_type=None,
+  create_key=_descriptor._internal_create_key,
+  fields=[
+    _descriptor.FieldDescriptor(
+      name='screen_no', full_name='koapy.backend.kiwoom_open_api_plus.grpc.ConditionRequest.screen_no', index=0,
+      number=1, type=9, cpp_type=9, label=1,
+      has_default_value=False, default_value=b"".decode('utf-8'),
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+    _descriptor.FieldDescriptor(
+      name='condition_name', full_name='koapy.backend.kiwoom_open_api_plus.grpc.ConditionRequest.condition_name', index=1,
+      number=2, type=9, cpp_type=9, label=1,
+      has_default_value=False, default_value=b"".decode('utf-8'),
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+    _descriptor.FieldDescriptor(
+      name='condition_index', full_name='koapy.backend.kiwoom_open_api_plus.grpc.ConditionRequest.condition_index', index=2,
+      number=3, type=5, cpp_type=1, label=1,
+      has_default_value=False, default_value=0,
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+    _descriptor.FieldDescriptor(
+      name='search_type', full_name='koapy.backend.kiwoom_open_api_plus.grpc.ConditionRequest.search_type', index=3,
+      number=4, type=5, cpp_type=1, label=1,
+      has_default_value=False, default_value=0,
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+    _descriptor.FieldDescriptor(
+      name='request_name', full_name='koapy.backend.kiwoom_open_api_plus.grpc.ConditionRequest.request_name', index=4,
+      number=5, type=9, cpp_type=9, label=1,
+      has_default_value=False, default_value=b"".decode('utf-8'),
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+    _descriptor.FieldDescriptor(
+      name='flags', full_name='koapy.backend.kiwoom_open_api_plus.grpc.ConditionRequest.flags', index=5,
+      number=6, type=11, cpp_type=10, label=1,
+      has_default_value=False, default_value=None,
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+  ],
+  extensions=[
+  ],
+  nested_types=[],
+  enum_types=[
+  ],
+  serialized_options=None,
+  is_extendable=False,
+  syntax='proto3',
+  extension_ranges=[],
+  oneofs=[
+  ],
+  serialized_start=3368,
+  serialized_end=3576,
+)
+
+
+_SETLOGLEVELREQUEST = _descriptor.Descriptor(
+  name='SetLogLevelRequest',
+  full_name='koapy.backend.kiwoom_open_api_plus.grpc.SetLogLevelRequest',
+  filename=None,
+  file=DESCRIPTOR,
+  containing_type=None,
+  create_key=_descriptor._internal_create_key,
+  fields=[
+    _descriptor.FieldDescriptor(
+      name='level', full_name='koapy.backend.kiwoom_open_api_plus.grpc.SetLogLevelRequest.level', index=0,
+      number=1, type=5, cpp_type=1, label=1,
+      has_default_value=False, default_value=0,
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+    _descriptor.FieldDescriptor(
+      name='logger', full_name='koapy.backend.kiwoom_open_api_plus.grpc.SetLogLevelRequest.logger', index=1,
+      number=2, type=9, cpp_type=9, label=1,
+      has_default_value=False, default_value=b"".decode('utf-8'),
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+  ],
+  extensions=[
+  ],
+  nested_types=[],
+  enum_types=[
+  ],
+  serialized_options=None,
+  is_extendable=False,
+  syntax='proto3',
+  extension_ranges=[],
+  oneofs=[
+  ],
+  serialized_start=3578,
+  serialized_end=3629,
+)
+
+
+_SETLOGLEVELRESPONSE = _descriptor.Descriptor(
+  name='SetLogLevelResponse',
+  full_name='koapy.backend.kiwoom_open_api_plus.grpc.SetLogLevelResponse',
+  filename=None,
+  file=DESCRIPTOR,
+  containing_type=None,
+  create_key=_descriptor._internal_create_key,
+  fields=[
+  ],
+  extensions=[
+  ],
+  nested_types=[],
+  enum_types=[
+  ],
+  serialized_options=None,
+  is_extendable=False,
+  syntax='proto3',
+  extension_ranges=[],
+  oneofs=[
+  ],
+  serialized_start=3631,
+  serialized_end=3652,
+)
+
+
+_BIDIRECTIONALREALINITIALIZEREQUEST = _descriptor.Descriptor(
+  name='BidirectionalRealInitializeRequest',
+  full_name='koapy.backend.kiwoom_open_api_plus.grpc.BidirectionalRealInitializeRequest',
+  filename=None,
+  file=DESCRIPTOR,
+  containing_type=None,
+  create_key=_descriptor._internal_create_key,
+  fields=[
+    _descriptor.FieldDescriptor(
+      name='fid_list', full_name='koapy.backend.kiwoom_open_api_plus.grpc.BidirectionalRealInitializeRequest.fid_list', index=0,
+      number=1, type=5, cpp_type=1, label=3,
+      has_default_value=False, default_value=[],
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+    _descriptor.FieldDescriptor(
+      name='flags', full_name='koapy.backend.kiwoom_open_api_plus.grpc.BidirectionalRealInitializeRequest.flags', index=1,
+      number=2, type=11, cpp_type=10, label=1,
+      has_default_value=False, default_value=None,
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+  ],
+  extensions=[
+  ],
+  nested_types=[],
+  enum_types=[
+  ],
+  serialized_options=None,
+  is_extendable=False,
+  syntax='proto3',
+  extension_ranges=[],
+  oneofs=[
+  ],
+  serialized_start=3655,
+  serialized_end=3783,
+)
+
+
+_BIDIRECTIONALREALREGISTERREQUEST = _descriptor.Descriptor(
+  name='BidirectionalRealRegisterRequest',
+  full_name='koapy.backend.kiwoom_open_api_plus.grpc.BidirectionalRealRegisterRequest',
+  filename=None,
+  file=DESCRIPTOR,
+  containing_type=None,
+  create_key=_descriptor._internal_create_key,
+  fields=[
+    _descriptor.FieldDescriptor(
+      name='code_list', full_name='koapy.backend.kiwoom_open_api_plus.grpc.BidirectionalRealRegisterRequest.code_list', index=0,
+      number=1, type=9, cpp_type=9, label=3,
+      has_default_value=False, default_value=[],
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+    _descriptor.FieldDescriptor(
+      name='fid_list', full_name='koapy.backend.kiwoom_open_api_plus.grpc.BidirectionalRealRegisterRequest.fid_list', index=1,
+      number=2, type=5, cpp_type=1, label=3,
+      has_default_value=False, default_value=[],
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+  ],
+  extensions=[
+  ],
+  nested_types=[],
+  enum_types=[
+  ],
+  serialized_options=None,
+  is_extendable=False,
+  syntax='proto3',
+  extension_ranges=[],
+  oneofs=[
+  ],
+  serialized_start=3785,
+  serialized_end=3856,
+)
+
+
+_BIDIRECTIONALREALREMOVEREQUEST = _descriptor.Descriptor(
+  name='BidirectionalRealRemoveRequest',
+  full_name='koapy.backend.kiwoom_open_api_plus.grpc.BidirectionalRealRemoveRequest',
+  filename=None,
+  file=DESCRIPTOR,
+  containing_type=None,
+  create_key=_descriptor._internal_create_key,
+  fields=[
+    _descriptor.FieldDescriptor(
+      name='code_list', full_name='koapy.backend.kiwoom_open_api_plus.grpc.BidirectionalRealRemoveRequest.code_list', index=0,
+      number=1, type=9, cpp_type=9, label=3,
+      has_default_value=False, default_value=[],
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+  ],
+  extensions=[
+  ],
+  nested_types=[],
+  enum_types=[
+  ],
+  serialized_options=None,
+  is_extendable=False,
+  syntax='proto3',
+  extension_ranges=[],
+  oneofs=[
+  ],
+  serialized_start=3858,
+  serialized_end=3909,
+)
+
+
+_BIDIRECTIONALREALSTOPREQUEST = _descriptor.Descriptor(
+  name='BidirectionalRealStopRequest',
+  full_name='koapy.backend.kiwoom_open_api_plus.grpc.BidirectionalRealStopRequest',
+  filename=None,
+  file=DESCRIPTOR,
+  containing_type=None,
+  create_key=_descriptor._internal_create_key,
+  fields=[
+  ],
+  extensions=[
+  ],
+  nested_types=[],
+  enum_types=[
+  ],
+  serialized_options=None,
+  is_extendable=False,
+  syntax='proto3',
+  extension_ranges=[],
+  oneofs=[
+  ],
+  serialized_start=3911,
+  serialized_end=3941,
+)
+
+
+_BIDIRECTIONALREALREQUEST = _descriptor.Descriptor(
+  name='BidirectionalRealRequest',
+  full_name='koapy.backend.kiwoom_open_api_plus.grpc.BidirectionalRealRequest',
+  filename=None,
+  file=DESCRIPTOR,
+  containing_type=None,
+  create_key=_descriptor._internal_create_key,
+  fields=[
+    _descriptor.FieldDescriptor(
+      name='initialize_request', full_name='koapy.backend.kiwoom_open_api_plus.grpc.BidirectionalRealRequest.initialize_request', index=0,
+      number=1, type=11, cpp_type=10, label=1,
+      has_default_value=False, default_value=None,
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+    _descriptor.FieldDescriptor(
+      name='register_request', full_name='koapy.backend.kiwoom_open_api_plus.grpc.BidirectionalRealRequest.register_request', index=1,
+      number=2, type=11, cpp_type=10, label=1,
+      has_default_value=False, default_value=None,
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+    _descriptor.FieldDescriptor(
+      name='remove_request', full_name='koapy.backend.kiwoom_open_api_plus.grpc.BidirectionalRealRequest.remove_request', index=2,
+      number=3, type=11, cpp_type=10, label=1,
+      has_default_value=False, default_value=None,
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+    _descriptor.FieldDescriptor(
+      name='stop_request', full_name='koapy.backend.kiwoom_open_api_plus.grpc.BidirectionalRealRequest.stop_request', index=3,
+      number=4, type=11, cpp_type=10, label=1,
+      has_default_value=False, default_value=None,
+      message_type=None, enum_type=None, containing_type=None,
+      is_extension=False, extension_scope=None,
+      serialized_options=None, file=DESCRIPTOR,  create_key=_descriptor._internal_create_key),
+  ],
+  extensions=[
+  ],
+  nested_types=[],
+  enum_types=[
+  ],
+  serialized_options=None,
+  is_extendable=False,
+  syntax='proto3',
+  extension_ranges=[],
+  oneofs=[
+    _descriptor.OneofDescriptor(
+      name='request', full_name='koapy.backend.kiwoom_open_api_plus.grpc.BidirectionalRealRequest.request',
+      index=0, containing_type=None,
+      create_key=_descriptor._internal_create_key,
+    fields=[]),
+  ],
+  serialized_start=3944,
+  serialized_end=4385,
+)
+
+_ARGUMENT.oneofs_by_name['value'].fields.append(
+  _ARGUMENT.fields_by_name['string_value'])
+_ARGUMENT.fields_by_name['string_value'].containing_oneof = _ARGUMENT.oneofs_by_name['value']
+_ARGUMENT.oneofs_by_name['value'].fields.append(
+  _ARGUMENT.fields_by_name['long_value'])
+_ARGUMENT.fields_by_name['long_value'].containing_oneof = _ARGUMENT.oneofs_by_name['value']
+_ARGUMENT.oneofs_by_name['value'].fields.append(
+  _ARGUMENT.fields_by_name['bool_value'])
+_ARGUMENT.fields_by_name['bool_value'].containing_oneof = _ARGUMENT.oneofs_by_name['value']
+_CALLREQUEST.fields_by_name['arguments'].message_type = _ARGUMENT
+_RETURNVALUE.oneofs_by_name['value'].fields.append(
+  _RETURNVALUE.fields_by_name['string_value'])
+_RETURNVALUE.fields_by_name['string_value'].containing_oneof = _RETURNVALUE.oneofs_by_name['value']
+_RETURNVALUE.oneofs_by_name['value'].fields.append(
+  _RETURNVALUE.fields_by_name['long_value'])
+_RETURNVALUE.fields_by_name['long_value'].containing_oneof = _RETURNVALUE.oneofs_by_name['value']
+_RETURNVALUE.oneofs_by_name['value'].fields.append(
+  _RETURNVALUE.fields_by_name['bool_value'])
+_RETURNVALUE.fields_by_name['bool_value'].containing_oneof = _RETURNVALUE.oneofs_by_name['value']
+_CALLRESPONSE.fields_by_name['return_value'].message_type = _RETURNVALUE
+_BIDIRECTIONALLISTENREQUEST.fields_by_name['listen_request'].message_type = _LISTENREQUEST
+_BIDIRECTIONALLISTENREQUEST.fields_by_name['handled_request'].message_type = _HANDLEDREQUEST
+_BIDIRECTIONALLISTENREQUEST.fields_by_name['stop_listen_request'].message_type = _STOPLISTENREQUEST
+_BIDIRECTIONALLISTENREQUEST.oneofs_by_name['request'].fields.append(
+  _BIDIRECTIONALLISTENREQUEST.fields_by_name['listen_request'])
+_BIDIRECTIONALLISTENREQUEST.fields_by_name['listen_request'].containing_oneof = _BIDIRECTIONALLISTENREQUEST.oneofs_by_name['request']
+_BIDIRECTIONALLISTENREQUEST.oneofs_by_name['request'].fields.append(
+  _BIDIRECTIONALLISTENREQUEST.fields_by_name['handled_request'])
+_BIDIRECTIONALLISTENREQUEST.fields_by_name['handled_request'].containing_oneof = _BIDIRECTIONALLISTENREQUEST.oneofs_by_name['request']
+_BIDIRECTIONALLISTENREQUEST.oneofs_by_name['request'].fields.append(
+  _BIDIRECTIONALLISTENREQUEST.fields_by_name['stop_listen_request'])
+_BIDIRECTIONALLISTENREQUEST.fields_by_name['stop_listen_request'].containing_oneof = _BIDIRECTIONALLISTENREQUEST.oneofs_by_name['request']
+_MULTIDATA.fields_by_name['values'].message_type = _REPEATEDSTRING
+_LISTENRESPONSE.fields_by_name['arguments'].message_type = _ARGUMENT
+_LISTENRESPONSE.fields_by_name['single_data'].message_type = _SINGLEDATA
+_LISTENRESPONSE.fields_by_name['multi_data'].message_type = _MULTIDATA
+_CALLANDLISTENREQUEST.fields_by_name['call_request'].message_type = _CALLREQUEST
+_CALLANDLISTENREQUEST.fields_by_name['listen_request'].message_type = _LISTENREQUEST
+_CALLANDLISTENRESPONSE.fields_by_name['call_response'].message_type = _CALLRESPONSE
+_CALLANDLISTENRESPONSE.fields_by_name['listen_response'].message_type = _LISTENRESPONSE
+_CALLANDLISTENRESPONSE.oneofs_by_name['response'].fields.append(
+  _CALLANDLISTENRESPONSE.fields_by_name['call_response'])
+_CALLANDLISTENRESPONSE.fields_by_name['call_response'].containing_oneof = _CALLANDLISTENRESPONSE.oneofs_by_name['response']
+_CALLANDLISTENRESPONSE.oneofs_by_name['response'].fields.append(
+  _CALLANDLISTENRESPONSE.fields_by_name['listen_response'])
+_CALLANDLISTENRESPONSE.fields_by_name['listen_response'].containing_oneof = _CALLANDLISTENRESPONSE.oneofs_by_name['response']
+_LOGINCREDENTIALS_ACCOUNTPASSWORDSENTRY.containing_type = _LOGINCREDENTIALS
+_LOGINCREDENTIALS.fields_by_name['account_passwords'].message_type = _LOGINCREDENTIALS_ACCOUNTPASSWORDSENTRY
+_LOGINREQUEST.fields_by_name['credentials'].message_type = _LOGINCREDENTIALS
+_REALREQUEST.fields_by_name['flags'].message_type = _REALREQUESTFLAGS
+[docs]_TRANSACTIONSTOPCONDITION.fields_by_name['comparator'].enum_type = _TRANSACTIONSTOPCONDITIONCOMPARTOR
+[docs]_TRANSACTIONREQUEST_INPUTSENTRY.containing_type = _TRANSACTIONREQUEST
+_TRANSACTIONREQUEST.fields_by_name['inputs'].message_type = _TRANSACTIONREQUEST_INPUTSENTRY
+_TRANSACTIONREQUEST.fields_by_name['stop_condition'].message_type = _TRANSACTIONSTOPCONDITION
+_TRANSACTIONREQUEST.fields_by_name['flags'].message_type = _REALREQUESTFLAGS
+_ORDERREQUEST.fields_by_name['target'].message_type = _ORDERSUBSCRIPTIONTARGET
+_CONDITIONREQUEST.fields_by_name['flags'].message_type = _CONDITIONREQUESTFLAGS
+_BIDIRECTIONALREALINITIALIZEREQUEST.fields_by_name['flags'].message_type = _REALREQUESTFLAGS
+_BIDIRECTIONALREALREQUEST.fields_by_name['initialize_request'].message_type = _BIDIRECTIONALREALINITIALIZEREQUEST
+_BIDIRECTIONALREALREQUEST.fields_by_name['register_request'].message_type = _BIDIRECTIONALREALREGISTERREQUEST
+_BIDIRECTIONALREALREQUEST.fields_by_name['remove_request'].message_type = _BIDIRECTIONALREALREMOVEREQUEST
+[docs]_BIDIRECTIONALREALREQUEST.fields_by_name['stop_request'].message_type = _BIDIRECTIONALREALSTOPREQUEST
+_BIDIRECTIONALREALREQUEST.oneofs_by_name['request'].fields.append(
+  _BIDIRECTIONALREALREQUEST.fields_by_name['initialize_request'])
+_BIDIRECTIONALREALREQUEST.fields_by_name['initialize_request'].containing_oneof = _BIDIRECTIONALREALREQUEST.oneofs_by_name['request']
+_BIDIRECTIONALREALREQUEST.oneofs_by_name['request'].fields.append(
+  _BIDIRECTIONALREALREQUEST.fields_by_name['register_request'])
+_BIDIRECTIONALREALREQUEST.fields_by_name['register_request'].containing_oneof = _BIDIRECTIONALREALREQUEST.oneofs_by_name['request']
+_BIDIRECTIONALREALREQUEST.oneofs_by_name['request'].fields.append(
+  _BIDIRECTIONALREALREQUEST.fields_by_name['remove_request'])
+_BIDIRECTIONALREALREQUEST.fields_by_name['remove_request'].containing_oneof = _BIDIRECTIONALREALREQUEST.oneofs_by_name['request']
+_BIDIRECTIONALREALREQUEST.oneofs_by_name['request'].fields.append(
+  _BIDIRECTIONALREALREQUEST.fields_by_name['stop_request'])
+[docs]_BIDIRECTIONALREALREQUEST.fields_by_name['stop_request'].containing_oneof = _BIDIRECTIONALREALREQUEST.oneofs_by_name['request']
+DESCRIPTOR.message_types_by_name['Argument'] = _ARGUMENT
+DESCRIPTOR.message_types_by_name['CallRequest'] = _CALLREQUEST
+DESCRIPTOR.message_types_by_name['ReturnValue'] = _RETURNVALUE
+DESCRIPTOR.message_types_by_name['CallResponse'] = _CALLRESPONSE
+DESCRIPTOR.message_types_by_name['ListenRequest'] = _LISTENREQUEST
+DESCRIPTOR.message_types_by_name['HandledRequest'] = _HANDLEDREQUEST
+DESCRIPTOR.message_types_by_name['StopListenRequest'] = _STOPLISTENREQUEST
+DESCRIPTOR.message_types_by_name['BidirectionalListenRequest'] = _BIDIRECTIONALLISTENREQUEST
+DESCRIPTOR.message_types_by_name['SingleData'] = _SINGLEDATA
+DESCRIPTOR.message_types_by_name['RepeatedString'] = _REPEATEDSTRING
+DESCRIPTOR.message_types_by_name['MultiData'] = _MULTIDATA
+DESCRIPTOR.message_types_by_name['ListenResponse'] = _LISTENRESPONSE
+DESCRIPTOR.message_types_by_name['CallAndListenRequest'] = _CALLANDLISTENREQUEST
+DESCRIPTOR.message_types_by_name['CallAndListenResponse'] = _CALLANDLISTENRESPONSE
+DESCRIPTOR.message_types_by_name['LoginCredentials'] = _LOGINCREDENTIALS
+DESCRIPTOR.message_types_by_name['LoginRequest'] = _LOGINREQUEST
+DESCRIPTOR.message_types_by_name['RealRequestFlags'] = _REALREQUESTFLAGS
+DESCRIPTOR.message_types_by_name['RealRequest'] = _REALREQUEST
+DESCRIPTOR.message_types_by_name['TransactionStopCondition'] = _TRANSACTIONSTOPCONDITION
+DESCRIPTOR.message_types_by_name['TransactionRequest'] = _TRANSACTIONREQUEST
+DESCRIPTOR.message_types_by_name['OrderSubscriptionTarget'] = _ORDERSUBSCRIPTIONTARGET
+DESCRIPTOR.message_types_by_name['OrderRequest'] = _ORDERREQUEST
+DESCRIPTOR.message_types_by_name['LoadConditionRequest'] = _LOADCONDITIONREQUEST
+DESCRIPTOR.message_types_by_name['ConditionRequestFlags'] = _CONDITIONREQUESTFLAGS
+DESCRIPTOR.message_types_by_name['ConditionRequest'] = _CONDITIONREQUEST
+DESCRIPTOR.message_types_by_name['SetLogLevelRequest'] = _SETLOGLEVELREQUEST
+DESCRIPTOR.message_types_by_name['SetLogLevelResponse'] = _SETLOGLEVELRESPONSE
+DESCRIPTOR.message_types_by_name['BidirectionalRealInitializeRequest'] = _BIDIRECTIONALREALINITIALIZEREQUEST
+DESCRIPTOR.message_types_by_name['BidirectionalRealRegisterRequest'] = _BIDIRECTIONALREALREGISTERREQUEST
+DESCRIPTOR.message_types_by_name['BidirectionalRealRemoveRequest'] = _BIDIRECTIONALREALREMOVEREQUEST
+DESCRIPTOR.message_types_by_name['BidirectionalRealStopRequest'] = _BIDIRECTIONALREALSTOPREQUEST
+DESCRIPTOR.message_types_by_name['BidirectionalRealRequest'] = _BIDIRECTIONALREALREQUEST
+DESCRIPTOR.enum_types_by_name['TransactionStopConditionCompartor'] = _TRANSACTIONSTOPCONDITIONCOMPARTOR
+_sym_db.RegisterFileDescriptor(DESCRIPTOR)
+
+[docs]Argument = _reflection.GeneratedProtocolMessageType('Argument', (_message.Message,), {
+  'DESCRIPTOR' : _ARGUMENT,
+  '__module__' : 'koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService_pb2'
+  # @@protoc_insertion_point(class_scope:koapy.backend.kiwoom_open_api_plus.grpc.Argument)
+  })
+_sym_db.RegisterMessage(Argument)
+
+[docs]CallRequest = _reflection.GeneratedProtocolMessageType('CallRequest', (_message.Message,), {
+  'DESCRIPTOR' : _CALLREQUEST,
+  '__module__' : 'koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService_pb2'
+  # @@protoc_insertion_point(class_scope:koapy.backend.kiwoom_open_api_plus.grpc.CallRequest)
+  })
+_sym_db.RegisterMessage(CallRequest)
+
+[docs]ReturnValue = _reflection.GeneratedProtocolMessageType('ReturnValue', (_message.Message,), {
+  'DESCRIPTOR' : _RETURNVALUE,
+  '__module__' : 'koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService_pb2'
+  # @@protoc_insertion_point(class_scope:koapy.backend.kiwoom_open_api_plus.grpc.ReturnValue)
+  })
+_sym_db.RegisterMessage(ReturnValue)
+
+[docs]CallResponse = _reflection.GeneratedProtocolMessageType('CallResponse', (_message.Message,), {
+  'DESCRIPTOR' : _CALLRESPONSE,
+  '__module__' : 'koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService_pb2'
+  # @@protoc_insertion_point(class_scope:koapy.backend.kiwoom_open_api_plus.grpc.CallResponse)
+  })
+_sym_db.RegisterMessage(CallResponse)
+
+[docs]ListenRequest = _reflection.GeneratedProtocolMessageType('ListenRequest', (_message.Message,), {
+  'DESCRIPTOR' : _LISTENREQUEST,
+  '__module__' : 'koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService_pb2'
+  # @@protoc_insertion_point(class_scope:koapy.backend.kiwoom_open_api_plus.grpc.ListenRequest)
+  })
+_sym_db.RegisterMessage(ListenRequest)
+
+[docs]HandledRequest = _reflection.GeneratedProtocolMessageType('HandledRequest', (_message.Message,), {
+  'DESCRIPTOR' : _HANDLEDREQUEST,
+  '__module__' : 'koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService_pb2'
+  # @@protoc_insertion_point(class_scope:koapy.backend.kiwoom_open_api_plus.grpc.HandledRequest)
+  })
+_sym_db.RegisterMessage(HandledRequest)
+
+[docs]StopListenRequest = _reflection.GeneratedProtocolMessageType('StopListenRequest', (_message.Message,), {
+  'DESCRIPTOR' : _STOPLISTENREQUEST,
+  '__module__' : 'koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService_pb2'
+  # @@protoc_insertion_point(class_scope:koapy.backend.kiwoom_open_api_plus.grpc.StopListenRequest)
+  })
+_sym_db.RegisterMessage(StopListenRequest)
+
+[docs]BidirectionalListenRequest = _reflection.GeneratedProtocolMessageType('BidirectionalListenRequest', (_message.Message,), {
+  'DESCRIPTOR' : _BIDIRECTIONALLISTENREQUEST,
+  '__module__' : 'koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService_pb2'
+  # @@protoc_insertion_point(class_scope:koapy.backend.kiwoom_open_api_plus.grpc.BidirectionalListenRequest)
+  })
+_sym_db.RegisterMessage(BidirectionalListenRequest)
+
+[docs]SingleData = _reflection.GeneratedProtocolMessageType('SingleData', (_message.Message,), {
+  'DESCRIPTOR' : _SINGLEDATA,
+  '__module__' : 'koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService_pb2'
+  # @@protoc_insertion_point(class_scope:koapy.backend.kiwoom_open_api_plus.grpc.SingleData)
+  })
+_sym_db.RegisterMessage(SingleData)
+
+[docs]RepeatedString = _reflection.GeneratedProtocolMessageType('RepeatedString', (_message.Message,), {
+  'DESCRIPTOR' : _REPEATEDSTRING,
+  '__module__' : 'koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService_pb2'
+  # @@protoc_insertion_point(class_scope:koapy.backend.kiwoom_open_api_plus.grpc.RepeatedString)
+  })
+_sym_db.RegisterMessage(RepeatedString)
+
+[docs]MultiData = _reflection.GeneratedProtocolMessageType('MultiData', (_message.Message,), {
+  'DESCRIPTOR' : _MULTIDATA,
+  '__module__' : 'koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService_pb2'
+  # @@protoc_insertion_point(class_scope:koapy.backend.kiwoom_open_api_plus.grpc.MultiData)
+  })
+_sym_db.RegisterMessage(MultiData)
+
+[docs]ListenResponse = _reflection.GeneratedProtocolMessageType('ListenResponse', (_message.Message,), {
+  'DESCRIPTOR' : _LISTENRESPONSE,
+  '__module__' : 'koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService_pb2'
+  # @@protoc_insertion_point(class_scope:koapy.backend.kiwoom_open_api_plus.grpc.ListenResponse)
+  })
+_sym_db.RegisterMessage(ListenResponse)
+
+[docs]CallAndListenRequest = _reflection.GeneratedProtocolMessageType('CallAndListenRequest', (_message.Message,), {
+  'DESCRIPTOR' : _CALLANDLISTENREQUEST,
+  '__module__' : 'koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService_pb2'
+  # @@protoc_insertion_point(class_scope:koapy.backend.kiwoom_open_api_plus.grpc.CallAndListenRequest)
+  })
+_sym_db.RegisterMessage(CallAndListenRequest)
+
+[docs]CallAndListenResponse = _reflection.GeneratedProtocolMessageType('CallAndListenResponse', (_message.Message,), {
+  'DESCRIPTOR' : _CALLANDLISTENRESPONSE,
+  '__module__' : 'koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService_pb2'
+  # @@protoc_insertion_point(class_scope:koapy.backend.kiwoom_open_api_plus.grpc.CallAndListenResponse)
+  })
+_sym_db.RegisterMessage(CallAndListenResponse)
+
+[docs]LoginCredentials = _reflection.GeneratedProtocolMessageType('LoginCredentials', (_message.Message,), {
+
+  'AccountPasswordsEntry' : _reflection.GeneratedProtocolMessageType('AccountPasswordsEntry', (_message.Message,), {
+    'DESCRIPTOR' : _LOGINCREDENTIALS_ACCOUNTPASSWORDSENTRY,
+    '__module__' : 'koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService_pb2'
+    # @@protoc_insertion_point(class_scope:koapy.backend.kiwoom_open_api_plus.grpc.LoginCredentials.AccountPasswordsEntry)
+    })
+  ,
+  'DESCRIPTOR' : _LOGINCREDENTIALS,
+  '__module__' : 'koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService_pb2'
+  # @@protoc_insertion_point(class_scope:koapy.backend.kiwoom_open_api_plus.grpc.LoginCredentials)
+  })
+_sym_db.RegisterMessage(LoginCredentials)
+_sym_db.RegisterMessage(LoginCredentials.AccountPasswordsEntry)
+
+[docs]LoginRequest = _reflection.GeneratedProtocolMessageType('LoginRequest', (_message.Message,), {
+  'DESCRIPTOR' : _LOGINREQUEST,
+  '__module__' : 'koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService_pb2'
+  # @@protoc_insertion_point(class_scope:koapy.backend.kiwoom_open_api_plus.grpc.LoginRequest)
+  })
+_sym_db.RegisterMessage(LoginRequest)
+
+[docs]RealRequestFlags = _reflection.GeneratedProtocolMessageType('RealRequestFlags', (_message.Message,), {
+  'DESCRIPTOR' : _REALREQUESTFLAGS,
+  '__module__' : 'koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService_pb2'
+  # @@protoc_insertion_point(class_scope:koapy.backend.kiwoom_open_api_plus.grpc.RealRequestFlags)
+  })
+_sym_db.RegisterMessage(RealRequestFlags)
+
+[docs]RealRequest = _reflection.GeneratedProtocolMessageType('RealRequest', (_message.Message,), {
+  'DESCRIPTOR' : _REALREQUEST,
+  '__module__' : 'koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService_pb2'
+  # @@protoc_insertion_point(class_scope:koapy.backend.kiwoom_open_api_plus.grpc.RealRequest)
+  })
+_sym_db.RegisterMessage(RealRequest)
+
+[docs]TransactionStopCondition = _reflection.GeneratedProtocolMessageType('TransactionStopCondition', (_message.Message,), {
+  'DESCRIPTOR' : _TRANSACTIONSTOPCONDITION,
+  '__module__' : 'koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService_pb2'
+  # @@protoc_insertion_point(class_scope:koapy.backend.kiwoom_open_api_plus.grpc.TransactionStopCondition)
+  })
+_sym_db.RegisterMessage(TransactionStopCondition)
+
+[docs]TransactionRequest = _reflection.GeneratedProtocolMessageType('TransactionRequest', (_message.Message,), {
+
+  'InputsEntry' : _reflection.GeneratedProtocolMessageType('InputsEntry', (_message.Message,), {
+    'DESCRIPTOR' : _TRANSACTIONREQUEST_INPUTSENTRY,
+    '__module__' : 'koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService_pb2'
+    # @@protoc_insertion_point(class_scope:koapy.backend.kiwoom_open_api_plus.grpc.TransactionRequest.InputsEntry)
+    })
+  ,
+  'DESCRIPTOR' : _TRANSACTIONREQUEST,
+  '__module__' : 'koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService_pb2'
+  # @@protoc_insertion_point(class_scope:koapy.backend.kiwoom_open_api_plus.grpc.TransactionRequest)
+  })
+_sym_db.RegisterMessage(TransactionRequest)
+_sym_db.RegisterMessage(TransactionRequest.InputsEntry)
+
+[docs]OrderSubscriptionTarget = _reflection.GeneratedProtocolMessageType('OrderSubscriptionTarget', (_message.Message,), {
+  'DESCRIPTOR' : _ORDERSUBSCRIPTIONTARGET,
+  '__module__' : 'koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService_pb2'
+  # @@protoc_insertion_point(class_scope:koapy.backend.kiwoom_open_api_plus.grpc.OrderSubscriptionTarget)
+  })
+_sym_db.RegisterMessage(OrderSubscriptionTarget)
+
+[docs]OrderRequest = _reflection.GeneratedProtocolMessageType('OrderRequest', (_message.Message,), {
+  'DESCRIPTOR' : _ORDERREQUEST,
+  '__module__' : 'koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService_pb2'
+  # @@protoc_insertion_point(class_scope:koapy.backend.kiwoom_open_api_plus.grpc.OrderRequest)
+  })
+_sym_db.RegisterMessage(OrderRequest)
+
+[docs]LoadConditionRequest = _reflection.GeneratedProtocolMessageType('LoadConditionRequest', (_message.Message,), {
+  'DESCRIPTOR' : _LOADCONDITIONREQUEST,
+  '__module__' : 'koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService_pb2'
+  # @@protoc_insertion_point(class_scope:koapy.backend.kiwoom_open_api_plus.grpc.LoadConditionRequest)
+  })
+_sym_db.RegisterMessage(LoadConditionRequest)
+
+[docs]ConditionRequestFlags = _reflection.GeneratedProtocolMessageType('ConditionRequestFlags', (_message.Message,), {
+  'DESCRIPTOR' : _CONDITIONREQUESTFLAGS,
+  '__module__' : 'koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService_pb2'
+  # @@protoc_insertion_point(class_scope:koapy.backend.kiwoom_open_api_plus.grpc.ConditionRequestFlags)
+  })
+_sym_db.RegisterMessage(ConditionRequestFlags)
+
+[docs]ConditionRequest = _reflection.GeneratedProtocolMessageType('ConditionRequest', (_message.Message,), {
+  'DESCRIPTOR' : _CONDITIONREQUEST,
+  '__module__' : 'koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService_pb2'
+  # @@protoc_insertion_point(class_scope:koapy.backend.kiwoom_open_api_plus.grpc.ConditionRequest)
+  })
+_sym_db.RegisterMessage(ConditionRequest)
+
+[docs]SetLogLevelRequest = _reflection.GeneratedProtocolMessageType('SetLogLevelRequest', (_message.Message,), {
+  'DESCRIPTOR' : _SETLOGLEVELREQUEST,
+  '__module__' : 'koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService_pb2'
+  # @@protoc_insertion_point(class_scope:koapy.backend.kiwoom_open_api_plus.grpc.SetLogLevelRequest)
+  })
+_sym_db.RegisterMessage(SetLogLevelRequest)
+
+[docs]SetLogLevelResponse = _reflection.GeneratedProtocolMessageType('SetLogLevelResponse', (_message.Message,), {
+  'DESCRIPTOR' : _SETLOGLEVELRESPONSE,
+  '__module__' : 'koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService_pb2'
+  # @@protoc_insertion_point(class_scope:koapy.backend.kiwoom_open_api_plus.grpc.SetLogLevelResponse)
+  })
+_sym_db.RegisterMessage(SetLogLevelResponse)
+
+[docs]BidirectionalRealInitializeRequest = _reflection.GeneratedProtocolMessageType('BidirectionalRealInitializeRequest', (_message.Message,), {
+  'DESCRIPTOR' : _BIDIRECTIONALREALINITIALIZEREQUEST,
+  '__module__' : 'koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService_pb2'
+  # @@protoc_insertion_point(class_scope:koapy.backend.kiwoom_open_api_plus.grpc.BidirectionalRealInitializeRequest)
+  })
+_sym_db.RegisterMessage(BidirectionalRealInitializeRequest)
+
+[docs]BidirectionalRealRegisterRequest = _reflection.GeneratedProtocolMessageType('BidirectionalRealRegisterRequest', (_message.Message,), {
+  'DESCRIPTOR' : _BIDIRECTIONALREALREGISTERREQUEST,
+  '__module__' : 'koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService_pb2'
+  # @@protoc_insertion_point(class_scope:koapy.backend.kiwoom_open_api_plus.grpc.BidirectionalRealRegisterRequest)
+  })
+_sym_db.RegisterMessage(BidirectionalRealRegisterRequest)
+
+[docs]BidirectionalRealRemoveRequest = _reflection.GeneratedProtocolMessageType('BidirectionalRealRemoveRequest', (_message.Message,), {
+  'DESCRIPTOR' : _BIDIRECTIONALREALREMOVEREQUEST,
+  '__module__' : 'koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService_pb2'
+  # @@protoc_insertion_point(class_scope:koapy.backend.kiwoom_open_api_plus.grpc.BidirectionalRealRemoveRequest)
+  })
+_sym_db.RegisterMessage(BidirectionalRealRemoveRequest)
+
+[docs]BidirectionalRealStopRequest = _reflection.GeneratedProtocolMessageType('BidirectionalRealStopRequest', (_message.Message,), {
+  'DESCRIPTOR' : _BIDIRECTIONALREALSTOPREQUEST,
+  '__module__' : 'koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService_pb2'
+  # @@protoc_insertion_point(class_scope:koapy.backend.kiwoom_open_api_plus.grpc.BidirectionalRealStopRequest)
+  })
+_sym_db.RegisterMessage(BidirectionalRealStopRequest)
+
+[docs]BidirectionalRealRequest = _reflection.GeneratedProtocolMessageType('BidirectionalRealRequest', (_message.Message,), {
+  'DESCRIPTOR' : _BIDIRECTIONALREALREQUEST,
+  '__module__' : 'koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService_pb2'
+  # @@protoc_insertion_point(class_scope:koapy.backend.kiwoom_open_api_plus.grpc.BidirectionalRealRequest)
+  })
+_sym_db.RegisterMessage(BidirectionalRealRequest)
+
+
+_LOGINCREDENTIALS_ACCOUNTPASSWORDSENTRY._options = None
+_TRANSACTIONREQUEST_INPUTSENTRY._options = None
+
+_KIWOOMOPENAPIPLUSSERVICE = _descriptor.ServiceDescriptor(
+  name='KiwoomOpenApiPlusService',
+  full_name='koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService',
+  file=DESCRIPTOR,
+  index=0,
+  serialized_options=None,
+  create_key=_descriptor._internal_create_key,
+  serialized_start=4548,
+  serialized_end=6506,
+  methods=[
+  _descriptor.MethodDescriptor(
+    name='Call',
+    full_name='koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService.Call',
+    index=0,
+    containing_service=None,
+    input_type=_CALLREQUEST,
+    output_type=_CALLRESPONSE,
+    serialized_options=None,
+    create_key=_descriptor._internal_create_key,
+  ),
+  _descriptor.MethodDescriptor(
+    name='Listen',
+    full_name='koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService.Listen',
+    index=1,
+    containing_service=None,
+    input_type=_LISTENREQUEST,
+    output_type=_LISTENRESPONSE,
+    serialized_options=None,
+    create_key=_descriptor._internal_create_key,
+  ),
+  _descriptor.MethodDescriptor(
+    name='BidirectionalListen',
+    full_name='koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService.BidirectionalListen',
+    index=2,
+    containing_service=None,
+    input_type=_BIDIRECTIONALLISTENREQUEST,
+    output_type=_LISTENRESPONSE,
+    serialized_options=None,
+    create_key=_descriptor._internal_create_key,
+  ),
+  _descriptor.MethodDescriptor(
+    name='LoginCall',
+    full_name='koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService.LoginCall',
+    index=3,
+    containing_service=None,
+    input_type=_LOGINREQUEST,
+    output_type=_LISTENRESPONSE,
+    serialized_options=None,
+    create_key=_descriptor._internal_create_key,
+  ),
+  _descriptor.MethodDescriptor(
+    name='TransactionCall',
+    full_name='koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService.TransactionCall',
+    index=4,
+    containing_service=None,
+    input_type=_TRANSACTIONREQUEST,
+    output_type=_LISTENRESPONSE,
+    serialized_options=None,
+    create_key=_descriptor._internal_create_key,
+  ),
+  _descriptor.MethodDescriptor(
+    name='OrderCall',
+    full_name='koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService.OrderCall',
+    index=5,
+    containing_service=None,
+    input_type=_ORDERREQUEST,
+    output_type=_LISTENRESPONSE,
+    serialized_options=None,
+    create_key=_descriptor._internal_create_key,
+  ),
+  _descriptor.MethodDescriptor(
+    name='RealCall',
+    full_name='koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService.RealCall',
+    index=6,
+    containing_service=None,
+    input_type=_REALREQUEST,
+    output_type=_LISTENRESPONSE,
+    serialized_options=None,
+    create_key=_descriptor._internal_create_key,
+  ),
+  _descriptor.MethodDescriptor(
+    name='LoadConditionCall',
+    full_name='koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService.LoadConditionCall',
+    index=7,
+    containing_service=None,
+    input_type=_LOADCONDITIONREQUEST,
+    output_type=_LISTENRESPONSE,
+    serialized_options=None,
+    create_key=_descriptor._internal_create_key,
+  ),
+  _descriptor.MethodDescriptor(
+    name='ConditionCall',
+    full_name='koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService.ConditionCall',
+    index=8,
+    containing_service=None,
+    input_type=_CONDITIONREQUEST,
+    output_type=_LISTENRESPONSE,
+    serialized_options=None,
+    create_key=_descriptor._internal_create_key,
+  ),
+  _descriptor.MethodDescriptor(
+    name='BidirectionalRealCall',
+    full_name='koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService.BidirectionalRealCall',
+    index=9,
+    containing_service=None,
+    input_type=_BIDIRECTIONALREALREQUEST,
+    output_type=_LISTENRESPONSE,
+    serialized_options=None,
+    create_key=_descriptor._internal_create_key,
+  ),
+  _descriptor.MethodDescriptor(
+    name='OrderListen',
+    full_name='koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService.OrderListen',
+    index=10,
+    containing_service=None,
+    input_type=_LISTENREQUEST,
+    output_type=_LISTENRESPONSE,
+    serialized_options=None,
+    create_key=_descriptor._internal_create_key,
+  ),
+  _descriptor.MethodDescriptor(
+    name='CustomListen',
+    full_name='koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService.CustomListen',
+    index=11,
+    containing_service=None,
+    input_type=_LISTENREQUEST,
+    output_type=_LISTENRESPONSE,
+    serialized_options=None,
+    create_key=_descriptor._internal_create_key,
+  ),
+  _descriptor.MethodDescriptor(
+    name='CustomCallAndListen',
+    full_name='koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService.CustomCallAndListen',
+    index=12,
+    containing_service=None,
+    input_type=_CALLANDLISTENREQUEST,
+    output_type=_CALLANDLISTENRESPONSE,
+    serialized_options=None,
+    create_key=_descriptor._internal_create_key,
+  ),
+  _descriptor.MethodDescriptor(
+    name='SetLogLevel',
+    full_name='koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService.SetLogLevel',
+    index=13,
+    containing_service=None,
+    input_type=_SETLOGLEVELREQUEST,
+    output_type=_SETLOGLEVELRESPONSE,
+    serialized_options=None,
+    create_key=_descriptor._internal_create_key,
+  ),
+])
+_sym_db.RegisterServiceDescriptor(_KIWOOMOPENAPIPLUSSERVICE)
+
+DESCRIPTOR.services_by_name['KiwoomOpenApiPlusService'] = _KIWOOMOPENAPIPLUSSERVICE
+
+# @@protoc_insertion_point(module_scope)
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/kiwoom_open_api_plus/grpc/KiwoomOpenApiPlusService_pb2_grpc.html b/_modules/koapy/backend/kiwoom_open_api_plus/grpc/KiwoomOpenApiPlusService_pb2_grpc.html new file mode 100644 index 00000000..7f87a46a --- /dev/null +++ b/_modules/koapy/backend/kiwoom_open_api_plus/grpc/KiwoomOpenApiPlusService_pb2_grpc.html @@ -0,0 +1,690 @@ + + + + + + + + koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService_pb2_grpc — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService_pb2_grpc

+# Generated by the gRPC Python protocol compiler plugin. DO NOT EDIT!
+"""Client and server classes corresponding to protobuf-defined services."""
+import grpc
+
+from koapy.backend.kiwoom_open_api_plus.grpc import KiwoomOpenApiPlusService_pb2 as koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2
+
+
+[docs]class KiwoomOpenApiPlusServiceStub(object):
+    """Missing associated documentation comment in .proto file."""
+
+    def __init__(self, channel):
+        """Constructor.
+
+        Args:
+            channel: A grpc.Channel.
+        """
+        self.Call = channel.unary_unary(
+                '/koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService/Call',
+                request_serializer=koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.CallRequest.SerializeToString,
+                response_deserializer=koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.CallResponse.FromString,
+                )
+        self.Listen = channel.unary_stream(
+                '/koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService/Listen',
+                request_serializer=koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.ListenRequest.SerializeToString,
+                response_deserializer=koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.ListenResponse.FromString,
+                )
+        self.BidirectionalListen = channel.stream_stream(
+                '/koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService/BidirectionalListen',
+                request_serializer=koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.BidirectionalListenRequest.SerializeToString,
+                response_deserializer=koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.ListenResponse.FromString,
+                )
+        self.LoginCall = channel.unary_stream(
+                '/koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService/LoginCall',
+                request_serializer=koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.LoginRequest.SerializeToString,
+                response_deserializer=koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.ListenResponse.FromString,
+                )
+        self.TransactionCall = channel.unary_stream(
+                '/koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService/TransactionCall',
+                request_serializer=koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.TransactionRequest.SerializeToString,
+                response_deserializer=koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.ListenResponse.FromString,
+                )
+        self.OrderCall = channel.unary_stream(
+                '/koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService/OrderCall',
+                request_serializer=koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.OrderRequest.SerializeToString,
+                response_deserializer=koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.ListenResponse.FromString,
+                )
+        self.RealCall = channel.unary_stream(
+                '/koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService/RealCall',
+                request_serializer=koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.RealRequest.SerializeToString,
+                response_deserializer=koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.ListenResponse.FromString,
+                )
+        self.LoadConditionCall = channel.unary_stream(
+                '/koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService/LoadConditionCall',
+                request_serializer=koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.LoadConditionRequest.SerializeToString,
+                response_deserializer=koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.ListenResponse.FromString,
+                )
+        self.ConditionCall = channel.unary_stream(
+                '/koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService/ConditionCall',
+                request_serializer=koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.ConditionRequest.SerializeToString,
+                response_deserializer=koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.ListenResponse.FromString,
+                )
+        self.BidirectionalRealCall = channel.stream_stream(
+                '/koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService/BidirectionalRealCall',
+                request_serializer=koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.BidirectionalRealRequest.SerializeToString,
+                response_deserializer=koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.ListenResponse.FromString,
+                )
+        self.OrderListen = channel.unary_stream(
+                '/koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService/OrderListen',
+                request_serializer=koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.ListenRequest.SerializeToString,
+                response_deserializer=koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.ListenResponse.FromString,
+                )
+        self.CustomListen = channel.unary_stream(
+                '/koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService/CustomListen',
+                request_serializer=koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.ListenRequest.SerializeToString,
+                response_deserializer=koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.ListenResponse.FromString,
+                )
+        self.CustomCallAndListen = channel.unary_stream(
+                '/koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService/CustomCallAndListen',
+                request_serializer=koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.CallAndListenRequest.SerializeToString,
+                response_deserializer=koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.CallAndListenResponse.FromString,
+                )
+        self.SetLogLevel = channel.unary_unary(
+                '/koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService/SetLogLevel',
+                request_serializer=koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.SetLogLevelRequest.SerializeToString,
+                response_deserializer=koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.SetLogLevelResponse.FromString,
+                )
+
+
+[docs]class KiwoomOpenApiPlusServiceServicer(object):
+    """Missing associated documentation comment in .proto file."""
+
+[docs]    def Call(self, request, context):
+        """1. rpcs for general function calls
+
+        unary rpc for an arbitrary function call,
+        can invoke arbitrary function on the server side by giving its name and arguments,
+        currently only simple data types like str and int are supported for arguments and return values
+        """
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
+[docs]    def Listen(self, request, context):
+        """2. rpcs for listening and handling events
+
+        server streaming rpc usually for listening events,
+        server will simply send stream items to client whenever event that is being listened is triggered,
+        client can handle those events solely on its own on client side but there is no guarantee that it will be synced with the server,
+        which means that event handler on the server side will not wait for the client to finish handling each event
+        """
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
+[docs]    def BidirectionalListen(self, request_iterator, context):
+        """bidirectional streaming rpc usually for listening and handling events with proper callbacks,
+        server will send an stream item to client whenever an event is triggered and will wait for an client's ack,
+        so that following callbacks from the client can actually be processed inside the server's event handler context
+        """
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
+[docs]    def LoginCall(self, request, context):
+        """3. rpcs for simple use cases that can be categorized into serveral distinct usage patterns
+
+        server streaming rpc for login/connect scenario,
+        would invoke Connect() and wait for OnEventConnect() event to test its success
+        """
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
+[docs]    def TransactionCall(self, request, context):
+        """server streaming rpc for general transaction requests,
+        would invoke CommRqData() with several SetInputValue()s for a transaction request,
+        would wait for OnReceiveTrData() events,
+        would handle those events to gather results by invoking GetRepeatCnt() and GetCommData() inside,
+        might do additional CommRqData() and SetInputValue() inside event handler for possible consecutive lookups
+        """
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
+[docs]    def OrderCall(self, request, context):
+        """server streaming rpc for making orders (buy/sell + update/cancel),
+        would invoke SendOrder() for submitting an order,
+        would wait for OnReceiveTrData() and OnReceiveChejanData() events to track its progress
+        """
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
+[docs]    def RealCall(self, request, context):
+        """server streaming rpc for listening realtime data events,
+        certain transaction requests would also register some realtime data to be sent,
+        but usually would just call SetRealReg() to register desired realtime data to listen explicitly,
+        and would call SetRealRemove() to unregister them after done using,
+        would wait for OnReceiveRealData() events
+        """
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
+[docs]    def LoadConditionCall(self, request, context):
+        """server streaming rpc for loading condition settings for conditioned search,
+        would call GetConditionLoad() and wait for OnReceiveConditionVer() event to test its success
+        """
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
+[docs]    def ConditionCall(self, request, context):
+        """server streaming rpc for conditioned search (serching stocks with serveral conditions),
+        would call SendCondition() and wait for OnReceiveTrCondition() or OnReceiveRealCondition() based on its requested type
+        """
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
+[docs]    def BidirectionalRealCall(self, request_iterator, context):
+        """4. rpcs for more complex use cases based on the previously categorized simple cases above
+
+        bidirectional streaming rpc for listening realtime data events,
+        with capability of managing observation pool (what stocks, what fields to listen to) online,
+        those management requests would be sent over the client streaming line,
+        and ordinary realtime data events would be sent over the server streaming line
+        """
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
+[docs]    def OrderListen(self, request, context):
+        """server streaming rpc for just listening order events (without submiting any order request compared to the simple case),
+        this is one-sided streaming rpc (server streaming rpc) like Listen() rpc,
+        so server would just send stream items with no consideration on coordination with its client
+        """
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
+[docs]    def CustomListen(self, request, context):
+        """5. rpcs for customized usage scenario (when there is no proper predefined interface to utilize)
+
+        pretty much similar to server streaming Listen() rpc,
+        but event handler would be instantiated dynamically based on the code given through the request
+        """
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
+[docs]    def CustomCallAndListen(self, request, context):
+        """pretty much similar to server streaming XXXCall() rpcs (or even Call() rpc),
+        but event handler would be instantiated dynamically based on the code given through the request
+        """
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
+[docs]    def SetLogLevel(self, request, context):
+        """6. rpcs for other mics scenarios
+
+        would update log level of process that this grpc server lives
+        """
+        context.set_code(grpc.StatusCode.UNIMPLEMENTED)
+        context.set_details('Method not implemented!')
+        raise NotImplementedError('Method not implemented!')
+
+
+[docs]def add_KiwoomOpenApiPlusServiceServicer_to_server(servicer, server):
+    rpc_method_handlers = {
+            'Call': grpc.unary_unary_rpc_method_handler(
+                    servicer.Call,
+                    request_deserializer=koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.CallRequest.FromString,
+                    response_serializer=koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.CallResponse.SerializeToString,
+            ),
+            'Listen': grpc.unary_stream_rpc_method_handler(
+                    servicer.Listen,
+                    request_deserializer=koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.ListenRequest.FromString,
+                    response_serializer=koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.ListenResponse.SerializeToString,
+            ),
+            'BidirectionalListen': grpc.stream_stream_rpc_method_handler(
+                    servicer.BidirectionalListen,
+                    request_deserializer=koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.BidirectionalListenRequest.FromString,
+                    response_serializer=koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.ListenResponse.SerializeToString,
+            ),
+            'LoginCall': grpc.unary_stream_rpc_method_handler(
+                    servicer.LoginCall,
+                    request_deserializer=koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.LoginRequest.FromString,
+                    response_serializer=koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.ListenResponse.SerializeToString,
+            ),
+            'TransactionCall': grpc.unary_stream_rpc_method_handler(
+                    servicer.TransactionCall,
+                    request_deserializer=koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.TransactionRequest.FromString,
+                    response_serializer=koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.ListenResponse.SerializeToString,
+            ),
+            'OrderCall': grpc.unary_stream_rpc_method_handler(
+                    servicer.OrderCall,
+                    request_deserializer=koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.OrderRequest.FromString,
+                    response_serializer=koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.ListenResponse.SerializeToString,
+            ),
+            'RealCall': grpc.unary_stream_rpc_method_handler(
+                    servicer.RealCall,
+                    request_deserializer=koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.RealRequest.FromString,
+                    response_serializer=koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.ListenResponse.SerializeToString,
+            ),
+            'LoadConditionCall': grpc.unary_stream_rpc_method_handler(
+                    servicer.LoadConditionCall,
+                    request_deserializer=koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.LoadConditionRequest.FromString,
+                    response_serializer=koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.ListenResponse.SerializeToString,
+            ),
+            'ConditionCall': grpc.unary_stream_rpc_method_handler(
+                    servicer.ConditionCall,
+                    request_deserializer=koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.ConditionRequest.FromString,
+                    response_serializer=koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.ListenResponse.SerializeToString,
+            ),
+            'BidirectionalRealCall': grpc.stream_stream_rpc_method_handler(
+                    servicer.BidirectionalRealCall,
+                    request_deserializer=koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.BidirectionalRealRequest.FromString,
+                    response_serializer=koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.ListenResponse.SerializeToString,
+            ),
+            'OrderListen': grpc.unary_stream_rpc_method_handler(
+                    servicer.OrderListen,
+                    request_deserializer=koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.ListenRequest.FromString,
+                    response_serializer=koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.ListenResponse.SerializeToString,
+            ),
+            'CustomListen': grpc.unary_stream_rpc_method_handler(
+                    servicer.CustomListen,
+                    request_deserializer=koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.ListenRequest.FromString,
+                    response_serializer=koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.ListenResponse.SerializeToString,
+            ),
+            'CustomCallAndListen': grpc.unary_stream_rpc_method_handler(
+                    servicer.CustomCallAndListen,
+                    request_deserializer=koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.CallAndListenRequest.FromString,
+                    response_serializer=koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.CallAndListenResponse.SerializeToString,
+            ),
+            'SetLogLevel': grpc.unary_unary_rpc_method_handler(
+                    servicer.SetLogLevel,
+                    request_deserializer=koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.SetLogLevelRequest.FromString,
+                    response_serializer=koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.SetLogLevelResponse.SerializeToString,
+            ),
+    }
+    generic_handler = grpc.method_handlers_generic_handler(
+            'koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService', rpc_method_handlers)
+    server.add_generic_rpc_handlers((generic_handler,))
+
+
+ # This class is part of an EXPERIMENTAL API.
+[docs]class KiwoomOpenApiPlusService(object):
+    """Missing associated documentation comment in .proto file."""
+
+    @staticmethod
+[docs]    def Call(request,
+            target,
+            options=(),
+            channel_credentials=None,
+            call_credentials=None,
+            insecure=False,
+            compression=None,
+            wait_for_ready=None,
+            timeout=None,
+            metadata=None):
+        return grpc.experimental.unary_unary(request, target, '/koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService/Call',
+            koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.CallRequest.SerializeToString,
+            koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.CallResponse.FromString,
+            options, channel_credentials,
+            insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
+
+    @staticmethod
+[docs]    def Listen(request,
+            target,
+            options=(),
+            channel_credentials=None,
+            call_credentials=None,
+            insecure=False,
+            compression=None,
+            wait_for_ready=None,
+            timeout=None,
+            metadata=None):
+        return grpc.experimental.unary_stream(request, target, '/koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService/Listen',
+            koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.ListenRequest.SerializeToString,
+            koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.ListenResponse.FromString,
+            options, channel_credentials,
+            insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
+
+    @staticmethod
+[docs]    def BidirectionalListen(request_iterator,
+            target,
+            options=(),
+            channel_credentials=None,
+            call_credentials=None,
+            insecure=False,
+            compression=None,
+            wait_for_ready=None,
+            timeout=None,
+            metadata=None):
+        return grpc.experimental.stream_stream(request_iterator, target, '/koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService/BidirectionalListen',
+            koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.BidirectionalListenRequest.SerializeToString,
+            koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.ListenResponse.FromString,
+            options, channel_credentials,
+            insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
+
+    @staticmethod
+[docs]    def LoginCall(request,
+            target,
+            options=(),
+            channel_credentials=None,
+            call_credentials=None,
+            insecure=False,
+            compression=None,
+            wait_for_ready=None,
+            timeout=None,
+            metadata=None):
+        return grpc.experimental.unary_stream(request, target, '/koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService/LoginCall',
+            koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.LoginRequest.SerializeToString,
+            koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.ListenResponse.FromString,
+            options, channel_credentials,
+            insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
+
+    @staticmethod
+[docs]    def TransactionCall(request,
+            target,
+            options=(),
+            channel_credentials=None,
+            call_credentials=None,
+            insecure=False,
+            compression=None,
+            wait_for_ready=None,
+            timeout=None,
+            metadata=None):
+        return grpc.experimental.unary_stream(request, target, '/koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService/TransactionCall',
+            koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.TransactionRequest.SerializeToString,
+            koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.ListenResponse.FromString,
+            options, channel_credentials,
+            insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
+
+    @staticmethod
+[docs]    def OrderCall(request,
+            target,
+            options=(),
+            channel_credentials=None,
+            call_credentials=None,
+            insecure=False,
+            compression=None,
+            wait_for_ready=None,
+            timeout=None,
+            metadata=None):
+        return grpc.experimental.unary_stream(request, target, '/koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService/OrderCall',
+            koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.OrderRequest.SerializeToString,
+            koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.ListenResponse.FromString,
+            options, channel_credentials,
+            insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
+
+    @staticmethod
+[docs]    def RealCall(request,
+            target,
+            options=(),
+            channel_credentials=None,
+            call_credentials=None,
+            insecure=False,
+            compression=None,
+            wait_for_ready=None,
+            timeout=None,
+            metadata=None):
+        return grpc.experimental.unary_stream(request, target, '/koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService/RealCall',
+            koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.RealRequest.SerializeToString,
+            koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.ListenResponse.FromString,
+            options, channel_credentials,
+            insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
+
+    @staticmethod
+[docs]    def LoadConditionCall(request,
+            target,
+            options=(),
+            channel_credentials=None,
+            call_credentials=None,
+            insecure=False,
+            compression=None,
+            wait_for_ready=None,
+            timeout=None,
+            metadata=None):
+        return grpc.experimental.unary_stream(request, target, '/koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService/LoadConditionCall',
+            koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.LoadConditionRequest.SerializeToString,
+            koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.ListenResponse.FromString,
+            options, channel_credentials,
+            insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
+
+    @staticmethod
+[docs]    def ConditionCall(request,
+            target,
+            options=(),
+            channel_credentials=None,
+            call_credentials=None,
+            insecure=False,
+            compression=None,
+            wait_for_ready=None,
+            timeout=None,
+            metadata=None):
+        return grpc.experimental.unary_stream(request, target, '/koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService/ConditionCall',
+            koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.ConditionRequest.SerializeToString,
+            koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.ListenResponse.FromString,
+            options, channel_credentials,
+            insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
+
+    @staticmethod
+[docs]    def BidirectionalRealCall(request_iterator,
+            target,
+            options=(),
+            channel_credentials=None,
+            call_credentials=None,
+            insecure=False,
+            compression=None,
+            wait_for_ready=None,
+            timeout=None,
+            metadata=None):
+        return grpc.experimental.stream_stream(request_iterator, target, '/koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService/BidirectionalRealCall',
+            koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.BidirectionalRealRequest.SerializeToString,
+            koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.ListenResponse.FromString,
+            options, channel_credentials,
+            insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
+
+    @staticmethod
+[docs]    def OrderListen(request,
+            target,
+            options=(),
+            channel_credentials=None,
+            call_credentials=None,
+            insecure=False,
+            compression=None,
+            wait_for_ready=None,
+            timeout=None,
+            metadata=None):
+        return grpc.experimental.unary_stream(request, target, '/koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService/OrderListen',
+            koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.ListenRequest.SerializeToString,
+            koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.ListenResponse.FromString,
+            options, channel_credentials,
+            insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
+
+    @staticmethod
+[docs]    def CustomListen(request,
+            target,
+            options=(),
+            channel_credentials=None,
+            call_credentials=None,
+            insecure=False,
+            compression=None,
+            wait_for_ready=None,
+            timeout=None,
+            metadata=None):
+        return grpc.experimental.unary_stream(request, target, '/koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService/CustomListen',
+            koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.ListenRequest.SerializeToString,
+            koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.ListenResponse.FromString,
+            options, channel_credentials,
+            insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
+
+    @staticmethod
+[docs]    def CustomCallAndListen(request,
+            target,
+            options=(),
+            channel_credentials=None,
+            call_credentials=None,
+            insecure=False,
+            compression=None,
+            wait_for_ready=None,
+            timeout=None,
+            metadata=None):
+        return grpc.experimental.unary_stream(request, target, '/koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService/CustomCallAndListen',
+            koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.CallAndListenRequest.SerializeToString,
+            koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.CallAndListenResponse.FromString,
+            options, channel_credentials,
+            insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
+
+    @staticmethod
+[docs]    def SetLogLevel(request,
+            target,
+            options=(),
+            channel_credentials=None,
+            call_credentials=None,
+            insecure=False,
+            compression=None,
+            wait_for_ready=None,
+            timeout=None,
+            metadata=None):
+        return grpc.experimental.unary_unary(request, target, '/koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService/SetLogLevel',
+            koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.SetLogLevelRequest.SerializeToString,
+            koapy_dot_backend_dot_kiwoom__open__api__plus_dot_grpc_dot_KiwoomOpenApiPlusService__pb2.SetLogLevelResponse.FromString,
+            options, channel_credentials,
+            insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/kiwoom_open_api_plus/grpc/event/KiwoomOpenApiPlusConditionEventHandler.html b/_modules/koapy/backend/kiwoom_open_api_plus/grpc/event/KiwoomOpenApiPlusConditionEventHandler.html new file mode 100644 index 00000000..8a19e47e --- /dev/null +++ b/_modules/koapy/backend/kiwoom_open_api_plus/grpc/event/KiwoomOpenApiPlusConditionEventHandler.html @@ -0,0 +1,401 @@ + + + + + + + + koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusConditionEventHandler — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusConditionEventHandler

+from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusError import (
+    KiwoomOpenApiPlusError,
+)
+from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusTrInfo import (
+    KiwoomOpenApiPlusTrInfo,
+)
+from koapy.backend.kiwoom_open_api_plus.grpc import KiwoomOpenApiPlusService_pb2
+from koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusEventHandlerForGrpc import (
+    KiwoomOpenApiPlusEventHandlerForGrpc,
+)
+from koapy.backend.kiwoom_open_api_plus.utils.list_conversion import string_to_list
+from koapy.utils.logging.Logging import Logging
+
+
+[docs]class KiwoomOpenApiPlusConditionEventHandler(
+    KiwoomOpenApiPlusEventHandlerForGrpc, Logging
+):
+    def __init__(self, control, request, context, screen_manager):
+        super().__init__(control, context)
+        self._request = request
+        self._screen_manager = screen_manager
+
+        self._screen_no = request.screen_no
+        self._condition_name = request.condition_name
+        self._condition_index = request.condition_index
+        self._search_type = request.search_type
+
+        self._request_name = request.request_name or "관심종목정보요청"
+        self._with_info = request.flags.with_info
+        self._is_future_option = request.flags.is_future_option
+        self._type_flag = 3 if self._is_future_option else 0
+
+        self._trcode = {0: "OPTKWFID", 3: "OPTFOFID"}[self._type_flag]
+        self._trinfo = KiwoomOpenApiPlusTrInfo.get_trinfo_by_code(self._trcode)
+
+        if self._trinfo is None:
+            self.logger.error("Cannot find names for trcode %s", self._trinfo)
+
+        self._single_names = self._trinfo.get_single_output_names()
+        self._multi_names = self._trinfo.get_multi_output_names()
+
+[docs]    def on_enter(self):
+        self.control.EnsureConditionLoaded()
+        condition_names = self.control.GetConditionNameListAsList()
+        assert (self._condition_index, self._condition_name) in condition_names
+        self._screen_no = self._screen_manager.borrow_screen(self._screen_no)
+        self.add_callback(self._screen_manager.return_screen, self._screen_no)
+        self.add_callback(self.control.DisconnectRealData, self._screen_no)
+        self.add_callback(
+            self.control.SendConditionStop,
+            self._screen_no,
+            self._condition_name,
+            self._condition_index,
+        )
+        KiwoomOpenApiPlusError.try_or_raise_boolean(
+            self.control.RateLimitedSendCondition.async_call(
+                self._screen_no,
+                self._condition_name,
+                self._condition_index,
+                self._search_type,
+            ),
+            "Failed to send condition",
+            except_callback=self.observer.on_error,
+        )
+
+[docs]    def OnReceiveTrCondition(
+        self, scrnno, codelist, condition_name, condition_index, prevnext
+    ):
+        if (scrnno, condition_name, condition_index) == (
+            self._screen_no,
+            self._condition_name,
+            self._condition_index,
+        ):
+            response = KiwoomOpenApiPlusService_pb2.ListenResponse()
+            response.name = "OnReceiveTrCondition"  # pylint: disable=no-member
+            response.arguments.add().string_value = scrnno  # pylint: disable=no-member
+            response.arguments.add().string_value = (
+                codelist  # pylint: disable=no-member
+            )
+            response.arguments.add().string_value = (
+                condition_name  # pylint: disable=no-member
+            )
+            response.arguments.add().long_value = (
+                condition_index  # pylint: disable=no-member
+            )
+            response.arguments.add().long_value = prevnext  # pylint: disable=no-member
+
+            self.observer.on_next(response)  # pylint: disable=no-member
+
+            if self._with_info:
+                if "^" in codelist:
+                    items = string_to_list(codelist, sep=";")
+                    items = [string_to_list(item, sep="^") for item in items]
+                    items = [tuple(item) for item in items]
+                    codes = [item[0] for item in items]
+                else:
+                    codes = string_to_list(codelist, sep=";")
+                KiwoomOpenApiPlusError.try_or_raise(
+                    self.control.RateLimitedCommKwRqData.async_call(
+                        codelist,
+                        0,
+                        len(codes),
+                        self._type_flag,
+                        self._request_name,
+                        self._screen_no,
+                    ),
+                    except_callback=self.observer.on_error,
+                )
+
+            should_continue = str(prevnext) not in ["", "0"]
+            should_not_complete = (
+                self._search_type == 1 or self._with_info or should_continue
+            )
+            should_complete = not should_not_complete
+
+            if should_complete:
+                self.observer.on_completed()
+                return
+            elif should_continue:
+                try:
+                    raise KiwoomOpenApiPlusError("Should not reach here")
+                    self.control.RateLimitedSendCondition.async_call(
+                        self._screen_no,
+                        self._condition_name,
+                        self._condition_index,
+                        int(prevnext),
+                    )  # pylint: disable=unreachable
+                except KiwoomOpenApiPlusError as e:
+                    self.observer.on_error(e)
+                    return
+
+[docs]    def OnReceiveRealCondition(
+        self, code, condition_type, condition_name, condition_index
+    ):
+        if (condition_name, int(condition_index)) == (
+            self._condition_name,
+            self._condition_index,
+        ):
+            response = KiwoomOpenApiPlusService_pb2.ListenResponse()
+            response.name = "OnReceiveRealCondition"  # pylint: disable=no-member
+            response.arguments.add().string_value = code  # pylint: disable=no-member
+            response.arguments.add().string_value = (
+                condition_type  # pylint: disable=no-member
+            )
+            response.arguments.add().string_value = (
+                condition_name  # pylint: disable=no-member
+            )
+            response.arguments.add().string_value = (
+                condition_index  # pylint: disable=no-member
+            )
+
+            self.observer.on_next(response)  # pylint: disable=no-member
+
+            if self._with_info:
+                codelist = code
+                codes = [code]
+                KiwoomOpenApiPlusError.try_or_raise(
+                    self.control.RateLimitedCommKwRqData.async_call(
+                        codelist,
+                        0,
+                        len(codes),
+                        self._type_flag,
+                        self._request_name,
+                        self._screen_no,
+                    ),
+                    except_callback=self.observer.on_error,
+                )
+
+[docs]    def OnReceiveTrData(
+        self,
+        scrnno,
+        rqname,
+        trcode,
+        recordname,
+        prevnext,
+        _datalength,
+        _errorcode,
+        _message,
+        _splmmsg,
+    ):
+        if (scrnno, rqname) == (self._screen_no, self._request_name):
+            response = KiwoomOpenApiPlusService_pb2.ListenResponse()
+            response.name = "OnReceiveTrData"  # pylint: disable=no-member
+            response.arguments.add().string_value = scrnno  # pylint: disable=no-member
+            response.arguments.add().string_value = rqname  # pylint: disable=no-member
+            response.arguments.add().string_value = trcode  # pylint: disable=no-member
+            response.arguments.add().string_value = (
+                recordname  # pylint: disable=no-member
+            )
+            response.arguments.add().string_value = (
+                prevnext  # pylint: disable=no-member
+            )
+
+            should_continue = str(prevnext) not in ["", "0"]
+            should_not_complete = self._search_type == 1 or should_continue
+            should_complete = not should_not_complete
+
+            repeat_cnt = self.control.GetRepeatCnt(trcode, recordname)
+
+            assert trcode.upper() == self._trcode
+
+            if repeat_cnt > 0:
+                if len(self._multi_names) == 0:
+                    self.logger.warning(
+                        "Repeat count greater than 0, but no multi data names available, fallback to sigle data names"
+                    )
+                    multi_names = self._multi_names
+                    self._multi_names = self._single_names
+                    self._single_name = multi_names
+                if len(self._multi_names) > 0:
+                    rows = [
+                        [
+                            self.control.GetCommData(
+                                trcode, recordname, i, name
+                            ).strip()
+                            for name in self._multi_names
+                        ]
+                        for i in range(repeat_cnt)
+                    ]
+                    response.multi_data.names.extend(
+                        self._multi_names
+                    )  # pylint: disable=no-member
+                    for row in rows:
+                        response.multi_data.values.add().values.extend(
+                            row
+                        )  # pylint: disable=no-member
+
+            if len(self._single_names) > 0:
+                values = [
+                    self.control.GetCommData(trcode, recordname, 0, name).strip()
+                    for name in self._single_names
+                ]
+                response.single_data.names.extend(
+                    self._single_names
+                )  # pylint: disable=no-member
+                response.single_data.values.extend(values)  # pylint: disable=no-member
+
+            self.observer.on_next(response)  # pylint: disable=no-member
+
+            if should_complete:
+                self.observer.on_completed()
+                return
+            elif should_continue:
+                try:
+                    raise KiwoomOpenApiPlusError("Should not reach here")
+                    KiwoomOpenApiPlusError.try_or_raise(
+                        self.control.RateLimitedCommKwRqData.async_call(
+                            self._codelist,
+                            int(prevnext),
+                            len(self._codes),
+                            3 if self._is_future_option else 0,
+                            self._request_name,
+                            self._screen_no,
+                        ),
+                        except_callback=self.observer.on_error,
+                    )  # pylint: disable=unreachable
+                except KiwoomOpenApiPlusError as e:
+                    self.observer.on_error(e)
+                    return
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/kiwoom_open_api_plus/grpc/event/KiwoomOpenApiPlusEventHandlerForGrpc.html b/_modules/koapy/backend/kiwoom_open_api_plus/grpc/event/KiwoomOpenApiPlusEventHandlerForGrpc.html new file mode 100644 index 00000000..4fd662ac --- /dev/null +++ b/_modules/koapy/backend/kiwoom_open_api_plus/grpc/event/KiwoomOpenApiPlusEventHandlerForGrpc.html @@ -0,0 +1,159 @@ + + + + + + + + koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusEventHandlerForGrpc — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusEventHandlerForGrpc

+from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusEventHandler import (
+    KiwoomOpenApiPlusEventHandler,
+)
+
+
+[docs]class KiwoomOpenApiPlusEventHandlerForGrpc(
+    KiwoomOpenApiPlusEventHandler
+):  # pylint: disable=abstract-method
+    def __init__(self, control, context):
+        super().__init__(control)
+
+        self._context = context
+        self._context.add_callback(self.stop)
+
+    @property
+[docs]    def context(self):
+        return self._context
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/kiwoom_open_api_plus/grpc/event/KiwoomOpenApiPlusEventHandlers.html b/_modules/koapy/backend/kiwoom_open_api_plus/grpc/event/KiwoomOpenApiPlusEventHandlers.html new file mode 100644 index 00000000..a4dab37c --- /dev/null +++ b/_modules/koapy/backend/kiwoom_open_api_plus/grpc/event/KiwoomOpenApiPlusEventHandlers.html @@ -0,0 +1,536 @@ + + + + + + + + koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusEventHandlers — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusEventHandlers

+from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusError import (
+    KiwoomOpenApiPlusError,
+)
+from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusRealType import (
+    KiwoomOpenApiPlusRealType,
+)
+from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusTrInfo import (
+    KiwoomOpenApiPlusTrInfo,
+)
+from koapy.backend.kiwoom_open_api_plus.grpc import KiwoomOpenApiPlusService_pb2
+from koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusEventHandlerForGrpc import (
+    KiwoomOpenApiPlusEventHandlerForGrpc,
+)
+from koapy.utils.logging.Logging import Logging
+from koapy.utils.notimplemented import isimplemented
+
+
+[docs]class KiwoomOpenApiPlusLazyAllEventHandler(
+    KiwoomOpenApiPlusEventHandlerForGrpc, Logging
+):
+[docs]    def OnReceiveTrData(
+        self,
+        scrnno,
+        rqname,
+        trcode,
+        recordname,
+        prevnext,
+        _datalength,
+        _errorcode,
+        _message,
+        _splmmsg,
+    ):
+        response = KiwoomOpenApiPlusService_pb2.ListenResponse()
+        response.name = "OnReceiveTrData"  # pylint: disable=no-member
+        response.arguments.add().string_value = scrnno  # pylint: disable=no-member
+        response.arguments.add().string_value = rqname  # pylint: disable=no-member
+        response.arguments.add().string_value = trcode  # pylint: disable=no-member
+        response.arguments.add().string_value = recordname  # pylint: disable=no-member
+        response.arguments.add().string_value = prevnext  # pylint: disable=no-member
+        self.observer.on_next(response)
+
+[docs]    def OnReceiveRealData(self, code, realtype, realdata):
+        response = KiwoomOpenApiPlusService_pb2.ListenResponse()
+        response.name = "OnReceiveRealData"  # pylint: disable=no-member
+        response.arguments.add().string_value = code  # pylint: disable=no-member
+        response.arguments.add().string_value = realtype  # pylint: disable=no-member
+        response.arguments.add().string_value = realdata  # pylint: disable=no-member
+        self.observer.on_next(response)
+
+[docs]    def OnReceiveMsg(self, scrnno, rqname, trcode, msg):
+        response = KiwoomOpenApiPlusService_pb2.ListenResponse()
+        response.name = "OnReceiveMsg"  # pylint: disable=no-member
+        response.arguments.add().string_value = scrnno  # pylint: disable=no-member
+        response.arguments.add().string_value = rqname  # pylint: disable=no-member
+        response.arguments.add().string_value = trcode  # pylint: disable=no-member
+        response.arguments.add().string_value = msg  # pylint: disable=no-member
+        self.observer.on_next(response)
+
+[docs]    def OnReceiveChejanData(self, gubun, itemcnt, fidlist):
+        response = KiwoomOpenApiPlusService_pb2.ListenResponse()
+        response.name = "OnReceiveChejanData"  # pylint: disable=no-member
+        response.arguments.add().string_value = gubun  # pylint: disable=no-member
+        response.arguments.add().long_value = itemcnt  # pylint: disable=no-member
+        response.arguments.add().string_value = fidlist  # pylint: disable=no-member
+        self.observer.on_next(response)
+
+[docs]    def OnEventConnect(self, errcode):
+        response = KiwoomOpenApiPlusService_pb2.ListenResponse()
+        response.name = "OnEventConnect"  # pylint: disable=no-member
+        response.arguments.add().long_value = errcode  # pylint: disable=no-member
+        self.observer.on_next(response)
+
+[docs]    def OnReceiveRealCondition(
+        self, code, condition_type, condition_name, condition_index
+    ):
+        response = KiwoomOpenApiPlusService_pb2.ListenResponse()
+        response.name = "OnReceiveRealCondition"  # pylint: disable=no-member
+        response.arguments.add().string_value = code  # pylint: disable=no-member
+        response.arguments.add().string_value = (
+            condition_type  # pylint: disable=no-member
+        )
+        response.arguments.add().string_value = (
+            condition_name  # pylint: disable=no-member
+        )
+        response.arguments.add().string_value = (
+            condition_index  # pylint: disable=no-member
+        )
+        self.observer.on_next(response)
+
+[docs]    def OnReceiveTrCondition(
+        self, scrnno, codelist, condition_name, condition_index, prevnext
+    ):
+        response = KiwoomOpenApiPlusService_pb2.ListenResponse()
+        response.name = "OnReceiveTrCondition"  # pylint: disable=no-member
+        response.arguments.add().string_value = scrnno  # pylint: disable=no-member
+        response.arguments.add().string_value = codelist  # pylint: disable=no-member
+        response.arguments.add().string_value = (
+            condition_name  # pylint: disable=no-member
+        )
+        response.arguments.add().long_value = (
+            condition_index  # pylint: disable=no-member
+        )
+        response.arguments.add().long_value = prevnext  # pylint: disable=no-member
+        self.observer.on_next(response)
+
+[docs]    def OnReceiveConditionVer(self, ret, msg):
+        response = KiwoomOpenApiPlusService_pb2.ListenResponse()
+        response.name = "OnReceiveConditionVer"  # pylint: disable=no-member
+        response.arguments.add().long_value = ret  # pylint: disable=no-member
+        response.arguments.add().string_value = msg  # pylint: disable=no-member
+        self.observer.on_next(response)
+
+
+[docs]class KiwoomOpenApiPlusEagerAllEventHandler(
+    KiwoomOpenApiPlusEventHandlerForGrpc, Logging
+):
+[docs]    def OnReceiveTrData(
+        self,
+        scrnno,
+        rqname,
+        trcode,
+        recordname,
+        prevnext,
+        _datalength,
+        _errorcode,
+        _message,
+        _splmmsg,
+    ):
+        response = KiwoomOpenApiPlusService_pb2.ListenResponse()
+        response.name = "OnReceiveTrData"  # pylint: disable=no-member
+        response.arguments.add().string_value = scrnno  # pylint: disable=no-member
+        response.arguments.add().string_value = rqname  # pylint: disable=no-member
+        response.arguments.add().string_value = trcode  # pylint: disable=no-member
+        response.arguments.add().string_value = recordname  # pylint: disable=no-member
+        response.arguments.add().string_value = prevnext  # pylint: disable=no-member
+
+        repeat_cnt = self.control.GetRepeatCnt(trcode, recordname)
+
+        trinfo = KiwoomOpenApiPlusTrInfo.get_trinfo_by_code(trcode)
+
+        if trinfo is None:
+            self.logger.error("Cannot find names for trcode %s", trinfo)
+
+        single_names = trinfo.get_single_output_names()
+        multi_names = trinfo.get_multi_output_names()
+
+        if len(single_names) > 0:
+            values = [
+                self.control.GetCommData(trcode, recordname, 0, name).strip()
+                for name in single_names
+            ]
+            response.single_data.names.extend(single_names)  # pylint: disable=no-member
+            response.single_data.values.extend(values)  # pylint: disable=no-member
+
+        if repeat_cnt > 0 and len(multi_names) > 0:
+            rows = [
+                [
+                    self.control.GetCommData(trcode, recordname, i, name).strip()
+                    for name in multi_names
+                ]
+                for i in range(repeat_cnt)
+            ]
+            response.multi_data.names.extend(multi_names)  # pylint: disable=no-member
+            for row in rows:
+                response.multi_data.values.add().values.extend(
+                    row
+                )  # pylint: disable=no-member
+
+        self.observer.on_next(response)
+
+[docs]    def OnReceiveRealData(self, code, realtype, realdata):
+        response = KiwoomOpenApiPlusService_pb2.ListenResponse()
+        response.name = "OnReceiveRealData"  # pylint: disable=no-member
+        response.arguments.add().string_value = code  # pylint: disable=no-member
+        response.arguments.add().string_value = realtype  # pylint: disable=no-member
+        response.arguments.add().string_value = realdata  # pylint: disable=no-member
+
+        fids = KiwoomOpenApiPlusRealType.get_fids_by_realtype_name(realtype)
+
+        if fids is None:
+            self.logger.error("Cannot find fids for realtype %s", realtype)
+
+        names = [
+            KiwoomOpenApiPlusRealType.Fid.get_name_by_fid(fid, str(fid)) for fid in fids
+        ]
+        values = [self.control.GetCommRealData(code, fid) for fid in fids]
+
+        assert len(names) == len(values)
+
+        response.single_data.names.extend(names)  # pylint: disable=no-member
+        response.single_data.values.extend(values)  # pylint: disable=no-member
+
+        self.observer.on_next(response)
+
+[docs]    def OnReceiveMsg(self, scrnno, rqname, trcode, msg):
+        response = KiwoomOpenApiPlusService_pb2.ListenResponse()
+        response.name = "OnReceiveMsg"  # pylint: disable=no-member
+        response.arguments.add().string_value = scrnno  # pylint: disable=no-member
+        response.arguments.add().string_value = rqname  # pylint: disable=no-member
+        response.arguments.add().string_value = trcode  # pylint: disable=no-member
+        response.arguments.add().string_value = msg  # pylint: disable=no-member
+        self.observer.on_next(response)
+
+[docs]    def OnReceiveChejanData(self, gubun, itemcnt, fidlist):
+        response = KiwoomOpenApiPlusService_pb2.ListenResponse()
+        response.name = "OnReceiveChejanData"  # pylint: disable=no-member
+        response.arguments.add().string_value = gubun  # pylint: disable=no-member
+        response.arguments.add().long_value = itemcnt  # pylint: disable=no-member
+        response.arguments.add().string_value = fidlist  # pylint: disable=no-member
+
+        fids = fidlist.rstrip(";")
+        fids = fids.split(";") if fids else []
+        fids = [int(fid) for fid in fids]
+
+        assert itemcnt == len(fids)
+
+        names = [
+            KiwoomOpenApiPlusRealType.Fid.get_name_by_fid(fid, str(fid)) for fid in fids
+        ]
+        values = [self.control.GetChejanData(fid).strip() for fid in fids]
+
+        response.single_data.names.extend(names)  # pylint: disable=no-member
+        response.single_data.values.extend(values)  # pylint: disable=no-member
+
+        self.observer.on_next(response)
+
+[docs]    def OnEventConnect(self, errcode):
+        response = KiwoomOpenApiPlusService_pb2.ListenResponse()
+        response.name = "OnEventConnect"  # pylint: disable=no-member
+        response.arguments.add().long_value = errcode  # pylint: disable=no-member
+        self.observer.on_next(response)
+
+[docs]    def OnReceiveRealCondition(
+        self, code, condition_type, condition_name, condition_index
+    ):
+        response = KiwoomOpenApiPlusService_pb2.ListenResponse()
+        response.name = "OnReceiveRealCondition"  # pylint: disable=no-member
+        response.arguments.add().string_value = code  # pylint: disable=no-member
+        response.arguments.add().string_value = (
+            condition_type  # pylint: disable=no-member
+        )
+        response.arguments.add().string_value = (
+            condition_name  # pylint: disable=no-member
+        )
+        response.arguments.add().string_value = (
+            condition_index  # pylint: disable=no-member
+        )
+        self.observer.on_next(response)
+
+[docs]    def OnReceiveTrCondition(
+        self, scrnno, codelist, condition_name, condition_index, prevnext
+    ):
+        response = KiwoomOpenApiPlusService_pb2.ListenResponse()
+        response.name = "OnReceiveTrCondition"  # pylint: disable=no-member
+        response.arguments.add().string_value = scrnno  # pylint: disable=no-member
+        response.arguments.add().string_value = codelist  # pylint: disable=no-member
+        response.arguments.add().string_value = (
+            condition_name  # pylint: disable=no-member
+        )
+        response.arguments.add().long_value = (
+            condition_index  # pylint: disable=no-member
+        )
+        response.arguments.add().long_value = prevnext  # pylint: disable=no-member
+        self.observer.on_next(response)
+
+[docs]    def OnReceiveConditionVer(self, ret, msg):
+        response = KiwoomOpenApiPlusService_pb2.ListenResponse()
+        response.name = "OnReceiveConditionVer"  # pylint: disable=no-member
+        response.arguments.add().long_value = ret  # pylint: disable=no-member
+        response.arguments.add().string_value = msg  # pylint: disable=no-member
+        self.observer.on_next(response)
+
+
+[docs]class KiwoomOpenApiPlusAllEventHandler(KiwoomOpenApiPlusEagerAllEventHandler):
+
+    pass
+
+
+[docs]class KiwoomOpenApiPlusLazySomeEventHandler(KiwoomOpenApiPlusLazyAllEventHandler):
+    def __init__(self, control, request, context):
+        super().__init__(control, context)
+        self._request = request
+
+[docs]    def slots(self):
+        names = self.names()
+        slots = [getattr(self, name) for name in names]
+        names_and_slots_implemented = [
+            (name, slot)
+            for name, slot in zip(names, slots)
+            if isimplemented(slot) and name in self._request.slots
+        ]
+        return names_and_slots_implemented
+
+
+[docs]class KiwoomOpenApiPlusEagerSomeEventHandler(KiwoomOpenApiPlusEagerAllEventHandler):
+    def __init__(self, control, request, context):
+        super().__init__(control, context)
+        self._request = request
+
+[docs]    def slots(self):
+        names = self.names()
+        slots = [getattr(self, name) for name in names]
+        names_and_slots_implemented = [
+            (name, slot)
+            for name, slot in zip(names, slots)
+            if isimplemented(slot) and name in self._request.slots
+        ]
+        return names_and_slots_implemented
+
+
+[docs]class KiwoomOpenApiPlusSomeEventHandler(KiwoomOpenApiPlusEagerSomeEventHandler):
+
+    pass
+
+
+[docs]class KiwoomOpenApiPlusSomeBidirectionalEventHandler(
+    KiwoomOpenApiPlusLazySomeEventHandler
+):
+    def __init__(self, control, request_iterator, context):
+        self._request_iterator = request_iterator
+        self._first_request = next(self._request_iterator)
+        assert self._first_request.HasField("listen_request")
+        self._request = request = self._first_request.listen_request
+        super().__init__(control, request, context)
+
+[docs]    def await_handled(self):
+        request = next(self._request_iterator)
+        if request.HasField("handled_request"):
+            pass
+        elif request.HasField("stop_listen_request"):
+            self.observer.on_completed()
+        else:
+            raise KiwoomOpenApiPlusError("Unexpected request")
+
+[docs]    def OnReceiveTrData(
+        self,
+        scrnno,
+        rqname,
+        trcode,
+        recordname,
+        prevnext,
+        _datalength,
+        _errorcode,
+        _message,
+        _splmmsg,
+    ):
+        super().OnReceiveTrData(
+            scrnno,
+            rqname,
+            trcode,
+            recordname,
+            prevnext,
+            _datalength,
+            _errorcode,
+            _message,
+            _splmmsg,
+        )
+        self.await_handled()
+
+[docs]    def OnReceiveRealData(self, code, realtype, realdata):
+        super().OnReceiveRealData(code, realtype, realdata)
+        self.await_handled()
+
+[docs]    def OnReceiveMsg(self, scrnno, rqname, trcode, msg):
+        super().OnReceiveMsg(scrnno, rqname, trcode, msg)
+        self.await_handled()
+
+[docs]    def OnReceiveChejanData(self, gubun, itemcnt, fidlist):
+        super().OnReceiveChejanData(gubun, itemcnt, fidlist)
+        self.await_handled()
+
+[docs]    def OnEventConnect(self, errcode):
+        super().OnEventConnect(errcode)
+        self.await_handled()
+
+[docs]    def OnReceiveRealCondition(
+        self, code, condition_type, condition_name, condition_index
+    ):
+        super().OnReceiveRealCondition(
+            code, condition_type, condition_name, condition_index
+        )
+        self.await_handled()
+
+[docs]    def OnReceiveTrCondition(
+        self, scrnno, codelist, condition_name, condition_index, prevnext
+    ):
+        super().OnReceiveTrCondition(
+            scrnno, codelist, condition_name, condition_index, prevnext
+        )
+        self.await_handled()
+
+[docs]    def OnReceiveConditionVer(self, ret, msg):
+        super().OnReceiveConditionVer(ret, msg)
+        self.await_handled()
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/kiwoom_open_api_plus/grpc/event/KiwoomOpenApiPlusKwTrEventHandler.html b/_modules/koapy/backend/kiwoom_open_api_plus/grpc/event/KiwoomOpenApiPlusKwTrEventHandler.html new file mode 100644 index 00000000..3c2ef6c6 --- /dev/null +++ b/_modules/koapy/backend/kiwoom_open_api_plus/grpc/event/KiwoomOpenApiPlusKwTrEventHandler.html @@ -0,0 +1,344 @@ + + + + + + + + koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusKwTrEventHandler — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusKwTrEventHandler

+import operator
+import re
+
+from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusError import (
+    KiwoomOpenApiPlusError,
+    KiwoomOpenApiPlusNegativeReturnCodeError,
+)
+from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusTrInfo import (
+    KiwoomOpenApiPlusTrInfo,
+)
+from koapy.backend.kiwoom_open_api_plus.grpc import KiwoomOpenApiPlusService_pb2
+from koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusEventHandlerForGrpc import (
+    KiwoomOpenApiPlusEventHandlerForGrpc,
+)
+from koapy.utils.itertools import chunk
+from koapy.utils.logging.Logging import Logging
+
+
+[docs]class KiwoomOpenApiPlusKwTrEventHandler(KiwoomOpenApiPlusEventHandlerForGrpc, Logging):
+
+    _num_codes_per_request = 100
+
+    def __init__(self, control, request, context, screen_manager):
+        super().__init__(control, context)
+        self._request = request
+        self._screen_manager = screen_manager
+
+        self._rqname = request.request_name
+        self._trcode = request.transaction_code.upper()
+        self._scrnno = request.screen_no
+        self._inputs = request.inputs
+
+        assert self._trcode in ["OPTKWFID", "OPTFOFID"]
+
+        self._type_flag = {"OPTKWFID": 0, "OPTFOFID": 3}[self._trcode]
+
+        self._trinfo = KiwoomOpenApiPlusTrInfo.get_trinfo_by_code(self._trcode)
+
+        if self._trinfo is None:
+            self.logger.error("Cannot find names for trcode %s", self._trinfo)
+
+        self._input_code = self._inputs.get("종목코드")
+
+        self._code_list = self._input_code.rstrip(";").split(";")
+        self._code_lists = [
+            codes for codes in chunk(self._code_list, self._num_codes_per_request)
+        ]
+        self._scrnnos = [None for _ in range(len(self._code_lists))]
+        self._scrnnos[0] = self._scrnno
+        self._scrnnos_completed = {}
+
+        self._single_names = self._trinfo.get_single_output_names()
+        self._multi_names = self._trinfo.get_multi_output_names()
+
+        stop_condition = request.stop_condition
+        stop_condition_is_valid = all(
+            [
+                stop_condition is not None,
+                stop_condition.name is not None,
+                len(stop_condition.name) > 0,
+                stop_condition.name in self._multi_names,
+            ]
+        )
+
+        if stop_condition_is_valid:
+            column_index_to_check = self._multi_names.index(stop_condition.name)
+            comparator = {
+                KiwoomOpenApiPlusService_pb2.TransactionStopConditionCompartor.LESS_THAN_OR_EQUAL_TO: operator.le,
+                KiwoomOpenApiPlusService_pb2.TransactionStopConditionCompartor.LESS_THAN: operator.lt,
+                KiwoomOpenApiPlusService_pb2.TransactionStopConditionCompartor.GREATER_THAN_OR_EQUAL_TO: operator.ge,
+                KiwoomOpenApiPlusService_pb2.TransactionStopConditionCompartor.GREATER_THAN: operator.gt,
+                KiwoomOpenApiPlusService_pb2.TransactionStopConditionCompartor.EQUAL_TO: operator.eq,
+                KiwoomOpenApiPlusService_pb2.TransactionStopConditionCompartor.NOT_EQUAL_TO: operator.ne,
+            }.get(stop_condition.comparator, operator.le)
+
+            def is_stop_condition(row):
+                return comparator(row[column_index_to_check], stop_condition.value)
+
+        else:
+
+            def is_stop_condition(_):
+                return False
+
+        self._is_stop_condition = is_stop_condition
+
+[docs]    def on_enter(self):
+        for i, scrnno in enumerate(self._scrnnos):
+            scrnno = self._screen_manager.borrow_screen(scrnno)
+            self._scrnnos[i] = scrnno
+            self._scrnnos_completed[scrnno] = False
+        for codes, scrnno in zip(self._code_lists, self._scrnnos):
+            self.add_callback(self._screen_manager.return_screen, scrnno)
+            self.add_callback(self.control.DisconnectRealData, scrnno)
+            KiwoomOpenApiPlusError.try_or_raise(
+                self.control.RateLimitedCommKwRqData.async_call(
+                    ";".join(codes),
+                    0,
+                    len(codes),
+                    self._type_flag,
+                    self._rqname,
+                    scrnno,
+                ),
+                except_callback=self.observer.on_error,
+            )
+
+[docs]    def OnReceiveTrData(
+        self,
+        scrnno,
+        rqname,
+        trcode,
+        recordname,
+        prevnext,
+        datalength,
+        errorcode,
+        message,
+        splmmsg,
+    ):
+        if (rqname, trcode) == (self._rqname, self._trcode) and scrnno in self._scrnnos:
+            response = KiwoomOpenApiPlusService_pb2.ListenResponse()
+            response.name = "OnReceiveTrData"  # pylint: disable=no-member
+            response.arguments.add().string_value = scrnno  # pylint: disable=no-member
+            response.arguments.add().string_value = rqname  # pylint: disable=no-member
+            response.arguments.add().string_value = trcode  # pylint: disable=no-member
+            response.arguments.add().string_value = (
+                recordname  # pylint: disable=no-member
+            )
+            response.arguments.add().string_value = (
+                prevnext  # pylint: disable=no-member
+            )
+
+            should_stop = prevnext in ["", "0"]
+            repeat_cnt = self.control.GetRepeatCnt(trcode, recordname)
+
+            if repeat_cnt > 0:
+                if len(self._multi_names) == 0:
+                    self.logger.warning(
+                        "Repeat count greater than 0, but no multi data names available, fallback to sigle data names"
+                    )
+                    multi_names = self._multi_names
+                    self._multi_names = self._single_names
+                    self._single_name = multi_names
+                if len(self._multi_names) > 0:
+                    rows = [
+                        [
+                            self.control.GetCommData(
+                                trcode, recordname, i, name
+                            ).strip()
+                            for name in self._multi_names
+                        ]
+                        for i in range(repeat_cnt)
+                    ]
+                    response.multi_data.names.extend(
+                        self._multi_names
+                    )  # pylint: disable=no-member
+                    for row in rows:
+                        if self._is_stop_condition(row):
+                            should_stop = True
+                            break
+                        response.multi_data.values.add().values.extend(
+                            row
+                        )  # pylint: disable=no-member
+
+            if len(self._single_names) > 0:
+                values = [
+                    self.control.GetCommData(trcode, recordname, 0, name).strip()
+                    for name in self._single_names
+                ]
+                response.single_data.names.extend(
+                    self._single_names
+                )  # pylint: disable=no-member
+                response.single_data.values.extend(values)  # pylint: disable=no-member
+
+            self.observer.on_next(response)
+
+            if should_stop:
+                self._scrnnos_completed[scrnno] = True
+                if all(self._scrnnos_completed.values()):
+                    self.observer.on_completed()
+                    return
+            else:
+                try:
+                    raise KiwoomOpenApiPlusError("Should not reach here")
+                except KiwoomOpenApiPlusError as e:
+                    self.observer.on_error(e)
+                    return
+
+[docs]    def OnEventConnect(self, errcode):
+        if errcode < 0:
+            error = KiwoomOpenApiPlusNegativeReturnCodeError(errcode)
+            self.observer.on_error(error)
+            return
+
+[docs]    def OnReceiveMsg(self, scrnno, rqname, trcode, msg):
+        if (rqname, trcode, scrnno) == (self._rqname, self._trcode, self._scrnno):
+            msg_pattern = r"^[^(]+\((-?[0-9]+)\)$"
+            match = re.match(msg_pattern, msg)
+            if match:
+                errcode = match.group(1)
+                errcode = int(errcode)
+                error = KiwoomOpenApiPlusNegativeReturnCodeError(errcode, msg)
+                self.observer.on_error(error)
+                return
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/kiwoom_open_api_plus/grpc/event/KiwoomOpenApiPlusLoadConditionEventHandler.html b/_modules/koapy/backend/kiwoom_open_api_plus/grpc/event/KiwoomOpenApiPlusLoadConditionEventHandler.html new file mode 100644 index 00000000..9b5ca5f4 --- /dev/null +++ b/_modules/koapy/backend/kiwoom_open_api_plus/grpc/event/KiwoomOpenApiPlusLoadConditionEventHandler.html @@ -0,0 +1,171 @@ + + + + + + + + koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusLoadConditionEventHandler — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusLoadConditionEventHandler

+from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusError import (
+    KiwoomOpenApiPlusError,
+)
+from koapy.backend.kiwoom_open_api_plus.grpc import KiwoomOpenApiPlusService_pb2
+from koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusEventHandlerForGrpc import (
+    KiwoomOpenApiPlusEventHandlerForGrpc,
+)
+
+
+[docs]class KiwoomOpenApiPlusLoadConditionEventHandler(KiwoomOpenApiPlusEventHandlerForGrpc):
+    def __init__(self, control, context, request):
+        super().__init__(control, context)
+        self._request = request
+
+[docs]    def on_enter(self):
+        KiwoomOpenApiPlusError.try_or_raise_boolean(
+            self.control.GetConditionLoad(), "Failed to load condition"
+        )
+
+[docs]    def OnReceiveConditionVer(self, ret, msg):
+        if ret != 1:
+            error = KiwoomOpenApiPlusError(msg)
+            self.observer.on_error(error)
+        response = KiwoomOpenApiPlusService_pb2.ListenResponse()
+        response.name = "OnReceiveConditionVer"  # pylint: disable=no-member
+        response.arguments.add().long_value = ret  # pylint: disable=no-member
+        response.arguments.add().string_value = msg  # pylint: disable=no-member
+        self.observer.on_next(response)  # pylint: disable=no-member
+        self.observer.on_completed()
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/kiwoom_open_api_plus/grpc/event/KiwoomOpenApiPlusLoggingEventHandler.html b/_modules/koapy/backend/kiwoom_open_api_plus/grpc/event/KiwoomOpenApiPlusLoggingEventHandler.html new file mode 100644 index 00000000..74f56cbb --- /dev/null +++ b/_modules/koapy/backend/kiwoom_open_api_plus/grpc/event/KiwoomOpenApiPlusLoggingEventHandler.html @@ -0,0 +1,257 @@ + + + + + + + + koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusLoggingEventHandler — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusLoggingEventHandler

+import datetime
+
+from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusEventHandler import (
+    KiwoomOpenApiPlusEventHandler,
+)
+from koapy.utils.logging.Logging import Logging
+
+
+[docs]class KiwoomOpenApiPlusLoggingEventHandler(KiwoomOpenApiPlusEventHandler, Logging):
+[docs]    def OnReceiveTrData(
+        self,
+        scrnno,
+        rqname,
+        trcode,
+        recordname,
+        prevnext,
+        _datalength,
+        _errorcode,
+        _message,
+        _splmmsg,
+    ):
+        self.logger.debug(
+            "OnReceiveTrData(%r, %r, %r, %r, %r)",
+            scrnno,
+            rqname,
+            trcode,
+            recordname,
+            prevnext,
+        )
+
+[docs]    def OnReceiveRealData(self, code, realtype, realdata):
+        self.logger.debug("OnReceiveRealData(%r, %r, %r)", code, realtype, realdata)
+        if code == "09" and realtype == "장시작시간":
+            signal_type = self.control.GetCommRealData(code, 215)
+            current_time = self.control.GetCommRealData(code, 20)
+            estimated_remaining_time = self.control.GetCommRealData(code, 214)
+            signal_type_msg = {
+                # 아래는 문서에서 확인 가능
+                "0": "장시작전(동시호가시작,이후1분단위)",
+                "2": "장종료전(동시호가시작,이후1분단위)",
+                "3": "장시작(동시호가종료)",
+                "4": "장종료(동시호가종료)",
+                "8": "장종료(시간내용없음)",
+                "9": "장마감(시간내용없음)",
+                # 이후는 추정
+                "s": "선물옵션장종료전(동시호가시작)",  # 17번반복
+                "a": "장후시간외종가시작",
+                "e": "선물옵션장종료(동시호가종료)",  # 17번반복
+                "b": "장후시간외종가종료",
+                "c": "시간외단일가시작",
+                "d": "시간외단일가종료",
+            }.get(signal_type, "알수없음")
+            if signal_type not in ["8", "9"]:
+                current_time = datetime.datetime.strptime(current_time, "%H%M%S")
+            else:
+                current_time = datetime.datetime.now()
+            ert = datetime.datetime.strptime(estimated_remaining_time, "%H%M%S")
+            estimated_remaining_time = datetime.timedelta(
+                hours=ert.hour, minutes=ert.minute, seconds=ert.second
+            )
+            self.logger.debug(
+                "%s, %s remaining", signal_type_msg, estimated_remaining_time
+            )
+
+[docs]    def OnReceiveMsg(self, scrnno, rqname, trcode, msg):
+        """
+        [OnReceiveMsg()이벤트]
+
+          OnReceiveMsg(
+          BSTR sScrNo,   // 화면번호
+          BSTR sRQName,  // 사용자 구분명
+          BSTR sTrCode,  // TR이름
+          BSTR sMsg     // 서버에서 전달하는 메시지
+          )
+
+          서버통신 후 수신한 메시지를 알려줍니다.
+          메시지에는 6자리 코드번호가 포함되는데 이 코드번호는 통보없이 수시로 변경될 수 있습니다. 따라서 주문이나 오류관련처리를
+          이 코드번호로 분류하시면 안됩니다.
+        """
+        self.logger.debug("OnReceiveMsg(%r, %r, %r, %r)", scrnno, rqname, trcode, msg)
+
+        if msg == "전문 처리 실패(-22)":
+            self.logger.warning("Server might have ended connection abruptly")
+
+[docs]    def OnReceiveChejanData(self, gubun, itemcnt, fidlist):
+        self.logger.debug("OnReceiveChejanData(%r, %r, %r)", gubun, itemcnt, fidlist)
+
+[docs]    def OnEventConnect(self, errcode):
+        self.logger.debug("OnEventConnect(%r)", errcode)
+
+[docs]    def OnReceiveRealCondition(
+        self, code, condition_type, condition_name, condition_index
+    ):
+        self.logger.debug(
+            "OnReceiveRealCondition(%r, %r, %r, %r)",
+            code,
+            condition_type,
+            condition_name,
+            condition_index,
+        )
+
+[docs]    def OnReceiveTrCondition(
+        self, scrnno, codelist, condition_name, condition_index, prevnext
+    ):
+        self.logger.debug(
+            "OnReceiveTrCondition(%r, %r, %r, %r, %r)",
+            scrnno,
+            codelist,
+            condition_name,
+            condition_index,
+            prevnext,
+        )
+
+[docs]    def OnReceiveConditionVer(self, ret, msg):
+        self.logger.debug("OnReceiveConditionVer(%r, %r)", ret, msg)
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/kiwoom_open_api_plus/grpc/event/KiwoomOpenApiPlusLoginEventHandler.html b/_modules/koapy/backend/kiwoom_open_api_plus/grpc/event/KiwoomOpenApiPlusLoginEventHandler.html new file mode 100644 index 00000000..2bba49e8 --- /dev/null +++ b/_modules/koapy/backend/kiwoom_open_api_plus/grpc/event/KiwoomOpenApiPlusLoginEventHandler.html @@ -0,0 +1,184 @@ + + + + + + + + koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusLoginEventHandler — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusLoginEventHandler

+from google.protobuf.json_format import MessageToDict
+
+from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusError import (
+    KiwoomOpenApiPlusError,
+    KiwoomOpenApiPlusNegativeReturnCodeError,
+)
+from koapy.backend.kiwoom_open_api_plus.grpc import KiwoomOpenApiPlusService_pb2
+from koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusEventHandlerForGrpc import (
+    KiwoomOpenApiPlusEventHandlerForGrpc,
+)
+
+
+[docs]class KiwoomOpenApiPlusLoginEventHandler(KiwoomOpenApiPlusEventHandlerForGrpc):
+    def __init__(self, control, request, context):
+        super().__init__(control, context)
+        self._request = request
+
+        if self._request.HasField("credentials"):
+            self._credentials = self._request.credentials
+            self._credentials = MessageToDict(
+                self._credentials, preserving_proto_field_name=True
+            )
+        else:
+            self._credentials = None
+
+[docs]    def on_enter(self):
+        if self._credentials is not None:
+            self.control.DisableAutoLogin()
+            KiwoomOpenApiPlusError.try_or_raise(self.control.CommConnect())
+            self.control.LoginUsingPywinauto(self._credentials)
+        else:
+            KiwoomOpenApiPlusError.try_or_raise(self.control.CommConnect())
+
+[docs]    def OnEventConnect(self, errcode):
+        if errcode < 0:
+            error = KiwoomOpenApiPlusNegativeReturnCodeError(errcode)
+            self.observer.on_error(error)
+        response = KiwoomOpenApiPlusService_pb2.ListenResponse()
+        response.name = "OnEventConnect"  # pylint: disable=no-member
+        response.arguments.add().long_value = errcode  # pylint: disable=no-member
+        self.observer.on_next(response)
+        self.observer.on_completed()
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/kiwoom_open_api_plus/grpc/event/KiwoomOpenApiPlusOrderEventHandler.html b/_modules/koapy/backend/kiwoom_open_api_plus/grpc/event/KiwoomOpenApiPlusOrderEventHandler.html new file mode 100644 index 00000000..8706ece6 --- /dev/null +++ b/_modules/koapy/backend/kiwoom_open_api_plus/grpc/event/KiwoomOpenApiPlusOrderEventHandler.html @@ -0,0 +1,491 @@ + + + + + + + + koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusOrderEventHandler — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusOrderEventHandler

+from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusError import (
+    KiwoomOpenApiPlusError,
+    KiwoomOpenApiPlusNegativeReturnCodeError,
+)
+from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusRealType import (
+    KiwoomOpenApiPlusRealType,
+)
+from koapy.backend.kiwoom_open_api_plus.grpc import KiwoomOpenApiPlusService_pb2
+from koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusEventHandlerForGrpc import (
+    KiwoomOpenApiPlusEventHandlerForGrpc,
+)
+from koapy.utils.logging.Logging import Logging
+
+
+[docs]class KiwoomOpenApiPlusBaseOrderEventHandler(
+    KiwoomOpenApiPlusEventHandlerForGrpc, Logging
+):
+    def __init__(self, control, context):
+        super().__init__(control, context)
+
+        self._single_names = ["주문번호"]
+        self._multi_names = []
+
+        self._is_stop_condition = lambda row: False
+        self._inputs = {}
+
+        self._listen_msg = True
+
+[docs]    def ResponseForOnReceiveMsg(self, scrnno, rqname, trcode, msg):
+        response = KiwoomOpenApiPlusService_pb2.ListenResponse()
+        response.name = "OnReceiveMsg"  # pylint: disable=no-member
+        response.arguments.add().string_value = scrnno  # pylint: disable=no-member
+        response.arguments.add().string_value = rqname  # pylint: disable=no-member
+        response.arguments.add().string_value = trcode  # pylint: disable=no-member
+        response.arguments.add().string_value = msg  # pylint: disable=no-member
+
+        return response
+
+[docs]    def OnReceiveMsg(self, scrnno, rqname, trcode, msg):
+        if self._listen_msg:
+            response = self.ResponseForOnReceiveMsg(scrnno, rqname, trcode, msg)
+            self.observer.on_next(response)
+
+        # 아래는 개발과정에서 확인 용도
+        # 키움에서도 경고하지만 메시지의 코드로 판단하는건 위험함 (게다가 모의투자만 해당)
+        if trcode == "KOA_NORMAL_BUY_KP_ORD":
+            if msg == "[00Z218] 모의투자 장종료 상태입니다":
+                self.logger.warning("Market is closed")
+            elif msg == "[00Z217] 모의투자 장시작전입니다":
+                self.logger.warning("Market is before opening")
+            elif msg == "[00Z237] 모의투자 단가를 입력하지 않는 호가입니다.":
+                self.logger.warning("Price is given but should not")
+            elif msg == "[00Z112] 모의투자 정상처리 되었습니다":
+                self.logger.debug("Order processed successfully")
+        elif trcode == "KOA_NORMAL_KP_CANCEL":
+            if msg == "[00Z924] 모의투자 취소수량이 취소가능수량을 초과합니다":
+                self.logger.warning("Not enough amount to cancel")
+
+[docs]    def ResponseForOnReceiveTrData(
+        self,
+        scrnno,
+        rqname,
+        trcode,
+        recordname,
+        prevnext,
+        datalength,
+        errorcode,
+        message,
+        splmmsg,
+    ):
+        response = KiwoomOpenApiPlusService_pb2.ListenResponse()
+        response.name = "OnReceiveTrData"  # pylint: disable=no-member
+        response.arguments.add().string_value = scrnno  # pylint: disable=no-member
+        response.arguments.add().string_value = rqname  # pylint: disable=no-member
+        response.arguments.add().string_value = trcode  # pylint: disable=no-member
+        response.arguments.add().string_value = recordname  # pylint: disable=no-member
+        response.arguments.add().string_value = prevnext  # pylint: disable=no-member
+
+        should_stop = prevnext in ["", "0"]  # pylint: disable=unused-variable
+        repeat_cnt = self.control.GetRepeatCnt(trcode, recordname)
+
+        if len(self._single_names) > 0:
+            values = [
+                self.control.GetCommData(trcode, recordname, 0, name).strip()
+                for name in self._single_names
+            ]
+            response.single_data.names.extend(
+                self._single_names
+            )  # pylint: disable=no-member
+            response.single_data.values.extend(values)  # pylint: disable=no-member
+
+        if repeat_cnt > 0 and len(self._multi_names) > 0:
+            rows = [
+                [
+                    self.control.GetCommData(trcode, recordname, i, name).strip()
+                    for name in self._multi_names
+                ]
+                for i in range(repeat_cnt)
+            ]
+            response.multi_data.names.extend(
+                self._multi_names
+            )  # pylint: disable=no-member
+            for row in rows:
+                if self._is_stop_condition(row):
+                    should_stop = True
+                    break
+                response.multi_data.values.add().values.extend(
+                    row
+                )  # pylint: disable=no-member
+
+        return response
+
+[docs]    def OnReceiveTrData(
+        self,
+        scrnno,
+        rqname,
+        trcode,
+        recordname,
+        prevnext,
+        datalength,
+        errorcode,
+        message,
+        splmmsg,
+    ):
+        order_no = self.control.GetCommData(trcode, recordname, 0, "주문번호").strip()
+        if order_no:
+            response = self.ResponseForOnReceiveTrData(
+                scrnno,
+                rqname,
+                trcode,
+                recordname,
+                prevnext,
+                datalength,
+                errorcode,
+                message,
+                splmmsg,
+            )
+            self.observer.on_next(response)
+
+            should_stop = prevnext in ["", "0"]
+            if not should_stop:
+                self.logger.warning("Unexpected to have prevnext for order tr data.")
+
+[docs]    def ResponseForOnReceiveChejanData(self, gubun, itemcnt, fidlist):
+        fids = fidlist.rstrip(";")
+        fids = fids.split(";") if fids else []
+        fids = [int(fid) for fid in fids]
+
+        assert itemcnt == len(fids)
+
+        names = [
+            KiwoomOpenApiPlusRealType.Fid.get_name_by_fid(fid, str(fid)) for fid in fids
+        ]
+        values = [self.control.GetChejanData(fid).strip() for fid in fids]
+
+        response = KiwoomOpenApiPlusService_pb2.ListenResponse()
+        response.name = "OnReceiveChejanData"  # pylint: disable=no-member
+        response.arguments.add().string_value = gubun  # pylint: disable=no-member
+        response.arguments.add().long_value = itemcnt  # pylint: disable=no-member
+        response.arguments.add().string_value = fidlist  # pylint: disable=no-member
+
+        response.single_data.names.extend(names)  # pylint: disable=no-member
+        response.single_data.values.extend(values)  # pylint: disable=no-member
+
+        return response
+
+[docs]    def OnReceiveChejanData(self, gubun, itemcnt, fidlist):
+        response = self.ResponseForOnReceiveChejanData(gubun, itemcnt, fidlist)
+        self.observer.on_next(response)
+
+[docs]    def OnEventConnect(self, errcode):
+        if errcode < 0:
+            error = KiwoomOpenApiPlusNegativeReturnCodeError(errcode)
+            self.observer.on_error(error)
+            return
+
+
+[docs]class KiwoomOpenApiPlusAllOrderEventHandler(KiwoomOpenApiPlusBaseOrderEventHandler):
+
+    pass
+
+
+[docs]class KiwoomOpenApiPlusOrderEventHandler(
+    KiwoomOpenApiPlusBaseOrderEventHandler, Logging
+):
+    def __init__(self, control, request, context, screen_manager):
+        super().__init__(control, context)
+
+        self._request = request
+        self._screen_manager = screen_manager
+
+        self._rqname = request.request_name
+        self._scrnno = request.screen_no
+        self._accno = request.account_no
+        self._ordertype = request.order_type
+        self._code = request.code
+        self._qty = request.quantity
+        self._price = request.price
+        self._hogagb = request.quote_type
+        self._orgorderno = request.original_order_no
+
+        self._order_no = None
+        self._should_stop = False
+
+[docs]    def on_enter(self):
+        self._scrnno = self._screen_manager.borrow_screen(self._scrnno)
+        self.add_callback(self._screen_manager.return_screen, self._scrnno)
+        self.add_callback(self.control.DisconnectRealData, self._scrnno)
+        KiwoomOpenApiPlusError.try_or_raise(
+            self.control.RateLimitedSendOrder.async_call(
+                self._rqname,
+                self._scrnno,
+                self._accno,
+                self._ordertype,
+                self._code,
+                self._qty,
+                self._price,
+                self._hogagb,
+                self._orgorderno,
+            ),
+            except_callback=self.observer.on_error,
+        )
+
+[docs]    def OnReceiveMsg(self, scrnno, rqname, trcode, msg):
+        if (rqname, scrnno) == (self._rqname, self._scrnno):
+            response = self.ResponseForOnReceiveMsg(scrnno, rqname, trcode, msg)
+            self.observer.on_next(response)
+
+[docs]    def OnReceiveTrData(
+        self,
+        scrnno,
+        rqname,
+        trcode,
+        recordname,
+        prevnext,
+        datalength,
+        errorcode,
+        message,
+        splmmsg,
+    ):
+        if (rqname, scrnno) == (self._rqname, self._scrnno):
+            response = self.ResponseForOnReceiveTrData(
+                scrnno,
+                rqname,
+                trcode,
+                recordname,
+                prevnext,
+                datalength,
+                errorcode,
+                message,
+                splmmsg,
+            )
+            self.observer.on_next(response)
+
+            self._order_no = self.control.GetCommData(
+                trcode, recordname, 0, "주문번호"
+            ).strip()
+            if not self._order_no:
+                e = KiwoomOpenApiPlusError("Cannot specify order no")
+                self.observer.on_error(e)
+                return
+
+            should_stop = prevnext in ["", "0"]
+            if not should_stop:
+                self.logger.warning("Unexpected to have prevnext for order tr data.")
+
+[docs]    def OnReceiveChejanData(self, gubun, itemcnt, fidlist):
+        # TODO: 정정 케이스에 대해 테스트 해보지 않음
+        # TODO: 취소를 취소하는 케이스 같은건 고려하지 않음
+        # TODO: 서로 같은 원주문을 정정 혹은 취소하는 케이스 사이에는 이벤트 전파가 필요할지 모르겠음
+        accno = self.control.GetChejanData(9201).strip()
+        code = self.control.GetChejanData(9001).strip()
+        if accno == self._accno and code.endswith(
+            self._code
+        ):  # code 비교시에 앞에 prefix 가 붙어오기 때문에 endswith 으로 비교해야됨
+            if gubun == "0":  # 접수와 체결시 (+ 취소 확인)
+                order_no = self.control.GetChejanData(9203).strip()
+                original_order_no = self.control.GetChejanData(904).strip()
+                status = self.control.GetChejanData(913).strip()
+                scrnno = self.control.GetChejanData(920).strip()
+                is_last = self.control.GetChejanData(819).strip() == "1"
+                if order_no in [self._order_no, self._orgorderno] or self._order_no in [
+                    order_no,
+                    original_order_no,
+                ]:
+                    response = self.ResponseForOnReceiveChejanData(
+                        gubun, itemcnt, fidlist
+                    )
+                    self.observer.on_next(response)
+                if (
+                    order_no == self._order_no
+                ):  # 자기 주문 처리하는 입장 OR 취소 및 정정 당한 뒤 원주문 정보를 받는 입장
+                    if is_last and self._should_stop:  # 취소 확인 이후 원주문 정보 받고 종료 (타)
+                        self.observer.on_completed()
+                        return
+                    elif status == "접수":
+                        pass
+                    elif status == "체결":
+                        orders_left = self.control.GetChejanData(902).strip()
+                        orders_left = int(orders_left) if orders_left.isdigit() else 0
+                        if orders_left == 0:
+                            self._should_stop = True  # 미체결수량이 더 이상 없다면 이후 잔고 이벤트 후 종료
+                    elif status == "확인":
+                        self._should_stop = True  # 취소 확인 이후 원주문 정보 받고 종료 (자)
+                    else:
+                        e = KiwoomOpenApiPlusError(
+                            "Unexpected order status: %s" % status
+                        )
+                        self.observer.on_error(e)
+                        return
+                elif order_no == self._orgorderno:  # 취소하는 입장에서 원주문 정보 받는 케이스
+                    if is_last and self._should_stop:  # 취소 확인 이후 원주문 정보 받고 종료 (자)
+                        self.observer.on_completed()
+                        return
+                    elif status in ["접수", "체결"]:
+                        pass
+                    else:
+                        e = KiwoomOpenApiPlusError(
+                            "Unexpected order status: %s" % status
+                        )
+                        self.observer.on_error(e)
+                        return
+                elif self._order_no == original_order_no:  # 취소 혹은 정정 당하는 케이스
+                    if status == "접수":
+                        pass
+                    elif status == "확인":
+                        self._should_stop = True  # 취소 확인 이후 원주문 정보 받고 종료 (타)
+                    else:
+                        e = KiwoomOpenApiPlusError(
+                            "Unexpected order status: %s" % status
+                        )
+                        self.observer.on_error(e)
+                        return
+            elif gubun == "1":  # 국내주식 잔고전달
+                response = self.ResponseForOnReceiveChejanData(gubun, itemcnt, fidlist)
+                self.observer.on_next(response)
+                if self._should_stop:  # 미체결수량이 더 이상 없다면 잔고 이벤트 후 종료
+                    self.observer.on_completed()
+                    return
+            elif gubun == "4":  # 파생 잔고전달
+                response = self.ResponseForOnReceiveChejanData(gubun, itemcnt, fidlist)
+                self.observer.on_next(response)
+                if self._should_stop:  # 미체결수량이 더 이상 없다면 잔고 이벤트 후 종료
+                    self.observer.on_completed()
+                    return
+            else:
+                e = KiwoomOpenApiPlusError("Unexpected gubun value: %s" % gubun)
+                self.observer.on_error(e)
+                return
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/kiwoom_open_api_plus/grpc/event/KiwoomOpenApiPlusRealEventHandler.html b/_modules/koapy/backend/kiwoom_open_api_plus/grpc/event/KiwoomOpenApiPlusRealEventHandler.html new file mode 100644 index 00000000..9de0a09f --- /dev/null +++ b/_modules/koapy/backend/kiwoom_open_api_plus/grpc/event/KiwoomOpenApiPlusRealEventHandler.html @@ -0,0 +1,484 @@ + + + + + + + + koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusRealEventHandler — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusRealEventHandler

+import queue
+import threading
+
+from time import sleep
+
+import grpc
+
+from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusError import (
+    KiwoomOpenApiPlusError,
+    KiwoomOpenApiPlusNegativeReturnCodeError,
+)
+from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusRealType import (
+    KiwoomOpenApiPlusRealType,
+)
+from koapy.backend.kiwoom_open_api_plus.grpc import KiwoomOpenApiPlusService_pb2
+from koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusEventHandlerForGrpc import (
+    KiwoomOpenApiPlusEventHandlerForGrpc,
+)
+from koapy.backend.kiwoom_open_api_plus.utils.queue.QueueBasedBufferedIterator import (
+    QueueBasedBufferedIterator,
+)
+from koapy.utils.itertools import chunk
+from koapy.utils.logging.Logging import Logging
+
+
+[docs]class KiwoomOpenApiPlusRealEventHandler(KiwoomOpenApiPlusEventHandlerForGrpc, Logging):
+
+    _num_codes_per_screen = 100
+    _default_opt_type = "0"
+
+    def __init__(self, control, request, context, screen_manager):
+        super().__init__(control, context)
+        self._request = request
+        self._screen_manager = screen_manager
+
+        self._screen_no = request.screen_no
+        self._code_list = request.code_list
+        self._fid_list = request.fid_list
+        self._opt_type = request.opt_type
+
+        self._infer_fids = request.flags.infer_fids
+        self._readable_names = request.flags.readable_names
+        self._fast_parse = request.flags.fast_parse
+
+        self._code_lists = [
+            codes for codes in chunk(self._code_list, self._num_codes_per_screen)
+        ]
+
+        if len(self._screen_no) == 0:
+            self._screen_nos = [None for i in range(len(self._code_lists))]
+        elif len(self._screen_no) < len(self._code_lists):
+            self.logger.warning("Given screen nos are not sufficient.")
+            self._screen_nos = list(self._screen_no) + [
+                None for i in range(len(self._code_lists) - len(self._screen_no))
+            ]
+        else:
+            self._screen_nos = self._screen_no
+
+        self._fid_list_joined = ";".join([str(fid) for fid in self._fid_list])
+        self._opt_type_final = self._opt_type or self._default_opt_type
+
+[docs]    def on_enter(self):
+        for screen_no, code_list in zip(self._screen_nos, self._code_lists):
+            code_list_joined = ";".join(code_list)
+            screen_no = self._screen_manager.borrow_screen(screen_no)
+            self.add_callback(self._screen_manager.return_screen, screen_no)
+            for code in code_list:
+                self.add_callback(
+                    self.control.SetRealRemove.async_call, screen_no, code
+                )
+            KiwoomOpenApiPlusError.try_or_raise(
+                self.control.SetRealReg.async_call(
+                    screen_no,
+                    code_list_joined,
+                    self._fid_list_joined,
+                    self._opt_type_final,
+                ).result()
+            )
+
+[docs]    def OnReceiveRealData(self, code, realtype, realdata):
+        if code in self._code_list:
+            response = KiwoomOpenApiPlusService_pb2.ListenResponse()
+            response.name = "OnReceiveRealData"  # pylint: disable=no-member
+            response.arguments.add().string_value = code  # pylint: disable=no-member
+            response.arguments.add().string_value = (
+                realtype  # pylint: disable=no-member
+            )
+            response.arguments.add().string_value = (
+                realdata  # pylint: disable=no-member
+            )
+
+            if self._infer_fids:
+                fids = KiwoomOpenApiPlusRealType.get_fids_by_realtype_name(realtype)
+            else:
+                fids = self._fid_list
+
+            if self._readable_names:
+                names = [
+                    KiwoomOpenApiPlusRealType.Fid.get_name_by_fid(fid, str(fid))
+                    for fid in fids
+                ]
+            else:
+                names = [str(fid) for fid in fids]
+
+            if self._infer_fids and self._fast_parse:
+                values = realdata.split("\t")
+            else:
+                values = [self.control.GetCommRealData(code, fid) for fid in fids]
+
+            assert len(names) == len(values)
+
+            response.single_data.names.extend(names)  # pylint: disable=no-member
+            response.single_data.values.extend(values)  # pylint: disable=no-member
+
+            self.observer.on_next(response)  # pylint: disable=no-member
+
+[docs]    def OnEventConnect(self, errcode):
+        if errcode < 0:
+            error = KiwoomOpenApiPlusNegativeReturnCodeError(errcode)
+            self.observer.on_error(error)
+            return
+
+
+[docs]class KiwoomOpenApiPlusBidirectionalRealEventHandler(
+    KiwoomOpenApiPlusRealEventHandler, Logging
+):
+    def __init__(self, control, request_iterator, context, screen_manager):
+        request = KiwoomOpenApiPlusService_pb2.RealRequest()
+        super().__init__(control, request, context, screen_manager)
+
+        self._request_iterator = request_iterator
+        self._buffered_request_iterator = QueueBasedBufferedIterator(
+            self._request_iterator
+        )
+
+        self._fid_list = []
+        self._fid_list_joined = ";".join(str(fid) for fid in self._fid_list)
+
+        self._screen_by_code = {}
+        self._code_list_by_screen = {}
+        self._code_list = []
+
+        self._request_iterator_consumer = None
+        self._request_iterator_consumer_should_stop = False
+        self._request_iterator_consumer_timeout = 2.0
+
+[docs]    def register_code(self, code, fid_list=None):
+        if code in self._screen_by_code:
+            screen_no = self._screen_by_code[code]
+            opt_type = "1"
+        else:
+            screen_no = None
+            opt_type = "0"
+
+            for (
+                existing_screen_no,
+                screen_code_list,
+            ) in self._code_list_by_screen.items():
+                if len(screen_code_list) < self._num_codes_per_screen:
+                    screen_no = existing_screen_no
+                    opt_type = "1"
+                    break
+
+            if screen_no is None:
+                screen_no = self._screen_manager.borrow_screen()
+                opt_type = "0"
+
+            self._screen_by_code[code] = screen_no
+            self._code_list_by_screen.setdefault(screen_no, []).append(code)
+            self._code_list.append(code)
+
+        if fid_list:
+            fid_list_joined = ";".join(str(fid) for fid in fid_list)
+        else:
+            fid_list_joined = self._fid_list_joined
+
+        self.logger.debug(
+            "Registering code %s to screen %s with type %s", code, screen_no, opt_type
+        )
+
+        def try_to_register(retry=2, timeout=3.0):
+            retry_count = 0
+
+            def call():
+                KiwoomOpenApiPlusError.try_or_raise(
+                    self.control.SetRealReg.async_call(
+                        screen_no, code, fid_list_joined, opt_type
+                    ),
+                    except_callback=on_error,
+                )
+
+            def on_error(e):
+                nonlocal retry_count
+                if isinstance(e, KiwoomOpenApiPlusError):
+                    error_message = (
+                        f"Failed to register {code=}. Reason: {e} ({e.code})."
+                    )
+                else:
+                    error_message = f"Failed to register {code=}. Reason: {e}."
+                if retry_count < retry:
+                    retry_count += 1
+                    self.logger.warning(
+                        f"{error_message} Retrying ({retry_count}/{retry}) in {timeout} ..."
+                    )
+                else:
+                    self.logger.warning(
+                        f"{error_message} Kiwoom server does not allow register."
+                    )
+                    return
+                sleep(timeout)
+                call()
+
+            call()
+
+        try_to_register()
+
+[docs]    def remove_code(self, code):
+        if code in self._screen_by_code:
+            screen_no = self._screen_by_code[code]
+            self.logger.debug("Removing code %s from screen %s", code, screen_no)
+            self.control.SetRealRemove.async_call(screen_no, code)
+            self._screen_by_code.pop(code)
+            self._code_list_by_screen[screen_no].remove(code)
+            self._code_list.remove(code)
+        else:
+            self.logger.warning(
+                "Given code %s is not in managed code list and cannot be removed", code
+            )
+
+[docs]    def remove_all_codes(self):
+        code_list = list(
+            self._code_list
+        )  # copy in order to prevent "modification while iteration"
+        for code in code_list:
+            self.remove_code(code)
+
+[docs]    def remove_all_screens(self):
+        self.remove_all_codes()
+        screen_nos = list(self._code_list_by_screen.keys())
+        for screen_no in screen_nos:
+            self.control.DisconnectRealData(
+                screen_no
+            )  # ensure although already removed in remove_all_codes()
+            self._screen_manager.return_screen(screen_no)
+            code_list = self._code_list_by_screen.pop(screen_no)
+            assert len(code_list) == 0
+
+[docs]    def consume_request_iterator(self):
+        while not self._request_iterator_consumer_should_stop:
+            try:
+                request = self._buffered_request_iterator.next(
+                    timeout=self._request_iterator_consumer_timeout
+                )
+            except queue.Empty:
+                pass
+            except grpc.RpcError:
+                break
+            else:
+                if request.HasField("register_request"):
+                    code_list = request.register_request.code_list
+                    fid_list = request.register_request.fid_list
+                    for code in code_list:
+                        self.register_code(code, fid_list)
+                elif request.HasField("remove_request"):
+                    code_list = request.remove_request.code_list
+                    for code in code_list:
+                        self.remove_code(code)
+                elif request.HasField("stop_request"):
+                    self.stop()
+                    break
+                elif request.HasField("initialize_request"):
+                    self._fid_list = request.initialize_request.fid_list
+                    self._fid_list_joined = ";".join(str(fid) for fid in self._fid_list)
+                    self._infer_fids = request.initialize_request.flags.infer_fids
+                    self._infer_fids = True
+                    self._readable_names = (
+                        request.initialize_request.flags.readable_names
+                    )
+                    self._fast_parse = request.initialize_request.flags.fast_parse
+                    self.remove_all_codes()
+                else:
+                    raise KiwoomOpenApiPlusError("Unexpected request")
+
+[docs]    def stop_request_iterator_consumer(self):
+        if (
+            self._request_iterator_consumer is not None
+            and self._request_iterator_consumer.is_alive()
+        ):
+            self._request_iterator_consumer_should_stop = True
+            self._request_iterator_consumer.join()
+
+[docs]    def start_request_iterator_consumer(self):
+        self.stop_request_iterator_consumer()
+        self._request_iterator_consumer_should_stop = False
+        self._request_iterator_consumer = threading.Thread(
+            target=self.consume_request_iterator, daemon=True
+        )
+        self._request_iterator_consumer.start()
+
+[docs]    def on_enter(self):
+        self.start_request_iterator_consumer()
+
+[docs]    def on_exit(self, exc_type=None, exc_value=None, traceback=None):
+        self.stop_request_iterator_consumer()
+        self.remove_all_screens()
+
+[docs]    def OnReceiveRealData(self, code, realtype, realdata):
+        if code in self._code_list:
+            response = KiwoomOpenApiPlusService_pb2.ListenResponse()
+            response.name = "OnReceiveRealData"  # pylint: disable=no-member
+            response.arguments.add().string_value = code  # pylint: disable=no-member
+            response.arguments.add().string_value = (
+                realtype  # pylint: disable=no-member
+            )
+            response.arguments.add().string_value = (
+                realdata  # pylint: disable=no-member
+            )
+
+            if self._infer_fids:
+                fids = KiwoomOpenApiPlusRealType.get_fids_by_realtype_name(realtype)
+            else:
+                fids = self._fid_list
+
+            if self._readable_names:
+                names = [
+                    KiwoomOpenApiPlusRealType.Fid.get_name_by_fid(fid, str(fid))
+                    for fid in fids
+                ]
+            else:
+                names = [str(fid) for fid in fids]
+
+            if self._infer_fids and self._fast_parse:
+                values = realdata.split("\t")
+            else:
+                values = [self.control.GetCommRealData(code, fid) for fid in fids]
+
+            assert len(names) == len(values)
+
+            response.single_data.names.extend(names)  # pylint: disable=no-member
+            response.single_data.values.extend(values)  # pylint: disable=no-member
+
+            self.observer.on_next(response)  # pylint: disable=no-member
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/kiwoom_open_api_plus/grpc/event/KiwoomOpenApiPlusTrEventHandler.html b/_modules/koapy/backend/kiwoom_open_api_plus/grpc/event/KiwoomOpenApiPlusTrEventHandler.html new file mode 100644 index 00000000..b5e6f733 --- /dev/null +++ b/_modules/koapy/backend/kiwoom_open_api_plus/grpc/event/KiwoomOpenApiPlusTrEventHandler.html @@ -0,0 +1,324 @@ + + + + + + + + koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusTrEventHandler — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusTrEventHandler

+import operator
+import re
+
+from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusError import (
+    KiwoomOpenApiPlusError,
+    KiwoomOpenApiPlusNegativeReturnCodeError,
+)
+from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusTrInfo import (
+    KiwoomOpenApiPlusTrInfo,
+)
+from koapy.backend.kiwoom_open_api_plus.grpc import KiwoomOpenApiPlusService_pb2
+from koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusEventHandlerForGrpc import (
+    KiwoomOpenApiPlusEventHandlerForGrpc,
+)
+from koapy.utils.logging.Logging import Logging
+
+
+[docs]class KiwoomOpenApiPlusTrEventHandler(KiwoomOpenApiPlusEventHandlerForGrpc, Logging):
+    def __init__(self, control, request, context, screen_manager):
+        super().__init__(control, context)
+        self._request = request
+        self._screen_manager = screen_manager
+
+        self._rqname = request.request_name
+        self._trcode = request.transaction_code
+        self._scrnno = request.screen_no
+        self._inputs = request.inputs
+
+        self._trinfo = KiwoomOpenApiPlusTrInfo.get_trinfo_by_code(self._trcode)
+
+        if self._trinfo is None:
+            self.logger.error("Cannot find names for trcode %s", self._trinfo)
+
+        self._input_code = self._inputs.get("종목코드")
+
+        self._single_names = self._trinfo.get_single_output_names()
+        self._multi_names = self._trinfo.get_multi_output_names()
+
+        stop_condition = request.stop_condition
+        stop_condition_is_valid = (
+            stop_condition is not None
+            and stop_condition.name is not None
+            and len(stop_condition.name) > 0
+            and (
+                stop_condition.name in self._multi_names
+                or stop_condition.name in self._single_names
+            )
+        )
+
+        if stop_condition_is_valid:
+            comparator = {
+                KiwoomOpenApiPlusService_pb2.TransactionStopConditionCompartor.LESS_THAN_OR_EQUAL_TO: operator.le,
+                KiwoomOpenApiPlusService_pb2.TransactionStopConditionCompartor.LESS_THAN: operator.lt,
+                KiwoomOpenApiPlusService_pb2.TransactionStopConditionCompartor.GREATER_THAN_OR_EQUAL_TO: operator.ge,
+                KiwoomOpenApiPlusService_pb2.TransactionStopConditionCompartor.GREATER_THAN: operator.gt,
+                KiwoomOpenApiPlusService_pb2.TransactionStopConditionCompartor.EQUAL_TO: operator.eq,
+                KiwoomOpenApiPlusService_pb2.TransactionStopConditionCompartor.NOT_EQUAL_TO: operator.ne,
+            }.get(stop_condition.comparator, operator.le)
+
+            if stop_condition.name in self._multi_names:
+                column_index_to_check = self._multi_names.index(stop_condition.name)
+            else:
+                # if it does not have multi_names, it may use single_names instead.
+                column_index_to_check = self._single_names.index(stop_condition.name)
+
+            def is_stop_condition(row):
+                return comparator(row[column_index_to_check], stop_condition.value)
+
+        else:
+
+            def is_stop_condition(_):
+                return False
+
+        self._is_stop_condition = is_stop_condition
+
+[docs]    def on_enter(self):
+        self._scrnno = self._screen_manager.borrow_screen(self._scrnno)
+        self.add_callback(self._screen_manager.return_screen, self._scrnno)
+        self.add_callback(self.control.DisconnectRealData, self._scrnno)
+        KiwoomOpenApiPlusError.try_or_raise(
+            self.control.RateLimitedCommRqData.async_call(
+                self._rqname, self._trcode, 0, self._scrnno, self._inputs
+            ),
+            except_callback=self.observer.on_error,
+        )
+
+[docs]    def OnReceiveTrData(
+        self,
+        scrnno,
+        rqname,
+        trcode,
+        recordname,
+        prevnext,
+        datalength,
+        errorcode,
+        message,
+        splmmsg,
+    ):
+        if (rqname, trcode, scrnno) == (self._rqname, self._trcode, self._scrnno):
+            response = KiwoomOpenApiPlusService_pb2.ListenResponse()
+            response.name = "OnReceiveTrData"  # pylint: disable=no-member
+            response.arguments.add().string_value = scrnno  # pylint: disable=no-member
+            response.arguments.add().string_value = rqname  # pylint: disable=no-member
+            response.arguments.add().string_value = trcode  # pylint: disable=no-member
+            response.arguments.add().string_value = (
+                recordname  # pylint: disable=no-member
+            )
+            response.arguments.add().string_value = (
+                prevnext  # pylint: disable=no-member
+            )
+
+            should_stop = prevnext in ["", "0"]
+            repeat_cnt = self.control.GetRepeatCnt(trcode, recordname)
+
+            if repeat_cnt > 0:
+                if len(self._multi_names) == 0:
+                    self.logger.warning(
+                        "Repeat count greater than 0, but no multi data names available, fallback to sigle data names"
+                    )
+                    self._single_names, self._multi_names = (
+                        self._multi_names,
+                        self._single_names,
+                    )
+                if len(self._multi_names) > 0:
+                    rows = [
+                        [
+                            self.control.GetCommData(
+                                trcode, recordname, i, name
+                            ).strip()
+                            for name in self._multi_names
+                        ]
+                        for i in range(repeat_cnt)
+                    ]
+                    response.multi_data.names.extend(
+                        self._multi_names
+                    )  # pylint: disable=no-member
+                    for row in rows:
+                        if self._is_stop_condition(row):
+                            should_stop = True
+                            break
+                        response.multi_data.values.add().values.extend(
+                            row
+                        )  # pylint: disable=no-member
+
+            if len(self._single_names) > 0:
+                values = [
+                    self.control.GetCommData(trcode, recordname, 0, name).strip()
+                    for name in self._single_names
+                ]
+                response.single_data.names.extend(
+                    self._single_names
+                )  # pylint: disable=no-member
+                response.single_data.values.extend(values)  # pylint: disable=no-member
+
+            self.observer.on_next(response)
+
+            if should_stop:
+                self.observer.on_completed()
+            else:
+                KiwoomOpenApiPlusError.try_or_raise(
+                    self.control.RateLimitedCommRqData.async_call(
+                        rqname, trcode, int(prevnext), scrnno, self._inputs
+                    ),
+                    except_callback=self.observer.on_error,
+                )
+
+[docs]    def OnEventConnect(self, errcode):
+        if errcode < 0:
+            error = KiwoomOpenApiPlusNegativeReturnCodeError(errcode)
+            self.observer.on_error(error)
+            return
+
+[docs]    def OnReceiveMsg(self, scrnno, rqname, trcode, msg):
+        if (rqname, trcode, scrnno) == (self._rqname, self._trcode, self._scrnno):
+            msg_pattern = r"^[^(]+\((-?[0-9]+)\)$"
+            match = re.match(msg_pattern, msg)
+            if match:
+                errcode = match.group(1)
+                errcode = int(errcode)
+                error = KiwoomOpenApiPlusNegativeReturnCodeError(errcode, msg)
+                self.observer.on_error(error)
+                return
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/kiwoom_open_api_plus/grpc/tools/compile_proto.html b/_modules/koapy/backend/kiwoom_open_api_plus/grpc/tools/compile_proto.html new file mode 100644 index 00000000..eee478a0 --- /dev/null +++ b/_modules/koapy/backend/kiwoom_open_api_plus/grpc/tools/compile_proto.html @@ -0,0 +1,178 @@ + + + + + + + + koapy.backend.kiwoom_open_api_plus.grpc.tools.compile_proto — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.kiwoom_open_api_plus.grpc.tools.compile_proto

+import subprocess
+
+from pathlib import Path
+
+
+[docs]def compile_proto():
+    proto_filename = "KiwoomOpenApiPlusService.proto"
+    file_path = Path(__file__)
+    file_dir = file_path.parent
+    project_dir = file_dir.parent.parent.parent.parent.parent
+    proto_path = project_dir
+    proto_filepath = (
+        proto_path
+        / "koapy"
+        / "backend"
+        / "kiwoom_open_api_plus"
+        / "grpc"
+        / proto_filename
+    )
+    python_out = project_dir
+    grpc_python_out = python_out
+    cmd = [
+        "python",
+        "-m",
+        "grpc_tools.protoc",
+        "--proto_path=%s" % str(proto_path),
+        "--python_out=%s" % str(python_out),
+        "--grpc_python_out=%s" % str(grpc_python_out),
+        str(proto_filepath),
+    ]
+    print(" ".join(cmd))
+    subprocess.check_call(cmd, cwd=project_dir)
+
+
+if __name__ == "__main__":
+    compile_proto()
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/kiwoom_open_api_plus/pyside2/KiwoomOpenApiPlusDialogHandler.html b/_modules/koapy/backend/kiwoom_open_api_plus/pyside2/KiwoomOpenApiPlusDialogHandler.html new file mode 100644 index 00000000..eece4018 --- /dev/null +++ b/_modules/koapy/backend/kiwoom_open_api_plus/pyside2/KiwoomOpenApiPlusDialogHandler.html @@ -0,0 +1,307 @@ + + + + + + + + koapy.backend.kiwoom_open_api_plus.pyside2.KiwoomOpenApiPlusDialogHandler — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.kiwoom_open_api_plus.pyside2.KiwoomOpenApiPlusDialogHandler

+import datetime
+import re
+
+from typing import Optional
+
+import pytz
+
+from koapy.backend.kiwoom_open_api_plus.pyside2.KiwoomOpenApiPlusManagerApplication import (
+    KiwoomOpenApiPlusManagerApplication,
+)
+from koapy.backend.kiwoom_open_api_plus.utils.pyside2.QDialogHandler import (
+    QDialogHandler,
+)
+from koapy.compat.pyside2.QtCore import QObject
+from koapy.compat.pywinauto import Desktop, WindowSpecification
+from koapy.compat.pywinauto.findwindows import ElementNotFoundError
+from koapy.utils.logging.Logging import Logging
+
+
+[docs]class DialogToHandle:
+[docs]    def should_handle(self, dialog: WindowSpecification) -> bool:
+        ...
+
+[docs]    def handle(self, dialog: WindowSpecification):
+        ...
+
+[docs]    def handle_if_needed(self, dialog: WindowSpecification):
+        if self.should_handle(dialog):
+            return self.handle(dialog)
+
+
+[docs]class KiwoomOpenApiPlusDialogToHandle(DialogToHandle, Logging):
+    @classmethod
+[docs]    def should_handle_by_title(cls, dialog: WindowSpecification, title: str):
+        try:
+            cls.logger.debug("Checking dialog title")
+            dialog_text = dialog.wrapper_object().window_text()
+        except ElementNotFoundError:
+            cls.logger.warning("Could not find dialog to check")
+        else:
+            return dialog_text == title
+
+    @classmethod
+[docs]    def handle_by_clicking_button(cls, dialog: WindowSpecification):
+        try:
+            cls.logger.debug("Clicking confirm button on dialog")
+            dialog["Button"].click()
+        except ElementNotFoundError:
+            cls.logger.warning("Could not find dialog to confirm")
+
+    @classmethod
+[docs]    def handle_by_emiting_should_restart_signal(
+        cls,
+        app: KiwoomOpenApiPlusManagerApplication,
+        restart_type: KiwoomOpenApiPlusManagerApplication.RestartType,
+    ):
+        cls.logger.debug("Restarting based on the dialog's instruction")
+        app.shouldRestart.emit(restart_type)
+
+    def __init__(
+        self,
+        title: Optional[str] = None,
+        time: Optional[datetime.time] = None,
+        body: Optional[str] = None,
+        app: Optional[KiwoomOpenApiPlusManagerApplication] = None,
+        restart_type: Optional[KiwoomOpenApiPlusManagerApplication.RestartType] = None,
+    ):
+        self._title = title
+        self._time = time
+        self._body = body
+
+        self._app = app
+        self._restart_type = restart_type
+
+[docs]    def to_specification(self) -> WindowSpecification:
+        desktop = Desktop(allow_magic_lookup=False)
+        title_re = re.escape(self._title)
+        specification = desktop.window(title_re=title_re)
+        return specification
+
+[docs]    def should_handle(self, dialog: WindowSpecification) -> bool:
+        return self.should_handle_by_title(dialog, self._title)
+
+[docs]    def handle(self, dialog: WindowSpecification):
+        self.handle_by_clicking_button(dialog)
+        if self._restart_type is not None:
+            self.handle_by_emiting_should_restart_signal(self._app, self._restart_type)
+
+[docs]    def handle_if_needed(self, dialog: WindowSpecification):
+        if self.should_handle(dialog):
+            return self.handle(dialog)
+
+
+[docs]class KiwoomOpenApiPlusDialogHandler(QDialogHandler):
+    def __init__(
+        self,
+        app: KiwoomOpenApiPlusManagerApplication,
+        parent: Optional[QObject] = None,
+    ):
+        self._app = app
+        self._parent = parent
+
+        kst = pytz.timezone("Asia/Seoul")
+
+        system_check_noticie = KiwoomOpenApiPlusDialogToHandle(
+            title="안녕하세요. 키움증권 입니다.",
+            time=datetime.time(hour=4, minute=45, tzinfo=kst),
+            body="""
+            안녕하세요. 키움증권 입니다.
+            시스템의 안정적인 운영을 위하여
+            매일 시스템 점검을 하고 있습니다.
+            점검시간은 월~토요일 (05:05 ~ 05:10)
+                    일요일    (04:00 ~ 04:30) 까지 입니다.
+            따라서 해당 시간대에는 접속단절이 될 수 있습니다.
+            참고하시기 바랍니다.
+            """,
+            app=app,
+        )
+        connection_lost = KiwoomOpenApiPlusDialogToHandle(
+            title="KHOpenAPI",
+            time=datetime.time(hour=5, minute=5, tzinfo=kst),
+            body="""
+            통신 연결이 끊겼습니다. 프로그램 종료후 재접속 해주시기 바랍니다.
+            """,
+            app=app,
+        )
+        hts_reconnect_notice = KiwoomOpenApiPlusDialogToHandle(
+            title="[HTS 재접속 안내]",
+            time=datetime.time(hour=6, minute=50, tzinfo=kst),
+            body="""
+            안녕하세요. 키움증권입니다.
+
+            오전 6시 50분 이전에 접속하신 고객님께서는
+            영웅문을 재접속하여 주시기 바랍니다.
+            재접속을 하지 않을 경우 거래종목 정보, 전일 거래에
+            대한 결제분 등이 반영되지 않아 실제 잔고와 차이가
+            발생할 수 있습니다.
+                                -키움증권-
+            """,
+            app=app,
+            restart_type=KiwoomOpenApiPlusManagerApplication.RestartType.RESTART_AND_RESTORE,
+        )
+
+        self._dialogs_to_handle = [
+            system_check_noticie,
+            connection_lost,
+            hts_reconnect_notice,
+        ]
+        self._specifications = [
+            dialog.to_specification() for dialog in self._dialogs_to_handle
+        ]
+
+        super().__init__(self._specifications, self._parent)
+
+        self.readyDialog.connect(self.onReadyDialog)
+
+[docs]    def onReadyDialog(self, dialog: WindowSpecification):
+        for dialog_to_handle in self._dialogs_to_handle:
+            try:
+                # pylint: disable=unused-variable
+                dialog_wrapper_object = dialog.wrapper_object()
+            except ElementNotFoundError:
+                break
+            else:
+                dialog_to_handle.handle_if_needed(dialog)
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/kiwoom_open_api_plus/pyside2/KiwoomOpenApiPlusManagerApplication.html b/_modules/koapy/backend/kiwoom_open_api_plus/pyside2/KiwoomOpenApiPlusManagerApplication.html new file mode 100644 index 00000000..099dc888 --- /dev/null +++ b/_modules/koapy/backend/kiwoom_open_api_plus/pyside2/KiwoomOpenApiPlusManagerApplication.html @@ -0,0 +1,920 @@ + + + + + + + + koapy.backend.kiwoom_open_api_plus.pyside2.KiwoomOpenApiPlusManagerApplication — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.kiwoom_open_api_plus.pyside2.KiwoomOpenApiPlusManagerApplication

+import datetime
+import os
+import sys
+
+from argparse import Namespace
+from contextlib import ExitStack, contextmanager
+from enum import Enum
+from pathlib import Path
+from subprocess import TimeoutExpired
+from threading import Timer
+from typing import List, Optional, Sequence, Tuple
+
+import grpc
+import win32api
+import win32con
+import win32job
+import win32process
+
+from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusError import (
+    KiwoomOpenApiPlusNegativeReturnCodeError,
+)
+from koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusServiceClient import (
+    KiwoomOpenApiPlusServiceClient,
+)
+from koapy.backend.kiwoom_open_api_plus.pyside2.KiwoomOpenApiPlusServerApplication import (
+    KiwoomOpenApiPlusServerApplication,
+)
+from koapy.backend.kiwoom_open_api_plus.pyside2.KiwoomOpenApiPlusSignalHandler import (
+    KiwoomOpenApiPlusSignalHandler,
+)
+from koapy.backend.kiwoom_open_api_plus.utils.pyside2.QThreadPoolExecutor import (
+    QThreadPoolExecutor,
+)
+from koapy.cli.extensions.parser import ArgumentParser
+from koapy.cli.utils.grpc_options import server_and_client_argument_parser
+from koapy.compat.pyside2.QtCore import QProcess, QSize, QThreadPool, QUrl, Signal
+from koapy.compat.pyside2.QtGui import QDesktopServices, QIcon
+from koapy.compat.pyside2.QtWidgets import QApplication, QMenu, QSystemTrayIcon
+from koapy.config import config, get_32bit_executable
+from koapy.utils.logging import set_verbosity
+from koapy.utils.logging.pyside2.QObjectLogging import QObjectLogging
+from koapy.utils.subprocess import Popen
+
+
+[docs]class KiwoomOpenApiPlusManagerApplicationArgumentParser(ArgumentParser):
+    def __init__(self):
+        self._parser = server_and_client_argument_parser
+
+[docs]    def parse_args(
+        self,
+        args: Optional[Sequence[str]] = None,
+        namespace: Optional[Namespace] = None,
+    ) -> Namespace:
+        return self._parser.parse_args(args, namespace)
+
+[docs]    def parse_known_args(
+        self,
+        args: Optional[Sequence[str]] = None,
+        namespace: Optional[Namespace] = None,
+    ) -> Tuple[Namespace, List[str]]:
+        return self._parser.parse_known_args(args, namespace)
+
+
+[docs]class KiwoomOpenApiPlusServerApplicationProcess(QProcess):
+    def __init__(self, args, parent=None):
+        super().__init__(parent)
+
+        self._args = args
+        self._executable = get_32bit_executable()
+        self._arguments = [
+            "-m",
+            KiwoomOpenApiPlusServerApplication.__module__,
+        ] + self._args
+
+        self.setProgram(self._executable)
+        self.setArguments(self._arguments)
+        self.setProcessChannelMode(QProcess.ForwardedChannels)
+
+        self._hJob = None
+        self._hProcess = None
+
+        self.started.connect(self._onStarted)
+        self.finished.connect(self._onFinished)
+
+    def _onStarted(self):
+        processId = self.processId()
+
+        if processId != 0:
+            # https://stackoverflow.com/questions/23434842/python-how-to-kill-child-processes-when-parent-dies/23587108#23587108s
+            jobAttributes = None
+            jobName = ""
+            self._hJob = win32job.CreateJobObject(jobAttributes, jobName)
+            extendedInfo = win32job.QueryInformationJobObject(
+                self._hJob, win32job.JobObjectExtendedLimitInformation
+            )
+            basicLimitInformation = extendedInfo["BasicLimitInformation"]
+            basicLimitInformation[
+                "LimitFlags"
+            ] = win32job.JOB_OBJECT_LIMIT_KILL_ON_JOB_CLOSE
+            win32job.SetInformationJobObject(
+                self._hJob,
+                win32job.JobObjectExtendedLimitInformation,
+                extendedInfo,
+            )
+            desiredAccess = win32con.PROCESS_TERMINATE | win32con.PROCESS_SET_QUOTA
+            inheritHandle = False
+            self._hProcess = win32api.OpenProcess(
+                desiredAccess,
+                inheritHandle,
+                processId,
+            )
+            win32job.AssignProcessToJobObject(self._hJob, self._hProcess)
+
+    def _onFinished(self):
+        exitCode = 0
+
+        if self._hProcess is not None:
+            try:
+                exitCode = win32process.GetExitCodeProcess(self._hProcess)
+            except win32process.error:
+                pass
+
+        if self._hJob is not None:
+            win32job.TerminateJobObject(self._hJob, exitCode)
+
+
+[docs]class KiwoomOpenApiPlusServerApplicationSubprocess:
+    def __init__(self, args, parent=None):
+        self._args = args
+        self._executable = get_32bit_executable()
+        self._cmd = [
+            self._executable,
+            "-m",
+            KiwoomOpenApiPlusServerApplication.__module__,
+        ] + self._args
+        self._proc = None
+        self._started = False
+
+[docs]    def start(self):
+        self._proc = Popen(self._cmd)
+        self._started = True
+
+[docs]    def waitForStarted(self, msecs: int = 30000) -> bool:
+        return self._started
+
+[docs]    def close(self):
+        if self._proc is not None:
+            self._proc.terminate()
+
+[docs]    def waitForFinished(self, msecs: int = 30000) -> bool:
+        if self._proc is not None:
+            secs = msecs / 1000
+            try:
+                return_code = self._proc.wait(secs)
+                return return_code == 0
+            except TimeoutExpired:
+                return False
+        return False
+
+
+[docs]class KiwoomOpenApiPlusManagerApplication(QObjectLogging):
+[docs]    class ConnectionStatus(Enum):
+[docs]        DISCONNECTED = 1
+[docs]        CONNECTED = 2
+
+[docs]    class ServerType(Enum):
+[docs]        SIMULATION = 1
+[docs]        REAL = 2
+[docs]        UNKNOWN = 3
+
+[docs]    class RestartType(Enum):
+[docs]        NO_RESTART = 1
+[docs]        RESTART_ONLY = 2
+[docs]        RESTART_AND_RESTORE = 3
+[docs]        RESTART_AND_CONNECT = 4
+[docs]        RESTART_WITH_UPDATE = 5
+[docs]        RESTART_WITH_UPDATE_AND_RESTORE = 6
+[docs]        RESTART_WITH_UPDATE_AND_CONNECT = 7
+
+[docs]    shouldRestart = Signal(RestartType)
+
+    def __init__(self, args=()):
+        # Parse args
+        self._args = list(args)
+        self._argument_parser = KiwoomOpenApiPlusManagerApplicationArgumentParser()
+        (
+            self._parsed_args,
+            self._remaining_args,
+        ) = self._argument_parser.parse_known_args(self._args[1:])
+
+        # Set verbosity level
+        self._verbose = self._parsed_args.verbose
+        set_verbosity(self._verbose)
+
+        # Attributes for gprc client
+        self._host = self._parsed_args.host
+        self._port = self._parsed_args.port
+
+        # Attributes for grpc client (SSL/TLS)
+        self._enable_ssl = self._parsed_args.enable_ssl
+        self._key_file = self._parsed_args.client_key_file
+        self._cert_file = self._parsed_args.client_cert_file
+        self._root_certs_file = self._parsed_args.client_root_certs_file
+
+        # Start creating application for real
+        self.logger.debug("Creating manager application")
+
+        # Create QApplication instance
+        self._app = QApplication.instance() or QApplication(
+            self._args[:1] + self._remaining_args
+        )
+
+        # Create this QObject after creating QApplication instance
+        super().__init__()
+
+        # Capture certain signals and handle them accordingly
+        self._signal_handler = KiwoomOpenApiPlusSignalHandler(self, self)
+        self._signal_handler.signaled.connect(self._onSignal)
+
+        # Capture dialogs from OpenAPI and handle them accordingly
+        from koapy.backend.kiwoom_open_api_plus.pyside2.KiwoomOpenApiPlusDialogHandler import (
+            KiwoomOpenApiPlusDialogHandler,
+        )
+
+        self._dialog_handler = KiwoomOpenApiPlusDialogHandler(self, self)
+
+        # Attributes for gprc client (ThreadPoolExecutor)
+        self._max_workers = config.get_int(
+            "koapy.backend.kiwoom_open_api_plus.grpc.client.max_workers",
+            8,
+        )
+        self._thread_pool = QThreadPool(self)
+        self._thread_pool.setMaxThreadCount(self._max_workers)
+        self._thread_pool_executor = QThreadPoolExecutor(self._thread_pool, self)
+
+        # Prepare grpc client credentials if applicable
+        if self._enable_ssl:
+            root_certificates = None
+            if self._root_certs_file:
+                with open(self._root_certs_file, "rb") as f:
+                    root_certificates = f.read()
+            private_key = None
+            if self._key_file:
+                with open(self._key_file, "rb") as f:
+                    private_key = f.read()
+            certificate_chain = None
+            if self._cert_file:
+                with open(self._cert_file, "rb") as f:
+                    certificate_chain = f.read()
+            self._credentials = grpc.ssl_channel_credentials(
+                root_certificates=root_certificates,
+                private_key=private_key,
+                certificate_chain=certificate_chain,
+            )
+        else:
+            self._credentials = None
+
+        # Initialize server subprocess and gprc client to the server
+        self._server_process = None
+        self._client = None
+        self._reinitializeServerProcessAndGrpcClient()
+
+        # Restart server application whenever restart is required
+        self.shouldRestart.connect(self._onShouldRestart)
+
+        # Create system tray icon
+        self._tray = self._createSystemTrayIcon()
+
+        # Initialize tray icon menu by invoking related event handlers
+        self._onEventConnect(0)
+
+        # Make tray icon visible
+        self._tray.show()
+
+    # ==============================================
+    # Functions for server/client (re)initialization
+    # ==============================================
+
+    def _closeClient(self):
+        self._client.close()
+
+    def _closeClientIfExists(self):
+        if hasattr(self, "_client") and self._client is not None:
+            self._closeClient()
+
+    def _closeServerProcess(self):
+        self._server_process.close()
+        self._server_process.waitForFinished()
+
+    def _closeServerProcessIfExists(self):
+        if hasattr(self, "_server_process") and self._server_process is not None:
+            self._closeServerProcess()
+
+    def _reinitializeServerProcessAndGrpcClient(self):
+        self._closeClientIfExists()
+        self._closeServerProcessIfExists()
+
+        # Create server application subprocess and start that
+        self._server_process = KiwoomOpenApiPlusServerApplicationProcess(
+            self._args[1:], self
+        )
+        self._server_process.start()
+        self._server_process.waitForStarted()
+
+        # Create gRPC client
+        self._client = KiwoomOpenApiPlusServiceClient(
+            host=self._host,
+            port=self._port,
+            credentials=self._credentials,
+            thread_pool=self._thread_pool_executor,
+        )
+
+        # Wait for the client to be ready
+        self._client_timeout = 30
+        assert self._client.is_ready(self._client_timeout), "Client is not ready"
+
+        # Listen OnEventConnect event from OpenAPI
+        # and change some application states based on that
+        self._client.OnEventConnect.connect(self._onEventConnect)
+
+    # =======================================
+    # Functions for creating system tray icon
+    # =======================================
+
+    def _createIcon(self):
+        icon = QIcon()
+        filePath = Path(__file__)
+        iconDir = (filePath.parent / "../data/icon/manager").resolve()
+
+        def addFilesForMode(icon, iconDir, mode):
+            icon.addFile(
+                str(iconDir / "favicon-16x16.png"),
+                QSize(16, 16),
+                mode,
+            )
+            icon.addFile(
+                str(iconDir / "favicon-32x32.png"),
+                QSize(32, 32),
+                mode,
+            )
+            icon.addFile(
+                str(iconDir / "apple-touch-icon.png"),
+                QSize(180, 180),
+                mode,
+            )
+            icon.addFile(
+                str(iconDir / "android-chrome-192x192.png"),
+                QSize(192, 192),
+                mode,
+            )
+            icon.addFile(
+                str(iconDir / "android-chrome-512x512.png"),
+                QSize(512, 512),
+                mode,
+            )
+
+        # Add files for each mode
+        addFilesForMode(icon, iconDir / "normal", QIcon.Normal)
+        addFilesForMode(icon, iconDir / "disabled", QIcon.Disabled)
+        addFilesForMode(icon, iconDir / "active", QIcon.Active)
+
+        return icon
+
+    def _createToolTip(self):
+        toolTip = "KOAPY Manager Application"
+        return toolTip
+
+    def _createContextMenu(self):
+        menu = QMenu()
+
+        # Section for actions related to connection and login
+        menu.addSection("Connection")
+        connectAction = menu.addAction("Login and connect")
+        connectAction.triggered.connect(self._onConnectActionTriggered)
+        showAccountWindowAction = menu.addAction("Show account window")
+        showAccountWindowAction.triggered.connect(
+            self._onShowAccountWindowActionTriggered
+        )
+        enableAutoLoginAction = menu.addAction("Enable auto login")
+        enableAutoLoginAction.triggered.connect(self._onEnableAutoLoginActionTriggered)
+        checkForUpdateAction = menu.addAction("Check for update")
+        checkForUpdateAction.triggered.connect(self._onCheckForUpdateActionTriggered)
+
+        # Section for displaying current status, should be disabled
+        menu.addSection("Status")
+        text = self._getConnectionStatusText(self.ConnectionStatus.DISCONNECTED)
+        self._connectionStatusAction = menu.addAction(text)
+        self._connectionStatusAction.setEnabled(False)
+        text = self._getServerTypeText(self.ServerType.UNKNOWN)
+        self._serverStatusAction = menu.addAction(text)
+        self._serverStatusAction.setEnabled(False)
+
+        # Section for external links (koapy)
+        menu.addSection("Links")
+        iconDir = Path(__file__).parent / "../data/icon/external"
+        iconDir = iconDir.resolve()
+        icon = QIcon(str(iconDir / "readthedocs.png"))
+        documentationAction = menu.addAction(icon, "Documentation")
+        documentationAction.triggered.connect(self._openReadTheDocs)
+        icon = QIcon(str(iconDir / "github.png"))
+        githubAction = menu.addAction(icon, "Github")
+        githubAction.triggered.connect(self._openGithub)
+
+        # Section for external links (kiwoom)
+        menu.addSection("Kiwoom Links")
+        openApiAction = menu.addAction("Kiwoom OpenAPI+ Home")
+        openApiAction.triggered.connect(self._openOpenApiHome)
+        openApiAction = menu.addAction("Kiwoom OpenAPI+ Document")
+        openApiAction.triggered.connect(self._openOpenApiDocument)
+        qnaAction = menu.addAction("Kiwoom OpenAPI+ Qna")
+        qnaAction.triggered.connect(self._openOpenApiQna)
+
+        # Section for exit and restart
+        menu.addSection("Exit")
+        restartAction = menu.addAction("Restart")
+        restartAction.triggered.connect(self._onRestartActionTriggered)
+        exitAction = menu.addAction("Exit")
+        exitAction.triggered.connect(self._onExitActionTriggered)
+
+        return menu
+
+    def _createSystemTrayIcon(self):
+        tray = QSystemTrayIcon()
+
+        self._icon = self._createIcon()
+        self._tooltip = self._createToolTip()
+        self._menu = self._createContextMenu()
+
+        tray.setIcon(self._icon)
+        tray.setToolTip(self._tooltip)
+        tray.setContextMenu(self._menu)
+
+        tray.activated.connect(self._onTrayIconActivated)  # pylint: disable=no-member
+
+        return tray
+
+    # =========================================
+    # Functions for controling tray icon states
+    # =========================================
+
+    def _updateTrayIconMode(self, mode: QIcon.Mode = QIcon.Normal):
+        icon = QIcon(self._icon.pixmap(16, mode))
+        self._tray.setIcon(icon)
+
+    def _getConnectionStatusText(self, status: ConnectionStatus):
+        text = {
+            self.ConnectionStatus.DISCONNECTED: "Status: Disconnected",
+            self.ConnectionStatus.CONNECTED: "Status: Connected",
+        }[status]
+        return text
+
+    def _updateConnectionStatus(self, status: ConnectionStatus):
+        text = self._getConnectionStatusText(status)
+        self._connectionStatusAction.setText(text)
+
+    def _getServerTypeText(self, server_type: ServerType):
+        text = {
+            self.ServerType.SIMULATION: "Server: Simulation",
+            self.ServerType.REAL: "Server: Real",
+            self.ServerType.UNKNOWN: "Server: Unknown",
+        }[server_type]
+        return text
+
+    def _updateServerType(self, server_type: ServerType):
+        text = self._getServerTypeText(server_type)
+        self._serverStatusAction.setText(text)
+
+    # =======================================
+    # Functions for handling tray icon events
+    # =======================================
+
+    def _onTrayIconActivated(self, reason):
+        pass
+
+    def _onExitActionTriggered(self):
+        self.exit()
+
+    def _onRestartActionTriggered(self):
+        self._emitShouldRestart(self.RestartType.RESTART_AND_RESTORE)
+
+    def _onConnectActionTriggered(self):
+        self._connect()
+
+    def _onShowAccountWindowActionTriggered(self):
+        self._showAccountWindow()
+
+    def _onEnableAutoLoginActionTriggered(self):
+        self._enableAutoLogin()
+
+    def _onCheckForUpdateActionTriggered(self):
+        self._emitShouldRestart(self.RestartType.RESTART_WITH_UPDATE_AND_RESTORE)
+
+    def _openOpenApiHome(self):
+        openApiHomeUrl = "https://www.kiwoom.com/h/customer/download/VOpenApiInfoView"
+        url = QUrl(openApiHomeUrl)
+        QDesktopServices.openUrl(url)
+
+    def _openOpenApiDocument(self):
+        openApiHomeUrl = "https://download.kiwoom.com/web/openapi/kiwoom_openapi_plus_devguide_ver_1.5.pdf"
+        url = QUrl(openApiHomeUrl)
+        QDesktopServices.openUrl(url)
+
+    def _openOpenApiQna(self):
+        openApiQnaUrl = "https://www.kiwoom.com/h/common/bbs/VBbsBoardBWOAZView"
+        url = QUrl(openApiQnaUrl)
+        QDesktopServices.openUrl(url)
+
+    def _openGithub(self):
+        githubUrl = "https://github.com/elbakramer/koapy"
+        url = QUrl(githubUrl)
+        QDesktopServices.openUrl(url)
+
+    def _openReadTheDocs(self):
+        docUrl = "https://koapy.readthedocs.io/en/latest/"
+        url = QUrl(docUrl)
+        QDesktopServices.openUrl(url)
+
+    # ==============================
+    # Functions for general behavior
+    # ==============================
+
+    def _ensureConnectedAndThen(self, callback=None):
+        if not self._client.IsConnected():
+            self.logger.debug("Connecting to OpenAPI server")
+        self._client.EnsureConnectedAndThen(callback)
+
+    def _connect(self):
+        self._ensureConnectedAndThen()
+
+    def _showAccountWindow(self):
+        self._ensureConnectedAndThen(lambda errcode: self._client.ShowAccountWindow())
+
+    def _enableAutoLogin(self):
+        self._ensureConnectedAndThen(
+            lambda errcode: self._client.EnsureAutoLoginEnabled()
+        )
+
+    def _emitShouldRestart(self, restart_type: Optional[RestartType] = None):
+        if restart_type is None:
+            restart_type = self.RestartType.RESTART_ONLY
+        self.shouldRestart.emit(restart_type)
+
+    def _emitShouldRestartAndConnect(self):
+        self._emitShouldRestart(self.RestartType.RESTART_AND_CONNECT)
+
+    def _onShouldRestart(self, restart_type: RestartType):
+        self._restart(restart_type)
+
+    # ===================================
+    # Functions for handling other events
+    # ===================================
+
+    def _onSignal(self, signal, frame):
+        self.logger.debug("Received %r for manager application", signal)
+        self.exit(signal)
+
+    def _tryReconnect(self):
+        now = datetime.datetime.now()
+        buffer = datetime.timedelta(minutes=5)
+
+        target = now
+        timediff = datetime.timedelta()
+
+        maintanance_start_time = now.replace(hour=5, minute=5, second=0, microsecond=0)
+        maintanance_end_time = now.replace(hour=5, minute=10, second=0, microsecond=0)
+
+        maintanance_start_time_sunday = now.replace(
+            hour=4, minute=0, second=0, microsecond=0
+        )
+        maintanance_end_time_sunday = now.replace(
+            hour=4, minute=30, second=0, microsecond=0
+        )
+
+        is_maintanance = (
+            (maintanance_start_time - buffer) < now < (maintanance_end_time + buffer)
+        )
+        is_maintanance_sunday = (
+            (maintanance_start_time_sunday - buffer)
+            < now
+            < (maintanance_end_time_sunday + buffer)
+        )
+        is_sunday = now.weekday() == 6
+
+        if is_maintanance:
+            target = maintanance_end_time + buffer
+        elif is_sunday and is_maintanance_sunday:
+            target = maintanance_end_time_sunday + buffer
+
+        timediff = target - now
+        total_seconds = timediff.total_seconds()
+
+        if total_seconds > 0:
+            self.logger.warning(
+                "Connection lost due to maintanance, waiting until %s, then will try to reconnect",
+                target,
+            )
+            # QTimer is not working, why?
+            # QTimer.singleShot(total_seconds * 1000, self._emitShouldRestartAndConnect)
+            timer = Timer(total_seconds, self._emitShouldRestartAndConnect)
+            timer.start()
+        else:
+            self.logger.warning(
+                "Connection lost unexpectedly, will try to reconnect right away"
+            )
+            self._emitShouldRestartAndConnect()
+
+    def _onEventConnect(self, errcode):
+        state = self._client.GetConnectState()
+
+        if state == 1:
+            self._updateTrayIconMode(QIcon.Normal)
+            self._updateConnectionStatus(self.ConnectionStatus.CONNECTED)
+            server = self._client.GetServerGubun()
+            if server == "1":
+                self._updateServerType(self.ServerType.SIMULATION)
+            else:
+                self._updateServerType(self.ServerType.REAL)
+        else:
+            self._updateTrayIconMode(QIcon.Disabled)
+            self._updateConnectionStatus(self.ConnectionStatus.DISCONNECTED)
+            self._updateServerType(self.ServerType.UNKNOWN)
+
+        if errcode == KiwoomOpenApiPlusNegativeReturnCodeError.OP_ERR_SOCKET_CLOSED:
+            self.logger.error("Socket closed")
+            self._tryReconnect()
+        elif errcode == KiwoomOpenApiPlusNegativeReturnCodeError.OP_ERR_CONNECT:
+            self.logger.error("Failed to connect")
+
+    # ================================
+    # Functions for context management
+    # ================================
+
+    def _close(self):
+        self._closeClient()
+        self._closeServerProcess()
+
+[docs]    def close(self):
+        return self._close()
+
+    def __enter__(self):
+        return self
+
+    def __exit__(self, exc_type, exc_value, traceback):
+        self.close()
+
+    @contextmanager
+    def _execContext(self):
+        with ExitStack() as stack:
+            stack.enter_context(self._signal_handler)
+            stack.enter_context(self._dialog_handler)
+            stack.enter_context(self._thread_pool_executor)
+            stack.enter_context(self)
+            yield
+
+    # ==============================
+    # Functions for public interface
+    # ==============================
+
+    def __getattr__(self, name):
+        return getattr(self._app, name)
+
+    def _exec(self):
+        with self._execContext():
+            self.logger.debug("Started manager application")
+            return self._app.exec_()
+
+    def _exit(self, return_code=0):
+        self.logger.debug("Exiting manager application")
+        return self._app.exit(return_code)
+
+    def _isConnected(self):
+        return self._client.is_ready() and self._client.IsConnected()
+
+    def _getAPIModulePath(self):
+        from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusTypeLibSpec import (
+            API_MODULE_PATH,
+        )
+
+        module_path = API_MODULE_PATH
+        return module_path
+
+    def _getAutoLoginDatPath(self):
+        module_path = self._getAPIModulePath()
+        autologin_dat = module_path / "system" / "Autologin.dat"
+        return autologin_dat
+
+    def _isAutoLoginEnabled(self):
+        autologin_dat = self._getAutoLoginDatPath()
+        return autologin_dat.exists()
+
+    def _disableAutoLogin(self):
+        self.logger.info("Disabling auto login")
+        autologin_dat = self._getAutoLoginDatPath()
+        if autologin_dat.exists():
+            self.logger.info("Removing %s", autologin_dat)
+            os.remove(autologin_dat)
+            self.logger.info("Disabled auto login")
+            return True
+        else:
+            self.logger.info("Autologin is already disabled")
+            return False
+
+    def _restart(self, restart_type: Optional[RestartType] = None):
+        self.logger.debug("Restarting server application")
+
+        if restart_type is None:
+            restart_type = self.RestartType.RESTART_ONLY
+
+        is_connected = self._isConnected()
+        is_autologin_enabled = self._isAutoLoginEnabled()
+
+        should_connect_to_restore = (
+            restart_type
+            in [
+                self.RestartType.RESTART_AND_RESTORE,
+                self.RestartType.RESTART_WITH_UPDATE_AND_RESTORE,
+            ]
+            and is_connected
+        )
+        should_connect_anyway = restart_type in [
+            self.RestartType.RESTART_AND_CONNECT,
+            self.RestartType.RESTART_WITH_UPDATE_AND_CONNECT,
+        ]
+        should_connect = should_connect_to_restore or should_connect_anyway
+
+        should_update = restart_type in [
+            self.RestartType.RESTART_WITH_UPDATE,
+            self.RestartType.RESTART_WITH_UPDATE_AND_RESTORE,
+            self.RestartType.RESTART_WITH_UPDATE_AND_CONNECT,
+        ]
+
+        if should_update:
+            self._reinitializeServerProcessAndGrpcClient()
+            if is_autologin_enabled:
+                self._disableAutoLogin()
+            self._client.CommConnectAndThen()
+            is_updated = self._client.HandleVersionUpgradeUsingPywinauto(
+                self._server_process.processId()
+            )
+            if is_updated:
+                self._reinitializeServerProcessAndGrpcClient()
+            if is_autologin_enabled:
+                self.logger.info("Enabling auto login back")
+                self._enableAutoLogin()
+                if is_updated:
+                    self.logger.info("Done update, enabled auto login")
+                else:
+                    self.logger.info("There was no version update, enabled auto login")
+        else:
+            self._reinitializeServerProcessAndGrpcClient()
+
+        if should_connect:
+            self.logger.debug("Re-establishing connection")
+            self._connect()
+
+[docs]    def exec_(self):
+        return self._exec()
+
+[docs]    def exit(self, return_code=0):
+        return self._exit(return_code)
+
+[docs]    def restart(self, restart_type: Optional[RestartType] = None):
+        return self._restart(restart_type)
+
+[docs]    def execAndExit(self):
+        code = self.exec_()
+        sys.exit(code)
+
+    @classmethod
+[docs]    def main(cls, args=None):
+        if args is None:
+            args = sys.argv
+        app = cls(args)
+        app.execAndExit()
+
+
+if __name__ == "__main__":
+    KiwoomOpenApiPlusManagerApplication.main()
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/kiwoom_open_api_plus/pyside2/KiwoomOpenApiPlusServerApplication.html b/_modules/koapy/backend/kiwoom_open_api_plus/pyside2/KiwoomOpenApiPlusServerApplication.html new file mode 100644 index 00000000..26c66618 --- /dev/null +++ b/_modules/koapy/backend/kiwoom_open_api_plus/pyside2/KiwoomOpenApiPlusServerApplication.html @@ -0,0 +1,562 @@ + + + + + + + + koapy.backend.kiwoom_open_api_plus.pyside2.KiwoomOpenApiPlusServerApplication — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.kiwoom_open_api_plus.pyside2.KiwoomOpenApiPlusServerApplication

+import sys
+
+from argparse import Namespace
+from contextlib import ExitStack, contextmanager
+from enum import Enum
+from pathlib import Path
+from typing import List, Optional, Sequence, Tuple
+
+import grpc
+
+from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusQAxWidget import (
+    KiwoomOpenApiPlusQAxWidget,
+)
+from koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusServiceServer import (
+    KiwoomOpenApiPlusServiceServer,
+)
+from koapy.backend.kiwoom_open_api_plus.pyside2.KiwoomOpenApiPlusSignalHandler import (
+    KiwoomOpenApiPlusSignalHandler,
+)
+from koapy.backend.kiwoom_open_api_plus.utils.pyside2.QThreadPoolExecutor import (
+    QThreadPoolExecutor,
+)
+from koapy.cli.extensions.parser import ArgumentParser
+from koapy.cli.utils.grpc_options import (
+    server_and_client_argument_parser,
+    server_argument_parser,
+)
+from koapy.compat.pyside2.QtCore import QSize, QThreadPool
+from koapy.compat.pyside2.QtGui import QIcon
+from koapy.compat.pyside2.QtWidgets import QApplication, QMenu, QSystemTrayIcon
+from koapy.config import config
+from koapy.utils.logging import set_verbosity
+from koapy.utils.logging.pyside2.QObjectLogging import QObjectLogging
+
+
+[docs]class KiwoomOpenApiPlusServerApplicationArgumentParser(ArgumentParser):
+    def __init__(self):
+        self._server_argument_parser = server_argument_parser
+        self._server_and_client_argument_parser = server_and_client_argument_parser
+
+    def _merge_results(
+        self,
+        server_namespace,
+        server_and_client_namespace,
+        server_args=None,
+        server_and_client_args=None,
+    ):
+        namespace = Namespace()
+
+        # copy server namespace values
+        for key, value in vars(server_namespace).items():
+            setattr(namespace, key, value)
+
+        # set aliases
+        namespace.host = server_namespace.bind_address
+
+        # copy fallback options to main options
+        if not namespace.key_file and server_and_client_namespace.server_key_file:
+            namespace.key_file = server_and_client_namespace.server_key_file
+        if not namespace.cert_file and server_and_client_namespace.server_cert_file:
+            namespace.cert_file = server_and_client_namespace.server_cert_file
+        if (
+            not namespace.root_certs_file
+            and server_and_client_namespace.server_root_certs_file
+        ):
+            namespace.root_certs_file = (
+                server_and_client_namespace.server_root_certs_file
+            )
+
+        if server_args is not None and server_and_client_args is not None:
+            # filter unrecognized args
+            unrecognized_args = [
+                arg for arg in server_args if arg in server_and_client_args
+            ]
+            return namespace, unrecognized_args
+        else:
+            return namespace
+
+[docs]    def parse_args(
+        self,
+        args: Optional[Sequence[str]] = None,
+        namespace: Optional[Namespace] = None,
+    ) -> Namespace:
+        server_namespace = self._server_argument_parser.parse_args(args, namespace)
+        server_and_client_namespace = (
+            self._server_and_client_argument_parser.parse_args(args, namespace)
+        )
+        namespace = self._merge_results(
+            server_namespace,
+            server_and_client_namespace,
+        )
+        return namespace
+
+[docs]    def parse_known_args(
+        self,
+        args: Optional[Sequence[str]] = None,
+        namespace: Optional[Namespace] = None,
+    ) -> Tuple[Namespace, List[str]]:
+        (
+            server_namespace,
+            server_args,
+        ) = self._server_argument_parser.parse_known_args(args, namespace)
+        (
+            server_and_client_namespace,
+            server_and_client_args,
+        ) = self._server_and_client_argument_parser.parse_known_args(args, namespace)
+        namespace, unrecognized_args = self._merge_results(
+            server_namespace,
+            server_and_client_namespace,
+            server_args,
+            server_and_client_args,
+        )
+        return namespace, unrecognized_args
+
+
+[docs]class KiwoomOpenApiPlusServerApplication(QObjectLogging):
+[docs]    class ConnectionStatus(Enum):
+[docs]        DISCONNECTED = 1
+[docs]        CONNECTED = 2
+
+[docs]    class ServerType(Enum):
+[docs]        SIMULATION = 1
+[docs]        REAL = 2
+[docs]        UNKNOWN = 3
+
+    def __init__(self, args=()):
+        # Parse args
+        self._args = list(args)
+        self._argument_parser = KiwoomOpenApiPlusServerApplicationArgumentParser()
+        (
+            self._parsed_args,
+            self._remaining_args,
+        ) = self._argument_parser.parse_known_args(self._args[1:])
+
+        # Set verbosity level
+        self._verbose = self._parsed_args.verbose
+        set_verbosity(self._verbose)
+
+        # Attributes for gprc server
+        self._bind_address = self._parsed_args.bind_address
+        self._port = self._parsed_args.port
+
+        # Attributes for grpc server (SSL/TLS)
+        self._key_file = self._parsed_args.key_file
+        self._cert_file = self._parsed_args.cert_file
+        self._root_certs_file = self._parsed_args.root_certs_file
+        self._require_client_auth = self._parsed_args.require_client_auth
+
+        # Start creating application for real
+        self.logger.debug("Creating server application")
+
+        # Create QApplication instance
+        self._app = QApplication.instance() or QApplication(
+            self._args[:1] + self._remaining_args
+        )
+
+        # Create this QObject after creating QApplication instance
+        super().__init__()
+
+        # Capture certain signals and handle them accordingly
+        self._signal_handler = KiwoomOpenApiPlusSignalHandler(self, self)
+        self._signal_handler.signaled.connect(self._onSignal)
+
+        # Attributes for gprc server (ThreadPoolExecutor)
+        self._max_workers = config.get_int(
+            "koapy.backend.kiwoom_open_api_plus.grpc.server.max_workers",
+            8,
+        )
+        self._thread_pool = QThreadPool(self)
+        self._thread_pool.setMaxThreadCount(self._max_workers)
+        self._thread_pool_executor = QThreadPoolExecutor(self._thread_pool, self)
+
+        # Prepare grpc server credentials if applicable
+        if (self._key_file and self._cert_file) or self._root_certs_file:
+            private_key_certificate_chain_pairs = None
+            server_key = None
+            server_cert = None
+            if self._key_file:
+                with open(self._key_file, "rb") as f:
+                    server_key = f.read()
+            if self._cert_file:
+                with open(self._cert_file, "rb") as f:
+                    server_cert = f.read()
+            if server_key and server_cert:
+                private_key_certificate_chain_pairs = [
+                    (server_key, server_cert),
+                ]
+            root_certificates = None
+            if self._root_certs_file:
+                with open(self._root_certs_file, "rb") as f:
+                    root_certificates = f.read()
+            require_client_auth = self._require_client_auth
+            self._credentials = grpc.ssl_server_credentials(
+                private_key_certificate_chain_pairs=private_key_certificate_chain_pairs,
+                root_certificates=root_certificates,
+                require_client_auth=require_client_auth,
+            )
+        else:
+            self._credentials = None
+
+        # Create OpenAPI control object
+        self._control = KiwoomOpenApiPlusQAxWidget()
+
+        # Create gRPC server
+        self._server = KiwoomOpenApiPlusServiceServer(
+            control=self._control,
+            host=self._bind_address,
+            port=self._port,
+            credentials=self._credentials,
+            thread_pool=self._thread_pool_executor,
+        )
+
+        # Listen OnEventConnect event from OpenAPI
+        # and change some application states based on that
+        self._control.OnEventConnect.connect(self._onEventConnect)
+
+        # Create system tray icon
+        self._tray = self._createSystemTrayIcon()
+
+        # Initialize tray icon menu by invoking related event handlers
+        self._onEventConnect(0)
+
+        # Make tray icon visible
+        self._tray.show()
+
+    # =======================================
+    # Functions for creating system tray icon
+    # =======================================
+
+    def _createIcon(self):
+        icon = QIcon()
+        filePath = Path(__file__)
+        iconDir = (filePath.parent / "../data/icon/server").resolve()
+
+        def addFilesForMode(icon, iconDir, mode):
+            icon.addFile(
+                str(iconDir / "favicon-16x16.png"),
+                QSize(16, 16),
+                mode,
+            )
+            icon.addFile(
+                str(iconDir / "favicon-32x32.png"),
+                QSize(32, 32),
+                mode,
+            )
+            icon.addFile(
+                str(iconDir / "apple-touch-icon.png"),
+                QSize(180, 180),
+                mode,
+            )
+            icon.addFile(
+                str(iconDir / "android-chrome-192x192.png"),
+                QSize(192, 192),
+                mode,
+            )
+            icon.addFile(
+                str(iconDir / "android-chrome-512x512.png"),
+                QSize(512, 512),
+                mode,
+            )
+
+        # Add files for each mode
+        addFilesForMode(icon, iconDir / "normal", QIcon.Normal)
+        addFilesForMode(icon, iconDir / "disabled", QIcon.Disabled)
+        addFilesForMode(icon, iconDir / "active", QIcon.Active)
+
+        return icon
+
+    def _createToolTip(self):
+        toolTip = "KOAPY Server Application"
+        return toolTip
+
+    def _createContextMenu(self):
+        menu = QMenu()
+
+        # Section for displaying current status, should be disabled
+        menu.addSection("Status")
+        text = self._getConnectionStatusText(self.ConnectionStatus.DISCONNECTED)
+        self._connectionStatusAction = menu.addAction(text)
+        self._connectionStatusAction.setEnabled(False)
+        text = self._getServerTypeText(self.ServerType.UNKNOWN)
+        self._serverStatusAction = menu.addAction(text)
+        self._serverStatusAction.setEnabled(False)
+
+        # Exit button
+        menu.addSection("Exit")
+        exitAction = menu.addAction("Exit")
+        exitAction.triggered.connect(self._onExitButtonClicked)
+
+        return menu
+
+    def _createSystemTrayIcon(self):
+        tray = QSystemTrayIcon()
+
+        self._icon = self._createIcon()
+        self._tooltip = self._createToolTip()
+        self._menu = self._createContextMenu()
+
+        tray.setIcon(self._icon)
+        tray.setToolTip(self._tooltip)
+        tray.setContextMenu(self._menu)
+
+        tray.activated.connect(self._onTrayIconActivated)  # pylint: disable=no-member
+
+        return tray
+
+    # =========================================
+    # Functions for controling tray icon states
+    # =========================================
+
+    def _updateTrayIconMode(self, mode: QIcon.Mode = QIcon.Normal):
+        icon = QIcon(self._icon.pixmap(16, mode))
+        self._tray.setIcon(icon)
+
+    def _getConnectionStatusText(self, status: ConnectionStatus):
+        text = {
+            self.ConnectionStatus.DISCONNECTED: "Status: Disconnected",
+            self.ConnectionStatus.CONNECTED: "Status: Connected",
+        }[status]
+        return text
+
+    def _updateConnectionStatus(self, status: ConnectionStatus):
+        text = self._getConnectionStatusText(status)
+        self._connectionStatusAction.setText(text)
+
+    def _getServerTypeText(self, server_type: ServerType):
+        text = {
+            self.ServerType.SIMULATION: "Server: Simulation",
+            self.ServerType.REAL: "Server: Real",
+            self.ServerType.UNKNOWN: "Server: Unknown",
+        }[server_type]
+        return text
+
+    def _updateServerType(self, server_type: ServerType):
+        text = self._getServerTypeText(server_type)
+        self._serverStatusAction.setText(text)
+
+    # =======================================
+    # Functions for handling tray icon events
+    # =======================================
+
+    def _onTrayIconActivated(self, reason):
+        if reason == QSystemTrayIcon.DoubleClick:
+            self._control.showNormal()
+            self._control.activateWindow()
+
+    def _onExitButtonClicked(self):
+        self.exit()
+
+    # ===================================
+    # Functions for handling other events
+    # ===================================
+
+    def _onSignal(self, signal, frame):
+        self.logger.debug("Received %r for server application ", signal)
+        self.exit(signal)
+
+    def _onEventConnect(self, errcode):
+        state = self._control.GetConnectState()
+        if state == 1:
+            self._updateTrayIconMode(QIcon.Normal)
+            self._updateConnectionStatus(self.ConnectionStatus.CONNECTED)
+            server = self._control.GetServerGubun()
+            if server == "1":
+                self._updateServerType(self.ServerType.SIMULATION)
+            else:
+                self._updateServerType(self.ServerType.REAL)
+        else:
+            self._updateTrayIconMode(QIcon.Disabled)
+            self._updateConnectionStatus(self.ConnectionStatus.DISCONNECTED)
+            self._updateServerType(self.ServerType.UNKNOWN)
+
+    # ================================
+    # Functions for context management
+    # ================================
+
+    @contextmanager
+    def _execContext(self):
+        with ExitStack() as stack:
+            stack.enter_context(self._signal_handler)
+            stack.enter_context(self._thread_pool_executor)
+            stack.enter_context(self._server)
+            yield
+
+    # ==============================
+    # Functions for public interface
+    # ==============================
+
+    def __getattr__(self, name):
+        return getattr(self._app, name)
+
+    def _exec(self):
+        with self._execContext():
+            self.logger.debug("Started server application")
+            return self._app.exec_()
+
+    def _exit(self, return_code=0):
+        self.logger.debug("Exiting server application")
+        return self._app.exit(return_code)
+
+[docs]    def exec_(self):
+        return self._exec()
+
+[docs]    def exit(self, return_code=0):
+        return self._exit(return_code)
+
+[docs]    def execAndExit(self):
+        code = self.exec_()
+        sys.exit(code)
+
+    @classmethod
+[docs]    def main(cls, args=None):
+        if args is None:
+            args = sys.argv
+        app = cls(args)
+        app.execAndExit()
+
+
+if __name__ == "__main__":
+    KiwoomOpenApiPlusServerApplication.main()
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/kiwoom_open_api_plus/pyside2/KiwoomOpenApiPlusSignalHandler.html b/_modules/koapy/backend/kiwoom_open_api_plus/pyside2/KiwoomOpenApiPlusSignalHandler.html new file mode 100644 index 00000000..15ad50ad --- /dev/null +++ b/_modules/koapy/backend/kiwoom_open_api_plus/pyside2/KiwoomOpenApiPlusSignalHandler.html @@ -0,0 +1,159 @@ + + + + + + + + koapy.backend.kiwoom_open_api_plus.pyside2.KiwoomOpenApiPlusSignalHandler — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.kiwoom_open_api_plus.pyside2.KiwoomOpenApiPlusSignalHandler

+import signal as signal_module
+
+from koapy.backend.kiwoom_open_api_plus.utils.pyside2.QSignalHandler import (
+    QSignalHandler,
+)
+
+
+[docs]class KiwoomOpenApiPlusSignalHandler(QSignalHandler):
+    def __init__(self, app, parent=None):
+        self._app = app
+        self._parent = parent
+
+        self._signals = [
+            signal_module.SIGINT,
+            signal_module.SIGTERM,
+        ]
+        super().__init__(self._signals, self._parent)
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/kiwoom_open_api_plus/utils/grpc/PipeableMultiThreadedRendezvous.html b/_modules/koapy/backend/kiwoom_open_api_plus/utils/grpc/PipeableMultiThreadedRendezvous.html new file mode 100644 index 00000000..870ba3f7 --- /dev/null +++ b/_modules/koapy/backend/kiwoom_open_api_plus/utils/grpc/PipeableMultiThreadedRendezvous.html @@ -0,0 +1,168 @@ + + + + + + + + koapy.backend.kiwoom_open_api_plus.utils.grpc.PipeableMultiThreadedRendezvous — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.kiwoom_open_api_plus.utils.grpc.PipeableMultiThreadedRendezvous

+from collections.abc import Iterator
+
+from grpc._channel import _MultiThreadedRendezvous as MultiThreadedRendezvous
+
+
+[docs]class PipeableMultiThreadedRendezvous(Iterator):
+    def __init__(self, rendezvous, iterator=None):
+        super().__init__()
+        self._rendezvous = rendezvous
+        self._iterator = iterator or self._rendezvous
+        assert isinstance(self._rendezvous, MultiThreadedRendezvous)
+        assert isinstance(self._iterator, Iterator)
+
+    def __next__(self):
+        return self._iterator.__next__()
+
+[docs]    def pipe(self, func):
+        rendezvous = self._rendezvous
+        iterator = func(self._iterator)
+        return type(self)(rendezvous, iterator)
+
+    def __getattr__(self, name):
+        try:
+            return getattr(self._rendezvous, name)
+        except AttributeError:
+            return getattr(self._iterator, name)
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/kiwoom_open_api_plus/utils/list_conversion.html b/_modules/koapy/backend/kiwoom_open_api_plus/utils/list_conversion.html new file mode 100644 index 00000000..634e0631 --- /dev/null +++ b/_modules/koapy/backend/kiwoom_open_api_plus/utils/list_conversion.html @@ -0,0 +1,187 @@ + + + + + + + + koapy.backend.kiwoom_open_api_plus.utils.list_conversion — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.kiwoom_open_api_plus.utils.list_conversion

+import collections
+
+from functools import wraps
+from inspect import signature
+
+
+[docs]def string_to_list(s, sep=";"):
+    if s is None:
+        return s
+    if not isinstance(s, str) and isinstance(s, collections.abc.Iterable):
+        return s
+    return s.rstrip(sep).split(sep) if s else []
+
+
+[docs]def list_to_string(l, sep=";"):
+    if l is None:
+        return l
+    if isinstance(l, str):
+        return l
+    if not isinstance(l, collections.abc.Iterable):
+        return l
+    return sep.join(l) if l else ""
+
+
+[docs]def convert_list_arguments(*indices):
+    def decorator(f):
+        sig = signature(f)
+        names = tuple(sig.parameters.keys())
+
+        @wraps(f)
+        def wrapper(*args, **kwargs):
+            ba = sig.bind(*args, **kwargs)
+            ba.apply_defaults()
+            for i in indices:
+                if isinstance(i, int):
+                    i = names[i]
+                if isinstance(i, str):
+                    ba.arguments[i] = list_to_string(ba.arguments[i])
+            args = ba.args
+            kwargs = ba.kwargs
+            return f(*args, **kwargs)
+
+        return wrapper
+
+    return decorator
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/kiwoom_open_api_plus/utils/module_path.html b/_modules/koapy/backend/kiwoom_open_api_plus/utils/module_path.html new file mode 100644 index 00000000..4209a24e --- /dev/null +++ b/_modules/koapy/backend/kiwoom_open_api_plus/utils/module_path.html @@ -0,0 +1,161 @@ + + + + + + + + koapy.backend.kiwoom_open_api_plus.utils.module_path — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.kiwoom_open_api_plus.utils.module_path

+import functools
+
+from pathlib import Path
+
+from deprecated import deprecated
+
+from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusTypeLibSpec import (
+    API_MODULE_PATH,
+)
+
+
+@deprecated
+@functools.lru_cache()
+[docs]def GetAPIModulePath() -> Path:
+    return API_MODULE_PATH
+
+
+if __name__ == "__main__":
+    print(GetAPIModulePath())
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/kiwoom_open_api_plus/utils/pyside2/QDialogHandler.html b/_modules/koapy/backend/kiwoom_open_api_plus/utils/pyside2/QDialogHandler.html new file mode 100644 index 00000000..c160188b --- /dev/null +++ b/_modules/koapy/backend/kiwoom_open_api_plus/utils/pyside2/QDialogHandler.html @@ -0,0 +1,248 @@ + + + + + + + + koapy.backend.kiwoom_open_api_plus.utils.pyside2.QDialogHandler — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.kiwoom_open_api_plus.utils.pyside2.QDialogHandler

+import re
+
+from typing import Dict, List, Optional, Sequence, Set
+
+from koapy.compat.pyside2.QtCore import QObject, Signal
+from koapy.compat.pywinauto import Desktop, WindowSpecification
+from koapy.compat.pywinauto.findwindows import ElementNotFoundError
+from koapy.compat.pywinauto.timings import TimeoutError as PywinautoTimeoutError
+from koapy.utils.logging.pyside2.QThreadLogging import QThreadLogging
+
+
+[docs]class QDialogHandler(QThreadLogging):
+
+[docs]    readyDialog = Signal(WindowSpecification)
+[docs]    notReadyDialog = Signal(WindowSpecification)
+
+    def __init__(
+        self,
+        specifications: Optional[Sequence[WindowSpecification]] = None,
+        parent: Optional[QObject] = None,
+    ):
+        QThreadLogging.__init__(self, parent)
+
+        self._specifications: List[WindowSpecification] = (
+            specifications and list(self._specifications) or []
+        )
+
+        self._dialogs_not_ready: Set[WindowSpecification] = set(self._specifications)
+        self._dialogs_ready: Set[WindowSpecification] = set()
+
+        self._text_by_dialog: Dict[WindowSpecification, str] = {}
+
+        self._should_stop = False
+
+        self._timeout = 1 / len(self._dialogs_not_ready)
+        self._retry_interval = self._timeout / 5
+
+        assert self._timeout >= self._retry_interval * 2
+
+    @classmethod
+[docs]    def from_titles(cls, titles: Sequence[str], allow_magic_lookup: bool = False):
+        titles_escaped = [re.escape(title) for title in titles]
+        desktop = Desktop(allow_magic_lookup=allow_magic_lookup)
+        specifications = [
+            desktop.window(title_re=title_re) for title_re in titles_escaped
+        ]
+        return cls(specifications)
+
+[docs]    def get_text_of_dialog(
+        self,
+        dialog: WindowSpecification,
+        default: Optional[str] = None,
+    ):
+        if dialog in self._text_by_dialog:
+            dialog_text = self._text_by_dialog[dialog]
+        else:
+            try:
+                dialog_text = dialog.wrapper_object().window_text()
+            except ElementNotFoundError:
+                dialog_text = default
+            else:
+                self._text_by_dialog[dialog] = dialog_text
+        return dialog_text
+
+[docs]    def run(self):
+        while not self._should_stop:
+            for dialog in list(self._dialogs_not_ready):
+                try:
+                    dialog.wait("ready", self._timeout, self._retry_interval)
+                except (PywinautoTimeoutError, ElementNotFoundError):
+                    continue
+                else:
+                    dialog_text = self.get_text_of_dialog(dialog)
+                    self.logger.debug("Dialog found: %s", dialog_text)
+                    self._dialogs_not_ready.remove(dialog)
+                    self._dialogs_ready.add(dialog)
+                    self.readyDialog.emit(dialog)
+
+            for dialog in list(self._dialogs_ready):
+                try:
+                    dialog.wait_not("ready", self._timeout, self._retry_interval)
+                except (PywinautoTimeoutError, ElementNotFoundError):
+                    continue
+                else:
+                    dialog_text = self.get_text_of_dialog(dialog) or "(Unknown)"
+                    self.logger.debug("Dialog closed: %s", dialog_text)
+                    self._dialogs_ready.remove(dialog)
+                    self._dialogs_not_ready.add(dialog)
+                    self.notReadyDialog.emit(dialog)
+
+[docs]    def stop(self):
+        self._should_stop = True
+
+[docs]    def wait_for_termination(self, timeout=None):
+        if timeout is not None:
+            return self.wait(timeout)
+        else:
+            return self.wait()
+
+    def __enter__(self):
+        self.start()
+        return self
+
+    def __exit__(self, exc_type, exc_value, traceback):
+        self.stop()
+        self.wait_for_termination()
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/kiwoom_open_api_plus/utils/pyside2/QSignalHandler.html b/_modules/koapy/backend/kiwoom_open_api_plus/utils/pyside2/QSignalHandler.html new file mode 100644 index 00000000..404aefcc --- /dev/null +++ b/_modules/koapy/backend/kiwoom_open_api_plus/utils/pyside2/QSignalHandler.html @@ -0,0 +1,270 @@ + + + + + + + + koapy.backend.kiwoom_open_api_plus.utils.pyside2.QSignalHandler — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.kiwoom_open_api_plus.utils.pyside2.QSignalHandler

+import signal as signal_module
+import socket
+
+from signal import Signals
+from types import FrameType
+from typing import Iterable, Optional, overload
+
+from koapy.compat.pyside2.QtCore import QObject, Signal
+from koapy.compat.pyside2.QtNetwork import QAbstractSocket
+from koapy.utils.logging.pyside2.QAbstractSocketLogging import QAbstractSocketLogging
+
+
+[docs]class QSignalHandler(QAbstractSocketLogging):
+
+[docs]    signaled = Signal(Signals, FrameType)
+
+    @overload
+    def __init__(self, signals: Iterable[Signals], parent: Optional[QObject]):
+        ...
+
+    @overload
+    def __init__(self, parent: Optional[QObject]):
+        ...
+
+    def __init__(self, *args, **kwargs):
+        signals: Optional[Iterable[Signals]] = None
+        parent: Optional[QObject] = None
+
+        args = list(args)
+        kwargs = dict(kwargs)
+
+        if len(args) > 0 and not isinstance(args[0], QObject):
+            signals = args.pop(0)
+        elif "signals" in kwargs:
+            signals = kwargs.pop("signals")
+
+        if len(args) > 0:
+            parent = args[0]
+        elif "parent" in kwargs:
+            parent = kwargs["parent"]
+
+        self._signals = signals
+        self._parent = parent
+
+        QAbstractSocketLogging.__init__(
+            self, QAbstractSocket.UdpSocket, *args, **kwargs
+        )
+
+        self._old_wakeup_fd = None
+        self._old_signal_handlers = {}
+
+        self._wsock, self._rsock = socket.socketpair(socket.AF_INET, socket.SOCK_STREAM)
+
+        self.readyRead.connect(self.onReadyRead)
+
+[docs]    def onReadyRead(self):
+        # it is up to the library to remove any bytes from fd before calling poll or select again
+        # check https://docs.python.org/3.9/library/signal.html#signal.set_wakeup_fd for more details
+        data = self.readData(1)
+
+        # not actually using this, since file descriptor is used for wakeup purpose only
+        _signal = data[0]
+
+[docs]    def emitSignal(self, signal, frame):
+        signal = signal_module.Signals(signal)
+        self.signaled.emit(signal, frame)
+
+[docs]    def setWakeUpFileDescriptor(self, descriptor, warn_on_full_buffer=True):
+        old_wakeup_fd = signal_module.set_wakeup_fd(
+            descriptor, warn_on_full_buffer=warn_on_full_buffer
+        )
+        # remember first time replcement only
+        if self._old_wakeup_fd is None:
+            self._old_wakeup_fd = old_wakeup_fd
+        return old_wakeup_fd
+
+[docs]    def restoreWakeUpFileDescrptor(self):
+        if self._old_wakeup_fd is not None:
+            old_wakeup_fd = signal_module.set_wakeup_fd(self._old_wakeup_fd)
+            self._old_wakeup_fd = None
+            return old_wakeup_fd
+
+[docs]    def setHandler(self, signal, handler):
+        old_handler = signal_module.signal(signal, handler)
+        # remember first time replcement only
+        if signal not in self._old_signal_handlers:
+            self._old_signal_handlers[signal] = old_handler
+        return old_handler
+
+[docs]    def restoreHandler(self, signal, default=None):
+        if signal in self._old_signal_handlers:
+            if default is None:
+                default = signal_module.SIG_DFL
+            old_handler = self._old_signal_handlers.pop(signal, default)
+            old_handler = signal_module.signal(signal, old_handler)
+            return old_handler
+
+[docs]    def restoreAllHandlers(self):
+        if self._old_signal_handlers:
+            old_signal_handlers = dict(self._old_signal_handlers)
+            for signal, handler in old_signal_handlers.items():
+                self.restoreHandler(signal, handler)
+            self._old_signal_handlers = {}
+
+[docs]    def setAll(self):
+        self.setSocketDescriptor(self._rsock.fileno())
+
+        # setting warn_on_full_buffer=False, since we are using the wakeup fd only for wakeups
+        # check https://docs.python.org/3.9/library/signal.html#signal.set_wakeup_fd for more details
+        self.setWakeUpFileDescriptor(self._wsock.fileno(), warn_on_full_buffer=False)
+
+        if self._signals:
+            for signal in self._signals:
+                self.setHandler(signal, self.emitSignal)
+
+[docs]    def restoreAll(self):
+        self.restoreWakeUpFileDescrptor()
+        self.restoreAllHandlers()
+
+    def __del__(self):
+        self.restoreAll()
+
+    def __enter__(self):
+        self.setAll()
+        return self
+
+    def __exit__(self, exc_type, exc_value, traceback):
+        self.restoreAll()
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/kiwoom_open_api_plus/utils/pyside2/QThreadPoolExecutor.html b/_modules/koapy/backend/kiwoom_open_api_plus/utils/pyside2/QThreadPoolExecutor.html new file mode 100644 index 00000000..9df15488 --- /dev/null +++ b/_modules/koapy/backend/kiwoom_open_api_plus/utils/pyside2/QThreadPoolExecutor.html @@ -0,0 +1,242 @@ + + + + + + + + koapy.backend.kiwoom_open_api_plus.utils.pyside2.QThreadPoolExecutor — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.kiwoom_open_api_plus.utils.pyside2.QThreadPoolExecutor

+import atexit
+
+from concurrent.futures import Executor, Future
+from threading import RLock
+from typing import Any, Callable, Dict, List, Optional, Tuple, Union, overload
+
+from koapy.compat.pyside2.QtCore import QObject, QRunnable, QThreadPool
+
+
+[docs]class QThreadPoolExecutorRunnable(QRunnable):
+    def __init__(
+        self,
+        future: Future,
+        fn: Callable[..., Any],
+        args: Union[Tuple[Any], List[Any]],
+        kwargs: Dict[str, Any],
+    ):
+        super().__init__()
+
+        self._future = future
+        self._fn = fn
+        self._args = args
+        self._kwargs = kwargs
+
+[docs]    def run(self):
+        # pylint: disable=broad-except,self-cls-assignment
+        if not self._future.set_running_or_notify_cancel():
+            return
+        try:
+            result = self._fn(*self._args, **self._kwargs)
+        except BaseException as exc:
+            self._future.set_exception(exc)
+            # break a reference cycle with the exception 'exc'
+            self = None
+        else:
+            self._future.set_result(result)
+
+
+[docs]class QThreadPoolExecutor(QObject, Executor):
+    # pylint: disable=arguments-differ
+
+    @overload
+    def __init__(self, thread_pool: QThreadPool, parent: Optional[QObject]):
+        ...
+
+    @overload
+    def __init__(self, parent: Optional[QObject]):
+        ...
+
+    def __init__(self, *args, **kwargs):
+        thread_pool: Optional[QThreadPool] = None
+        parent: Optional[QObject] = None
+
+        args = list(args)
+        kwargs = dict(kwargs)
+
+        if len(args) > 0 and isinstance(args[0], QThreadPool):
+            thread_pool = args.pop(0)
+        elif "thread_pool" in kwargs:
+            thread_pool = kwargs.pop("thread_pool")
+
+        if len(args) > 0:
+            parent = args[0]
+        elif "parent" in kwargs:
+            parent = kwargs["parent"]
+
+        if thread_pool is None:
+            thread_pool = QThreadPool(self)
+
+        self._thread_pool = thread_pool
+        self._parent = parent
+
+        QObject.__init__(self, *args, **kwargs)
+        Executor.__init__(self)
+
+        self._shutdown = False
+        self._shutdown_lock = RLock()
+
+        atexit.register(self.shutdown)
+
+    def __del__(self):
+        atexit.unregister(self.shutdown)
+
+[docs]    def submit(self, fn, *args, **kwargs):
+        with self._shutdown_lock:
+            if self._shutdown:
+                raise RuntimeError("Cannot schedule new futures after shutdown")
+            future = Future()
+            runnable = QThreadPoolExecutorRunnable(future, fn, args, kwargs)
+            runnable.setAutoDelete(True)
+            self._thread_pool.start(runnable)
+            return future
+
+[docs]    def shutdown(self, wait=True, cancel_futures=False):
+        with self._shutdown_lock:
+            self._shutdown = True
+            if cancel_futures:
+                self._thread_pool.clear()
+        if wait:
+            self._thread_pool.waitForDone()
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/kiwoom_open_api_plus/utils/queue/QueueBasedBufferedIterator.html b/_modules/koapy/backend/kiwoom_open_api_plus/utils/queue/QueueBasedBufferedIterator.html new file mode 100644 index 00000000..9f7e4dd6 --- /dev/null +++ b/_modules/koapy/backend/kiwoom_open_api_plus/utils/queue/QueueBasedBufferedIterator.html @@ -0,0 +1,194 @@ + + + + + + + + koapy.backend.kiwoom_open_api_plus.utils.queue.QueueBasedBufferedIterator — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.kiwoom_open_api_plus.utils.queue.QueueBasedBufferedIterator

+import sys
+import threading
+
+from queue import Queue
+
+from koapy.backend.kiwoom_open_api_plus.utils.queue.QueueIterator import (
+    BufferedQueueIterator,
+)
+from koapy.utils.logging.Logging import Logging
+
+
+[docs]class QueueBasedBufferedIterator(BufferedQueueIterator, Logging):
+
+    _check_timeout = 1
+    _default_maxsize = 10
+
+    def __init__(self, iterator, queue=None, maxsize=None):
+        if queue is None:
+            if maxsize is None:
+                maxsize = self._default_maxsize
+            queue = Queue(maxsize)
+
+        self._iterator = iterator
+        self._queue = queue
+        self._maxsize = maxsize
+        self._exc_info = None
+
+        super().__init__(self._queue)
+
+        self._thread = threading.Thread(target=self._consume_iterator, daemon=True)
+        self._thread.start()
+
+    def _consume_iterator(self):
+        try:
+            for item in self._iterator:
+                self._queue.put(item)
+        except Exception:  # pylint: disable=broad-except
+            self.logger.exception("Exception raised while consuming iterator")
+            self._exc_info = sys.exc_info()
+
+[docs]    def next(self, block=True, timeout=None):
+        try:
+            item = super().next(block, timeout)
+        except StopIteration as e:
+            if self._exc_info is not None:
+                raise self._exc_info[1] from e
+            else:
+                raise e
+        else:
+            if self._exc_info is not None:
+                raise self._exc_info[1]
+        return item
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/kiwoom_open_api_plus/utils/queue/QueueBasedIterableObserver.html b/_modules/koapy/backend/kiwoom_open_api_plus/utils/queue/QueueBasedIterableObserver.html new file mode 100644 index 00000000..2236a62d --- /dev/null +++ b/_modules/koapy/backend/kiwoom_open_api_plus/utils/queue/QueueBasedIterableObserver.html @@ -0,0 +1,209 @@ + + + + + + + + koapy.backend.kiwoom_open_api_plus.utils.queue.QueueBasedIterableObserver — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.kiwoom_open_api_plus.utils.queue.QueueBasedIterableObserver

+from queue import Empty, Queue
+
+from rx.core.typing import Observer
+
+from koapy.backend.kiwoom_open_api_plus.utils.queue.QueueIterator import (
+    BufferedQueueIterator,
+)
+
+
+[docs]class QueueBasedIterableObserverIterator(BufferedQueueIterator):
+    def __init__(self, queue, sentinel):
+        self._queue = queue
+        self._sentinel = sentinel
+        super().__init__(self._queue)
+
+[docs]    def next(self, block=True, timeout=None):
+        value, error = super().next(block, timeout)
+        if value == self._sentinel:
+            raise StopIteration
+        elif error is not None and isinstance(error, Exception):
+            raise error
+        return value
+
+[docs]    def head(self):
+        value, error = super().head()
+        if value == self._sentinel:
+            raise Empty
+        elif error is not None and isinstance(error, Exception):
+            raise error
+        return value
+
+
+[docs]class QueueBasedIterableObserver(Observer):
+
+    _default_maxsize = 0
+    _queue_get_timeout = 2
+
+    def __init__(self, queue=None, maxsize=None):
+        if queue is None:
+            if maxsize is None:
+                maxsize = self._default_maxsize
+            queue = Queue(maxsize)
+
+        self._queue = queue
+        self._maxsize = maxsize
+        self._sentinel = object()
+
+        self._iterator = QueueBasedIterableObserverIterator(self._queue, self._sentinel)
+
+    @property
+[docs]    def queue(self):
+        return self._queue
+
+[docs]    def on_next(self, value):
+        self._queue.put((value, None))
+
+[docs]    def on_error(self, error):
+        self._queue.put((None, error))
+
+[docs]    def on_completed(self):
+        self._queue.put((self._sentinel, None))
+
+    def __iter__(self):
+        return self._iterator
+
+[docs]    def stop(self):
+        return self._iterator.stop()
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/kiwoom_open_api_plus/utils/queue/QueueIterator.html b/_modules/koapy/backend/kiwoom_open_api_plus/utils/queue/QueueIterator.html new file mode 100644 index 00000000..8c2964ae --- /dev/null +++ b/_modules/koapy/backend/kiwoom_open_api_plus/utils/queue/QueueIterator.html @@ -0,0 +1,225 @@ + + + + + + + + koapy.backend.kiwoom_open_api_plus.utils.queue.QueueIterator — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.kiwoom_open_api_plus.utils.queue.QueueIterator

+import atexit
+
+from queue import Empty
+
+
+[docs]class QueueIterator:
+
+    _check_timeout = 1
+
+    def __init__(self, queue):
+        self._queue = queue
+        self._should_stop = False
+
+        atexit.register(self.stop)
+
+    def __del__(self):
+        atexit.unregister(self.stop)
+
+    @property
+[docs]    def queue(self):
+        return self._queue
+
+[docs]    def next(self, block=True, timeout=None):
+        if block and timeout is None:
+            timeout = self._check_timeout
+            while not self._should_stop:
+                try:
+                    item = self._queue.get(block=block, timeout=timeout)
+                except Empty:
+                    pass
+                else:
+                    self._queue.task_done()
+                    return item
+            raise StopIteration
+        else:
+            item = self._queue.get(block=block, timeout=timeout)
+            self._queue.task_done()
+            return item
+
+[docs]    def next_nowait(self):
+        return self.next(block=False)
+
+[docs]    def has_next(self):
+        return not self._queue.empty()
+
+    def __iter__(self):
+        return self
+
+    def __next__(self):
+        return self.next()
+
+[docs]    def stop(self):
+        self._should_stop = True
+
+[docs]    def enable(self):
+        self._should_stop = False
+
+
+[docs]class BufferedQueueIterator(QueueIterator):
+    def __init__(self, queue):
+        super().__init__(queue)
+
+        self._none = object()
+        self._head = self._none
+
+[docs]    def next(self, block=True, timeout=None):
+        if self._head is not self._none:
+            item = self._head
+            self._head = self._none
+            return item
+        else:
+            return super().next(block, timeout)
+
+[docs]    def has_next(self):
+        return self._head is not self._none or super().has_next()
+
+[docs]    def head(self):
+        if self._head is not self._none:
+            return self._head
+        else:
+            item = self.next_nowait()  # raises queue.Empty if queue is empty
+            self._head = item
+            return self._head
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/kiwoom_open_api_w/core/KiwoomOpenApiWDynamicCallable.html b/_modules/koapy/backend/kiwoom_open_api_w/core/KiwoomOpenApiWDynamicCallable.html new file mode 100644 index 00000000..ea6b1be1 --- /dev/null +++ b/_modules/koapy/backend/kiwoom_open_api_w/core/KiwoomOpenApiWDynamicCallable.html @@ -0,0 +1,180 @@ + + + + + + + + koapy.backend.kiwoom_open_api_w.core.KiwoomOpenApiWDynamicCallable — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.kiwoom_open_api_w.core.KiwoomOpenApiWDynamicCallable

+from inspect import Signature
+
+from koapy.backend.kiwoom_open_api_w.core.KiwoomOpenApiWSignature import (
+    KiwoomOpenApiWDispatchSignature,
+)
+
+
+[docs]class KiwoomOpenApiWDynamicCallable:
+    def __init__(self, control, name):
+        self._control = control
+        self._name = name
+        self._signature = KiwoomOpenApiWDispatchSignature.from_name(self._name)
+        self._function = self._signature.to_pyside2_function_prototype()
+        self._should_test_return_type = (
+            self._signature.return_annotation is not Signature.empty
+        )
+
+[docs]    def is_valid_return_type(self, result):
+        if self._should_test_return_type and not isinstance(
+            result, self._signature.return_annotation
+        ):
+            return False
+        return True
+
+    def __call__(self, *args, **kwargs):
+        ba = self._signature.bind(*args, **kwargs)
+        ba.apply_defaults()
+        result = self._control.dynamicCall(self._function, list(ba.args))
+        if not self.is_valid_return_type(result):
+            raise TypeError(
+                "Return type of %s was expected for function call %s(...), but %s was found."
+                % (
+                    self._signature.return_annotation,
+                    self._name,
+                    type(result),
+                )
+            )
+        return result
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/kiwoom_open_api_w/core/KiwoomOpenApiWError.html b/_modules/koapy/backend/kiwoom_open_api_w/core/KiwoomOpenApiWError.html new file mode 100644 index 00000000..6e7fd7f9 --- /dev/null +++ b/_modules/koapy/backend/kiwoom_open_api_w/core/KiwoomOpenApiWError.html @@ -0,0 +1,318 @@ + + + + + + + + koapy.backend.kiwoom_open_api_w.core.KiwoomOpenApiWError — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.kiwoom_open_api_w.core.KiwoomOpenApiWError

+from functools import wraps
+
+
+[docs]class KiwoomOpenApiWError(Exception):
+    def __init__(self, message=None):
+        if message is not None:
+            super().__init__(message)
+        else:
+            super().__init__()
+
+        self._message = message
+
+    @property
+[docs]    def message(self):
+        return self._message
+
+    @classmethod
+[docs]    def try_or_raise(cls, arg, message=None):
+        return KiwoomOpenApiWNegativeReturnCodeError.try_or_raise(arg, message)
+
+    @classmethod
+[docs]    def try_or_raise_boolean(cls, arg, message):
+        return KiwoomOpenApiWBooleanReturnCodeError.try_or_raise(arg, message)
+
+
+[docs]class KiwoomOpenApiWNegativeReturnCodeError(KiwoomOpenApiWError):
+
+[docs]    OP_ERR_NONE = 0
+[docs]    OP_ERR_NO_LOGIN = -1
+[docs]    OP_ERR_LOGIN = -100
+[docs]    OP_ERR_CONNECT = -101
+[docs]    OP_ERR_VERSION = -102
+[docs]    OP_ERR_TRCODE = -103
+[docs]    OP_ERR_NO_REGOPENAPI = -104
+[docs]    OP_ERR_SISE_OVERFLOW = -200
+[docs]    OP_ERR_ORDER_OVERFLOW = -201
+[docs]    OP_ERR_RQ_WRONG_INPUT = -202
+[docs]    OP_ERR_ORD_WRONG_INPUT = -300
+[docs]    OP_ERR_ORD_WRONG_ACCPWD = -301
+[docs]    OP_ERR_ORD_WRONG_ACCNO = -302
+[docs]    OP_ERR_ORD_WRONG_QTY200 = -303
+[docs]    OP_ERR_ORD_WRONG_QTY400 = -304
+
+[docs]    MSG_ERR_NONE = "정상처리"
+[docs]    MSG_ERR_NO_LOGIN = "미접속상태"
+[docs]    MSG_ERR_LOGIN = "로그인시 접속 실패 (아이피 오류 또는 접속정보 오류)"
+[docs]    MSG_ERR_CONNECT = "서버 접속 실패"
+[docs]    MSG_ERR_VERSION = "버전처리가 실패하였습니다."
+[docs]    MSG_ERR_TRCODE = "TrCode 가 존재하지 않습니다."
+[docs]    MSG_ERR_NO_REGOPENAPI = "해외OpenAPI 미신청"
+[docs]    MSG_ERR_SISE_OVERFLOW = "조회과부화"
+[docs]    MSG_ERR_ORDER_OVERFLOW = "주문과부화"
+[docs]    MSG_ERR_RQ_WRONG_INPUT = "조회입력값(명칭/누락) 오류"
+[docs]    MSG_ERR_ORD_WRONG_INPUT = "주문입력갑 오류"
+[docs]    MSG_ERR_ORD_WRONG_ACCPWD = "계좌비밀번호를 입력하십시오."
+[docs]    MSG_ERR_ORD_WRONG_ACCNO = "타인 계좌를 사용할 수 없습니다."
+[docs]    MSG_ERR_ORD_WRONG_QTY200 = "경고-주문수량 200개 초과"
+[docs]    MSG_ERR_ORD_WRONG_QTY400 = "제한-주문수량 400개 초과"
+
+[docs]    ERROR_MESSAGE_BY_CODE = {
+        OP_ERR_NONE: MSG_ERR_NONE,
+        OP_ERR_NO_LOGIN: MSG_ERR_NO_LOGIN,
+        OP_ERR_LOGIN: MSG_ERR_LOGIN,
+        OP_ERR_CONNECT: MSG_ERR_CONNECT,
+        OP_ERR_VERSION: MSG_ERR_VERSION,
+        OP_ERR_TRCODE: MSG_ERR_TRCODE,
+        OP_ERR_NO_REGOPENAPI: MSG_ERR_NO_REGOPENAPI,
+        OP_ERR_SISE_OVERFLOW: MSG_ERR_SISE_OVERFLOW,
+        OP_ERR_ORDER_OVERFLOW: MSG_ERR_ORDER_OVERFLOW,
+        OP_ERR_RQ_WRONG_INPUT: MSG_ERR_RQ_WRONG_INPUT,
+        OP_ERR_ORD_WRONG_INPUT: MSG_ERR_ORD_WRONG_INPUT,
+        OP_ERR_ORD_WRONG_ACCPWD: MSG_ERR_ORD_WRONG_ACCPWD,
+        OP_ERR_ORD_WRONG_ACCNO: MSG_ERR_ORD_WRONG_ACCNO,
+        OP_ERR_ORD_WRONG_QTY200: MSG_ERR_ORD_WRONG_QTY200,
+        OP_ERR_ORD_WRONG_QTY400: MSG_ERR_ORD_WRONG_QTY400,
+    }
+
+    @classmethod
+[docs]    def get_error_message_by_code(cls, code, default=None):
+        return cls.ERROR_MESSAGE_BY_CODE.get(code, default)
+
+    @classmethod
+[docs]    def check_code_or_raise(cls, code):
+        if code < 0:
+            raise cls(code)
+        return code
+
+    @classmethod
+[docs]    def wrap_to_check_code_or_raise(cls, func):
+        @wraps(func)
+        def wrapper(*args, **kwargs):
+            return cls.check_code_or_raise(func(*args, **kwargs))
+
+        return wrapper
+
+    @classmethod
+[docs]    def try_or_raise(cls, arg, message=None):
+        if isinstance(arg, int):
+            return cls.check_code_or_raise(arg)
+        elif callable(arg):
+            return cls.wrap_to_check_code_or_raise(arg)
+        else:
+            raise TypeError("Expected 'int' or 'callable' but %s found" % type(arg))
+
+    def __init__(self, code, message=None):
+        if message is None:
+            message = self.get_error_message_by_code(code)
+
+        super().__init__(message)
+
+        self._code = code
+        self._message = message
+
+    def __str__(self):
+        return self._message
+
+    def __repr__(self):
+        return "{}({!r}, {!r})".format(
+            self.__class__.__name__, self._code, self._message
+        )
+
+    @property
+[docs]    def code(self):
+        return self._code
+
+
+[docs]class KiwoomOpenApiWBooleanReturnCodeError(KiwoomOpenApiWError):
+
+[docs]    OP_ERR_SUCCESS = 1
+[docs]    OP_ERR_FAILURE = 0
+
+    @classmethod
+[docs]    def check_code_or_raise(cls, code, message=None):
+        if not code:
+            raise cls(message)
+        return code
+
+    @classmethod
+[docs]    def wrap_to_check_code_or_raise(cls, func, message=None):
+        @wraps(func)
+        def wrapper(*args, **kwargs):
+            return cls.check_code_or_raise(func(*args, **kwargs), message)
+
+        return wrapper
+
+    @classmethod
+[docs]    def try_or_raise(cls, arg, message=None):
+        if isinstance(arg, (int, bool)):
+            return cls.check_code_or_raise(arg, message)
+        elif callable(arg):
+            return cls.wrap_to_check_code_or_raise(arg, message)
+        else:
+            raise TypeError(
+                "Expected 'int', 'bool' or 'callable' but %s found" % type(arg)
+            )
+
+    def __init__(self, code, message=None):
+        super().__init__(message)
+
+        self._code = code
+        self._message = message
+
+    def __str__(self):
+        if self._message:
+            return self._message
+        else:
+            return self.__repr__()
+
+    def __repr__(self):
+        return "{}({!r}, {!r})".format(
+            self.__class__.__name__, self._code, self._message
+        )
+
+    @property
+[docs]    def code(self):
+        return self._code
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/kiwoom_open_api_w/core/KiwoomOpenApiWEventHandler.html b/_modules/koapy/backend/kiwoom_open_api_w/core/KiwoomOpenApiWEventHandler.html new file mode 100644 index 00000000..08eaee56 --- /dev/null +++ b/_modules/koapy/backend/kiwoom_open_api_w/core/KiwoomOpenApiWEventHandler.html @@ -0,0 +1,246 @@ + + + + + + + + koapy.backend.kiwoom_open_api_w.core.KiwoomOpenApiWEventHandler — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.kiwoom_open_api_w.core.KiwoomOpenApiWEventHandler

+from contextlib import ExitStack
+from threading import RLock
+
+from koapy.backend.kiwoom_open_api_plus.utils.queue.QueueBasedIterableObserver import (
+    QueueBasedIterableObserver,
+)
+from koapy.backend.kiwoom_open_api_w.core.KiwoomOpenApiWEventHandlerFunctions import (
+    KiwoomOpenApiWEventHandlerFunctions,
+)
+from koapy.utils.notimplemented import isimplemented
+
+
+[docs]class KiwoomOpenApiWEventHandler(KiwoomOpenApiWEventHandlerFunctions):
+    def __init__(self, control):
+        self._control = control
+        self._observer = QueueBasedIterableObserver()
+        self._enter_count = 0
+        self._should_exit = False
+        self._stack = ExitStack()
+        self._lock = RLock()
+
+    @property
+[docs]    def control(self):
+        return self._control
+
+    @property
+[docs]    def observer(self):
+        return self._observer
+
+    @classmethod
+[docs]    def names(cls):
+        names = [
+            name
+            for name in dir(KiwoomOpenApiWEventHandlerFunctions)
+            if name.startswith("On")
+        ]
+        return names
+
+[docs]    def slots(self):
+        names = self.names()
+        slots = [getattr(self, name) for name in names]
+        names_and_slots_implemented = [
+            (name, slot) for name, slot in zip(names, slots) if isimplemented(slot)
+        ]
+        return names_and_slots_implemented
+
+[docs]    def connect(self):
+        for name, slot in self.slots():
+            getattr(self.control, name).connect(slot)
+
+[docs]    def disconnect(self):
+        for name, slot in self.slots():
+            getattr(self.control, name).disconnect(slot)
+
+[docs]    def on_enter(self):
+        pass
+
+[docs]    def on_exit(self, exc_type=None, exc_value=None, traceback=None):
+        pass
+
+[docs]    def add_callback(self, callback, *args, **kwargs):
+        self._stack.callback(callback, *args, **kwargs)
+
+[docs]    def enter(self):
+        with self._lock:
+            self.connect()
+            self.on_enter()
+            self._should_exit = True
+
+[docs]    def exit(self, exc_type=None, exc_value=None, traceback=None):
+        with self._lock:
+            if self._should_exit:
+                self.disconnect()
+                self.on_exit(exc_type, exc_value, traceback)
+                self._stack.__exit__(exc_type, exc_value, traceback)
+                self._should_exit = False
+
+[docs]    def stop(self):
+        return self.observer.stop()
+
+[docs]    def close(self):
+        self.exit()
+        self.stop()
+
+    def __enter__(self):
+        with self._lock:
+            if self._enter_count == 0:
+                self.enter()
+            self._enter_count += 1
+            return self
+
+    def __exit__(self, exc_type, exc_value, traceback):
+        if exc_type is not None:
+            return self.exit(exc_type, exc_value, traceback)
+        with self._lock:
+            if self._enter_count > 0:
+                self._enter_count -= 1
+            if self._enter_count == 0:
+                return self.exit(exc_type, exc_value, traceback)
+        return
+
+    def __iter__(self):
+        with self:
+            return iter(self.observer)
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/kiwoom_open_api_w/core/KiwoomOpenApiWEventHandlerFunctions.html b/_modules/koapy/backend/kiwoom_open_api_w/core/KiwoomOpenApiWEventHandlerFunctions.html new file mode 100644 index 00000000..4b50c135 --- /dev/null +++ b/_modules/koapy/backend/kiwoom_open_api_w/core/KiwoomOpenApiWEventHandlerFunctions.html @@ -0,0 +1,165 @@ + + + + + + + + koapy.backend.kiwoom_open_api_w.core.KiwoomOpenApiWEventHandlerFunctions — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.kiwoom_open_api_w.core.KiwoomOpenApiWEventHandlerFunctions

+from koapy.utils.notimplemented import notimplemented
+
+
+[docs]class KiwoomOpenApiWEventHandlerFunctions:
+    @notimplemented
+[docs]    def OnEventConnect(self, errcode):
+        raise NotImplementedError
+
+    @notimplemented
+[docs]    def OnReceiveMsg(self, scrnno, rqname, trcode, msg):
+        raise NotImplementedError
+
+    @notimplemented
+[docs]    def OnReceiveTrData(self, scrnno, rqname, trcode, recordname, prevnext):
+        raise NotImplementedError
+
+    @notimplemented
+[docs]    def OnReceiveRealData(self, code, realtype, realdata):
+        raise NotImplementedError
+
+    @notimplemented
+[docs]    def OnReceiveChejanData(self, gubun, itemcnt, fidlist):
+        raise NotImplementedError
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/kiwoom_open_api_w/core/KiwoomOpenApiWLoggingEventHandler.html b/_modules/koapy/backend/kiwoom_open_api_w/core/KiwoomOpenApiWLoggingEventHandler.html new file mode 100644 index 00000000..3f27793a --- /dev/null +++ b/_modules/koapy/backend/kiwoom_open_api_w/core/KiwoomOpenApiWLoggingEventHandler.html @@ -0,0 +1,170 @@ + + + + + + + + koapy.backend.kiwoom_open_api_w.core.KiwoomOpenApiWLoggingEventHandler — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.kiwoom_open_api_w.core.KiwoomOpenApiWLoggingEventHandler

+from koapy.backend.kiwoom_open_api_w.core.KiwoomOpenApiWEventHandler import (
+    KiwoomOpenApiWEventHandler,
+)
+from koapy.utils.logging.Logging import Logging
+
+
+[docs]class KiwoomOpenApiWLoggingEventHandler(KiwoomOpenApiWEventHandler, Logging):
+[docs]    def OnReceiveTrData(self, scrnno, rqname, trcode, recordname, prevnext):
+        self.logger.debug(
+            "OnReceiveTrData(%r, %r, %r, %r, %r)",
+            scrnno,
+            rqname,
+            trcode,
+            recordname,
+            prevnext,
+        )
+
+[docs]    def OnReceiveRealData(self, code, realtype, realdata):
+        self.logger.debug("OnReceiveRealData(%r, %r, %r)", code, realtype, realdata)
+
+[docs]    def OnReceiveMsg(self, scrnno, rqname, trcode, msg):
+        self.logger.debug("OnReceiveMsg(%r, %r, %r, %r)", scrnno, rqname, trcode, msg)
+
+[docs]    def OnReceiveChejanData(self, gubun, itemcnt, fidlist):
+        self.logger.debug("OnReceiveChejanData(%r, %r, %r)", gubun, itemcnt, fidlist)
+
+[docs]    def OnEventConnect(self, errcode):
+        self.logger.debug("OnEventConnect(%r)", errcode)
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/kiwoom_open_api_w/core/KiwoomOpenApiWQAxWidget.html b/_modules/koapy/backend/kiwoom_open_api_w/core/KiwoomOpenApiWQAxWidget.html new file mode 100644 index 00000000..035cb1ab --- /dev/null +++ b/_modules/koapy/backend/kiwoom_open_api_w/core/KiwoomOpenApiWQAxWidget.html @@ -0,0 +1,258 @@ + + + + + + + + koapy.backend.kiwoom_open_api_w.core.KiwoomOpenApiWQAxWidget — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.kiwoom_open_api_w.core.KiwoomOpenApiWQAxWidget

+from koapy.backend.kiwoom_open_api_w.core.KiwoomOpenApiWDynamicCallable import (
+    KiwoomOpenApiWDynamicCallable,
+)
+from koapy.backend.kiwoom_open_api_w.core.KiwoomOpenApiWLoggingEventHandler import (
+    KiwoomOpenApiWLoggingEventHandler,
+)
+from koapy.backend.kiwoom_open_api_w.core.KiwoomOpenApiWQAxWidgetMixin import (
+    KiwoomOpenApiWQAxWidgetMixin,
+)
+from koapy.backend.kiwoom_open_api_w.core.KiwoomOpenApiWSignalConnector import (
+    KiwoomOpenApiWSignalConnector,
+)
+from koapy.backend.kiwoom_open_api_w.core.KiwoomOpenApiWSignature import (
+    KiwoomOpenApiWDispatchSignature,
+    KiwoomOpenApiWEventHandlerSignature,
+)
+from koapy.compat.pyside2.QtAxContainer import QAxWidget
+from koapy.compat.pyside2.QtCore import QEvent, Qt
+from koapy.compat.pyside2.QtWidgets import QWidget
+from koapy.utils.logging.pyside2.QWidgetLogging import QWidgetLogging
+from koapy.utils.platform import is_32bit
+
+
+[docs]class KiwoomOpenApiWQAxWidget(QWidgetLogging, KiwoomOpenApiWQAxWidgetMixin):
+
+[docs]    CLSID = "{D1ACAB7D-A3AF-49E4-9004-C9E98344E17A}"
+
+[docs]    METHOD_NAMES = KiwoomOpenApiWDispatchSignature.names()
+[docs]    EVENT_NAMES = KiwoomOpenApiWEventHandlerSignature.names()
+
+    def __init__(self, *args, **kwargs):
+        # Check 32bit requirement
+        assert is_32bit(), "Control object should be created in 32bit environment"
+
+        # Process arguments
+        control = None
+        parent = None
+        window_flags = None
+
+        args = list(args)
+        kwargs = dict(kwargs)
+
+        if len(args) > 0 and isinstance(args[0], str):
+            control = args.pop(0)
+        elif "c" in kwargs:
+            control = kwargs.pop("c")
+
+        if len(args) > 0 and (args[0] is None or isinstance(args[0], QWidget)):
+            parent = args[0]
+        elif "parent" in kwargs:
+            parent = kwargs["parent"]
+
+        if len(args) > 1:
+            window_flags = args[1]
+        elif "f" in kwargs:
+            window_flags = kwargs["f"]
+
+        if control is None:
+            control = self.CLSID
+
+        # Call super inits
+        QWidgetLogging.__init__(self, *args, **kwargs)
+        KiwoomOpenApiWQAxWidgetMixin.__init__(self)
+
+        # Create QAxWidget
+        self._control = control
+        self._ax = QAxWidget(self._control, self)
+
+        # Check if instantiation of the QAxWidget was successful
+        successful = not self._ax.isNull()
+        if not successful:
+            raise RuntimeError(
+                "Requested control {} could not be instantiated".format(self._control)
+            )
+
+        # Set methods as attributes
+        for method_name in self.METHOD_NAMES:
+            dynamic_callable = KiwoomOpenApiWDynamicCallable(self._ax, method_name)
+            setattr(self, method_name, dynamic_callable)
+
+        # Set signals as attributes
+        for event_name in self.EVENT_NAMES:
+            signal_connector = KiwoomOpenApiWSignalConnector(event_name)
+            signal_connector.connect_to(self._ax)
+            setattr(self, event_name, signal_connector)
+
+        # Enable logging for QAxWidget exceptions
+        self._ax.exception.connect(self._onException)  # pylint: disable=no-member
+
+        # Enable logging for OpenAPI events
+        self._event_logger = KiwoomOpenApiWLoggingEventHandler(self)
+        self._event_logger.connect()
+
+    def _onException(
+        self, code, source, desc, help
+    ):  # pylint: disable=redefined-builtin
+        self.logger.error("QAxBaseException(%r, %r, %r, %r)", code, source, desc, help)
+
+    def __getattr__(self, name):
+        try:
+            return getattr(self._ax, name)
+        except AttributeError as e:
+            raise AttributeError(
+                "'{}' object has no attribute '{}'".format(
+                    self.__class__.__name__, name
+                )
+            ) from e
+
+[docs]    def changeEvent(self, event):
+        if event.type() == QEvent.WindowStateChange:
+            if self.windowState() & Qt.WindowMinimized:
+                event.accept()
+
+[docs]    def closeEvent(self, event):
+        self.hide()
+        event.ignore()
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/kiwoom_open_api_w/core/KiwoomOpenApiWQAxWidgetMixin.html b/_modules/koapy/backend/kiwoom_open_api_w/core/KiwoomOpenApiWQAxWidgetMixin.html new file mode 100644 index 00000000..08f9dbe0 --- /dev/null +++ b/_modules/koapy/backend/kiwoom_open_api_w/core/KiwoomOpenApiWQAxWidgetMixin.html @@ -0,0 +1,145 @@ + + + + + + + + koapy.backend.kiwoom_open_api_w.core.KiwoomOpenApiWQAxWidgetMixin — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.kiwoom_open_api_w.core.KiwoomOpenApiWQAxWidgetMixin

+[docs]class KiwoomOpenApiWQAxWidgetMixin:
+
+    pass
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/kiwoom_open_api_w/core/KiwoomOpenApiWSignalConnector.html b/_modules/koapy/backend/kiwoom_open_api_w/core/KiwoomOpenApiWSignalConnector.html new file mode 100644 index 00000000..b9bc5733 --- /dev/null +++ b/_modules/koapy/backend/kiwoom_open_api_w/core/KiwoomOpenApiWSignalConnector.html @@ -0,0 +1,208 @@ + + + + + + + + koapy.backend.kiwoom_open_api_w.core.KiwoomOpenApiWSignalConnector — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.kiwoom_open_api_w.core.KiwoomOpenApiWSignalConnector

+import inspect
+import threading
+
+from koapy.backend.kiwoom_open_api_w.core.KiwoomOpenApiWSignature import (
+    KiwoomOpenApiWEventHandlerSignature,
+)
+from koapy.compat.pyside2 import PYQT5, PYSIDE2, PythonQtError
+from koapy.utils.logging.Logging import Logging
+
+
+[docs]class KiwoomOpenApiWSignalConnector(Logging):
+    def __init__(self, name=None):
+        super().__init__()
+
+        self._name = name
+        self._lock = threading.RLock()
+        self._slots = list()
+
+        self._signature = KiwoomOpenApiWEventHandlerSignature.from_name(self._name)
+        self._param_types = [
+            (p.annotation) for p in self._signature.parameters.values()
+        ]
+        self._signal = self._signature.to_pyside2_event_signal()
+
+[docs]    def is_valid_slot(self, slot):
+        slot_signature = inspect.signature(slot)
+        slot_types = [(p.annotation) for p in slot_signature.parameters.values()]
+        condition = len(self._param_types) == len(
+            slot_types
+        )  # currently only check parameter length
+        return condition
+
+[docs]    def connect_to(self, control):
+        if PYSIDE2:
+            return control.connect(self._signal, self)
+        elif PYQT5:
+            return getattr(control, self._name).connect(self)
+        else:
+            raise PythonQtError("Unsupported Qt bindings")
+
+[docs]    def connect(self, slot):
+        if not self.is_valid_slot(slot):
+            raise TypeError("Invalid slot: %s" % slot)
+        with self._lock:
+            if slot not in self._slots:
+                self._slots.append(slot)
+
+[docs]    def disconnect(self, slot=None):
+        with self._lock:
+            if slot is None:
+                self._slots.clear()
+            elif slot in self._slots:
+                self._slots.remove(slot)
+            else:
+                self.logger.warning("Tried to disconnect a slot that doesn't exist")
+
+[docs]    def call(self, *args, **kwargs):
+        # make a copy in order to prevent modification during iteration problem
+        with self._lock:
+            slots = list(self._slots)
+        # TODO: use Thread with await/join for concurrency?
+        for slot in slots:
+            slot(*args, **kwargs)
+
+    def __call__(self, *args, **kwargs):
+        return self.call(*args, **kwargs)
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backend/kiwoom_open_api_w/core/KiwoomOpenApiWSignature.html b/_modules/koapy/backend/kiwoom_open_api_w/core/KiwoomOpenApiWSignature.html new file mode 100644 index 00000000..ba220208 --- /dev/null +++ b/_modules/koapy/backend/kiwoom_open_api_w/core/KiwoomOpenApiWSignature.html @@ -0,0 +1,327 @@ + + + + + + + + koapy.backend.kiwoom_open_api_w.core.KiwoomOpenApiWSignature — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backend.kiwoom_open_api_w.core.KiwoomOpenApiWSignature

+from collections import OrderedDict
+from inspect import Parameter, Signature
+
+import pythoncom
+
+from win32com.client import genpy, selecttlb
+
+from koapy.compat.pyside2.QtCore import SIGNAL
+
+
+[docs]def BuildOleItems(clsid):
+    tlbs = selecttlb.EnumTlbs()
+    tlbs = {tlb.clsid: tlb for tlb in tlbs}
+
+    tlbSpec = tlbs.get(clsid)
+
+    if tlbSpec is None:
+        return {}  # raise LookupError('KHOpenAPI Module not found')
+
+    if tlbSpec.dll is None:
+        tlb = pythoncom.LoadRegTypeLib(
+            tlbSpec.clsid, int(tlbSpec.major, 16), int(tlbSpec.minor, 16), tlbSpec.lcid
+        )
+    else:
+        tlb = pythoncom.LoadTypeLib(tlbSpec.dll)
+
+    gen = genpy.Generator(tlb, tlbSpec.dll, None, bBuildHidden=1)
+    oleItems, _enumItems, _recordItems, _vtableItems = gen.BuildOleItemsFromType()
+
+    oleItems = {str(clsId): oleItem for clsId, oleItem in oleItems.items()}
+
+    return oleItems
+
+
+[docs]class KiwoomOpenApiWSignature(Signature):
+
+[docs]    MODULE_CLSID = "{1F8A15ED-A979-488F-9694-1EDA98188FFC}"
+
+[docs]    OLE_ITEMS = BuildOleItems(MODULE_CLSID)
+
+[docs]    DISPATCH_CLSID = "{85B07632-4F84-4CEF-991D-C79DE781363D}"
+[docs]    EVENT_CLSID = "{952B31F8-06FD-4D5A-A021-5FF57F5030AE}"
+
+[docs]    PYTHONTYPE_TO_QTTYPE = {
+        int: "int",
+        str: "const QString&",
+    }
+
+[docs]    COMTYPE_TO_PYTHONTYPE = {
+        pythoncom.VT_I4: int,
+        pythoncom.VT_BSTR: str,
+        pythoncom.VT_VARIANT: type(
+            None
+        ),  # QVariant does not exist in PySide2 (Currently PyQt5 only)
+        pythoncom.VT_VOID: type(None),
+    }
+
+    def __init__(
+        self, name, parameters=None, return_annotation=Signature.empty, entry=None
+    ):
+        self._name = name
+        self._entry = entry
+        super().__init__(parameters, return_annotation=return_annotation)
+
+    @property
+[docs]    def name(self):
+        return self._name
+
+    @classmethod
+    def _pythontype_to_qttype(cls, typ):
+        return cls.PYTHONTYPE_TO_QTTYPE[typ]
+
+[docs]    def to_pyside2_function_prototype(self):
+        name = self._name
+        parameters = self.parameters
+        parameters = parameters.values()
+        parameters = [self._pythontype_to_qttype(p.annotation) for p in parameters]
+        prototype = "{}({})".format(name, ", ".join(parameters))
+        return prototype
+
+[docs]    def to_pyside2_event_signal(self):
+        return SIGNAL(self.to_pyside2_function_prototype())
+
+    @classmethod
+    def _comtype_to_pythontype(cls, typ):
+        return cls.COMTYPE_TO_PYTHONTYPE[typ]
+
+    @classmethod
+    def _from_entry(cls, name, entry):
+        arg_names = entry.names[1:]
+        arg_types = [typ[0] for typ in entry.desc[2]]
+        return_type = entry.desc[8][0]
+        parameters = [
+            Parameter(
+                name=arg_name,
+                kind=Parameter.POSITIONAL_OR_KEYWORD,
+                annotation=cls._comtype_to_pythontype(arg_type),
+            )
+            for arg_name, arg_type in zip(arg_names, arg_types)
+        ]
+        return_annotation = cls._comtype_to_pythontype(return_type)
+        signature = cls(
+            name=name,
+            parameters=parameters,
+            return_annotation=return_annotation,
+            entry=entry,
+        )
+        return signature
+
+
+[docs]class KiwoomOpenApiWDispatchSignature(KiwoomOpenApiWSignature):
+
+[docs]    DISPATCH_SIGNATURES_BY_NAME = {}
+
+    @classmethod
+[docs]    def from_name(cls, name):
+        return cls.DISPATCH_SIGNATURES_BY_NAME[name]
+
+    @classmethod
+[docs]    def names(cls):
+        return list(cls.DISPATCH_SIGNATURES_BY_NAME.keys())
+
+
+[docs]def LoadDispatchSignatures(oleItems, clsId):
+    if clsId not in oleItems:
+        return {}
+    dispatch = oleItems[clsId]
+    dispatch_funcs = [
+        (name, entry)
+        for name, entry in dispatch.mapFuncs.items()
+        if not any(
+            [
+                entry.desc[9] & pythoncom.FUNCFLAG_FRESTRICTED
+                and entry.desc[0] != pythoncom.DISPID_NEWENUM,
+                entry.desc[3] != pythoncom.FUNC_DISPATCH,
+                entry.desc[0] == pythoncom.DISPID_NEWENUM,
+            ]
+        )
+    ]
+    dispatch_signatures_by_name = OrderedDict()
+    for func_name, entry in dispatch_funcs:
+        signature = KiwoomOpenApiWDispatchSignature._from_entry(
+            func_name, entry
+        )  # pylint: disable=protected-access
+        dispatch_signatures_by_name[func_name] = signature
+    return dispatch_signatures_by_name
+
+
+[docs]KiwoomOpenApiWDispatchSignature.DISPATCH_SIGNATURES_BY_NAME = LoadDispatchSignatures(
+    KiwoomOpenApiWSignature.OLE_ITEMS, KiwoomOpenApiWSignature.DISPATCH_CLSID
+)
+
+
+[docs]class KiwoomOpenApiWEventHandlerSignature(KiwoomOpenApiWSignature):
+
+[docs]    EVENT_HANDLER_SIGNATURES_BY_NAME = {}
+
+    @classmethod
+[docs]    def from_name(cls, name):
+        return cls.EVENT_HANDLER_SIGNATURES_BY_NAME[name]
+
+    @classmethod
+[docs]    def names(cls):
+        return list(cls.EVENT_HANDLER_SIGNATURES_BY_NAME.keys())
+
+
+[docs]def LoadEventHandlerSignatures(oleItems, clsId):
+    if clsId not in oleItems:
+        return {}
+    event = oleItems[clsId]
+    event_funcs = event.mapFuncs.items()
+    event_handler_signatures_by_name = OrderedDict()
+    for func_name, entry in event_funcs:
+        signature = KiwoomOpenApiWEventHandlerSignature._from_entry(
+            func_name, entry
+        )  # pylint: disable=protected-access
+        event_handler_signatures_by_name[func_name] = signature
+    return event_handler_signatures_by_name
+
+
+[docs]KiwoomOpenApiWEventHandlerSignature.EVENT_HANDLER_SIGNATURES_BY_NAME = (
+    LoadEventHandlerSignatures(
+        KiwoomOpenApiWSignature.OLE_ITEMS, KiwoomOpenApiWSignature.EVENT_CLSID
+    )
+)
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backtrader/KiwoomOpenApiPlusBroker.html b/_modules/koapy/backtrader/KiwoomOpenApiPlusBroker.html new file mode 100644 index 00000000..1747d90e --- /dev/null +++ b/_modules/koapy/backtrader/KiwoomOpenApiPlusBroker.html @@ -0,0 +1,578 @@ + + + + + + + + koapy.backtrader.KiwoomOpenApiPlusBroker — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backtrader.KiwoomOpenApiPlusBroker

+import collections
+
+from backtrader import BrokerBase, BuyOrder, Order, SellOrder
+from backtrader.comminfo import CommInfoBase
+from backtrader.position import Position
+from backtrader.utils.py3 import with_metaclass
+
+from koapy.backtrader.KiwoomOpenApiPlusStore import KiwoomOpenApiPlusStore
+
+
+[docs]class KiwoomOpenApiPlusCommInfo(CommInfoBase):
+
+    # pylint: disable=no-member
+
+[docs]    params = (
+        ("stocklike", True),
+        ("commtype", CommInfoBase.COMM_PERC),
+        ("percabs", False),
+        ("commission", 0.015),
+        ("tax", 0.25),
+        ("mult", 1.0),
+    )
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+
+        if self._commtype == self.COMM_PERC and not self.p.percabs:
+            self.p.tax /= 100.0
+
+    def _getcommissionbuy(self, size, price, pseudoexec):
+        return size * price * self.p.commission * self.p.mult
+
+    def _getcommissionsell(self, size, price, pseudoexec):
+        return abs(size) * price * (self.p.commission + self.p.tax) * self.p.mult
+
+    def _getcommission(self, size, price, pseudoexec):
+        if size < 0:
+            return self._getcommissionsell(size, price, pseudoexec)
+        else:
+            return self._getcommissionbuy(size, price, pseudoexec)
+
+
+[docs]class MetaKiwoomOpenApiPlusBroker(BrokerBase.__class__):
+    def __init__(cls, name, bases, dct):
+        super().__init__(name, bases, dct)
+        KiwoomOpenApiPlusStore.BrokerCls = cls
+
+
+[docs]class KiwoomOpenApiPlusBroker(with_metaclass(MetaKiwoomOpenApiPlusBroker, BrokerBase)):
+
+[docs]    params = (
+        ("use_positions", True),
+        ("commission", KiwoomOpenApiPlusCommInfo()),
+    )
+
+    _store = KiwoomOpenApiPlusStore
+
+    def __init__(self, *args, **kwargs):
+        super().__init__()
+
+        self.k = self._store(*args, **kwargs)
+
+        self.orders = collections.OrderedDict()  # orders by order id
+        self.notifs = collections.deque()  # holds orders which are notified
+
+        self.opending = collections.defaultdict(list)  # pending transmission
+        self.brackets = dict()  # confirmed brackets
+
+        self.startingcash = self.cash = 0.0
+        self.startingvalue = self.value = 0.0
+        self.positions = collections.defaultdict(Position)
+
+[docs]    def start(self):
+        super().start()
+        self.k.start(broker=self)
+        self.startingcash = self.cash = self.k.get_cash()
+        self.startingvalue = self.value = self.k.get_value()
+
+        if self.p.use_positions:  # pylint: disable=no-member
+            for p in self.k.get_positions():
+                is_sell = p["side"] == "sell"
+                size = p["units"]
+                if is_sell:
+                    size = -size
+                price = p["avgPrice"]
+                self.positions[p["instrument"]] = Position(size, price)
+
+[docs]    def data_started(self, data):
+        pos = self.getposition(data)
+
+        if pos.size < 0:
+            # pylint: disable=unexpected-keyword-arg
+            order = SellOrder(
+                data=data,
+                size=pos.size,
+                price=pos.price,
+                exectype=Order.Market,
+                simulated=True,
+            )
+
+            order.addcomminfo(self.getcommissioninfo(data))
+            order.execute(
+                0,
+                pos.size,
+                pos.price,
+                0,
+                0.0,
+                0.0,
+                pos.size,
+                0.0,
+                0.0,
+                0.0,
+                0.0,
+                pos.size,
+                pos.price,
+            )
+
+            order.completed()
+            self.notify(order)
+
+        elif pos.size > 0:
+            # pylint: disable=unexpected-keyword-arg
+            order = BuyOrder(
+                data=data,
+                size=pos.size,
+                price=pos.price,
+                exectype=Order.Market,
+                simulated=True,
+            )
+
+            order.addcomminfo(self.getcommissioninfo(data))
+            order.execute(
+                0,
+                pos.size,
+                pos.price,
+                0,
+                0.0,
+                0.0,
+                pos.size,
+                0.0,
+                0.0,
+                0.0,
+                0.0,
+                pos.size,
+                pos.price,
+            )
+
+            order.completed()
+            self.notify(order)
+
+[docs]    def stop(self):
+        super().stop()
+        self.k.stop()
+
+[docs]    def getcash(self):
+        self.cash = self.k.get_cash()
+        return self.cash
+
+[docs]    def getvalue(self, datas=None):
+        self.value = self.k.get_value()
+        return self.value
+
+[docs]    def getposition(self, data, clone=True):  # pylint: disable=arguments-differ
+        pos = self.positions[data._dataname]  # pylint: disable=protected-access
+        if clone:
+            pos = pos.clone()
+        return pos
+
+[docs]    def orderstatus(self, order):
+        order = self.orders[order.ref]
+        return order.status
+
+    def _submit(self, oref):
+        order = self.orders[oref]
+        order.submit(self)
+        self.notify(order)
+        for o in self._bracketnotif(order):
+            o.submit(self)
+            self.notify(o)
+
+    def _reject(self, oref):
+        order = self.orders[oref]
+        order.reject(self)
+        self.notify(order)
+        self._bracketize(order, cancel=True)
+
+    def _accept(self, oref):
+        order = self.orders[oref]
+        order.accept()
+        self.notify(order)
+        for o in self._bracketnotif(order):
+            o.accept(self)
+            self.notify(o)
+
+    def _cancel(self, oref):
+        order = self.orders[oref]
+        order.cancel()
+        self.notify(order)
+        self._bracketize(order, cancel=True)
+
+    def _expire(self, oref):
+        order = self.orders[oref]
+        order.expire()
+        self.notify(order)
+        self._bracketize(order, cancel=True)
+
+    def _bracketnotif(self, order):
+        pref = getattr(order.parent, "ref", order.ref)  # parent ref or self
+        br = self.brackets.get(pref, None)  # to avoid recursion
+        return br[-2:] if br is not None else []
+
+    def _bracketize(self, order, cancel=False):
+        pref = getattr(order.parent, "ref", order.ref)  # parent ref or self
+        br = self.brackets.pop(pref, None)  # to avoid recursion
+        if br is None:
+            return
+
+        if not cancel:
+            if len(br) == 3:  # all 3 orders in place, parent was filled
+                br = br[1:]  # discard index 0, parent
+                for o in br:
+                    o.activate()  # simulate activate for children
+                self.brackets[pref] = br  # not done - reinsert children
+
+            elif len(br) == 2:  # filling a children
+                oidx = br.index(order)  # find index to filled (0 or 1)
+                self._cancel(br[1 - oidx].ref)  # cancel remaining (1 - 0 -> 1)
+        else:
+            # Any cancellation cancel the others
+            for o in br:
+                if o.alive():
+                    self._cancel(o.ref)
+
+    def _fill(self, oref, size, price, ttype, **kwargs):
+        order = self.orders[oref]
+
+        if not order.alive():  # can be a bracket
+            pref = getattr(order.parent, "ref", order.ref)
+            if pref not in self.brackets:
+                msg = (
+                    "Order fill received for {}, with price {} and size {} "
+                    "but order is no longer alive and is not a bracket. "
+                    "Unknown situation"
+                )
+                msg.format(order.ref, price, size)
+                self.put_notification(
+                    msg, order, price, size
+                )  # pylint: disable=no-member
+                return
+
+            # [main, stopside, takeside], neg idx to array are -3, -2, -1
+            if ttype == "STOP_LOSS_FILLED":
+                order = self.brackets[pref][-2]
+            elif ttype == "TAKE_PROFIT_FILLED":
+                order = self.brackets[pref][-1]
+            else:
+                msg = (
+                    "Order fill received for {}, with price {} and size {} "
+                    "but order is no longer alive and is a bracket. "
+                    "Unknown situation"
+                )
+                msg.format(order.ref, price, size)
+                self.put_notification(
+                    msg, order, price, size
+                )  # pylint: disable=no-member
+                return
+
+        data = order.data
+        pos = self.getposition(data, clone=False)
+        psize, pprice, opened, closed = pos.update(size, price)
+
+        comminfo = self.getcommissioninfo(data)  # pylint: disable=unused-variable
+
+        closedvalue = closedcomm = 0.0
+        openedvalue = openedcomm = 0.0
+        margin = pnl = 0.0
+
+        if size >= 0:
+            openedvalue = comminfo.getvaluesize(size, price)
+            openedcomm = comminfo.confirmexec(size, price)
+        else:
+            closedvalue = comminfo.getvaluesize(size, price)
+            closedcomm = comminfo.confirmexec(size, price)
+
+        order.execute(
+            data.datetime[0],
+            size,
+            price,
+            closed,
+            closedvalue,
+            closedcomm,
+            opened,
+            openedvalue,
+            openedcomm,
+            margin,
+            pnl,
+            psize,
+            pprice,
+        )
+
+        if order.executed.remsize:
+            order.partial()
+            self.notify(order)
+        else:
+            order.completed()
+            self.notify(order)
+            self._bracketize(order)
+
+    def _transmit(self, order):
+        oref = order.ref
+        pref = getattr(order.parent, "ref", oref)  # parent ref or self
+
+        if order.transmit:
+            if oref != pref:  # children order
+                # Put parent in orders dict, but add stopside and takeside
+                # to order creation. Return the takeside order, to have 3s
+                takeside = order  # alias for clarity
+                parent, stopside = self.opending.pop(pref)
+                for o in parent, stopside, takeside:
+                    self.orders[o.ref] = o  # write them down
+
+                self.brackets[pref] = [parent, stopside, takeside]
+                self.k.order_create(parent, stopside, takeside)
+                return takeside  # parent was already returned
+
+            else:  # Parent order, which is not being transmitted
+                self.orders[order.ref] = order
+                return self.k.order_create(order)
+
+        # Not transmitting
+        self.opending[pref].append(order)
+        return order
+
+[docs]    def buy(
+        self,
+        owner,
+        data,
+        size,
+        price=None,
+        plimit=None,
+        exectype=None,
+        valid=None,
+        tradeid=0,
+        oco=None,
+        trailamount=None,
+        trailpercent=None,
+        parent=None,
+        transmit=True,
+        **kwargs
+    ):  # pylint: disable=arguments-differ
+
+        # pylint: disable=unexpected-keyword-arg
+        order = BuyOrder(
+            owner=owner,
+            data=data,
+            size=size,
+            price=price,
+            pricelimit=plimit,
+            exectype=exectype,
+            valid=valid,
+            tradeid=tradeid,
+            trailamount=trailamount,
+            trailpercent=trailpercent,
+            parent=parent,
+            transmit=transmit,
+        )
+
+        order.addinfo(**kwargs)
+        order.addcomminfo(self.getcommissioninfo(data))
+        return self._transmit(order)
+
+[docs]    def sell(
+        self,
+        owner,
+        data,
+        size,
+        price=None,
+        plimit=None,
+        exectype=None,
+        valid=None,
+        tradeid=0,
+        oco=None,
+        trailamount=None,
+        trailpercent=None,
+        parent=None,
+        transmit=True,
+        **kwargs
+    ):  # pylint: disable=arguments-differ
+
+        # pylint: disable=unexpected-keyword-arg
+        order = SellOrder(
+            owner=owner,
+            data=data,
+            size=size,
+            price=price,
+            pricelimit=plimit,
+            exectype=exectype,
+            valid=valid,
+            tradeid=tradeid,
+            trailamount=trailamount,
+            trailpercent=trailpercent,
+            parent=parent,
+            transmit=transmit,
+        )
+
+        order.addinfo(**kwargs)
+        order.addcomminfo(self.getcommissioninfo(data))
+        return self._transmit(order)
+
+[docs]    def cancel(self, order):
+        order = self.orders[order.ref]
+        if order.status == Order.Cancelled:
+            return
+        return self.k.order_cancel(order)
+
+[docs]    def notify(self, order):
+        self.notifs.append(order.clone())
+
+[docs]    def get_notification(self):
+        if not self.notifs:
+            return None
+        return self.notifs.popleft()
+
+[docs]    def next(self):
+        self.notifs.append(None)
+
+    # below may not accurate
+
+[docs]    def submit(self, order):
+        return self._transmit(order)
+
+[docs]    def add_order_history(self, orders, notify=False):
+        return self.k.add_order_history(orders, notify)
+
+[docs]    def set_fund_history(self, fund):
+        return self.k.set_fund_history(fund)
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backtrader/KiwoomOpenApiPlusData.html b/_modules/koapy/backtrader/KiwoomOpenApiPlusData.html new file mode 100644 index 00000000..2ac6c902 --- /dev/null +++ b/_modules/koapy/backtrader/KiwoomOpenApiPlusData.html @@ -0,0 +1,507 @@ + + + + + + + + koapy.backtrader.KiwoomOpenApiPlusData — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backtrader.KiwoomOpenApiPlusData

+import datetime
+
+from backtrader import date2num, num2date
+from backtrader.feed import DataBase
+from backtrader.utils.py3 import queue
+from pytz import utc
+
+from koapy.backtrader.KiwoomOpenApiPlusStore import KiwoomOpenApiPlusStore
+from koapy.utils.logging.Logging import Logging
+
+
+[docs]class MetaKiwoomOpenApiPlusData(type(Logging), type(DataBase)):
+    def __init__(cls, clsname, bases, dct):
+        super().__init__(clsname, bases, dct)
+        KiwoomOpenApiPlusStore.DataCls = cls
+
+
+[docs]class KiwoomOpenApiPlusData(DataBase, Logging, metaclass=MetaKiwoomOpenApiPlusData):
+
+    # pylint: disable=no-member
+
+[docs]    params = (
+        ("qcheck", 0.5),
+        ("historical", False),  # do backfilling at the start
+        ("backfill_start", True),  # do backfilling at the start
+        ("backfill", True),  # do backfilling when reconnecting
+        ("backfill_from", None),  # additional data source to do backfill from
+        ("useask", False),
+        ("reconnect", True),
+        ("reconnections", -1),  # forever
+        ("reconntimeout", 5.0),
+        ("tz", "Asia/Seoul"),
+        (
+            "tzinput",
+            None,
+        ),  # this should be none (utc) since we are already putting datetimes converted to utc
+        ("calendar", None),
+    )
+
+    _store = KiwoomOpenApiPlusStore
+
+    _ST_FROM, _ST_START, _ST_LIVE, _ST_HISTORBACK, _ST_OVER = range(5)
+
+    def __init__(self, *args, **kwargs):
+        self.k = self._store(*args, **kwargs)
+
+        if self.p.dataname not in self.k.datanames:
+            self.k.datanames.append(self.p.dataname)
+
+        self.qlive = queue.Queue()
+        self.qhist = queue.Queue()
+
+        self.contractdetails = None
+
+        self._statelivereconn = False
+        self._storedmsg = dict()
+        self._state = self._ST_OVER
+        self._reconns = 0
+
+        self._tz = self._gettz()
+
+    def _timeoffset(self):
+        return self.k.timeoffset()
+
+[docs]    def isnaive(self, dt):
+        return dt.tzinfo is None or dt.tzinfo.utcoffset(dt) is None
+
+[docs]    def asutc(self, dt, tz=None, naive=True):
+        if tz is None:
+            tz = self._tz
+        if self.isnaive(dt) and tz is not None:
+            dt = tz.localize(dt)
+        dt = dt.astimezone(utc)
+        if naive:
+            dt = dt.replace(tzinfo=None)
+        return dt
+
+[docs]    def date2num(self, dt, tz=None):  # pylint: disable=arguments-differ
+        dt = self.asutc(dt, tz)
+        return date2num(dt)
+
+[docs]    def num2date(self, dt=None, tz=None, naive=False):
+        if dt is None:
+            dt = self.lines.datetime[0]
+        if tz is None:
+            tz = self._tz
+        return num2date(dt, tz, naive)
+
+[docs]    def fromtimestamp(self, timestamp, tz=None):
+        if tz is None:
+            tz = self._tz
+        return datetime.datetime.fromtimestamp(timestamp, tz=tz)
+
+[docs]    def islive(self):
+        return not self.p.historical
+
+[docs]    def setenvironment(self, env):
+        super().setenvironment(env)
+        env.addstore(self.k)
+
+[docs]    def start(self):
+        super().start()
+
+        self.qlive = queue.Queue()
+        self.qhist = queue.Queue()
+
+        self._statelivereconn = False
+        self._storedmsg = dict()
+        self._state = self._ST_OVER
+
+        self.k.start(data=self)
+
+        otf = self.k.get_granularity(self.p.timeframe, self.p.compression)
+
+        if otf is None:
+            self.logger.warning(
+                "Given timeframe and compression not supported: (%s, %s)",
+                self.p.timeframe,
+                self.p.compression,
+            )
+            self.put_notification(self.NOTSUPPORTED_TF)
+            self._state = self._ST_OVER
+            return
+
+        self.contractdetails = cd = self.k.get_instrument(self.p.dataname)
+
+        if cd is None:
+            self.logger.warning("Given dataname is not supported")
+            self.put_notification(self.NOTSUBSCRIBED)
+            self._state = self._ST_OVER
+            return
+
+        if self.p.backfill_from is not None:
+            self._state = self._ST_FROM
+            self.p.backfill_from.setenvironment(self._env)
+            self.p.backfill_from._start()  # pylint: disable=protected-access
+        else:
+            self._start_finish()
+            self._state = self._ST_START
+            self._st_start()
+
+        self._reconns = 0
+
+    def _st_start(self, instart=True, tmout=None):
+        if self.p.historical:
+            self.put_notification(self.DELAYED)
+
+            dtend = None
+            if self.todate < float("inf"):
+                dtend = self.num2date(self.todate)
+
+            dtbegin = None
+            if self.fromdate > float("-inf"):
+                dtbegin = self.num2date(self.fromdate)
+
+            self.qhist = self.k.candles(
+                self.p.dataname, dtbegin, dtend, self.p.timeframe, self.p.compression
+            )
+
+            self._state = self._ST_HISTORBACK
+
+            return True
+        else:
+            self.qlive = self.k.streaming_prices(self.p.dataname, tmout=tmout)
+
+            if instart:
+                self._statelivereconn = self.p.backfill_start
+            else:
+                self._statelivereconn = self.p.backfill
+
+            if self._statelivereconn:
+                self.put_notification(self.DELAYED)
+
+            self._state = self._ST_LIVE
+
+            if instart:
+                self._reconns = self.p.reconnections
+
+            if instart and not self.p.backfill_start:
+                self.put_notification(self.DELAYED)
+
+                msg = self.k.initial_today_historical_msg(data=self)
+
+                self.qhist.put(msg)
+                self.qhist.put({})
+
+                self._state = self._ST_HISTORBACK
+
+            return True
+
+[docs]    def stop(self):
+        super().stop()
+        self.k.stop()
+
+[docs]    def haslivedata(self):
+        return bool(self._storedmsg or not self.qlive.empty())
+
+    def _load(self):
+        if self._state == self._ST_OVER:
+            return False
+
+        while True:
+            if self._state == self._ST_LIVE:
+                try:
+                    msg = self._storedmsg.pop(None, None) or self.qlive.get(
+                        timeout=self._qcheck
+                    )
+                except queue.Empty:
+                    return None
+
+                if msg is None:
+                    self.put_notification(self.CONNBROKEN)
+
+                    if not self.p.reconnect or self._reconns == 0:
+                        self.put_notification(self.DISCONNECTED)
+                        self._state = self._ST_OVER
+                        return False
+
+                    self._reconns -= 1
+                    self._st_start(instart=False, tmout=self.p.reconntimeout)
+                    continue
+
+                if "code" in msg:
+                    self.put_notification(self.CONNBROKEN)
+
+                    code = msg["code"]
+
+                    if code not in [599, 598, 596]:
+                        self.put_notification(self.DISCONNECTED)
+                        self._state = self._ST_OVER
+                        return False
+
+                    if not self.p.reconnect or self._reconns == 0:
+                        self.put_notification(self.DISCONNECTED)
+                        self._state = self._ST_OVER
+                        return False
+
+                    self._reconns -= 1
+                    self._st_start(instart=False, tmout=self.p.reconntimeout)
+                    continue
+
+                self._reconns = self.p.reconnections
+
+                if not self._statelivereconn:
+                    if self._laststatus != self.LIVE:
+                        if self.qlive.qsize() <= 1:
+                            self.put_notification(self.LIVE)
+
+                    ret = self._load_tick(msg)
+                    if ret:
+                        return True
+                    continue
+
+                self._storedmsg[None] = msg
+
+                if self._laststatus != self.DELAYED:
+                    self.put_notification(self.DELAYED)
+
+                dtend = None
+                if len(self) > 1:
+                    dtbegin = self.datetime.datetime(-1)
+                elif self.fromdate > float("-inf"):
+                    dtbegin = self.num2date(self.fromdate)
+                else:
+                    dtbegin = None
+
+                dtend = self.fromtimestamp(int(msg["time"]) / 10**6)
+
+                self.qhist = self.k.candles(
+                    self.p.dataname,
+                    dtbegin,
+                    dtend,
+                    self.p.timeframe,
+                    self.p.compression,
+                )
+
+                self._state = self._ST_HISTORBACK
+                self._statelivereconn = False
+                continue
+
+            elif self._state == self._ST_HISTORBACK:
+                msg = self.qhist.get()
+                if msg is None:
+                    self.put_notification(self.DISCONNECTED)
+                    self._state = self._ST_OVER
+                    return False
+
+                elif "code" in msg:
+                    self.put_notification(self.NOTSUBSCRIBED)
+                    self.put_notification(self.DISCONNECTED)
+                    self._state = self._ST_OVER
+                    return False
+
+                if msg:
+                    if self._load_history(msg):
+                        return True
+                    continue
+                else:
+                    if self.p.historical:
+                        self.put_notification(self.DISCONNECTED)
+                        self._state = self._ST_OVER
+                        return False
+
+                self._state = self._ST_LIVE
+                continue
+
+            elif self._state == self._ST_FROM:
+                if not self.p.backfill_from.next():
+                    self._state = self._ST_START
+                    continue
+
+                # copy lines of the same name
+                for alias in self.lines.getlinealiases():
+                    lsrc = getattr(self.p.backfill_from.lines, alias)
+                    ldst = getattr(self.lines, alias)
+
+                    ldst[0] = lsrc[0]
+
+                return True
+
+            elif self._state == self._ST_START:
+                if not self._st_start(instart=False):
+                    self._state = self._ST_OVER
+                    return False
+
+    def _load_tick(self, msg):
+        dtobj = self.fromtimestamp(int(msg["time"]) / 10**6)
+        dt = self.date2num(dtobj)
+        if dt <= self.lines.datetime[-1]:
+            return False  # time already seen
+
+        # Common fields
+        self.lines.datetime[0] = dt
+        self.lines.volume[0] = 0.0
+        self.lines.openinterest[0] = 0.0
+
+        # Put the prices into the bar
+        tick = float(msg["ask"]) if self.p.useask else float(msg["bid"])
+        self.lines.open[0] = tick
+        self.lines.high[0] = tick
+        self.lines.low[0] = tick
+        self.lines.close[0] = tick
+        self.lines.volume[0] = 0.0
+        self.lines.openinterest[0] = 0.0
+
+        return True
+
+    def _load_history(self, msg):
+        dtobj = self.fromtimestamp(int(msg["time"]) / 10**6)
+        dt = self.date2num(dtobj)
+        if dt <= self.lines.datetime[-1]:
+            return False  # time already seen
+
+        # Common fields
+        self.lines.datetime[0] = dt
+        self.lines.volume[0] = float(msg["volume"])
+        self.lines.openinterest[0] = 0.0
+
+        # Put the prices into the bar
+        self.lines.open[0] = float(msg["open"])
+        self.lines.high[0] = float(msg["high"])
+        self.lines.low[0] = float(msg["low"])
+        self.lines.close[0] = float(msg["close"])
+
+        return True
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backtrader/KiwoomOpenApiPlusEventStreamer.html b/_modules/koapy/backtrader/KiwoomOpenApiPlusEventStreamer.html new file mode 100644 index 00000000..e2a246a9 --- /dev/null +++ b/_modules/koapy/backtrader/KiwoomOpenApiPlusEventStreamer.html @@ -0,0 +1,464 @@ + + + + + + + + koapy.backtrader.KiwoomOpenApiPlusEventStreamer — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backtrader.KiwoomOpenApiPlusEventStreamer

+import datetime
+import threading
+
+import rx
+
+from exchange_calendars import get_calendar
+from rx import operators as ops
+from rx.core.typing import Observer
+from rx.scheduler import ThreadPoolScheduler
+from rx.subject import Subject
+
+from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusRealType import (
+    KiwoomOpenApiPlusRealType,
+)
+from koapy.backend.kiwoom_open_api_plus.grpc import KiwoomOpenApiPlusService_pb2
+from koapy.backend.kiwoom_open_api_plus.utils.queue.QueueBasedBufferedIterator import (
+    QueueBasedBufferedIterator,
+)
+from koapy.backend.kiwoom_open_api_plus.utils.queue.QueueBasedIterableObserver import (
+    QueueBasedIterableObserver,
+)
+from koapy.utils.logging.Logging import Logging
+
+
+[docs]class KiwoomOpenApiPlusPriceEventChannel(Logging):
+
+    _krx_timezone = get_calendar("XKRX").tz
+
+    def __init__(self, stub):
+        self._stub = stub
+        self._fid_list = KiwoomOpenApiPlusRealType.get_fids_by_realtype_name("주식시세")
+
+        self._request_observer = QueueBasedIterableObserver()
+        self._request_iterator = iter(self._request_observer)
+        self._response_iterator = self._stub.BidirectionalRealCall(
+            self._request_iterator
+        )
+        self._response_subject = Subject()
+        self._response_scheduler_max_workers = 8
+        self._response_scheduler = ThreadPoolScheduler(
+            self._response_scheduler_max_workers
+        )
+        self._buffered_response_iterator = QueueBasedBufferedIterator(
+            self._response_iterator
+        )
+        self._response_observable = rx.from_iterable(
+            self._buffered_response_iterator, self._response_scheduler
+        )
+        self._response_subscription = self._response_observable.subscribe(
+            self._response_subject
+        )
+
+        self._subjects_by_code = {}
+
+        self.initialize()
+
+[docs]    def close(self):
+        for _code, (_subject, subscription) in self._subjects_by_code.items():
+            subscription.dispose()
+        self._response_subscription.dispose()
+        self._buffered_response_iterator.stop()
+        self._response_iterator.cancel()
+
+    def __del__(self):
+        self.close()
+
+[docs]    def initialize(self):
+        request = KiwoomOpenApiPlusService_pb2.BidirectionalRealRequest()
+        request.initialize_request.fid_list.extend(
+            self._fid_list
+        )  # pylint: disable=no-member
+        self._request_observer.on_next(request)
+
+[docs]    def register_code(self, code):
+        request = KiwoomOpenApiPlusService_pb2.BidirectionalRealRequest()
+        code_list = [code]
+        fid_list = KiwoomOpenApiPlusRealType.get_fids_by_realtype_name("주식시세")
+        request.register_request.code_list.extend(
+            code_list
+        )  # pylint: disable=no-member
+        request.register_request.fid_list.extend(fid_list)  # pylint: disable=no-member
+        self._request_observer.on_next(request)
+        self.logger.debug("Registering code %s for real events", code)
+
+[docs]    def is_for_code(self, response, code):
+        return response.arguments[0].string_value == code
+
+[docs]    def filter_for_code(self, code):
+        return ops.filter(lambda response: self.is_for_code(response, code))
+
+[docs]    def is_valid_price_event(self, response):
+        return all(name in response.single_data.names for name in ["20", "27", "28"])
+
+[docs]    def filter_price_event(self):
+        return ops.filter(self.is_valid_price_event)
+
+[docs]    def time_to_timestamp(self, fid20):
+        dt = datetime.datetime.now(self._krx_timezone).date()
+        tm = datetime.datetime.strptime(fid20, "%H%M%S").time()
+        dt = datetime.datetime.combine(dt, tm)
+        dt = self._krx_timezone.localize(dt)
+        return dt.timestamp() * (10**6)
+
+[docs]    def event_to_dict(self, response):
+        single_data = dict(zip(response.single_data.names, response.single_data.values))
+        result = {
+            "time": self.time_to_timestamp(single_data["20"]),
+            "bid": abs(float(single_data["28"])),
+            "ask": abs(float(single_data["27"])),
+        }
+        return result
+
+[docs]    def convert_to_dict(self):
+        return ops.map(self.event_to_dict)
+
+[docs]    def get_observable_for_code(self, code):
+        self.register_code(code)
+        if code not in self._subjects_by_code:
+            subject = Subject()
+            subscription = self._response_subject.pipe(
+                self.filter_for_code(code),
+                self.filter_price_event(),
+                self.convert_to_dict(),
+            ).subscribe(subject)
+            self._subjects_by_code[code] = (subject, subscription)
+        subject, subscription = self._subjects_by_code[code]
+        return subject
+
+
+[docs]class KiwoomOpenApiPlusOrderEventChannel:
+    def __init__(self, stub):
+        self._stub = stub
+
+        request = KiwoomOpenApiPlusService_pb2.ListenRequest()
+        self._response_iterator = self._stub.OrderListen(request)
+        self._response_subject = Subject()
+        self._response_scheduler_max_workers = 8
+        self._response_scheduler = ThreadPoolScheduler(
+            self._response_scheduler_max_workers
+        )
+        self._buffered_response_iterator = QueueBasedBufferedIterator(
+            self._response_iterator
+        )
+        self._response_observable = rx.from_iterable(
+            self._buffered_response_iterator, self._response_scheduler
+        )
+        self._response_subscription = self._response_observable.subscribe(
+            self._response_subject
+        )
+
+        self._observable = Subject()
+        self._subscription = self._response_subject.pipe(
+            self.filter_chejan_response(),
+            self.convert_to_dict(),
+        ).subscribe(self._observable)
+
+[docs]    def close(self):
+        self._subscription.dispose()
+        self._response_subscription.dispose()
+        self._buffered_response_iterator.stop()
+        self._response_iterator.cancel()
+
+    def __del__(self):
+        self.close()
+
+[docs]    def is_chejan_response(self, response):
+        name = response.name
+        gubun = response.arguments[0].string_value
+        if name == "OnReceiveChejanData" and gubun == "0":
+            data = dict(zip(response.single_data.names, response.single_data.values))
+            order_type = data["주문구분"]
+            hoga_type = data["매매구분"]
+            status = data["주문상태"]
+            market_order_created_and_filled = (
+                order_type in ["+매수", "-매도"]
+                and hoga_type in ["시장가"]
+                and status in ["체결"]
+            )
+            limit_order_created = (
+                order_type in ["+매수", "-매도"]
+                and hoga_type in ["보통"]
+                and status in ["접수"]
+                and data["819"] in ["0"]
+            )  # 취소 확인 뒤에 오는 원주문 이벤트는 819 가 1 로 들어오는 것 같음
+            order_filled = order_type in ["+매수", "-매도"] and status in ["체결"]
+            order_canceled = order_type in ["매수취소", "매도취소"] and status in ["확인"]
+            condition = any(
+                [
+                    market_order_created_and_filled,
+                    limit_order_created,
+                    order_filled,
+                    order_canceled,
+                ]
+            )
+            return condition
+        return False
+
+[docs]    def filter_chejan_response(self):
+        return ops.filter(self.is_chejan_response)
+
+[docs]    def event_to_dict(self, response):
+        result = {}
+        data = dict(zip(response.single_data.names, response.single_data.values))
+        original_order_no = data["원주문번호"]
+        if int(original_order_no):
+            status = data["주문상태"]
+            if status == "확인":
+                reject_reason = data["거부사유"]
+                result = {
+                    "type": "ORDER_CANCEL",
+                    "orderId": original_order_no,
+                    "reason": reject_reason if int(reject_reason) else "ORDER_FILLED",
+                }
+        else:
+            status = data["주문상태"]
+            hoga_type = data["매매구분"]
+            if status == "접수":
+                if hoga_type == "보통":
+                    order_no = data["주문번호"]
+                    result = {
+                        "type": "LIMIT_ORDER_CREATE",
+                        "id": order_no,
+                    }
+                elif hoga_type == "시장가":
+                    pass
+                else:
+                    self.logger.warning("Unexpected hoga type %s", hoga_type)
+            elif status == "체결":
+                if hoga_type == "보통":
+                    order_no = data["주문번호"]
+                    units = data["단위체결량"]
+                    buy_or_sell = data["주문구분"]
+                    side = {
+                        "+매수": "buy",
+                        "-매도": "sell",
+                    }[buy_or_sell]
+                    price = data["단위체결가"]
+                    result = {
+                        "type": "ORDER_FILLED",
+                        "orderId": order_no,
+                        "units": int(units),
+                        "side": side,
+                        "price": abs(float(price)),
+                    }
+                elif hoga_type == "시장가":
+                    order_no = data["주문번호"]
+                    units = data["단위체결량"]
+                    buy_or_sell = data["주문구분"]
+                    side = {
+                        "+매수": "buy",
+                        "-매도": "sell",
+                    }[buy_or_sell]
+                    price = data["단위체결가"]
+                    result = {
+                        "type": "MARKET_ORDER_CREATE",
+                        "id": order_no,
+                        "tradeOpened": {"id": order_no},
+                        "units": int(units),
+                        "side": side,
+                        "price": abs(float(price)),
+                    }
+                else:
+                    self.logger.warning("Unexpected hoga type %s", hoga_type)
+            else:
+                self.logger.warning("Unexcpected status %s", status)
+        return result
+
+[docs]    def convert_to_dict(self):
+        return ops.map(self.event_to_dict)
+
+[docs]    def get_observable(self):
+        return self._observable
+
+
+[docs]class MetaKiwoomOpenApiPlusEventStreamer(type(Logging), type(Observer)):
+    pass
+
+
+[docs]class KiwoomOpenApiPlusEventStreamer(
+    Observer, Logging, metaclass=MetaKiwoomOpenApiPlusEventStreamer
+):
+
+    _price_event_channels_by_stub = {}
+    _order_event_channels_by_stub = {}
+
+    _lock = threading.RLock()
+
+    def __init__(self, stub, queue):
+        super().__init__()
+        self._stub = stub
+        self._queue = queue
+
+[docs]    def on_next(self, value):
+        self._queue.put(value)
+
+[docs]    def on_error(self, error):
+        self.logger.error("Streamer.on_error(%s)", error)
+
+[docs]    def on_completed(self):
+        pass
+
+[docs]    def rates(self, code):
+        with self._lock:
+            if self._stub not in self._price_event_channels_by_stub:
+                self._price_event_channels_by_stub[
+                    self._stub
+                ] = KiwoomOpenApiPlusPriceEventChannel(self._stub)
+            event_channel = self._price_event_channels_by_stub[self._stub]
+        subscription = event_channel.get_observable_for_code(code).subscribe(self)
+        self.logger.debug("Subscribing rates for code %s", code)
+        return subscription
+
+[docs]    def events(self):
+        with self._lock:
+            if self._stub not in self._order_event_channels_by_stub:
+                self._order_event_channels_by_stub[
+                    self._stub
+                ] = KiwoomOpenApiPlusOrderEventChannel(self._stub)
+            event_channel = self._order_event_channels_by_stub[self._stub]
+        subscription = event_channel.get_observable().subscribe(self)
+        self.logger.debug("Subscribing order events")
+        return subscription
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backtrader/KiwoomOpenApiPlusStore.html b/_modules/koapy/backtrader/KiwoomOpenApiPlusStore.html new file mode 100644 index 00000000..fc219e93 --- /dev/null +++ b/_modules/koapy/backtrader/KiwoomOpenApiPlusStore.html @@ -0,0 +1,951 @@ + + + + + + + + koapy.backtrader.KiwoomOpenApiPlusStore — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backtrader.KiwoomOpenApiPlusStore

+import collections
+import datetime
+import threading
+import time
+
+import backtrader as bt
+import numpy as np
+import pandas as pd
+
+from backtrader import TimeFrame
+from backtrader.metabase import MetaParams
+from backtrader.utils.py3 import queue
+from exchange_calendars import get_calendar
+
+from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusEntrypoint import (
+    KiwoomOpenApiPlusEntrypoint,
+)
+from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusError import (
+    KiwoomOpenApiPlusError,
+    KiwoomOpenApiPlusNegativeReturnCodeError,
+)
+from koapy.backtrader.KiwoomOpenApiPlusEventStreamer import (
+    KiwoomOpenApiPlusEventStreamer,
+)
+from koapy.utils.logging.Logging import Logging
+
+
+[docs]class KiwoomOpenApiPlusJsonError(KiwoomOpenApiPlusNegativeReturnCodeError):
+    def __init__(self, code, message=None):
+        if isinstance(code, KiwoomOpenApiPlusError):
+            err = code
+            code = getattr(
+                err, "code", KiwoomOpenApiPlusNegativeReturnCodeError.OP_ERR_FAIL
+            )
+            message = err.message
+        super().__init__(code, message)
+
+[docs]    def error_response(self, description=None):
+        response = {
+            "code": self.code,
+            "message": self.message,
+            "description": description or "",
+        }
+        return response
+
+
+[docs]class KiwoomOpenApiPlusTimeFrameError(KiwoomOpenApiPlusJsonError):
+    def __init__(self):
+        super().__init__(code=597, message="Given TimeFrame is not supported")
+
+
+[docs]class HistoricalPriceRecord(
+    collections.namedtuple(
+        "HistoricalPriceRecord", ["time", "open", "high", "low", "close", "volume"]
+    )
+):
+
+    __slots__ = ()
+
+    _krx_timezone = get_calendar("XKRX").tz
+
+    @classmethod
+[docs]    def from_tuple(cls, tup):
+        if "일자" in tup._fields:
+            dt = datetime.datetime.strptime(tup.일자, "%Y%m%d")
+            dt = cls._krx_timezone.localize(dt)
+            time = dt.timestamp() * (10**6)  # pylint: disable=redefined-outer-name
+        elif "체결시간" in tup._fields:
+            dt = datetime.datetime.strptime(tup.체결시간, "%Y%m%d%H%M%S")
+            dt = cls._krx_timezone.localize(dt)
+            time = dt.timestamp() * (10**6)
+        else:
+            raise KiwoomOpenApiPlusError("Cannot specify time")
+        open = abs(float(tup.시가))  # pylint: disable=redefined-builtin
+        high = abs(float(tup.고가))
+        low = abs(float(tup.저가))
+        close = abs(float(tup.현재가))
+        volume = abs(float(tup.거래량))
+        return cls(time, open, high, low, close, volume)
+
+    @classmethod
+[docs]    def records_from_dataframe(cls, df):
+        return [cls.from_tuple(tup) for tup in df[::-1].itertuples()]
+
+    @classmethod
+[docs]    def dict_records_from_dataframe(cls, df):
+        return [msg._asdict() for msg in cls.records_from_dataframe(df)]
+
+
+[docs]class API:
+
+    # 우선은 최대한 기존 Oanda 구현을 유지한채로 맞춰서 동작할 수 있도록 구현해놓고
+    # 추후 동작이 되는게 확인되면 천천히 하단 API 에 맞게 최적화를 하는 방향으로 작업하는 것으로...
+
+    _krx_timezone = get_calendar("XKRX").tz
+
+    def __init__(self, context):
+        self._context = context
+        self._codes = self._context.GetCodeListByMarketAsList()
+
+    def __getattr__(self, name):
+        return getattr(self._context, name)
+
+[docs]    def get_instruments_original(
+        self, account, instruments
+    ):  # TODO: 계좌에 따라 시장이 다를 수 있음
+        instruments = self.GetStockInfoAsDataFrame(instruments)
+        instruments = [tup._asdict() for tup in instruments.itertuples(index=False)]
+        response = {"instruments": instruments}
+        return response
+
+[docs]    def get_instruments(self, account, instruments):
+        if isinstance(instruments, str):
+            instruments = [instruments]
+        instruments = [inst for inst in instruments if inst in self._codes]
+        response = {"instruments": instruments}
+        return response
+
+[docs]    def get_history(self, trcode, inputs, dtbegin=None, dtend=None):
+        if trcode == "opt10079":
+            code = inputs["종목코드"]
+            interval = inputs["틱범위"]
+            adjusted_price = inputs.get("수정주가구분") == "1"
+            df = self.GetTickStockDataAsDataFrame(
+                code, interval, dtend, dtbegin, adjusted_price=adjusted_price
+            )
+        elif trcode == "opt10080":
+            code = inputs["종목코드"]
+            interval = inputs["틱범위"]
+            adjusted_price = inputs.get("수정주가구분") == "1"
+            df = self.GetMinuteStockDataAsDataFrame(
+                code, interval, dtend, dtbegin, adjusted_price=adjusted_price
+            )
+        elif trcode == "opt10081":
+            code = inputs["종목코드"]
+            adjusted_price = inputs.get("수정주가구분") == "1"
+            df = self.GetDailyStockDataAsDataFrame(
+                code, dtend, dtbegin, adjusted_price=adjusted_price
+            )
+        elif trcode == "opt10082":
+            code = inputs["종목코드"]
+            adjusted_price = inputs.get("수정주가구분") == "1"
+            df = self.GetWeeklyStockDataAsDataFrame(
+                code, dtend, dtbegin, adjusted_price=adjusted_price
+            )
+        elif trcode == "opt10083":
+            code = inputs["종목코드"]
+            adjusted_price = inputs.get("수정주가구분") == "1"
+            df = self.GetMonthlyStockDataAsDataFrame(
+                code, dtend, dtbegin, adjusted_price=adjusted_price
+            )
+        elif trcode == "opt10094":
+            code = inputs["종목코드"]
+            adjusted_price = inputs.get("수정주가구분") == "1"
+            df = self.GetYearlyStockDataAsDataFrame(
+                code, dtend, dtbegin, adjusted_price=adjusted_price
+            )
+        else:
+            raise KiwoomOpenApiPlusError("Unexpected trcode %s" % trcode)
+
+        candles = HistoricalPriceRecord.dict_records_from_dataframe(df)
+        response = {"candles": candles}
+        return response
+
+[docs]    def get_positions(self, account):
+        _summary, foreach = self.GetAccountEvaluationStatusAsSeriesAndDataFrame(account)
+        positions = [
+            {
+                "instrument": tup.종목코드,
+                "side": "buy",
+                "units": float(tup.보유수량),
+                "avgPrice": float(tup.매입금액) / float(tup.보유수량),
+            }
+            for tup in foreach.itertuples()
+        ]
+        response = {"positions": positions}
+        return response
+
+[docs]    def get_account(self, account):
+        summary, _foreach = self.GetAccountEvaluationStatusAsSeriesAndDataFrame(account)
+        response = {
+            "marginAvail": float(summary["D+2추정예수금"]),
+            "balance": float(summary["추정예탁자산"]),
+        }
+        return response
+
+[docs]    def create_order(self, account, **kwargs):
+        request_name = "create_order({}, {})".format(account, kwargs)
+        screen_no = ""
+        account_no = account
+        order_type = {
+            "buy": 1,
+            "sell": 2,
+        }[kwargs["side"]]
+        code = kwargs["instrument"]
+        quantity = kwargs["units"]
+        price = kwargs.get("price", 0)
+        quote_type = {
+            "limit": "00",
+            "market": "03",
+        }[kwargs["type"]]
+        original_order_no = ""
+        responses = self.OrderCall(
+            request_name,
+            screen_no,
+            account_no,
+            order_type,
+            code,
+            quantity,
+            price,
+            quote_type,
+            original_order_no,
+        )
+
+        MAX_ORDER_RES_CNT = 5
+        for i in range(MAX_ORDER_RES_CNT):
+            res = next(responses)
+            if (
+                res.name == "OnReceiveChejanData"
+                and res.arguments[0].string_value == "0"  # 주문접수 or 체결
+            ):
+                break
+
+        accept_data = dict(zip(res.single_data.names, res.single_data.values))
+        result = {"orderOpened": {"id": accept_data["주문번호"]}}
+        return result
+
+[docs]    def close_order(self, account, oid, size, dataname):
+        request_name = "close_order({}, {}, {}, {})".format(
+            account, oid, size, dataname
+        )
+        screen_no = ""
+        account_no = account
+        order_type = 3 if size >= 0 else 4
+        code = dataname
+        quantity = 0
+        price = 0
+        quote_type = ""
+        original_order_no = oid
+        responses = self.OrderCall(
+            request_name,
+            screen_no,
+            account_no,
+            order_type,
+            code,
+            quantity,
+            price,
+            quote_type,
+            original_order_no,
+        )
+        _msg = next(responses)
+        _tr = next(responses)
+        _accept = next(responses)
+        confirm = next(responses)
+        confirm_data = dict(zip(confirm.single_data.names, confirm.single_data.values))
+        result = {"orderOpened": {"id": confirm_data["주문번호"]}}
+        return result
+
+[docs]    def get_today_quotes_by_code(self, codes=None):
+        if codes is None:
+            codes = self._codes
+        df = self.GetStockQuoteInfoAsDataFrame(codes)
+        dt = pd.to_datetime(
+            df["일자"].str.cat(df["체결시간"]), format="%Y%m%d%H%M%S"
+        ).dt.tz_localize(self._krx_timezone)
+        dt = dt.astype(np.int64) // 10**3
+        df = pd.DataFrame(
+            {
+                "dataname": df["종목코드"],
+                "time": dt,
+                "open": df["시가"].astype(float).abs(),
+                "high": df["고가"].astype(float).abs(),
+                "low": df["저가"].astype(float).abs(),
+                "close": df["종가"].astype(float).abs(),
+                "volume": df["거래량"].astype(float).abs(),
+            }
+        )
+        msgs = {tup.dataname: tup._asdict() for tup in df.itertuples(index=False)}
+        return msgs
+
+
+[docs]class MetaSingleton(MetaParams):
+    def __init__(cls, clsname, bases, dct):
+        super().__init__(clsname, bases, dct)
+        cls._singleton = None
+
+    def __call__(cls, *args, **kwargs):
+        if cls._singleton is None:
+            cls._singleton = super().__call__(*args, **kwargs)
+
+        return cls._singleton
+
+
+[docs]class MetaKiwoomOpenApiPlusStore(type(Logging), MetaSingleton):
+    pass
+
+
+[docs]class KiwoomOpenApiPlusStore(Logging, metaclass=MetaKiwoomOpenApiPlusStore):
+    # pylint: disable=protected-access
+
+[docs]    BrokerCls = None  # broker class will auto register
+[docs]    DataCls = None  # data class will auto register
+
+[docs]    params = (
+        ("account", ""),
+        ("account_tmout", 60.0),  # TODO: 60초마다 TR 을 날리는데 정말 이게 필요한가?
+    )
+
+    _DTEPOCH = datetime.datetime(1970, 1, 1)
+
+    @classmethod
+[docs]    def getdata(cls, *args, **kwargs):
+        if cls.DataCls is None:
+            from koapy.backtrader.KiwoomOpenApiPlusData import KiwoomOpenApiPlusData
+
+            cls.DataCls = KiwoomOpenApiPlusData
+        return cls.DataCls(*args, **kwargs)  # pylint: disable=not-callable
+
+    @classmethod
+[docs]    def getbroker(cls, *args, **kwargs):
+        if cls.BrokerCls is None:
+            from koapy.backtrader.KiwoomOpenApiPlusBroker import KiwoomOpenApiPlusBroker
+
+            cls.BrokerCls = KiwoomOpenApiPlusBroker
+        return cls.BrokerCls(*args, **kwargs)  # pylint: disable=not-callable
+
+    def __init__(self, context=None):
+        super().__init__()
+
+        self.notifs = collections.deque()
+
+        self._env = None
+        self.broker = None
+
+        self.datas = list()
+        self.datanames = list()
+
+        self._ever_started = False
+        self._today_quotes_by_code = None
+        self._today_quotes_by_code_done = threading.Event()
+
+        self._orders = collections.OrderedDict()  # map order.ref to oid
+        self._ordersrev = collections.OrderedDict()  # map oid to order.ref
+        self._transpend = collections.defaultdict(collections.deque)
+
+        if context is None:
+            context = KiwoomOpenApiPlusEntrypoint()
+
+        self._context = context
+        self._context.EnsureConnected()
+
+        if not self.p.account:
+            self.p.account = self._context.GetFirstAvailableAccount()
+
+        self.api = API(self._context)
+
+        self._cash = 0.0
+        self._value = 0.0
+        self._evt_acct = threading.Event()
+
+        self.q_account = None
+        self.q_ordercreate = None
+        self.q_orderclose = None
+
+        self._tmoffset = datetime.timedelta()
+
+[docs]    def start(self, data=None, broker=None):
+        if not self._ever_started:
+            self._ever_started = True
+            self._today_quotes_by_code = self.api.get_today_quotes_by_code(
+                self.datanames
+            )
+            self._today_quotes_by_code_done.set()
+
+        if data is None and broker is None:
+            return
+
+        if data is not None:
+            self._env = data._env  # pylint: disable=protected-access
+            self.datas.append(data)
+
+            if self.broker is not None:
+                self.broker.data_started(data)
+
+            self._today_quotes_by_code_done.wait()
+
+        elif broker is not None:
+            self.broker = broker
+            self.streaming_events()
+            self.broker_threads()
+
+[docs]    def initial_today_historical_msg(self, data=None):
+        if data is not None:
+            return self._today_quotes_by_code.get(data.p.dataname)
+
+[docs]    def stop(self):
+        pass
+
+[docs]    def put_notification(self, msg, *args, **kwargs):
+        self.notifs.append((msg, args, kwargs))
+
+[docs]    def get_notifications(self):
+        self.notifs.append(None)
+        return [x for x in iter(self.notifs.popleft, None)]
+
+[docs]    def timeoffset(self):
+        return self._tmoffset
+
+    _GRANULARITIES = {
+        (TimeFrame.Ticks, 1): ("opt10079", {"종목코드": "", "틱범위": "1", "수정주가구분": "1"}),
+        (TimeFrame.Ticks, 3): ("opt10079", {"종목코드": "", "틱범위": "3", "수정주가구분": "1"}),
+        (TimeFrame.Ticks, 5): ("opt10079", {"종목코드": "", "틱범위": "5", "수정주가구분": "1"}),
+        (TimeFrame.Ticks, 10): ("opt10079", {"종목코드": "", "틱범위": "10", "수정주가구분": "1"}),
+        (TimeFrame.Ticks, 30): ("opt10079", {"종목코드": "", "틱범위": "30", "수정주가구분": "1"}),
+        (TimeFrame.Minutes, 1): ("opt10080", {"종목코드": "", "틱범위": "1", "수정주가구분": "1"}),
+        (TimeFrame.Minutes, 3): ("opt10080", {"종목코드": "", "틱범위": "3", "수정주가구분": "1"}),
+        (TimeFrame.Minutes, 5): ("opt10080", {"종목코드": "", "틱범위": "5", "수정주가구분": "1"}),
+        (TimeFrame.Minutes, 10): ("opt10080", {"종목코드": "", "틱범위": "10", "수정주가구분": "1"}),
+        (TimeFrame.Minutes, 15): ("opt10080", {"종목코드": "", "틱범위": "15", "수정주가구분": "1"}),
+        (TimeFrame.Minutes, 30): ("opt10080", {"종목코드": "", "틱범위": "30", "수정주가구분": "1"}),
+        (TimeFrame.Minutes, 45): ("opt10080", {"종목코드": "", "틱범위": "45", "수정주가구분": "1"}),
+        (TimeFrame.Minutes, 60): ("opt10080", {"종목코드": "", "틱범위": "60", "수정주가구분": "1"}),
+        (TimeFrame.Days, 1): ("opt10081", {"종목코드": "", "기준일자": "", "수정주가구분": "1"}),
+        (TimeFrame.Weeks, 1): (
+            "opt10082",
+            {"종목코드": "", "기준일자": "", "끝일자": "", "수정주가구분": "1"},
+        ),
+        (TimeFrame.Months, 1): (
+            "opt10083",
+            {"종목코드": "", "기준일자": "", "끝일자": "", "수정주가구분": "1"},
+        ),
+        (TimeFrame.Years, 1): (
+            "opt10094",
+            {"종목코드": "", "기준일자": "", "끝일자": "", "수정주가구분": "1"},
+        ),
+    }
+
+[docs]    def get_granularity(self, timeframe, compression, default=None):
+        return self._GRANULARITIES.get((timeframe, compression), default)
+
+[docs]    def get_instrument(self, dataname):
+        try:
+            insts = self.api.get_instruments(self.p.account, instruments=dataname)
+        except KiwoomOpenApiPlusError:
+            return None
+
+        i = insts.get("instruments", [{}])
+        inst = i[0] if len(i) else None
+        return inst
+
+[docs]    def streaming_events(self, tmout=None):
+        q = queue.Queue()
+        kwargs = {"q": q, "tmout": tmout}
+
+        t = threading.Thread(target=self._t_streaming_listener, kwargs=kwargs)
+        t.daemon = True
+        t.start()
+
+        t = threading.Thread(target=self._t_streaming_events, kwargs=kwargs)
+        t.daemon = True
+        t.start()
+        return q
+
+    def _t_streaming_listener(self, q, tmout=None):
+        while True:
+            trans = q.get()
+            self._transaction(trans)
+
+    def _t_streaming_events(self, q, tmout=None):
+        if tmout is not None:
+            time.sleep(tmout)
+        streamer = KiwoomOpenApiPlusEventStreamer(self.api, q)
+        streamer.events()
+
+[docs]    def candles(self, dataname, dtbegin, dtend, timeframe, compression):
+        kwargs = locals().copy()
+        kwargs.pop("self")
+        kwargs["q"] = q = queue.Queue()
+        t = threading.Thread(target=self._t_candles, kwargs=kwargs)
+        t.daemon = True
+        t.start()
+        return q
+
+    def _t_candles(self, dataname, dtbegin, dtend, timeframe, compression, q):
+        trcode, inputs = self.get_granularity(timeframe, compression, (None, None))
+
+        if trcode is None:
+            e = KiwoomOpenApiPlusTimeFrameError()
+            q.put(e.error_response)
+            return
+
+        inputs = inputs.copy()
+        inputs["종목코드"] = dataname
+
+        if dtbegin is not None:
+            if "끝일자" in inputs:
+                inputs["끝일자"] = dtbegin.strftime("%Y%m%d")
+
+        if dtend is not None:
+            if "기준일자" in inputs:
+                inputs["기준일자"] = dtend.strftime("%Y%m%d")
+
+        try:
+            response = self.api.get_history(trcode, inputs, dtbegin, dtend)
+        except KiwoomOpenApiPlusError as e:
+            q.put(KiwoomOpenApiPlusJsonError(e).error_response())
+            q.put(None)
+            return
+
+        for candle in response.get("candles", []):
+            q.put(candle)
+
+        q.put({})
+
+[docs]    def streaming_prices(self, dataname, tmout=None):
+        q = queue.Queue()
+        kwargs = {"q": q, "dataname": dataname, "tmout": tmout}
+        t = threading.Thread(target=self._t_streaming_prices, kwargs=kwargs)
+        t.daemon = True
+        t.start()
+        return q
+
+    def _t_streaming_prices(self, dataname, q, tmout):
+        if tmout is not None:
+            time.sleep(tmout)
+        streamer = KiwoomOpenApiPlusEventStreamer(self.api, q)
+        streamer.rates(dataname)
+
+[docs]    def get_cash(self):
+        return self._cash
+
+[docs]    def get_value(self):
+        return self._value
+
+[docs]    def get_positions(self):
+        try:
+            positions = self.api.get_positions(self.p.account)
+        except KiwoomOpenApiPlusError:
+            return None
+
+        poslist = positions.get("positions", [])
+        return poslist
+
+[docs]    def broker_threads(self):
+        self.q_account = queue.Queue()
+        self.q_account.put(True)  # force an immediate update
+        t = threading.Thread(target=self._t_account)
+        t.daemon = True
+        t.start()
+
+        self.q_ordercreate = queue.Queue()
+        t = threading.Thread(target=self._t_order_create)
+        t.daemon = True
+        t.start()
+
+        self.q_orderclose = queue.Queue()
+        t = threading.Thread(target=self._t_order_cancel)
+        t.daemon = True
+        t.start()
+
+        # Wait once for the values to be set
+        self._evt_acct.wait(self.p.account_tmout)
+
+    def _t_account(self):
+        while True:
+            try:
+                msg = self.q_account.get(timeout=self.p.account_tmout)
+                if msg is None:
+                    break  # end of thread
+            except queue.Empty:  # tmout -> time to refresh
+                pass
+
+            try:
+                accinfo = self.api.get_account(self.p.account)
+            except Exception as e:  # pylint: disable=broad-except
+                self.put_notification(e)
+                continue
+
+            try:
+                self._cash = accinfo["marginAvail"]
+                self._value = accinfo["balance"]
+            except KeyError:
+                pass
+
+            self._evt_acct.set()
+
+    # from below, it's related to processing orders
+
+    _ORDEREXECS = {
+        bt.Order.Market: "market",
+        bt.Order.Limit: "limit",
+        bt.Order.Stop: "stop",
+        bt.Order.StopLimit: "stop",
+    }
+
+[docs]    def order_create(self, order, stopside=None, takeside=None, **kwargs):
+        okwargs = dict()
+        okwargs["instrument"] = order.data._dataname
+        okwargs["units"] = abs(order.created.size)
+        okwargs["side"] = "buy" if order.isbuy() else "sell"
+        okwargs["type"] = self._ORDEREXECS[order.exectype]
+        if order.exectype != bt.Order.Market:
+            okwargs["price"] = order.created.price
+            if order.valid is None:
+                # 1 year and datetime.max fail ... 1 month works
+                valid = datetime.datetime.utcnow() + datetime.timedelta(days=30)
+            else:
+                valid = order.data.num2date(order.valid)
+                # To timestamp with seconds precision
+            okwargs["expiry"] = int((valid - self._DTEPOCH).total_seconds())
+
+        if order.exectype == bt.Order.StopLimit:
+            okwargs["lowerBound"] = order.created.pricelimit
+            okwargs["upperBound"] = order.created.pricelimit
+
+        if order.exectype == bt.Order.StopTrail:
+            okwargs["trailingStop"] = order.trailamount
+
+        if stopside is not None:
+            okwargs["stopLoss"] = stopside.price
+
+        if takeside is not None:
+            okwargs["takeProfit"] = takeside.price
+
+        okwargs.update(**kwargs)  # anything from the user
+
+        self.q_ordercreate.put(
+            (
+                order.ref,
+                okwargs,
+            )
+        )
+        return order
+
+    _OIDSINGLE = ["orderOpened", "tradeOpened", "tradeReduced"]
+    _OIDMULTIPLE = ["tradesClosed"]
+
+    def _t_order_create(self):
+        while True:
+            msg = self.q_ordercreate.get()
+            if msg is None:
+                break
+
+            oref, okwargs = msg
+            try:
+                o = self.api.create_order(self.p.account, **okwargs)
+            except Exception as e:
+                self.logger.exception(
+                    "Exception while create_order(%s, %s)", self.p.account, okwargs
+                )
+                self.put_notification(e)
+                self.broker._reject(oref)
+
+            # Ids are delivered in different fields and all must be fetched to
+            # match them (as executions) to the order generated here
+            oids = list()
+            for oidfield in self._OIDSINGLE:
+                if oidfield in o and "id" in o[oidfield]:
+                    oids.append(o[oidfield]["id"])
+
+            for oidfield in self._OIDMULTIPLE:
+                if oidfield in o:
+                    for suboidfield in o[oidfield]:
+                        oids.append(suboidfield["id"])
+
+            if not oids:
+                self.logger.warning("Rejecting %s because no oids specified", oref)
+                self.broker._reject(oref)
+                return
+
+            self._orders[oref] = oids[0]
+            self.broker._submit(oref)
+            if okwargs["type"] == "market":
+                self.broker._accept(oref)  # taken immediately
+
+            for oid in oids:
+                self._ordersrev[oid] = oref  # maps ids to backtrader order
+
+                # An transaction may have happened and was stored
+                tpending = self._transpend[oid]
+                tpending.append(None)  # eom marker
+                while True:
+                    trans = tpending.popleft()
+                    if trans is None:
+                        break
+                    self._process_transaction(oid, trans)
+
+[docs]    def order_cancel(self, order):
+        self.q_orderclose.put((order.ref, order.created.size, order.data.p.dataname))
+        return order
+
+    def _t_order_cancel(self):
+        while True:
+            msg = self.q_orderclose.get()
+            if msg is None:
+                break
+
+            oref, size, dataname = msg
+            oid = self._orders.get(oref, None)
+            if oid is None:
+                continue  # the order is no longer there
+            try:
+                o = self.api.close_order(self.p.account, oid, size, dataname)
+            except Exception as e:
+                self.logger.exception("Failed to close order")
+                continue  # not cancelled - FIXME: notify
+
+            self.broker._cancel(oref)
+
+    _X_ORDER_CREATE = (
+        "STOP_ORDER_CREATE",
+        "LIMIT_ORDER_CREATE",
+        "MARKET_IF_TOUCHED_ORDER_CREATE",
+    )
+
+    def _transaction(self, trans):
+        # Invoked from Streaming Events. May actually receive an event for an
+        # oid which has not yet been returned after creating an order. Hence
+        # store if not yet seen, else forward to processer
+        ttype = trans["type"]
+        if ttype == "MARKET_ORDER_CREATE":
+            try:
+                oid = trans["tradeReduced"]["id"]
+            except KeyError:
+                try:
+                    oid = trans["tradeOpened"]["id"]
+                except KeyError:
+                    return  # cannot do anything else
+
+        elif ttype in self._X_ORDER_CREATE:
+            oid = trans["id"]
+        elif ttype == "ORDER_FILLED":
+            oid = trans["orderId"]
+
+        elif ttype == "ORDER_CANCEL":
+            oid = trans["orderId"]
+
+        elif ttype == "TRADE_CLOSE":
+            oid = trans["id"]
+            pid = trans["tradeId"]
+            if pid in self._orders and False:  # Know nothing about trade
+                return  # can do nothing
+
+            # Skip above - at the moment do nothing
+            # Received directly from an event in the WebGUI for example which
+            # closes an existing position related to order with id -> pid
+            # COULD BE DONE: Generate a fake counter order to gracefully
+            # close the existing position
+            msg = (
+                "Received TRADE_CLOSE for unknown order, possibly generated"
+                " over a different client or GUI"
+            )
+            self.put_notification(msg, trans)
+            return
+
+        else:  # Go aways gracefully
+            try:
+                oid = trans["id"]
+            except KeyError:
+                oid = "None"
+
+            msg = "Received {} with oid {}. Unknown situation"
+            msg = msg.format(ttype, oid)
+            self.put_notification(msg, trans)
+            return
+
+        try:
+            self._process_transaction(oid, trans)
+        except KeyError:  # not yet seen, keep as pending
+            self._transpend[oid].append(trans)
+
+    _X_ORDER_FILLED = (
+        "MARKET_ORDER_CREATE",
+        "ORDER_FILLED",
+        "TAKE_PROFIT_FILLED",
+        "STOP_LOSS_FILLED",
+        "TRAILING_STOP_FILLED",
+    )
+
+    def _process_transaction(self, oid, trans):
+        try:
+            oref = self._ordersrev[oid]
+        except KeyError:
+            return
+
+        ttype = trans["type"]
+
+        if ttype in self._X_ORDER_FILLED:
+            size = trans["units"]
+            if trans["side"] == "sell":
+                size = -size
+            price = trans["price"]
+            self.broker._fill(oref, size, price, ttype=ttype)
+
+        elif ttype in self._X_ORDER_CREATE:
+            self.broker._accept(oref)
+            self._ordersrev[oid] = oref
+
+        elif ttype in "ORDER_CANCEL":
+            reason = trans["reason"]
+            if reason == "ORDER_FILLED":
+                pass  # individual execs have done the job
+            elif reason == "TIME_IN_FORCE_EXPIRED":
+                self.broker._expire(oref)
+            elif reason == "CLIENT_REQUEST":
+                self.broker._cancel(oref)
+            else:  # default action ... if nothing else
+                self.logger.warning("Rejecting %s since it's canceled", oref)
+                self.broker._reject(oref)
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backtrader/KrxHistoricalDailyPriceData.html b/_modules/koapy/backtrader/KrxHistoricalDailyPriceData.html new file mode 100644 index 00000000..7870e902 --- /dev/null +++ b/_modules/koapy/backtrader/KrxHistoricalDailyPriceData.html @@ -0,0 +1,263 @@ + + + + + + + + koapy.backtrader.KrxHistoricalDailyPriceData — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backtrader.KrxHistoricalDailyPriceData

+import pandas as pd
+
+from backtrader import TimeFrame, date2num
+from backtrader.feed import DataBase
+from tqdm import tqdm
+
+from koapy.utils.data.KrxHistoricalDailyPriceDataForBacktestLoader import (
+    KrxHistoricalDailyPriceDataForBacktestLoader,
+)
+
+
+[docs]class KrxHistoricalDailyPriceData(DataBase):
+
+    # pylint: disable=no-member
+
+[docs]    params = (
+        ("loader", None),
+        ("symbol", None),
+        ("name", None),
+        ("fromdate", None),
+        ("todate", None),
+        ("compression", 1),
+        ("timeframe", TimeFrame.Days),
+        ("calendar", None),
+        ("lazy", False),
+    )
+
+[docs]    lines = (
+        "amount",
+        "marketcap",
+        "shares",
+    )
+
+    def __init__(self):
+        super().__init__()
+
+        assert self.p.loader
+        assert self.p.symbol
+
+        assert self.p.timeframe == TimeFrame.Days
+        assert self.p.compression == 1
+
+        self.p.name = self.p.name or self.p.symbol or ""
+
+        self._cursor = None
+        self._started_already = False
+
+        if not self.p.lazy:
+            self.start()
+
+    def _close_cursor(self):
+        if self._cursor is not None:
+            self._cursor.close()
+            self._cursor = None
+
+    def _initialize_cursor(self):
+        self._close_cursor()
+        self._cursor = self.p.loader.load_as_cursor(
+            self.p.symbol, start_time=self.p.fromdate, end_time=self.p.todate
+        )
+
+[docs]    def start(self):
+        if not self._started_already:
+            self._initialize_cursor()
+            self._started_already = True
+
+[docs]    def stop(self):
+        self._close_cursor()
+        self._started_already = False
+
+    def _load(self):
+        if self._cursor is None:
+            return False
+
+        try:
+            date, open_, high, low, close, volume, amount, marcap, shares = next(
+                self._cursor
+            )
+        except StopIteration:
+            return False
+        else:
+            dt = pd.Timestamp(date)
+
+            self.lines.datetime[0] = date2num(dt)
+            self.lines.open[0] = open_
+            self.lines.high[0] = high
+            self.lines.low[0] = low
+            self.lines.close[0] = close
+            self.lines.volume[0] = volume
+            self.lines.openinterest[0] = 0.0
+
+            self.lines.amount[0] = amount
+            self.lines.marketcap[0] = marcap
+            self.lines.shares[0] = shares
+
+            return True
+
+    @classmethod
+[docs]    def adddata_fromfile(
+        cls,
+        cerebro,
+        filename,
+        symbols=None,
+        fromdate=None,
+        todate=None,
+        progress_bar=True,
+    ):
+        loader = KrxHistoricalDailyPriceDataForBacktestLoader(filename)
+        if symbols is None:
+            symbols = loader.get_symbols()
+        progress = tqdm(symbols, disable=not progress_bar)
+        for symbol in progress:
+            progress.set_description("Adding Symbol [%s]" % symbol)
+            data = cls(
+                loader=loader,
+                symbol=symbol,
+                fromdate=fromdate,
+                todate=todate,
+                name=symbol,
+            )  # pylint: disable=unexpected-keyword-arg
+            cerebro.adddata(data, name=data.p.name)
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backtrader/KrxHistoricalDailyPriceDataFromSQLite.html b/_modules/koapy/backtrader/KrxHistoricalDailyPriceDataFromSQLite.html new file mode 100644 index 00000000..a22c0e50 --- /dev/null +++ b/_modules/koapy/backtrader/KrxHistoricalDailyPriceDataFromSQLite.html @@ -0,0 +1,261 @@ + + + + + + + + koapy.backtrader.KrxHistoricalDailyPriceDataFromSQLite — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backtrader.KrxHistoricalDailyPriceDataFromSQLite

+import pandas as pd
+
+from backtrader import TimeFrame, date2num
+from sqlalchemy import create_engine, inspect
+from tqdm import tqdm
+
+from koapy.backtrader.SQLiteData import SQLiteData
+from koapy.utils.data.KrxHistoricalDailyPriceDataForBacktestLoader import (
+    KrxHistoricalDailyPriceDataForBacktestLoader,
+)
+
+
+[docs]class KrxHistoricalDailyPriceDataFromSQLite(SQLiteData):
+
+    # pylint: disable=no-member
+
+[docs]    params = (
+        ("engine", None),
+        ("symbol", None),
+        ("name", None),
+        ("fromdate", None),
+        ("todate", None),
+        ("compression", 1),
+        ("timeframe", TimeFrame.Days),
+        ("calendar", None),
+        ("timestampcolumn", 0),
+        ("timestampcolumntimezone", None),
+        ("lazy", False),
+    )
+
+[docs]    lines = (
+        "amount",
+        "marketcap",
+        "shares",
+    )
+
+    def __init__(self):
+        assert self.p.timeframe == TimeFrame.Days
+        assert self.p.compression == 1
+
+        self.p.tablename = self.p.tablename or self.p.symbol or None
+        self.p.name = self.p.name or self.p.symbol or self.p.tablename or ""
+
+        super().__init__()
+
+    def _load(self):
+        if self._cursor is None:
+            return False
+
+        try:
+            date, open_, high, low, close, volume, amount, marcap, shares = next(
+                self._cursor
+            )
+        except StopIteration:
+            return False
+        else:
+            dt = pd.Timestamp(date)
+
+            self.lines.datetime[0] = date2num(dt)
+            self.lines.open[0] = open_
+            self.lines.high[0] = high
+            self.lines.low[0] = low
+            self.lines.close[0] = close
+            self.lines.volume[0] = volume
+            self.lines.openinterest[0] = 0.0
+
+            self.lines.amount[0] = amount
+            self.lines.marketcap[0] = marcap
+            self.lines.shares[0] = shares
+
+            return True
+
+    @classmethod
+[docs]    def dump_from_store(
+        cls,
+        source_filename,
+        dest_filename,
+        symbols=None,
+        fromdate=None,
+        todate=None,
+        progress_bar=True,
+    ):
+        loader = KrxHistoricalDailyPriceDataForBacktestLoader(source_filename)
+        if symbols is None:
+            symbols = loader.get_symbols()
+        engine = create_engine("sqlite:///" + dest_filename)
+        progress = tqdm(symbols, disable=not progress_bar)
+        for symbol in progress:
+            progress.set_description("Dumping Symbol [%s]" % symbol)
+            data = loader.load(symbol, start_time=fromdate, end_time=todate)
+            data.to_sql(symbol, engine, if_exists="replace")
+
+    @classmethod
+[docs]    def adddata_fromfile(
+        cls,
+        cerebro,
+        filename,
+        symbols=None,
+        fromdate=None,
+        todate=None,
+        progress_bar=True,
+    ):
+        engine = create_engine("sqlite:///" + filename)
+        inspector = inspect(engine)
+        if symbols is None:
+            symbols = inspector.get_table_names()
+        progress = tqdm(symbols, disable=not progress_bar)
+        for symbol in progress:
+            progress.set_description("Adding Symbol [%s]" % symbol)
+            # pylint: disable=unexpected-keyword-arg
+            data = cls(
+                engine=engine,
+                tablename=symbol,
+                fromdate=fromdate,
+                todate=todate,
+                symbol=symbol,
+                name=symbol,
+            )
+            cerebro.adddata(data, name=data.p.name)
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backtrader/KrxTradingCalendar.html b/_modules/koapy/backtrader/KrxTradingCalendar.html new file mode 100644 index 00000000..82fcd4d5 --- /dev/null +++ b/_modules/koapy/backtrader/KrxTradingCalendar.html @@ -0,0 +1,199 @@ + + + + + + + + koapy.backtrader.KrxTradingCalendar — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backtrader.KrxTradingCalendar

+import datetime
+
+import pytz
+
+from backtrader.tradingcal import TradingCalendarBase
+from backtrader.utils.py3 import string_types
+from pandas import DataFrame, DatetimeIndex, Timestamp
+
+
+[docs]class ExchangeCalendarsTradingCalendar(TradingCalendarBase):
+
+    # pylint: disable=no-member
+
+[docs]    params = (
+        ("calendar", None),
+        ("cachesize", 365),
+    )
+
+    def __init__(self):
+        super().__init__()
+
+        self._calendar = self.p.calendar
+
+        if isinstance(self._calendar, string_types):
+            from exchange_calendars import get_calendar
+
+            self._calendar = get_calendar(self._calendar)
+
+        self.dcache = DatetimeIndex([0.0])
+        self.idcache = DataFrame(index=DatetimeIndex([0.0]))
+        self.csize = datetime.timedelta(days=self.p.cachesize)
+
+    def _nextday(self, day):
+        d = day + self._calendar.day
+        return d, d.isocalendar()
+
+[docs]    def schedule(
+        self, day, tz=None
+    ):  # pylint: disable=arguments-differ,unused-argument
+        """
+        day: expecting naive datetime.datetime day in utc timezone
+        tz: treat/localize internal naive datetimes to this timezone
+        returns: (opening, closing) naive datetime.datetime pair in utc timezone
+        """
+        session = Timestamp(day, tz=pytz.UTC).normalize()
+        opening, closing = self._calendar.open_and_close_for_session(session)
+        opening = opening.tz.localize(None).to_pydatetime()
+        closing = closing.tz.localize(None).to_pydatetime()
+        return opening, closing
+
+
+[docs]class KrxTradingCalendar(ExchangeCalendarsTradingCalendar):
+
+[docs]    params = (
+        ("calendar", "XKRX"),
+        ("cachesize", 365),
+    )
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backtrader/SQLAlchemyData.html b/_modules/koapy/backtrader/SQLAlchemyData.html new file mode 100644 index 00000000..2be67228 --- /dev/null +++ b/_modules/koapy/backtrader/SQLAlchemyData.html @@ -0,0 +1,269 @@ + + + + + + + + koapy.backtrader.SQLAlchemyData — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backtrader.SQLAlchemyData

+import datetime
+
+import pandas as pd
+
+from backtrader import date2num
+from backtrader.feed import DataBase
+from sqlalchemy import MetaData, Table, create_engine, select
+
+
+[docs]class SQLAlchemyData(DataBase):
+
+    # pylint: disable=no-member
+
+[docs]    params = (
+        ("url", None),
+        ("engine", None),
+        ("connection", None),
+        ("tablename", None),
+        ("timestampcolumn", 0),
+        ("timestampcolumntimezone", None),
+        ("timestampcolumnsort", False),
+        ("lazy", True),
+    )
+
+    def __init__(self):
+        super().__init__()
+
+        assert self.p.url
+        assert self.p.tablename
+
+        self._engine = self.p.engine
+        self._should_dispose = False
+
+        self._cursor = None
+
+        if self.p.timestampcolumntimezone is None:
+            self.p.timestampcolumntimezone = datetime.datetime.now().astimezone().tzinfo
+
+        self._started_already = False
+
+        if not self.p.lazy:
+            self.start()
+
+    def _dispose_engine(self):
+        if self._engine is not None and self._should_dispose:
+            self._engine.dispose()
+            self._engine = None
+
+    def _initialize_engine(self):
+        self._dispose_engine()
+
+        self._engine = self.p.engine
+        self._should_dispose = False
+
+        if self._engine is None:
+            if self.p.connection is not None:
+                self._engine = create_engine(
+                    self.p.url, creator=lambda: self.p.connection
+                )
+                self._should_dispose = False
+            else:
+                self._engine = create_engine(self.p.url)
+                self._should_dispose = True
+
+        assert self._engine is not None
+
+    def _close_cursor(self):
+        if self._cursor is not None:
+            self._cursor.close()
+            self._cursor = None
+
+    def _initialize_cursor(self):
+        self._close_cursor()
+
+        metadata = MetaData()
+        table = Table(self.p.tablename, metadata, autoload_with=self._engine)
+        timestampcolumn = table.columns[
+            self.p.timestampcolumn
+        ]  # pylint: disable=unsubscriptable-object
+        statement = select(table)
+
+        if self.p.timestampcolumnsort:
+            statement = statement.order_by(timestampcolumn)
+
+        if self.p.fromdate is not None:
+            fromdate = pd.Timestamp(self.p.fromdate, tz=self.p.timestampcolumntimezone)
+            statement = statement.where(timestampcolumn >= fromdate)
+
+        if self.p.todate is not None:
+            todate = pd.Timestamp(self.p.todate, tz=self.p.timestampcolumntimezone)
+            statement = statement.where(timestampcolumn <= todate)
+
+        statement = statement.execution_options(stream_results=True)
+
+        self._cursor = self._engine.execute(statement)
+
+[docs]    def start(self):
+        if not self._started_already:
+            self._initialize_engine()
+            self._initialize_cursor()
+            self._started_already = True
+
+[docs]    def stop(self):
+        self._close_cursor()
+        self._dispose_engine()
+        self._started_already = False
+
+    def _load(self):
+        if self._cursor is None:
+            return False
+
+        try:
+            date, open_, high, low, close, volume, openinterest = next(self._cursor)
+        except StopIteration:
+            return False
+        else:
+            dt = pd.Timestamp(date)
+
+            self.lines.datetime[0] = date2num(dt)
+            self.lines.open[0] = open_
+            self.lines.high[0] = high
+            self.lines.low[0] = low
+            self.lines.close[0] = close
+            self.lines.volume[0] = volume
+            self.lines.openinterest[0] = openinterest
+
+            return True
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backtrader/SQLAlchemySQLiteData.html b/_modules/koapy/backtrader/SQLAlchemySQLiteData.html new file mode 100644 index 00000000..dcb47bc9 --- /dev/null +++ b/_modules/koapy/backtrader/SQLAlchemySQLiteData.html @@ -0,0 +1,159 @@ + + + + + + + + koapy.backtrader.SQLAlchemySQLiteData — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backtrader.SQLAlchemySQLiteData

+from .SQLAlchemyData import SQLAlchemyData
+
+
+[docs]class SQLAlchemySQLiteData(SQLAlchemyData):
+
+    # pylint: disable=no-member
+
+[docs]    params = (("filename", None),)
+
+    def __init__(self):
+        if not self.p.url:
+            self.p.url = "sqlite://"
+
+            if self.p.filename:
+                self.p.url += "/" + self.p.filename
+
+        super().__init__()
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/backtrader/SQLiteData.html b/_modules/koapy/backtrader/SQLiteData.html new file mode 100644 index 00000000..14319788 --- /dev/null +++ b/_modules/koapy/backtrader/SQLiteData.html @@ -0,0 +1,283 @@ + + + + + + + + koapy.backtrader.SQLiteData — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.backtrader.SQLiteData

+import datetime
+import sqlite3
+
+import pandas as pd
+
+from backtrader import date2num
+from backtrader.feed import DataBase
+
+
+[docs]class SQLiteData(DataBase):
+
+    # pylint: disable=no-member
+
+[docs]    params = (
+        ("filename", None),
+        ("connection", None),
+        ("engine", None),
+        ("tablename", None),
+        ("timestampcolumn", 0),
+        ("timestampcolumntimezone", None),
+        ("timestampcolumnsort", False),
+        ("timestampcolumnformat", None),  # '%Y-%m-%d %H:%M:%S.%f'
+        ("lazy", True),
+    )
+
+    def __init__(self):
+        super().__init__()
+
+        assert self.p.tablename
+
+        self._connection = self.p.connection
+        self._should_close = False
+
+        self._cursor = None
+
+        if self.p.timestampcolumntimezone is None:
+            self.p.timestampcolumntimezone = datetime.datetime.now().astimezone().tzinfo
+
+        self._started_already = False
+
+        if not self.p.lazy:
+            self.start()
+
+    def _close_connection(self):
+        if self._connection is not None and self._should_close:
+            self._connection.close()
+            self._connection = None
+
+    def _initialize_connection(self):
+        self._close_connection()
+
+        self._connection = self.p.connection
+        self._should_close = False
+
+        if self._connection is None:
+            if self.p.engine is not None:
+                self._connection = self.p.engine.raw_connection()
+                self._should_close = True
+            elif self.p.filename:
+                self._connection = sqlite3.connect(
+                    self.p.filename, check_same_thread=False
+                )
+                self._should_close = True
+
+        assert self._connection is not None
+
+    def _close_cursor(self):
+        if self._cursor is not None:
+            self._cursor.close()
+            self._cursor = None
+
+    def _initialize_cursor(self):
+        self._close_cursor()
+
+        self._cursor = self._connection.cursor()
+
+        timestampcolumn = self.p.timestampcolumn
+
+        if isinstance(timestampcolumn, int):
+            self._cursor.execute("SELECT * FROM '{}' LIMIT 0".format(self.p.tablename))
+            timestampcolumn = self._cursor.description[timestampcolumn][0]
+
+        statement = "SELECT * FROM '{}'".format(self.p.tablename)
+
+        condition_prefix = " WHERE "
+        parameters = []
+
+        if self.p.fromdate is not None:
+            fromdate = pd.Timestamp(self.p.fromdate, tz=self.p.timestampcolumntimezone)
+            if self.p.timestampcolumnformat:
+                fromdate = fromdate.strftime(self.p.timestampcolumnformat)
+            statement += condition_prefix
+            statement += "'{}' >= ?".format(timestampcolumn)
+            parameters.append(fromdate)
+            condition_prefix = " AND "
+
+        if self.p.todate is not None:
+            todate = pd.Timestamp(self.p.todate, tz=self.p.timestampcolumntimezone)
+            if self.p.timestampcolumnformat:
+                todate = fromdate.strftime(self.p.timestampcolumnformat)
+            statement += condition_prefix
+            statement += "'{}' <= ?".format(timestampcolumn)
+            parameters.append(todate)
+            condition_prefix = " AND "
+
+        if self.p.timestampcolumnsort:
+            statement += " ORDER BY '{}' ASC".format(timestampcolumn)
+
+        self._cursor.execute(statement, parameters)
+
+[docs]    def start(self):
+        if not self._started_already:
+            self._initialize_connection()
+            self._initialize_cursor()
+            self._started_already = True
+
+[docs]    def stop(self):
+        self._close_cursor()
+        self._close_connection()
+        self._started_already = False
+
+    def _load(self):
+        if self._cursor is None:
+            return False
+
+        try:
+            date, open_, high, low, close, volume, openinterest = next(self._cursor)
+        except StopIteration:
+            return False
+        else:
+            dt = pd.Timestamp(date)
+
+            self.lines.datetime[0] = date2num(dt)
+            self.lines.open[0] = open_
+            self.lines.high[0] = high
+            self.lines.low[0] = low
+            self.lines.close[0] = close
+            self.lines.volume[0] = volume
+            self.lines.openinterest[0] = openinterest
+
+            return True
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/cli.html b/_modules/koapy/cli.html new file mode 100644 index 00000000..6a60fe99 --- /dev/null +++ b/_modules/koapy/cli.html @@ -0,0 +1,537 @@ + + + + + + + + koapy.cli — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.cli

+"""Console script for koapy."""
+
+import os
+
+import click
+
+from koapy.cli.commands.disable import disable
+from koapy.cli.commands.enable import enable
+from koapy.cli.commands.generate import generate
+from koapy.cli.commands.get import get
+from koapy.cli.commands.install import install
+from koapy.cli.commands.serve import serve
+from koapy.cli.commands.show import show
+from koapy.cli.commands.uninstall import uninstall
+from koapy.cli.commands.update import update
+from koapy.cli.utils.credentials import get_credentials
+from koapy.cli.utils.fail_with_usage import fail_with_usage
+from koapy.cli.utils.verbose_option import verbose_option
+from koapy.config import default_encoding
+from koapy.utils.logging import get_logger
+
+[docs]logger = get_logger(__name__)
+
+[docs]help_option_names = ["-h", "--help"]
+[docs]context_settings = dict(
+    help_option_names=help_option_names,
+)
+
+
+@click.group(context_settings=context_settings)
+@click.version_option(message="%(version)s")
+[docs]def cli():
+    pass
+
+
+cli.add_command(disable)
+cli.add_command(enable)
+cli.add_command(generate)
+cli.add_command(get)
+cli.add_command(install)
+cli.add_command(serve)
+cli.add_command(show)
+cli.add_command(uninstall)
+cli.add_command(update)
+
+
+@cli.command(short_help="Ensure logged in when server is up.")
+@click.option(
+    "-i",
+    "--interactive",
+    is_flag=True,
+    help="Put login information with prompts. Disables auto login for manual login.",
+)
+@click.option(
+    "-d",
+    "--disable-auto-login",
+    is_flag=True,
+    help="Disable auto login and use credentials given explicitly from config file.",
+)
+@click.option(
+    "-p", "--port", metavar="PORT", help="Port number of grpc server (optional)."
+)
+@verbose_option()
+[docs]def login(interactive, disable_auto_login, port):
+    credentials = get_credentials(interactive)
+
+    from koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusServiceClient import (
+        KiwoomOpenApiPlusServiceClient,
+    )
+
+    with KiwoomOpenApiPlusServiceClient(port=port, check_timeout=1) as context:
+        state = context.GetConnectState()
+        if state == 0:
+            click.echo("Logging in...")
+        else:
+            click.echo("Already logged in.")
+        if context.IsAutoLoginEnabled():
+            if not disable_auto_login:
+                credentials = None
+        context.EnsureConnected(credentials)
+        gubun = context.GetServerGubun()
+        if gubun == "1":
+            click.echo("Logged into Simulation server.")
+        else:
+            click.echo("Logged into Real server.")
+
+
+@cli.command(short_help="Watch realtime data.")
+@click.option(
+    "-c",
+    "--code",
+    "codes",
+    metavar="CODE",
+    multiple=True,
+    help="Stock code to get. Can set multiple times.",
+)
+@click.option(
+    "-i",
+    "--input",
+    metavar="FILENAME",
+    type=click.Path(),
+    help="Text or excel file containing codes. Alternative to --code option.",
+)
+@click.option(
+    "-f",
+    "--fid",
+    "fids",
+    metavar="FID",
+    multiple=True,
+    help="FID to get. Can set multiple times.",
+)
+@click.option(
+    "-t", "--realtype", metavar="REALTYPE", help="Real type name. Alternative to --fid."
+)
+@click.option(
+    "-o",
+    "--output",
+    metavar="FILENAME",
+    type=click.File("w", lazy=True),
+    default="-",
+    help="Output filename (optional).",
+)
+@click.option(
+    "-f",
+    "--format",
+    metavar="FORMAT",
+    type=click.Choice(["json", "md"], case_sensitive=False),
+    default="json",
+    help="Output format [json|md].",
+)
+@click.option(
+    "-p", "--port", metavar="PORT", help="Port number of grpc server (optional)."
+)
+@verbose_option()
+[docs]def watch(codes, input, fids, realtype, output, format, port):
+    # pylint: disable=redefined-builtin
+
+    if (codes, fids, realtype) == (tuple(), tuple(), None):
+        fail_with_usage()
+
+    codes_len = len(codes)
+
+    if codes_len == 0:
+        if input is None:
+            fail_with_usage("Either code or input should be given.")
+        if not os.path.exists(input):
+            fail_with_usage("Given input does not exist.")
+
+        if os.path.isfile(input):
+            if input.endswith(".xlsx"):
+                import pandas as pd
+
+                df = pd.read_excel(input, dtype=str)
+                code_column = "종목코드"
+                if code_column in df:
+                    codes = df[code_column]
+                else:
+                    codes = df.iloc[0]
+                codes_len = len(codes)
+            elif input.endswith(".txt"):
+                with open(input, "r", encoding=default_encoding) as f:
+                    codes = [line.strip() for line in f]
+                codes_len = len(codes)
+            else:
+                fail_with_usage("Unrecognized input type.")
+        else:
+            fail_with_usage("Unrecognized input type.")
+
+    if realtype is not None:
+        from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusRealType import (
+            KiwoomOpenApiPlusRealType,
+        )
+
+        fids_from_realtype = KiwoomOpenApiPlusRealType.get_fids_by_realtype_name(
+            realtype
+        )
+        fids = list(set(fids).union(set(fids_from_realtype)))
+
+    if not codes:
+        fail_with_usage("No codes to watch. Set --code or --input.")
+
+    if not fids:
+        fail_with_usage("Cannot infer fids to watch. Set either --fid or --realtype.")
+
+    import datetime
+
+    import pandas as pd
+
+    from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusEntrypoint import (
+        KiwoomOpenApiPlusEntrypoint,
+    )
+    from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusRealType import (
+        KiwoomOpenApiPlusRealType,
+    )
+
+    def parse_message(message):
+        fids = message.single_data.names
+        names = [
+            KiwoomOpenApiPlusRealType.Fid.get_name_by_fid(fid, str(fid)) for fid in fids
+        ]
+        values = message.single_data.values
+        dic = {
+            name: value for fid, name, value in zip(fids, names, values) if name != fid
+        }
+        series = pd.Series(dic)
+        return series
+
+    if format == "json":
+
+        def print_message(message):
+            click.echo(parse_message(message).to_json(), file=output)
+
+    else:
+
+        def print_message(message):
+            code = message.arguments[0].string_value
+            name = message.arguments[1].string_value
+            click.echo("[{}] [{}]".format(code, name), file=output)
+            click.echo("[%s]" % datetime.datetime.now(), file=output)
+            click.echo(parse_message(message).to_markdown(), file=output)
+
+    with KiwoomOpenApiPlusEntrypoint(port=port) as context:
+        context.EnsureConnected()
+
+        for event in context.GetRealDataForCodesAsStream(codes, fids, infer_fids=True):
+            print_message(event)
+
+
+[docs]order_types = [
+    "1",
+    "2",
+    "3",
+    "4",
+    "5",
+    "6",
+]
+
+[docs]quote_types = [
+    "00",
+    "03",
+    "05",
+    "06",
+    "07",
+    "10",
+    "13",
+    "16",
+    "20",
+    "23",
+    "26",
+    "61",
+    "62",
+    "81",
+]
+
+
+@cli.command(short_help="Place an order.")
+@click.option("--request-name", metavar="NAME")
+@click.option("--screen-no", metavar="SCRNO")
+@click.option("--account-no", metavar="ACCNO")
+@click.option("--order-type", type=click.Choice(order_types))
+@click.option("--code", metavar="CODE")
+@click.option("--quantity", metavar="QTY")
+@click.option("--price", metavar="PRICE")
+@click.option("--quote-type", type=click.Choice(quote_types))
+@click.option("--original-order-no", metavar="ORDERNO")
+@click.option(
+    "-f",
+    "--format",
+    metavar="FORMAT",
+    type=click.Choice(["pretty", "json"], case_sensitive=False),
+)
+@click.option(
+    "-p", "--port", metavar="PORT", help="Port number of grpc server (optional)."
+)
+@verbose_option()
+[docs]def order(
+    request_name,
+    screen_no,
+    account_no,
+    order_type,
+    code,
+    quantity,
+    price,
+    quote_type,
+    original_order_no,
+    format,
+    port,
+):
+    # pylint: disable=redefined-builtin
+
+    # TODO: 주문 취소시 기존 주문에 대한 이벤트 스트림 종료되도록
+
+    """
+    \b
+    [주문유형]
+      1 : 신규매수
+      2 : 신규매도
+      3 : 매수취소
+      4 : 매도취소
+      5 : 매수정정
+      6 : 매도정정
+
+    \b
+    [거래구분]
+      모의투자에서는 지정가 주문과 시장가 주문만 가능합니다.
+      00 : 지정가
+      03 : 시장가
+      05 : 조건부지정가
+      06 : 최유리지정가
+      07 : 최우선지정가
+      10 : 지정가IOC
+      13 : 시장가IOC
+      16 : 최유리IOC
+      20 : 지정가FOK
+      23 : 시장가FOK
+      26 : 최유리FOK
+      61 : 장전시간외종가
+      62 : 시간외단일가매매
+      81 : 장후시간외종가
+    """
+
+    if (request_name, screen_no, account_no, order_type, code, quantity) == (
+        None,
+        None,
+        None,
+        None,
+        None,
+        None,
+    ):
+        fail_with_usage()
+
+    if order_type is None:
+        fail_with_usage()
+
+    from google.protobuf.json_format import MessageToDict
+
+    from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusEntrypoint import (
+        KiwoomOpenApiPlusEntrypoint,
+    )
+
+    if format == "json":
+        import json
+
+        def print_message(message):
+            click.echo(json.dumps(MessageToDict(message)))
+
+    else:
+        import pprint
+
+        pp = pprint.PrettyPrinter()
+
+        def print_message(message):
+            click.echo(pp.pformat(MessageToDict(message)))
+
+    with KiwoomOpenApiPlusEntrypoint(port=port) as context:
+        context.EnsureConnected()
+
+        if order_type in ["3", "4"] and (account_no is None or code is None):
+            for account_no_candidate in context.GetAccountList():
+                df = context.GetOrderLogAsDataFrame1(account_no_candidate)
+                if "주문번호" in df.columns:
+                    rows = df.loc[df["주문번호"] == original_order_no, :]
+                    if rows.shape[0] > 0:
+                        row = rows.iloc[0, :]
+                        if account_no is None:
+                            account_no = row["계좌번호"]
+                        if code is None:
+                            code = row["종목코드"]
+                        break
+
+        if account_no is None:
+            logger.info("Account not given. Using first account available.")
+            account_no = context.GetFirstAvailableAccount()
+
+        responses = context.OrderCall(
+            request_name,
+            screen_no,
+            account_no,
+            order_type,
+            code,
+            quantity,
+            price,
+            quote_type,
+            original_order_no,
+        )
+        for response in responses:
+            print_message(response)
+
+
+[docs]def main():
+    cli()
+
+
+if __name__ == "__main__":
+    main()
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/cli/commands/disable.html b/_modules/koapy/cli/commands/disable.html new file mode 100644 index 00000000..5bd7a3a5 --- /dev/null +++ b/_modules/koapy/cli/commands/disable.html @@ -0,0 +1,155 @@ + + + + + + + + koapy.cli.commands.disable — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.cli.commands.disable

+import click
+
+from .auto_login import auto_login
+
+
+@click.group(short_help="Disable things, including auto login.")
+[docs]def disable():
+    pass
+
+
+disable.add_command(auto_login)
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/cli/commands/disable/auto_login.html b/_modules/koapy/cli/commands/disable/auto_login.html new file mode 100644 index 00000000..aa0b76e4 --- /dev/null +++ b/_modules/koapy/cli/commands/disable/auto_login.html @@ -0,0 +1,190 @@ + + + + + + + + koapy.cli.commands.disable.auto_login — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.cli.commands.disable.auto_login

+import click
+
+from koapy.cli.utils.verbose_option import verbose_option
+
+
+[docs]def disable_auto_login_after_login(port):
+    from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusEntrypoint import (
+        KiwoomOpenApiPlusEntrypoint,
+    )
+
+    with KiwoomOpenApiPlusEntrypoint(port=port) as context:
+        context.EnsureConnected()
+        context.DisableAutoLogin()
+
+
+[docs]def disable_auto_login_without_login():
+    from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusQAxWidgetMixin import (
+        KiwoomOpenApiPlusQAxWidgetUniversalMixin,
+    )
+    from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusTypeLibSpec import (
+        API_MODULE_PATH,
+    )
+
+    class GetAPIModulePathStub:
+        def GetAPIModulePath(self):
+            return API_MODULE_PATH
+
+    class DisableAutoLoginStub(
+        GetAPIModulePathStub,
+        KiwoomOpenApiPlusQAxWidgetUniversalMixin,
+    ):
+        pass
+
+    stub = DisableAutoLoginStub()
+    stub.DisableAutoLogin()
+
+
+@click.command(short_help="Disable auto login.")
+@click.option(
+    "-p", "--port", metavar="PORT", help="Port number of grpc server (optional)."
+)
+@verbose_option(default=5, show_default=True)
+[docs]def auto_login(port):
+    disable_auto_login_without_login()
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/cli/commands/enable.html b/_modules/koapy/cli/commands/enable.html new file mode 100644 index 00000000..de82c9f3 --- /dev/null +++ b/_modules/koapy/cli/commands/enable.html @@ -0,0 +1,155 @@ + + + + + + + + koapy.cli.commands.enable — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.cli.commands.enable

+import click
+
+from .auto_login import auto_login
+
+
+@click.group(short_help="Enable things, including auto login.")
+[docs]def enable():
+    pass
+
+
+enable.add_command(auto_login)
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/cli/commands/enable/auto_login.html b/_modules/koapy/cli/commands/enable/auto_login.html new file mode 100644 index 00000000..a59594f6 --- /dev/null +++ b/_modules/koapy/cli/commands/enable/auto_login.html @@ -0,0 +1,164 @@ + + + + + + + + koapy.cli.commands.enable.auto_login — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.cli.commands.enable.auto_login

+import click
+
+from koapy.cli.utils.verbose_option import verbose_option
+
+
+@click.command(short_help="Enable auto login.")
+@click.option(
+    "-p", "--port", metavar="PORT", help="Port number of grpc server (optional)."
+)
+@verbose_option(default=5, show_default=True)
+[docs]def auto_login(port):
+    from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusEntrypoint import (
+        KiwoomOpenApiPlusEntrypoint,
+    )
+
+    with KiwoomOpenApiPlusEntrypoint(port=port) as context:
+        context.EnsureConnected()
+        context.EnsureAutoLoginEnabled()
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/cli/commands/generate.html b/_modules/koapy/cli/commands/generate.html new file mode 100644 index 00000000..e43f2048 --- /dev/null +++ b/_modules/koapy/cli/commands/generate.html @@ -0,0 +1,157 @@ + + + + + + + + koapy.cli.commands.generate — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.cli.commands.generate

+import click
+
+from .grpc import grpc
+from .openapi import openapi
+
+
+@click.group(short_help="Generate files related to grpc, openapi.")
+[docs]def generate():
+    pass
+
+
+generate.add_command(grpc)
+generate.add_command(openapi)
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/cli/commands/generate/grpc.html b/_modules/koapy/cli/commands/generate/grpc.html new file mode 100644 index 00000000..a454dc2f --- /dev/null +++ b/_modules/koapy/cli/commands/generate/grpc.html @@ -0,0 +1,157 @@ + + + + + + + + koapy.cli.commands.generate.grpc — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.cli.commands.generate.grpc

+import click
+
+from .ssl_credentials import ssl_credentials
+
+
+@click.group(short_help="Generate grpc related files.")
+[docs]def grpc():
+    pass
+
+
+grpc.add_command(ssl_credentials)
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/cli/commands/generate/grpc/ssl_credentials.html b/_modules/koapy/cli/commands/generate/grpc/ssl_credentials.html new file mode 100644 index 00000000..0f2b9d3a --- /dev/null +++ b/_modules/koapy/cli/commands/generate/grpc/ssl_credentials.html @@ -0,0 +1,388 @@ + + + + + + + + koapy.cli.commands.generate.grpc.ssl_credentials — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.cli.commands.generate.grpc.ssl_credentials

+import datetime
+
+import click
+
+from cryptography import x509
+from cryptography.hazmat.primitives import hashes, serialization
+from cryptography.hazmat.primitives.asymmetric import rsa
+from cryptography.x509.oid import NameOID
+
+from koapy.config import default_encoding
+
+
+[docs]def generate_self_signed_key_cert(
+    organization_name,
+    common_name,
+    key_filename=None,
+    cert_filename=None,
+    key_password=None,
+    country_name=None,
+    state_or_province_name=None,
+    locality_name=None,
+    valid_days=None,
+):
+    # generate root ca key
+    root_ca_key = rsa.generate_private_key(
+        public_exponent=65537,
+        key_size=2048,
+    )
+    encryption_algorithm = serialization.NoEncryption()
+    if key_password is not None:
+        if not isinstance(key_password, bytes):
+            encoding = default_encoding
+            key_password = key_password.encode(encoding)
+        encryption_algorithm = serialization.BestAvailableEncryption(key_password)
+    root_ca_key_bytes = root_ca_key.private_bytes(
+        encoding=serialization.Encoding.PEM,
+        format=serialization.PrivateFormat.TraditionalOpenSSL,
+        encryption_algorithm=encryption_algorithm,
+    )
+    if key_filename is None:
+        key_filename = "root_ca_key.pem"
+    with open(key_filename, "wb") as f:
+        f.write(root_ca_key_bytes)
+
+    # generate root ca cert
+    name_attributes = []
+    if country_name is not None:
+        name_attributes.append(x509.NameAttribute(NameOID.COUNTRY_NAME, country_name))
+    if state_or_province_name is not None:
+        name_attributes.append(
+            x509.NameAttribute(NameOID.STATE_OR_PROVINCE_NAME, state_or_province_name)
+        )
+    if locality_name is not None:
+        name_attributes.append(x509.NameAttribute(NameOID.LOCALITY_NAME, locality_name))
+    name_attributes += [
+        x509.NameAttribute(NameOID.ORGANIZATION_NAME, organization_name),
+        x509.NameAttribute(NameOID.COMMON_NAME, common_name),
+    ]
+    subject = issuer = x509.Name(name_attributes)
+    cert_builder = x509.CertificateBuilder()
+    cert_builder = cert_builder.subject_name(subject)
+    cert_builder = cert_builder.issuer_name(issuer)
+    cert_builder = cert_builder.public_key(root_ca_key.public_key())
+    cert_builder = cert_builder.serial_number(x509.random_serial_number())
+    if valid_days is None:
+        valid_days = 356 * 10
+    not_valid_before = datetime.datetime.utcnow()
+    not_valid_after = not_valid_before + datetime.timedelta(days=valid_days)
+    cert_builder = cert_builder.not_valid_before(not_valid_before)
+    cert_builder = cert_builder.not_valid_after(not_valid_after)
+    cert_builder = cert_builder.add_extension(
+        x509.SubjectAlternativeName([x509.DNSName("localhost")]),
+        critical=False,
+    )
+    root_ca_cert = cert_builder.sign(root_ca_key, hashes.SHA256())
+    root_ca_cert_bytes = root_ca_cert.public_bytes(serialization.Encoding.PEM)
+    if cert_filename is None:
+        cert_filename = "root_ca_cert.pem"
+    with open(cert_filename, "wb") as f:
+        f.write(root_ca_cert_bytes)
+
+
+[docs]def generate_key_cert_signed_by_authority(
+    organization_name,
+    common_name,
+    alternative_dns_names=None,
+    key_filename=None,
+    csr_filename=None,
+    cert_filename=None,
+    key_password=None,
+    country_name=None,
+    state_or_province_name=None,
+    locality_name=None,
+    valid_days=None,
+    authority_key_filename=None,
+    authority_cert_filename=None,
+    authority_key_password=None,
+):
+    # generate server key
+    key = rsa.generate_private_key(
+        public_exponent=65537,
+        key_size=2048,
+    )
+    encryption_algorithm = serialization.NoEncryption()
+    if key_password is not None:
+        if not isinstance(key_password, bytes):
+            encoding = default_encoding
+            key_password = key_password.encode(encoding)
+        encryption_algorithm = serialization.BestAvailableEncryption(key_password)
+    key_bytes = key.private_bytes(
+        encoding=serialization.Encoding.PEM,
+        format=serialization.PrivateFormat.TraditionalOpenSSL,
+        encryption_algorithm=encryption_algorithm,
+    )
+    if key_filename is None:
+        key_filename = "key.pem"
+    with open(key_filename, "wb") as f:
+        f.write(key_bytes)
+
+    # generate server csr
+    name_attributes = []
+    if country_name is not None:
+        name_attributes.append(x509.NameAttribute(NameOID.COUNTRY_NAME, country_name))
+    if state_or_province_name is not None:
+        name_attributes.append(
+            x509.NameAttribute(NameOID.STATE_OR_PROVINCE_NAME, state_or_province_name)
+        )
+    if locality_name is not None:
+        name_attributes.append(x509.NameAttribute(NameOID.LOCALITY_NAME, locality_name))
+    name_attributes += [
+        x509.NameAttribute(NameOID.ORGANIZATION_NAME, organization_name),
+        x509.NameAttribute(NameOID.COMMON_NAME, common_name),
+    ]
+    subject = x509.Name(name_attributes)
+    csr_builder = x509.CertificateSigningRequestBuilder()
+    csr_builder = csr_builder.subject_name(subject)
+    if alternative_dns_names is None:
+        alternative_dns_names = ["localhost"]
+    csr_builder = csr_builder.add_extension(
+        x509.SubjectAlternativeName(
+            [x509.DNSName(name) for name in alternative_dns_names]
+        ),
+        critical=False,
+    )
+    csr = csr_builder.sign(key, hashes.SHA256())
+    csr_bytes = csr.public_bytes(serialization.Encoding.PEM)
+    if csr_filename is None:
+        csr_filename = "csr.pem"
+    with open(csr_filename, "wb") as f:
+        f.write(csr_bytes)
+
+    # get authority key and cert
+    if authority_key_password is not None:
+        if not isinstance(authority_key_password, bytes):
+            encoding = default_encoding
+            authority_key_password = authority_key_password.encode(encoding)
+    if authority_key_filename is None:
+        authority_key_filename = "root_ca_key.pem"
+    with open(authority_key_filename, "rb") as f:
+        authority_key = serialization.load_pem_private_key(
+            f.read(),
+            password=authority_key_password,
+        )
+    if authority_cert_filename is None:
+        authority_cert_filename = "root_ca_cert.pem"
+    with open(authority_cert_filename, "rb") as f:
+        authority_cert = x509.load_pem_x509_certificate(f.read())
+
+    # root ca signs and issues server cert from server csr
+    cert_builder = x509.CertificateBuilder()
+    cert_builder = cert_builder.subject_name(subject)
+    cert_builder = cert_builder.issuer_name(authority_cert.subject)
+    cert_builder = cert_builder.public_key(csr.public_key())
+    cert_builder = cert_builder.serial_number(x509.random_serial_number())
+    if valid_days is None:
+        valid_days = 356
+    not_valid_before = datetime.datetime.utcnow()
+    not_valid_after = not_valid_before + datetime.timedelta(days=valid_days)
+    cert_builder = cert_builder.not_valid_before(not_valid_before)
+    cert_builder = cert_builder.not_valid_after(not_valid_after)
+    for extension in csr.extensions:
+        cert_builder = cert_builder.add_extension(
+            extension.value,
+            critical=extension.critical,
+        )
+    cert = cert_builder.sign(authority_key, hashes.SHA256())
+    cert_bytes = cert.public_bytes(serialization.Encoding.PEM)
+    if cert_filename is None:
+        cert_filename = "cert.pem"
+    with open(cert_filename, "wb") as f:
+        f.write(cert_bytes)
+
+
+@click.command(
+    short_help="Generate crypto-related files for server/client SSL/TLS.",
+)
+[docs]def ssl_credentials():
+    # generate root ca key and cert
+    root_ca_organization_name = "Root CA"
+    root_ca_common_name = "localhost"
+    root_ca_key_filename = "root_ca_key.pem"
+    root_ca_cert_filename = "root_ca_cert.pem"
+    generate_self_signed_key_cert(
+        root_ca_organization_name,
+        root_ca_common_name,
+        key_filename=root_ca_key_filename,
+        cert_filename=root_ca_cert_filename,
+    )
+
+    # generate server key and cert
+    server_organization_name = "Server"
+    server_common_name = "localhost"
+    server_key_filename = "server_key.pem"
+    server_csr_filename = "server_csr.pem"
+    server_cert_filename = "server_cert.pem"
+    generate_key_cert_signed_by_authority(
+        server_organization_name,
+        server_common_name,
+        key_filename=server_key_filename,
+        csr_filename=server_csr_filename,
+        cert_filename=server_cert_filename,
+        authority_key_filename=root_ca_key_filename,
+        authority_cert_filename=root_ca_cert_filename,
+    )
+
+    # generate client key and cert
+    client_organization_name = "Client"
+    client_common_name = "localhost"
+    client_key_filename = "client_key.pem"
+    client_csr_filename = "client_csr.pem"
+    client_cert_filename = "client_cert.pem"
+    generate_key_cert_signed_by_authority(
+        client_organization_name,
+        client_common_name,
+        key_filename=client_key_filename,
+        csr_filename=client_csr_filename,
+        cert_filename=client_cert_filename,
+        authority_key_filename=root_ca_key_filename,
+        authority_cert_filename=root_ca_cert_filename,
+    )
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/cli/commands/generate/openapi.html b/_modules/koapy/cli/commands/generate/openapi.html new file mode 100644 index 00000000..88ddccfc --- /dev/null +++ b/_modules/koapy/cli/commands/generate/openapi.html @@ -0,0 +1,157 @@ + + + + + + + + koapy.cli.commands.generate.openapi — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.cli.commands.generate.openapi

+import click
+
+from .python_stubs import python_stubs
+
+
+@click.group(short_help="Generate openapi related files.")
+[docs]def openapi():
+    pass
+
+
+openapi.add_command(python_stubs)
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/cli/commands/generate/openapi/python_stubs.html b/_modules/koapy/cli/commands/generate/openapi/python_stubs.html new file mode 100644 index 00000000..157db061 --- /dev/null +++ b/_modules/koapy/cli/commands/generate/openapi/python_stubs.html @@ -0,0 +1,222 @@ + + + + + + + + koapy.cli.commands.generate.openapi.python_stubs — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.cli.commands.generate.openapi.python_stubs

+import click
+
+from koapy.backend.kiwoom_open_api_plus.core.tools.generate_python_stubs import (
+    generate_python_stubs,
+)
+from koapy.config import default_encoding
+
+[docs]default_dispatch_class_name = "KiwoomOpenApiPlusDispatchFunctionsGenerated"
+[docs]default_dispatch_file_path = default_dispatch_class_name + ".py"
+
+[docs]default_event_class_name = "KiwoomOpenApiPlusEventFunctionsGenerated"
+[docs]default_event_file_path = default_event_class_name + ".py"
+
+
+@click.command(
+    short_help="Generate python stubs for OpenAPI Dispatch and Event.",
+)
+@click.option(
+    "--dispatch-class-name",
+    metavar="NAME",
+    help="Name for class with Dispatch functions.",
+    default=default_dispatch_class_name,
+    show_default=True,
+)
+@click.option(
+    "--dispatch-file-path",
+    type=click.Path(),
+    help="Path for python-stub with Dispatch functions.",
+    default=default_dispatch_file_path,
+    show_default=True,
+)
+@click.option(
+    "--event-class-name",
+    metavar="NAME",
+    help="Name for class with Event functions.",
+    default=default_event_class_name,
+    show_default=True,
+)
+@click.option(
+    "--event-file-path",
+    type=click.Path(),
+    help="Path for python-stub with Event functions.",
+    default=default_event_file_path,
+    show_default=True,
+)
+@click.option(
+    "--encoding",
+    metavar="ENCODING",
+    help="Encoding for stub files.",
+    default=default_encoding,
+    show_default=True,
+)
+@click.option(
+    "--force-overwrite",
+    help="Force overwrite even if target file already exists.",
+    is_flag=True,
+    show_default=True,
+)
+[docs]def python_stubs(
+    dispatch_class_name,
+    dispatch_file_path,
+    event_class_name,
+    event_file_path,
+    encoding,
+    force_overwrite,
+):
+    generate_python_stubs(
+        dispatch_class_name=dispatch_class_name,
+        dispatch_file_path=dispatch_file_path,
+        event_class_name=event_class_name,
+        event_file_path=event_file_path,
+        encoding=encoding,
+        force_overwrite=force_overwrite,
+    )
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/cli/commands/get.html b/_modules/koapy/cli/commands/get.html new file mode 100644 index 00000000..27627f7d --- /dev/null +++ b/_modules/koapy/cli/commands/get.html @@ -0,0 +1,184 @@ + + + + + + + + koapy.cli.commands.get — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.cli.commands.get

+import click
+
+from .account_data.deposit import deposit
+from .account_data.evaluation import evaluation
+from .account_data.orders import orders
+from .account_data.userinfo import userinfo
+from .chart_data.daily import daily
+from .chart_data.minute import minute
+from .openapi_meta.errmsg import errmsg
+from .openapi_meta.modulepath import modulepath
+from .openapi_meta.realinfo import realinfo
+from .openapi_meta.trinfo import trinfo
+from .stock_meta.codelist import codelist
+from .stock_meta.stockcode import stockcode
+from .stock_meta.stockinfo import stockinfo
+from .stock_meta.stockname import stockname
+
+
+@click.group(short_help="Get various types of data.")
+[docs]def get():
+    pass
+
+
+get.add_command(deposit)
+get.add_command(evaluation)
+get.add_command(orders)
+get.add_command(userinfo)
+
+get.add_command(daily)
+get.add_command(minute)
+
+get.add_command(errmsg)
+get.add_command(modulepath)
+get.add_command(realinfo)
+get.add_command(trinfo)
+
+get.add_command(codelist)
+get.add_command(stockcode)
+get.add_command(stockinfo)
+get.add_command(stockname)
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/cli/commands/get/account_data/deposit.html b/_modules/koapy/cli/commands/get/account_data/deposit.html new file mode 100644 index 00000000..f520e909 --- /dev/null +++ b/_modules/koapy/cli/commands/get/account_data/deposit.html @@ -0,0 +1,176 @@ + + + + + + + + koapy.cli.commands.get.account_data.deposit — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.cli.commands.get.account_data.deposit

+import click
+
+from koapy.cli.utils.verbose_option import verbose_option
+from koapy.utils.logging import get_logger
+
+[docs]logger = get_logger(__name__)
+
+
+@click.command(short_help="Get account deposit.")
+@click.option("-a", "--account", metavar="ACCNO", help="Account number.")
+@click.option(
+    "-p", "--port", metavar="PORT", help="Port number of grpc server (optional)."
+)
+@verbose_option()
+[docs]def deposit(account, port):
+    if account is None:
+        logger.info("Account not given. Using first account available.")
+
+    from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusEntrypoint import (
+        KiwoomOpenApiPlusEntrypoint,
+    )
+
+    with KiwoomOpenApiPlusEntrypoint(port=port) as context:
+        context.EnsureConnected()
+
+        if account is None:
+            account = context.GetAccountList()[0]
+
+        result = context.GetDepositInfo(account)
+        click.echo(result.to_markdown(floatfmt=".2f"))
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/cli/commands/get/account_data/evaluation.html b/_modules/koapy/cli/commands/get/account_data/evaluation.html new file mode 100644 index 00000000..9d95130e --- /dev/null +++ b/_modules/koapy/cli/commands/get/account_data/evaluation.html @@ -0,0 +1,209 @@ + + + + + + + + koapy.cli.commands.get.account_data.evaluation — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.cli.commands.get.account_data.evaluation

+import click
+
+from koapy.cli.utils.verbose_option import verbose_option
+from koapy.utils.logging import get_logger
+
+[docs]logger = get_logger(__name__)
+
+
+@click.command(short_help="Get account evaluation.")
+@click.option("-a", "--account", metavar="ACCNO", help="Account number.")
+@click.option(
+    "-d", "--include-delisted", is_flag=True, help="Include delisted.", default=True
+)
+@click.option("-D", "--exclude-delisted", is_flag=True, help="Exclude delisted.")
+@click.option(
+    "-e", "--for-each", is_flag=True, help="Show individual evaluation.", default=True
+)
+@click.option("-E", "--as-summary", is_flag=True, help="Show summarized evaluation.")
+@click.option(
+    "-p", "--port", metavar="PORT", help="Port number of grpc server (optional)."
+)
+@verbose_option()
+[docs]def evaluation(account, include_delisted, exclude_delisted, for_each, as_summary, port):
+    if account is None:
+        logger.info("Account not given. Using first account available.")
+
+    if exclude_delisted:
+        include_delisted = False
+
+    if as_summary:
+        for_each = False
+        lookup_type = "1"
+    elif for_each:
+        lookup_type = "2"
+
+    from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusEntrypoint import (
+        KiwoomOpenApiPlusEntrypoint,
+    )
+
+    with KiwoomOpenApiPlusEntrypoint(port=port) as context:
+        context.EnsureConnected()
+
+        if account is None:
+            account = context.GetAccountList()[0]
+
+        single, multi = context.GetAccountEvaluationStatusAsSeriesAndDataFrame(
+            account, include_delisted
+        )
+        click.echo("[계좌평가현황요청] : [계좌평가현황]")
+        click.echo(single.to_markdown(floatfmt=".2f"))
+        click.echo()
+        click.echo("[계좌평가현황요청] : [종목별계좌평가현황]")
+        click.echo(multi.to_markdown())
+        click.echo()
+
+        single, multi = context.GetAccountEvaluationBalanceAsSeriesAndDataFrame(
+            account, lookup_type
+        )
+        click.echo("[계좌평가잔고내역요청] : [계좌평가결과]")
+        click.echo(single.to_markdown(floatfmt=".2f"))
+        click.echo()
+        click.echo("[계좌평가잔고내역요청] : [계좌평가잔고개별합산]")
+        click.echo(multi.to_markdown())
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/cli/commands/get/account_data/orders.html b/_modules/koapy/cli/commands/get/account_data/orders.html new file mode 100644 index 00000000..a3bc66a6 --- /dev/null +++ b/_modules/koapy/cli/commands/get/account_data/orders.html @@ -0,0 +1,226 @@ + + + + + + + + koapy.cli.commands.get.account_data.orders — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.cli.commands.get.account_data.orders

+import click
+
+from koapy.cli.utils.verbose_option import verbose_option
+from koapy.utils.logging import get_logger
+
+[docs]logger = get_logger(__name__)
+
+
+@click.command(short_help="Get order history of a date.")
+@click.option("-a", "--account", metavar="ACCNO", help="Account number.")
+@click.option("-d", "--date", metavar="DATE", help="Date to get.")
+@click.option("-r", "--reverse", is_flag=True)
+@click.option("-e", "--executed-only", is_flag=True)
+@click.option("-E", "--not-executed-only", is_flag=True)
+@click.option("-S", "--stock-only", is_flag=True)
+@click.option("-B", "--bond-only", is_flag=True)
+@click.option("-s", "--sell-only", is_flag=True)
+@click.option("-b", "--buy-only", is_flag=True)
+@click.option("-c", "--code", metavar="CODE", help="Stock code to get.")
+@click.option("-o", "--starting-order-no", metavar="ORDERNO", help="Starting order no.")
+@click.option(
+    "-p", "--port", metavar="PORT", help="Port number of grpc server (optional)."
+)
+@verbose_option()
+[docs]def orders(
+    account,
+    date,
+    reverse,
+    executed_only,
+    not_executed_only,
+    stock_only,
+    bond_only,
+    sell_only,
+    buy_only,
+    code,
+    starting_order_no,
+    port,
+):
+    if account is None:
+        logger.info("Account not given. Using first account available.")
+
+    sort_type = "1"
+    if reverse:
+        sort_type = "2"
+    if executed_only:
+        sort_type = "3"
+    if not_executed_only:
+        sort_type = "4"
+    asset_type = "0"
+    if stock_only:
+        asset_type = "1"
+    if bond_only:
+        asset_type = "2"
+    order_type = "0"
+    if sell_only:
+        order_type = "1"
+    if buy_only:
+        order_type = "2"
+
+    from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusEntrypoint import (
+        KiwoomOpenApiPlusEntrypoint,
+    )
+
+    with KiwoomOpenApiPlusEntrypoint(port=port) as context:
+        context.EnsureConnected()
+        if account is None:
+            account = context.GetFirstAvailableAccount()
+        df = context.GetOrderLogAsDataFrame1(account)
+        click.echo("[실시간미체결요청]")
+        click.echo(df.to_markdown())
+        click.echo()
+        df = context.GetOrderLogAsDataFrame2(account)
+        click.echo("[실시간체결요청]")
+        click.echo(df.to_markdown())
+        click.echo()
+        df = context.GetOrderLogAsDataFrame3(
+            account, date, sort_type, asset_type, order_type, code, starting_order_no
+        )
+        click.echo("[계좌별주문체결내역상세요청]")
+        click.echo(df.to_markdown())
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/cli/commands/get/account_data/userinfo.html b/_modules/koapy/cli/commands/get/account_data/userinfo.html new file mode 100644 index 00000000..e42b8ea1 --- /dev/null +++ b/_modules/koapy/cli/commands/get/account_data/userinfo.html @@ -0,0 +1,187 @@ + + + + + + + + koapy.cli.commands.get.account_data.userinfo — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.cli.commands.get.account_data.userinfo

+import click
+
+from koapy.cli.utils.verbose_option import verbose_option
+
+
+@click.command(short_help="Get user information.")
+@click.option(
+    "-p", "--port", metavar="PORT", help="Port number of grpc server (optional)."
+)
+@verbose_option()
+[docs]def userinfo(port):
+    import pandas as pd
+
+    from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusEntrypoint import (
+        KiwoomOpenApiPlusEntrypoint,
+    )
+
+    with KiwoomOpenApiPlusEntrypoint(port=port) as context:
+        context.EnsureConnected()
+
+        result = {}
+        result["보유계좌수"] = context.GetLoginInfo("ACCOUNT_CNT")
+        account_numbers = context.GetLoginInfo("ACCLIST").rstrip(";").split(";")
+        for i, accno in enumerate(account_numbers):
+            result["계좌번호 (%d/%s)" % (i + 1, result["보유계좌수"])] = accno
+        result["사용자 ID"] = context.GetLoginInfo("USER_ID")
+        result["사용자 명"] = context.GetLoginInfo("USER_NAME")
+        result["키보드보안 해지 여부"] = {
+            "0": "정상",
+            "1": "해지",
+        }.get(context.GetLoginInfo("KEY_BSECGB"), "알수없음")
+        result["방화벽 설정 여부"] = {
+            "0": "미설정",
+            "1": "설정",
+            "2": "해지",
+        }.get(context.GetLoginInfo("FIREW_SECGB"), "알수없음")
+        result["접속서버 구분"] = {
+            "1": "모의투자",
+        }.get(context.GetServerGubun(), "실서버")
+
+        click.echo(pd.Series(result).to_markdown())
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/cli/commands/get/chart_data/daily.html b/_modules/koapy/cli/commands/get/chart_data/daily.html new file mode 100644 index 00000000..b5b5fb24 --- /dev/null +++ b/_modules/koapy/cli/commands/get/chart_data/daily.html @@ -0,0 +1,217 @@ + + + + + + + + koapy.cli.commands.get.chart_data.daily — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.cli.commands.get.chart_data.daily

+import click
+
+from koapy.cli.utils.fail_with_usage import fail_with_usage
+from koapy.cli.utils.verbose_option import verbose_option
+from koapy.utils.logging import get_logger
+
+[docs]logger = get_logger(__name__)
+
+
+@click.command(short_help="Get daily OHLCV of stocks.")
+@click.option("-c", "--code", metavar="CODE", help="Stock code to get.")
+@click.option(
+    "-o",
+    "--output",
+    metavar="FILENAME",
+    type=click.Path(),
+    help="Output filename for code.",
+)
+@click.option(
+    "-f",
+    "--format",
+    metavar="FORMAT",
+    type=click.Choice(["xlsx", "sqlite3"], case_sensitive=False),
+    default="xlsx",
+    help="Output format. (default: xlsx)",
+)
+@click.option(
+    "-s",
+    "--start-date",
+    metavar="YYYY-MM-DD",
+    type=click.DateTime(formats=["%Y-%m-%d", "%Y%m%d"]),
+    help="Most recent date to get. Defaults to today or yesterday if market is open.",
+)
+@click.option(
+    "-e",
+    "--end-date",
+    metavar="YYYY-MM-DD",
+    type=click.DateTime(formats=["%Y-%m-%d", "%Y%m%d"]),
+    help="Stops if reached, not included (optional).",
+)
+@click.option(
+    "-p", "--port", metavar="PORT", help="Port number of grpc server (optional)."
+)
+@verbose_option()
+[docs]def daily(
+    code, output, format, start_date, end_date, port
+):  # pylint: disable=redefined-builtin
+    if (code, output, start_date, end_date) == (None, None, None, None):
+        fail_with_usage()
+
+    if output is None:
+        output = "{}.{}".format(code, format)
+
+    from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusEntrypoint import (
+        KiwoomOpenApiPlusEntrypoint,
+    )
+
+    with KiwoomOpenApiPlusEntrypoint(port=port) as context:
+        context.EnsureConnected()
+        df = context.GetDailyStockDataAsDataFrame(code, start_date, end_date)
+
+    if format == "xlsx":
+        df.to_excel(output)
+        logger.info("Saved data to file: %s", output)
+    elif format == "sqlite3":
+        from sqlalchemy import create_engine
+
+        engine = create_engine("sqlite:///" + output)
+        tablename = "A" + code
+        df.to_sql(tablename, engine)
+        logger.info("Saved data to file %s with tablename %s", output, tablename)
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/cli/commands/get/chart_data/minute.html b/_modules/koapy/cli/commands/get/chart_data/minute.html new file mode 100644 index 00000000..bf4c91cc --- /dev/null +++ b/_modules/koapy/cli/commands/get/chart_data/minute.html @@ -0,0 +1,242 @@ + + + + + + + + koapy.cli.commands.get.chart_data.minute — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.cli.commands.get.chart_data.minute

+import click
+
+from koapy.cli.utils.fail_with_usage import fail_with_usage
+from koapy.cli.utils.verbose_option import verbose_option
+from koapy.utils.logging import get_logger
+
+[docs]logger = get_logger(__name__)
+
+[docs]minute_intervals = [
+    "1",
+    "3",
+    "5",
+    "10",
+    "15",
+    "30",
+    "45",
+    "60",
+]
+
+
+@click.command(short_help="Get minute OHLCV of stocks.")
+@click.option("-c", "--code", metavar="CODE", help="Stock code to get.")
+@click.option(
+    "-t",
+    "--interval",
+    metavar="INTERVAL",
+    type=click.Choice(minute_intervals, case_sensitive=False),
+    help="Minute interval. Possible values are [%s]" % "|".join(minute_intervals),
+)
+@click.option(
+    "-o",
+    "--output",
+    metavar="FILENAME",
+    type=click.Path(),
+    help="Output filename for code.",
+)
+@click.option(
+    "-f",
+    "--format",
+    metavar="FORMAT",
+    type=click.Choice(["xlsx", "sqlite3"], case_sensitive=False),
+    default="xlsx",
+    help="Output format. (default: xlsx)",
+)
+@click.option(
+    "-s",
+    "--start-date",
+    metavar="YYYY-MM-DD['T'hh:mm:ss]",
+    type=click.DateTime(
+        formats=["%Y-%m-%d", "%Y%m%d", "%Y-%m-%dT%H:%M:%S", "%Y%m%d%H%M%S"]
+    ),
+    help="Most recent date to get. Defaults to today or yesterday if market is open.",
+)
+@click.option(
+    "-e",
+    "--end-date",
+    metavar="YYYY-MM-DD['T'hh:mm:ss]",
+    type=click.DateTime(
+        formats=["%Y-%m-%d", "%Y%m%d", "%Y-%m-%dT%H:%M:%S", "%Y%m%d%H%M%S"]
+    ),
+    help="Stops if reached, not included (optional).",
+)
+@click.option(
+    "-p", "--port", metavar="PORT", help="Port number of grpc server (optional)."
+)
+@verbose_option()
+[docs]def minute(
+    code, interval, output, format, start_date, end_date, port
+):  # pylint: disable=redefined-builtin
+    if (code, interval, output, start_date, end_date) == (None, None, None, None, None):
+        fail_with_usage()
+
+    if interval is None:
+        fail_with_usage("Interval is not set.")
+
+    if output is None:
+        output = "{}.{}".format(code, format)
+
+    from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusEntrypoint import (
+        KiwoomOpenApiPlusEntrypoint,
+    )
+
+    with KiwoomOpenApiPlusEntrypoint(port=port) as context:
+        context.EnsureConnected()
+        df = context.GetMinuteStockDataAsDataFrame(code, interval, start_date, end_date)
+
+    if format == "xlsx":
+        df.to_excel(output)
+        logger.info("Saved data to file: %s", output)
+    elif format == "sqlite3":
+        from sqlalchemy import create_engine
+
+        engine = create_engine("sqlite:///" + output)
+        tablename = "A" + code
+        df.to_sql(tablename, engine)
+        logger.info("Saved data to file %s with tablename %s", output, tablename)
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/cli/commands/get/openapi_meta/errmsg.html b/_modules/koapy/cli/commands/get/openapi_meta/errmsg.html new file mode 100644 index 00000000..02960154 --- /dev/null +++ b/_modules/koapy/cli/commands/get/openapi_meta/errmsg.html @@ -0,0 +1,165 @@ + + + + + + + + koapy.cli.commands.get.openapi_meta.errmsg — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.cli.commands.get.openapi_meta.errmsg

+import click
+
+from koapy.cli.utils.fail_with_usage import fail_with_usage
+from koapy.cli.utils.verbose_option import verbose_option
+
+
+@click.command(short_help="Get error message for error code.")
+@click.option("-e", "--err-code", metavar="ERR", type=int, help="Error code to check.")
+@verbose_option()
+[docs]def errmsg(err_code):
+    if err_code is None:
+        fail_with_usage()
+
+    from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusError import (
+        KiwoomOpenApiPlusError,
+    )
+
+    err_msg = KiwoomOpenApiPlusError.get_error_message_by_code(err_code)
+    click.echo("[%d] %s" % (err_code, err_msg))
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/cli/commands/get/openapi_meta/modulepath.html b/_modules/koapy/cli/commands/get/openapi_meta/modulepath.html new file mode 100644 index 00000000..79231033 --- /dev/null +++ b/_modules/koapy/cli/commands/get/openapi_meta/modulepath.html @@ -0,0 +1,159 @@ + + + + + + + + koapy.cli.commands.get.openapi_meta.modulepath — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.cli.commands.get.openapi_meta.modulepath

+import click
+
+from koapy.cli.utils.verbose_option import verbose_option
+
+
+@click.command(short_help="Get OpenApi module installation path.")
+@verbose_option()
+[docs]def modulepath():
+    from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusTypeLibSpec import (
+        API_MODULE_PATH,
+    )
+
+    click.echo(API_MODULE_PATH)
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/cli/commands/get/openapi_meta/realinfo.html b/_modules/koapy/cli/commands/get/openapi_meta/realinfo.html new file mode 100644 index 00000000..c22b311a --- /dev/null +++ b/_modules/koapy/cli/commands/get/openapi_meta/realinfo.html @@ -0,0 +1,198 @@ + + + + + + + + koapy.cli.commands.get.openapi_meta.realinfo — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.cli.commands.get.openapi_meta.realinfo

+import click
+
+from koapy.cli.utils.verbose_option import verbose_option
+
+
+@click.command(short_help="Get real type info.")
+@click.option(
+    "-t",
+    "--realtype",
+    "realtypes",
+    metavar="REALTYPE",
+    multiple=True,
+    help="Real type name to get (like 주식시세).",
+)
+@verbose_option()
+[docs]def realinfo(realtypes):
+    from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusRealType import (
+        KiwoomOpenApiPlusRealType,
+    )
+
+    def get_realtypes():
+        if realtypes:
+            if "-" in realtypes:
+                with click.open_file("-", "r") as f:
+                    for realtype in f:
+                        yield realtype.strip()
+            else:
+                for realtype in realtypes:
+                    yield realtype
+        else:
+            while True:
+                try:
+                    realtype = click.prompt("realtype", prompt_suffix=" >>> ")
+                    realtype = realtype.strip()
+                    if realtype == "exit":
+                        break
+                    if realtype:
+                        yield realtype
+                except EOFError:
+                    break
+
+    for realtype in get_realtypes():
+        fids = KiwoomOpenApiPlusRealType.get_fids_by_realtype_name(realtype)
+        if fids:
+            names = [
+                KiwoomOpenApiPlusRealType.Fid.get_name_by_fid(fid, str(fid))
+                for fid in fids
+            ]
+            for fid, name in zip(fids, names):
+                click.echo("  [{}] = {}".format(fid, name))
+        else:
+            click.echo("Given realtype is invalid")
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/cli/commands/get/openapi_meta/trinfo.html b/_modules/koapy/cli/commands/get/openapi_meta/trinfo.html new file mode 100644 index 00000000..01dcfe6c --- /dev/null +++ b/_modules/koapy/cli/commands/get/openapi_meta/trinfo.html @@ -0,0 +1,208 @@ + + + + + + + + koapy.cli.commands.get.openapi_meta.trinfo — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.cli.commands.get.openapi_meta.trinfo

+import click
+
+from koapy.cli.utils.verbose_option import verbose_option
+
+
+@click.command(short_help="Get TR info.")
+@click.option(
+    "-t",
+    "--trcode",
+    "trcodes",
+    metavar="TRCODE",
+    multiple=True,
+    help="TR code to get (like opt10001).",
+)
+@verbose_option()
+[docs]def trinfo(trcodes):
+    from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusTrInfo import (
+        KiwoomOpenApiPlusTrInfo,
+    )
+
+    def get_codes():
+        if trcodes:
+            if "-" in trcodes:
+                with click.open_file("-", "r") as f:
+                    for code in f:
+                        yield code.strip()
+            else:
+                for code in trcodes:
+                    yield code
+        else:
+            while True:
+                try:
+                    code = click.prompt("trcode", prompt_suffix=" >>> ")
+                    code = code.strip()
+                    if code == "exit":
+                        break
+                    if code:
+                        yield code
+                except EOFError:
+                    break
+
+    for trcode in get_codes():
+        tr_info = KiwoomOpenApiPlusTrInfo.get_trinfo_by_code(trcode)
+        if tr_info is not None:
+            click.echo("[{}] : [{}]".format(tr_info.tr_code.upper(), tr_info.name))
+            click.echo("  [INPUT]")
+            for tr_input in tr_info.inputs:
+                click.echo("    %s" % tr_input.name)
+            if tr_info.single_outputs:
+                click.echo(
+                    "  [OUTPUT] [SINGLE DATA] : [%s]" % tr_info.single_outputs_name
+                )
+                for output in tr_info.single_outputs:
+                    click.echo("    %s" % output.name)
+            if tr_info.multi_outputs:
+                click.echo(
+                    "  [OUTPUT] [MULTI DATA]  : [%s]" % tr_info.multi_outputs_name
+                )
+                for output in tr_info.multi_outputs:
+                    click.echo("    %s" % output.name)
+        else:
+            click.echo("Given trcode is invalid")
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/cli/commands/get/stock_meta/codelist.html b/_modules/koapy/cli/commands/get/stock_meta/codelist.html new file mode 100644 index 00000000..d182ba93 --- /dev/null +++ b/_modules/koapy/cli/commands/get/stock_meta/codelist.html @@ -0,0 +1,219 @@ + + + + + + + + koapy.cli.commands.get.stock_meta.codelist — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.cli.commands.get.stock_meta.codelist

+import click
+
+from koapy.cli.commands.get.stock_meta.codelist_interactive import codelist_interactive
+from koapy.cli.utils.verbose_option import verbose_option
+
+[docs]market_codes = [
+    "0",
+    "10",
+    "3",
+    "8",
+    "50",
+    "4",
+    "5",
+    "6",
+    "9",
+    "30",
+    "all",
+]
+
+
+@click.command(short_help="Get stock codes.")
+@click.option(
+    "-m",
+    "--market",
+    "markets",
+    metavar="MARKET",
+    multiple=True,
+    type=click.Choice(market_codes, case_sensitive=False),
+    help="Stock market code to get. Can set multiple times.",
+)
+@click.option(
+    "-p", "--port", metavar="PORT", help="Port number of grpc server (optional)."
+)
+@verbose_option()
+[docs]def codelist(markets, port):
+    """
+    \b
+    Possible market codes are:
+      0 : 장내
+      10 : 코스닥
+      3 : ELW
+      8 : ETF
+      50 : KONEX
+      4 : 뮤추얼펀드
+      5 : 신주인수권
+      6 : 리츠
+      9 : 하이얼펀드
+      30 : K-OTC
+    """
+
+    if not markets and click.get_text_stream("stdin").isatty():
+        return codelist_interactive()
+
+    from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusEntrypoint import (
+        KiwoomOpenApiPlusEntrypoint,
+    )
+
+    with KiwoomOpenApiPlusEntrypoint(port=port) as context:
+        context.EnsureConnected()
+        codes = set()
+        for market in markets:
+            codes = codes.union(set(context.GetCodeListByMarketAsList(market)))
+        codes = sorted(list(codes))
+        for code in codes:
+            click.echo(code)
+
+
+[docs]def main():
+    codelist()  # pylint: disable=no-value-for-parameter
+
+
+if __name__ == "__main__":
+    main()
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/cli/commands/get/stock_meta/codelist_interactive.html b/_modules/koapy/cli/commands/get/stock_meta/codelist_interactive.html new file mode 100644 index 00000000..690bcf2c --- /dev/null +++ b/_modules/koapy/cli/commands/get/stock_meta/codelist_interactive.html @@ -0,0 +1,387 @@ + + + + + + + + koapy.cli.commands.get.stock_meta.codelist_interactive — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.cli.commands.get.stock_meta.codelist_interactive

+import curses
+import curses.ascii
+import logging
+import unicodedata
+
+import pygtrie
+
+from koapy.utils.logging.Logging import Logging
+
+
+[docs]class MarketEntry:
+    def __init__(self, code, name):
+        self.code = code
+        self.name = name
+        self.stocks = []
+
+[docs]    def to_string(self):
+        return "[{:2}] {}".format(self.code, self.name)
+
+
+[docs]class StockEntry:
+    def __init__(self, code, name):
+        self.code = code
+        self.name = name
+
+[docs]    def to_string(self):
+        return "[{}] {}".format(self.code, self.name)
+
+
+[docs]markets = [
+    MarketEntry(0, "KOSPI"),
+    MarketEntry(10, "KOSDAQ"),
+    MarketEntry(3, "ELW"),
+    MarketEntry(8, "ETF"),
+    MarketEntry(50, "KONEX"),
+    MarketEntry(4, "MUTUAL FUND"),
+    MarketEntry(5, "RIGHTS OFFERING"),
+    MarketEntry(6, "REITS"),
+    MarketEntry(9, "HIGH YIELD FUND"),
+    MarketEntry(30, "K-OTC"),
+]
+
+
+[docs]class StatusBarHandler(logging.Handler):
+    def __init__(self, screen, level=logging.NOTSET):
+        super().__init__(level)
+        self._screen = screen
+
+[docs]    def emit(self, record):
+        self._screen.set_footer_bar(record.getMessage())
+
+
+[docs]def screen_len(str):
+    l = 0
+    for c in str:
+        if unicodedata.east_asian_width(c) in ["F", "W"]:
+            l += 2
+        else:
+            l += 1
+    return l
+
+
+[docs]class Screen:
+    def __init__(self, screen):
+        self._screen = screen
+
+        curses.start_color()
+        curses.init_pair(1, curses.COLOR_BLACK, curses.COLOR_WHITE)
+
+        self._screen.clear()
+        self._screen.refresh()
+
+        self._height, self._width = self._screen.getmaxyx()
+
+        self._header_bar = curses.newwin(1, self._width, 0, 0)
+        self._header_bar.attron(curses.A_REVERSE)
+        self._header_bar_prefix = ">>> "
+        self._header_bar_text = self._header_bar_prefix
+        self._pad = curses.newpad(0, self._width)
+        self._footer_bar = curses.newwin(1, self._width, self._height - 1, 0)
+        self._footer_bar.attron(curses.A_REVERSE)
+        self._footer_text = ""
+
+        self._exit_key = ord("q")
+
+        self.refresh_header_bar()
+        self.set_footer_bar("Logs will appear here...")
+
+        self._handler = StatusBarHandler(self)
+        self._logger = Logging.get_logger("koapy")
+        self._logger.addHandler(self._handler)
+
+        from koapy import KiwoomOpenApiPlusEntrypoint
+
+        self._entrypoint = KiwoomOpenApiPlusEntrypoint()
+        self._entrypoint.EnsureConnected()
+
+[docs]    def refresh_header_bar(self):
+        self._height, self._width = self._screen.getmaxyx()
+        self._header_bar.resize(1, self._width)
+        self._header_bar.mvwin(0, 0)
+        self._header_bar.addstr(0, 0, self._header_bar_text.ljust(self._width - 1))
+        self._screen.move(0, screen_len(self._header_bar_text))
+        self._header_bar.refresh()
+
+[docs]    def set_header_bar(self, text):
+        self._header_bar_text = self._header_bar_prefix + text
+        self.refresh_header_bar()
+
+[docs]    def refresh_footer_bar(self):
+        self._height, self._width = self._screen.getmaxyx()
+        self._footer_bar.resize(1, self._width)
+        self._footer_bar.mvwin(self._height - 1, 0)
+        self._footer_bar.addstr(0, 0, self._footer_text.ljust(self._width - 1))
+        self._footer_bar.refresh()
+
+[docs]    def set_footer_bar(self, text):
+        self._footer_text = text
+        self.refresh_footer_bar()
+
+[docs]    def show_entries(self, entries):
+        trie = pygtrie.CharTrie()
+        for entry in entries:
+            trie[str(entry.code)] = entry
+            trie[entry.name] = entry
+        original_entries = entries
+        current_entries = original_entries
+        k = 0
+        cursor_y = 0
+        scroll_y = 0
+        query = ""
+        while k not in [curses.ascii.ESC, curses.KEY_LEFT]:
+            self.set_header_bar(query)
+            self.refresh_footer_bar()
+            self._height, self._width = self._screen.getmaxyx()
+            pad_height = self._height - 2
+            pad_width = self._width
+            self._pad.resize(len(current_entries), pad_width)
+            self._pad.clear()
+            if k == curses.KEY_DOWN:
+                cursor_y = cursor_y + 1
+            elif k == curses.KEY_UP:
+                cursor_y = cursor_y - 1
+            elif k == curses.KEY_PPAGE:
+                prev_scroll_y = scroll_y
+                scroll_y = max(scroll_y - pad_height, 0)
+                cursor_y -= prev_scroll_y - scroll_y
+            elif k == curses.KEY_NPAGE:
+                prev_scroll_y = scroll_y
+                scroll_y = min(
+                    scroll_y + pad_height, len(current_entries) - 1 - pad_height
+                )
+                scroll_y = max(0, scroll_y)
+                cursor_y += scroll_y - prev_scroll_y
+            elif k == curses.KEY_RIGHT:
+                if len(current_entries) > 0:
+                    entry = current_entries[cursor_y]
+                    if hasattr(entry, "stocks"):
+                        market = entry
+                        if len(market.stocks) == 0:
+                            stock_codes = self._entrypoint.GetCodeListByMarketAsList(
+                                market.code
+                            )
+                            stock_names = [
+                                self._entrypoint.GetMasterCodeName(code)
+                                for code in stock_codes
+                            ]
+                            stocks = [
+                                StockEntry(code, name)
+                                for code, name in zip(stock_codes, stock_names)
+                            ]
+                            market.stocks = stocks
+                        self._pad.clear()
+                        self._pad.refresh(0, 0, 1, 0, pad_height, pad_width - 1)
+                        self.show_entries(market.stocks)
+                        self._pad.clear()
+                        self._pad.refresh(0, 0, 1, 0, pad_height, pad_width - 1)
+                        k = 0
+                        continue
+            elif k in [curses.KEY_BACKSPACE, 8]:
+                if len(query) > 0:
+                    query = query[:-1]
+                    self.set_header_bar(query)
+                if len(query) > 0:
+                    if trie.has_key(query) or trie.has_subtrie(query):
+                        current_entries = trie.values(query)
+                else:
+                    current_entries = original_entries
+                self._pad.clear()
+                self._pad.refresh(0, 0, 1, 0, pad_height, pad_width - 1)
+                k = 0
+                continue
+            elif unicodedata.category(chr(k))[0] != "C":
+                query += chr(k)
+                self.set_header_bar(query)
+                if trie.has_key(query) or trie.has_subtrie(query):
+                    current_entries = trie.values(query)
+                else:
+                    current_entries = []
+                self._pad.clear()
+                self._pad.refresh(0, 0, 1, 0, pad_height, pad_width - 1)
+                k = 0
+                continue
+            cursor_y = min(len(current_entries) - 1, cursor_y)
+            cursor_y = max(0, cursor_y)
+            if k == curses.KEY_DOWN:
+                if cursor_y == (scroll_y + pad_height - 9):
+                    scroll_y = cursor_y - pad_height + 10
+                elif cursor_y > (scroll_y + pad_height - 2):
+                    scroll_y = cursor_y - pad_height + 1
+            elif k == curses.KEY_UP:
+                if cursor_y == scroll_y + 8:
+                    scroll_y = cursor_y - 9
+                elif cursor_y < scroll_y:
+                    scroll_y = cursor_y
+            scroll_y = min(len(current_entries) - 1, scroll_y)
+            scroll_y = max(0, scroll_y)
+            for i, market in enumerate(current_entries):
+                attr = 0
+                if i == cursor_y:
+                    attr = curses.A_UNDERLINE
+                self._pad.addstr(i, 0, market.to_string().ljust(pad_width - 1), attr)
+            self._pad.refresh(scroll_y, 0, 1, 0, pad_height, pad_width - 1)
+            k = self._screen.getch()
+
+
+[docs]def wrapper(stdscr):
+    screen = Screen(stdscr)
+    screen.show_entries(markets)
+
+
+[docs]def codelist_interactive():
+    curses.wrapper(wrapper)
+
+
+[docs]def main():
+    codelist_interactive()
+
+
+if __name__ == "__main__":
+    main()
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/cli/commands/get/stock_meta/stockcode.html b/_modules/koapy/cli/commands/get/stock_meta/stockcode.html new file mode 100644 index 00000000..a0711d58 --- /dev/null +++ b/_modules/koapy/cli/commands/get/stock_meta/stockcode.html @@ -0,0 +1,257 @@ + + + + + + + + koapy.cli.commands.get.stock_meta.stockcode — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.cli.commands.get.stock_meta.stockcode

+import click
+
+from koapy.cli.utils.verbose_option import verbose_option
+
+[docs]market_codes = [
+    "0",
+    "10",
+    "3",
+    "8",
+    "50",
+    "4",
+    "5",
+    "6",
+    "9",
+    "30",
+    "all",
+]
+
+
+@click.command(short_help="Get stock codes.")
+@click.option(
+    "-n",
+    "--name",
+    "names",
+    metavar="NAME",
+    multiple=True,
+    help="Name of stock. Can set multiple times.",
+)
+@click.option(
+    "-m",
+    "--market",
+    "markets",
+    metavar="MARKET",
+    multiple=True,
+    type=click.Choice(market_codes, case_sensitive=False),
+    help="Stock market code to get. Can set multiple times.",
+)
+@click.option(
+    "-p", "--port", metavar="PORT", help="Port number of grpc server (optional)."
+)
+@verbose_option()
+[docs]def stockcode(names, markets, port):
+    """
+    \b
+    Possible market codes are:
+      0 : 장내
+      10 : 코스닥
+      3 : ELW
+      8 : ETF
+      50 : KONEX
+      4 : 뮤추얼펀드
+      5 : 신주인수권
+      6 : 리츠
+      9 : 하이얼펀드
+      30 : K-OTC
+    """
+
+    markets_option = markets
+
+    from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusEntrypoint import (
+        KiwoomOpenApiPlusEntrypoint,
+    )
+
+    with KiwoomOpenApiPlusEntrypoint(port=port) as context:
+        context.EnsureConnected()
+
+        if not markets:
+            markets = ["0"]
+
+        codes = set()
+
+        for market in markets:
+            codes = codes.union(set(context.GetCodeListByMarketAsList(market)))
+
+        codes = sorted(list(codes))
+
+        if markets_option:
+            for code in codes:
+                click.echo(code)
+        else:
+
+            def get_names():
+                if names:
+                    if "-" in names:
+                        with click.open_file("-", "r") as f:
+                            for name in f:
+                                yield name.strip()
+                    else:
+                        for name in names:
+                            yield name
+                else:
+                    while True:
+                        try:
+                            name = click.prompt("name", prompt_suffix=" >>> ")
+                            name = name.strip()
+                            if name == "exit":
+                                break
+                            if name:
+                                yield name
+                        except EOFError:
+                            break
+
+            all_names = [context.GetMasterCodeName(code) for code in codes]
+            codes_by_name = dict(zip(all_names, codes))
+
+            for name in get_names():
+                code = codes_by_name.get(name, None)
+                if code:
+                    click.echo(code)
+                else:
+                    click.echo("Cannot find code for given name: %s." % name)
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/cli/commands/get/stock_meta/stockinfo.html b/_modules/koapy/cli/commands/get/stock_meta/stockinfo.html new file mode 100644 index 00000000..853d0b17 --- /dev/null +++ b/_modules/koapy/cli/commands/get/stock_meta/stockinfo.html @@ -0,0 +1,216 @@ + + + + + + + + koapy.cli.commands.get.stock_meta.stockinfo — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.cli.commands.get.stock_meta.stockinfo

+import click
+
+from koapy.cli.utils.fail_with_usage import fail_with_usage
+from koapy.cli.utils.verbose_option import verbose_option
+from koapy.config import default_encoding
+
+
+@click.command(short_help="Get basic information of stocks.")
+@click.option("-c", "--code", metavar="CODE", help="Stock code to get.")
+@click.option(
+    "-o",
+    "--output",
+    metavar="FILENAME",
+    type=click.Path(),
+    help="Output filename. Optional for single code (prints to console).",
+)
+@click.option(
+    "-f",
+    "--format",
+    type=click.Choice(["md", "xlsx", "json"], case_sensitive=False),
+    help="Output format. (default: md)",
+    default="md",
+    show_choices=True,
+)
+@click.option(
+    "-p", "--port", metavar="PORT", help="Port number of grpc server (optional)."
+)
+@verbose_option()
+[docs]def stockinfo(code, output, format, port):  # pylint: disable=redefined-builtin
+    if (code, output) == (None, None):
+        fail_with_usage()
+
+    if output is None:
+        if format is None:
+            format = "md"
+    else:
+        if format is None:
+            format = "xlsx"
+        if format == "xlsx":
+            if not output.endswith(".xlsx"):
+                output += ".xlsx"
+        elif format == "md":
+            if not output.endswith(".md"):
+                output += ".md"
+        elif format == "json":
+            if not output.endswith(".json"):
+                output += ".json"
+
+    import pandas as pd
+
+    from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusEntrypoint import (
+        KiwoomOpenApiPlusEntrypoint,
+    )
+
+    with KiwoomOpenApiPlusEntrypoint(port=port) as context:
+        context.EnsureConnected()
+        dic = context.GetStockBasicInfoAsDict(code)
+        series = pd.Series(dic)
+
+        if not output:
+            if format == "md":
+                click.echo(series.to_markdown())
+            elif format == "json":
+                click.echo(series.to_json())
+        else:
+            if format == "xlsx":
+                series.to_excel(output, header=False)
+            elif format == "json":
+                with open(output, "w", encoding=default_encoding) as f:
+                    click.echo(series.to_json(), file=f)
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/cli/commands/get/stock_meta/stockname.html b/_modules/koapy/cli/commands/get/stock_meta/stockname.html new file mode 100644 index 00000000..b9260705 --- /dev/null +++ b/_modules/koapy/cli/commands/get/stock_meta/stockname.html @@ -0,0 +1,196 @@ + + + + + + + + koapy.cli.commands.get.stock_meta.stockname — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.cli.commands.get.stock_meta.stockname

+import click
+
+from koapy.cli.utils.verbose_option import verbose_option
+
+
+@click.command(short_help="Get name for stock codes.")
+@click.option(
+    "-c",
+    "--code",
+    "codes",
+    metavar="CODE",
+    multiple=True,
+    help="Stock code to get. Can set multiple times.",
+)
+@click.option(
+    "-p", "--port", metavar="PORT", help="Port number of grpc server (optional)."
+)
+@verbose_option()
+[docs]def stockname(codes, port):
+    from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusEntrypoint import (
+        KiwoomOpenApiPlusEntrypoint,
+    )
+
+    with KiwoomOpenApiPlusEntrypoint(port=port) as context:
+        context.EnsureConnected()
+
+        def get_codes():
+            if codes:
+                if "-" in codes:
+                    with click.open_file("-", "r") as f:
+                        for code in f:
+                            yield code.strip()
+                else:
+                    for code in codes:
+                        yield code
+            else:
+                while True:
+                    try:
+                        code = click.prompt("code", prompt_suffix=" >>> ")
+                        code = code.strip()
+                        if code == "exit":
+                            break
+                        if code:
+                            yield code
+                    except EOFError:
+                        break
+
+        for code in get_codes():
+            name = context.GetMasterCodeName(code)
+            click.echo(name)
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/cli/commands/install.html b/_modules/koapy/cli/commands/install.html new file mode 100644 index 00000000..c6a30103 --- /dev/null +++ b/_modules/koapy/cli/commands/install.html @@ -0,0 +1,157 @@ + + + + + + + + koapy.cli.commands.install — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.cli.commands.install

+import click
+
+from .openapi import openapi
+from .pywin32 import pywin32
+
+
+@click.group(short_help="Install openapi module and others.")
+[docs]def install():
+    pass
+
+
+install.add_command(openapi)
+install.add_command(pywin32)
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/cli/commands/install/openapi.html b/_modules/koapy/cli/commands/install/openapi.html new file mode 100644 index 00000000..a3deb50e --- /dev/null +++ b/_modules/koapy/cli/commands/install/openapi.html @@ -0,0 +1,210 @@ + + + + + + + + koapy.cli.commands.install.openapi — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.cli.commands.install.openapi

+import contextlib
+import os
+import shutil
+import subprocess
+import tempfile
+
+import click
+
+from koapy.cli.utils.openapi import (
+    download_openapi_installer,
+    prepare_issfile_for_install,
+    run_installer_with_issfile,
+)
+from koapy.cli.utils.verbose_option import verbose_option
+from koapy.utils.logging import get_logger
+
+[docs]logger = get_logger(__name__)
+
+
+@click.command(short_help="Install openapi module.")
+@click.option(
+    "-t",
+    "--target",
+    metavar="TARGET",
+    type=click.Path(),
+    default="C:\\",
+    help='Target directory for installation. Will create "OpenAPI" folder under this directory for install. (default: "C:\\")',
+)
+@click.option(
+    "--cleanup/--no-cleanup",
+    default=True,
+    help="Clean up temporary directory after install. (default: true)",
+)
+@verbose_option(default=5, show_default=True)
+[docs]def openapi(target, cleanup):
+    with contextlib.ExitStack() as stack:
+        tempdir = tempfile.mkdtemp()
+        logger.info("Created temporary directory: %s", tempdir)
+        if cleanup:
+            stack.callback(shutil.rmtree, tempdir)
+            logger.info("Registered to remove the temporary directory after install.")
+        installer_filename = "OpenAPISetup.exe"
+        installer_filepath = os.path.join(tempdir, installer_filename)
+        logger.info("Downloading installer: %s", installer_filepath)
+        download_openapi_installer(installer_filepath)
+        iss_filename = "setup.iss"
+        iss_filepath = os.path.join(tempdir, iss_filename)
+        logger.info("Preparing .iss file: %s", iss_filepath)
+        prepare_issfile_for_install(iss_filepath, target)
+        log_filename = "setup.log"
+        log_filepath = os.path.join(tempdir, log_filename)
+        try:
+            _return_code = run_installer_with_issfile(
+                installer_filepath, iss_filepath, log_filepath, cwd=tempdir
+            )
+        except subprocess.CalledProcessError as e:
+            logger.exception(
+                "Failed to install openapi with return code: %d", e.returncode
+            )
+            raise RuntimeError(
+                "Failed to install openapi with return code: %d" % e.returncode
+            ) from e
+        else:
+            logger.info("Succesfully installed openapi.")
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/cli/commands/install/pywin32.html b/_modules/koapy/cli/commands/install/pywin32.html new file mode 100644 index 00000000..e914deb6 --- /dev/null +++ b/_modules/koapy/cli/commands/install/pywin32.html @@ -0,0 +1,157 @@ + + + + + + + + koapy.cli.commands.install.pywin32 — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.cli.commands.install.pywin32

+import click
+
+from koapy.cli.utils.pywin32 import install_pywin32
+from koapy.cli.utils.verbose_option import verbose_option
+
+
+@click.command(short_help="Install pywin32 and run post install script.")
+@click.option("--version", metavar="VERSION", help="Version of pywin32 to install.")
+@verbose_option(default=5, show_default=True)
+[docs]def pywin32(version):
+    install_pywin32(version)
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/cli/commands/serve.html b/_modules/koapy/cli/commands/serve.html new file mode 100644 index 00000000..f8a97852 --- /dev/null +++ b/_modules/koapy/cli/commands/serve.html @@ -0,0 +1,185 @@ + + + + + + + + koapy.cli.commands.serve — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.cli.commands.serve

+import sys
+
+import click
+
+from koapy.cli.utils.grpc_options import grpc_server_and_client_options
+from koapy.cli.utils.verbose_option import full_verbose_option
+
+
+@click.command(
+    context_settings=dict(
+        ignore_unknown_options=True,
+    ),
+    short_help="Start grpc server with tray application.",
+)
+@click.pass_context
+@grpc_server_and_client_options()
+@full_verbose_option()
+@click.argument("args", nargs=-1, type=click.UNPROCESSED)
+[docs]def serve(
+    ctx,
+    verbose,
+    **kwargs,
+):
+    # reconstruct args so that only the first argument is program
+    # and others are real arguments
+    context_depth = 0
+    c = ctx
+    while c is not None:
+        context_depth += 1
+        c = c.parent
+    args = sys.argv[:1] + sys.argv[context_depth:]
+
+    # force verbosity of created applications to follow the cli option
+    args.append("--verbose={}".format(verbose))
+
+    # call main function of manager application with the prepared args
+    from koapy.backend.kiwoom_open_api_plus.pyside2.KiwoomOpenApiPlusManagerApplication import (
+        KiwoomOpenApiPlusManagerApplication,
+    )
+
+    KiwoomOpenApiPlusManagerApplication.main(args)
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/cli/commands/show.html b/_modules/koapy/cli/commands/show.html new file mode 100644 index 00000000..3d5a6311 --- /dev/null +++ b/_modules/koapy/cli/commands/show.html @@ -0,0 +1,155 @@ + + + + + + + + koapy.cli.commands.show — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.cli.commands.show

+import click
+
+from .account_window import account_window
+
+
+@click.group(short_help="Show some configuration windows.")
+[docs]def show():
+    pass
+
+
+show.add_command(account_window)
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/cli/commands/show/account_window.html b/_modules/koapy/cli/commands/show/account_window.html new file mode 100644 index 00000000..8aea429b --- /dev/null +++ b/_modules/koapy/cli/commands/show/account_window.html @@ -0,0 +1,164 @@ + + + + + + + + koapy.cli.commands.show.account_window — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.cli.commands.show.account_window

+import click
+
+from koapy.cli.utils.verbose_option import verbose_option
+
+
+@click.command(short_help="Show configuration window for auto login.")
+@click.option(
+    "-p", "--port", metavar="PORT", help="Port number of grpc server (optional)."
+)
+@verbose_option()
+[docs]def account_window(port):
+    from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusEntrypoint import (
+        KiwoomOpenApiPlusEntrypoint,
+    )
+
+    with KiwoomOpenApiPlusEntrypoint(port=port) as context:
+        context.EnsureConnected()
+        context.ShowAccountWindow()
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/cli/commands/uninstall.html b/_modules/koapy/cli/commands/uninstall.html new file mode 100644 index 00000000..000c9b8a --- /dev/null +++ b/_modules/koapy/cli/commands/uninstall.html @@ -0,0 +1,157 @@ + + + + + + + + koapy.cli.commands.uninstall — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.cli.commands.uninstall

+import click
+
+from .openapi import openapi
+from .pywin32 import pywin32
+
+
+@click.group(short_help="Uninstall openapi module and others.")
+[docs]def uninstall():
+    pass
+
+
+uninstall.add_command(openapi)
+uninstall.add_command(pywin32)
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/cli/commands/uninstall/openapi.html b/_modules/koapy/cli/commands/uninstall/openapi.html new file mode 100644 index 00000000..e705e446 --- /dev/null +++ b/_modules/koapy/cli/commands/uninstall/openapi.html @@ -0,0 +1,207 @@ + + + + + + + + koapy.cli.commands.uninstall.openapi — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.cli.commands.uninstall.openapi

+import contextlib
+import os
+import shutil
+import subprocess
+import tempfile
+
+import click
+
+from koapy.cli.utils.openapi import (
+    download_openapi_installer,
+    prepare_issfile_for_uninstall,
+    run_installer_with_issfile,
+)
+from koapy.cli.utils.verbose_option import verbose_option
+from koapy.utils.logging import get_logger
+
+[docs]logger = get_logger(__name__)
+
+
+@click.command(short_help="Uninstall openapi module.")
+@click.option(
+    "--reboot/--no-reboot",
+    default=False,
+    help="Reboot after uninstall. (default: false)",
+)
+@click.option(
+    "--cleanup/--no-cleanup",
+    default=True,
+    help="Clean up temporary directory after uninstall. (default: true)",
+)
+@verbose_option(default=5, show_default=True)
+[docs]def openapi(reboot, cleanup):
+    with contextlib.ExitStack() as stack:
+        tempdir = tempfile.mkdtemp()
+        logger.info("Created temporary directory: %s", tempdir)
+        if cleanup:
+            stack.callback(shutil.rmtree, tempdir)
+            logger.info("Registered to remove the temporary directory after uninstall.")
+        installer_filename = "OpenAPISetup.exe"
+        installer_filepath = os.path.join(tempdir, installer_filename)
+        logger.info("Downloading installer: %s", installer_filepath)
+        download_openapi_installer(installer_filepath)
+        iss_filename = "setup.iss"
+        iss_filepath = os.path.join(tempdir, iss_filename)
+        logger.info("Preparing .iss file: %s", iss_filepath)
+        prepare_issfile_for_uninstall(iss_filepath, reboot)
+        log_filename = "setup.log"
+        log_filepath = os.path.join(tempdir, log_filename)
+        try:
+            _return_code = run_installer_with_issfile(
+                installer_filepath, iss_filepath, log_filepath, cwd=tempdir
+            )
+        except subprocess.CalledProcessError as e:
+            logger.exception(
+                "Failed to uninstall openapi with return code: %d", e.returncode
+            )
+            raise RuntimeError(
+                "Failed to uninstall openapi with return code: %d" % e.returncode
+            ) from e
+        else:
+            logger.info("Succesfully uninstalled openapi.")
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/cli/commands/uninstall/pywin32.html b/_modules/koapy/cli/commands/uninstall/pywin32.html new file mode 100644 index 00000000..59ec2c32 --- /dev/null +++ b/_modules/koapy/cli/commands/uninstall/pywin32.html @@ -0,0 +1,156 @@ + + + + + + + + koapy.cli.commands.uninstall.pywin32 — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.cli.commands.uninstall.pywin32

+import click
+
+from koapy.cli.utils.pywin32 import uninstall_pywin32
+from koapy.cli.utils.verbose_option import verbose_option
+
+
+@click.command(short_help="Uninstall pywin32 and run post uninstall script.")
+@verbose_option(default=5, show_default=True)
+[docs]def pywin32():
+    uninstall_pywin32()
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/cli/commands/update.html b/_modules/koapy/cli/commands/update.html new file mode 100644 index 00000000..77fdfa95 --- /dev/null +++ b/_modules/koapy/cli/commands/update.html @@ -0,0 +1,197 @@ + + + + + + + + koapy.cli.commands.update — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.cli.commands.update

+import click
+
+from koapy.cli.utils.credentials import get_credentials
+from koapy.cli.utils.verbose_option import verbose_option
+
+
+@click.group(short_help="Update openapi module and metadata.")
+[docs]def update():
+    pass
+
+
+@update.command(short_help="Update openapi TR metadata.")
+@verbose_option()
+[docs]def trinfo():
+    from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusTrInfo import (
+        KiwoomOpenApiPlusTrInfo,
+    )
+
+    KiwoomOpenApiPlusTrInfo.dump_trinfo_by_code()
+
+
+@update.command(short_help="Update openapi realtype metadata.")
+@verbose_option()
+[docs]def realtype():
+    from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusRealType import (
+        KiwoomOpenApiPlusRealType,
+    )
+
+    KiwoomOpenApiPlusRealType.dump_realtype_by_desc()
+
+
+@update.command(short_help="Update openapi module version.")
+@click.option(
+    "-i", "--interactive", is_flag=True, help="Put login information with prompts."
+)
+@verbose_option(default=5, show_default=True)
+[docs]def openapi(interactive):
+    from koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusVersionUpdater import (
+        KiwoomOpenApiPlusVersionUpdater,
+    )
+
+    credentials = get_credentials(interactive)
+    updater = KiwoomOpenApiPlusVersionUpdater(credentials)
+    updater.update_version_if_necessary()
+
+
+@update.command(short_help="Update gRPC stub files by compiling proto files.")
+[docs]def proto():
+    from koapy.backend.kiwoom_open_api_plus.grpc.tools.compile_proto import (
+        compile_proto,
+    )
+
+    compile_proto()
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/cli/extensions/functools.html b/_modules/koapy/cli/extensions/functools.html new file mode 100644 index 00000000..b4d82164 --- /dev/null +++ b/_modules/koapy/cli/extensions/functools.html @@ -0,0 +1,155 @@ + + + + + + + + koapy.cli.extensions.functools — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.cli.extensions.functools

+from functools import update_wrapper
+
+
+[docs]def update_wrapper_with_click_params(wrapper, wrapped, *args, **kwargs):
+    click_params_wrapper = getattr(wrapper, "__click_params__", [])
+    click_params_wrapped = getattr(wrapped, "__click_params__", [])
+    click_params = click_params_wrapped + click_params_wrapper
+    wrapper.__click_params__ = click_params
+    wrapped.__click_params__ = click_params
+    updated_wrapper = update_wrapper(wrapper, wrapped, *args, **kwargs)
+    return updated_wrapper
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/cli/extensions/parser.html b/_modules/koapy/cli/extensions/parser.html new file mode 100644 index 00000000..2b7dc0c9 --- /dev/null +++ b/_modules/koapy/cli/extensions/parser.html @@ -0,0 +1,284 @@ + + + + + + + + koapy.cli.extensions.parser — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.cli.extensions.parser

+import sys
+
+from argparse import Namespace
+from typing import Any, Callable, List, Optional, Sequence, Tuple, TypeVar, Union
+
+import click
+
+from click import Command
+
+[docs]Function = TypeVar("Function", bound=Callable[..., Any])
+[docs]FunctionOrCommand = TypeVar(
+    "FunctionOrCommand", bound=Union[Callable[..., Any], Command]
+)
+
+[docs]ArgumentDecorator = Callable[[FunctionOrCommand], FunctionOrCommand]
+[docs]CommandDecorator = Callable[[Function], Command]
+
+
+[docs]class ArgumentParser:
+[docs]    def parse_args(
+        self,
+        args: Optional[Sequence[str]] = None,
+        namespace: Optional[Namespace] = None,
+    ) -> Namespace:
+        raise NotImplementedError
+
+[docs]    def parse_known_args(
+        self,
+        args: Optional[Sequence[str]] = None,
+        namespace: Optional[Namespace] = None,
+    ) -> Tuple[Namespace, List[str]]:
+        raise NotImplementedError
+
+
+[docs]class ClickArgumentParser(ArgumentParser):
+
+    _unrecognized_args_attr = "args"
+
+    def __init__(
+        self,
+        params: Sequence[ArgumentDecorator],
+        command: Optional[CommandDecorator] = None,
+        help_option_names: Optional[Sequence[str]] = None,
+    ):
+        if help_option_names is None:
+            help_option_names = ["-h", "--help"]
+
+        if command is None:
+            command = click.command(
+                context_settings=dict(help_option_names=help_option_names)
+            )
+
+        self._params = params
+        self._command = command
+        self._help_option_names = help_option_names
+
+    def _callback(self, *args, **kwargs):
+        return args, kwargs
+
+    def _parse_args(
+        self,
+        args: Optional[Sequence[str]] = None,
+        namespace: Optional[Namespace] = None,
+        ignore_unknown_options: bool = False,
+        allow_extra_args: bool = False,
+        allow_interspersed_args: bool = True,
+    ) -> Tuple[Namespace, List[str]]:
+
+        if args is None:
+            args = sys.argv[1:]
+        else:
+            args = list(args)
+
+        if namespace is None:
+            namespace = Namespace()
+
+        def callback(*args, **kwargs):
+            return self._callback(*args, **kwargs)
+
+        if ignore_unknown_options:
+            unrecognized_args_param = click.argument(
+                self._unrecognized_args_attr,
+                nargs=-1,
+                type=click.UNPROCESSED,
+                metavar="[ARGS]...",
+            )
+            callback = unrecognized_args_param(callback)
+
+        for decorator in reversed(self._params):
+            callback = decorator(callback)
+
+        command = self._command(callback)
+        context_settings = dict(
+            help_option_names=self._help_option_names,
+            ignore_unknown_options=ignore_unknown_options,
+            allow_extra_args=allow_extra_args,
+            allow_interspersed_args=allow_interspersed_args,
+        )
+        command.context_settings.update(context_settings)
+
+        ret = command.main(args, standalone_mode=False)
+
+        if isinstance(ret, int):
+            sys.exit(ret)
+
+        callback_args, callback_kwargs = ret
+
+        assert len(callback_args) == 0
+
+        for key, value in callback_kwargs.items():
+            setattr(namespace, key, value)
+
+        unrecognized_args = []
+
+        if hasattr(namespace, self._unrecognized_args_attr):
+            unrecognized_args = getattr(namespace, self._unrecognized_args_attr)
+            unrecognized_args = list(unrecognized_args)
+            delattr(namespace, self._unrecognized_args_attr)
+
+        return namespace, unrecognized_args
+
+[docs]    def parse_args(
+        self,
+        args: Optional[Sequence[str]] = None,
+        namespace: Optional[Namespace] = None,
+    ) -> Namespace:
+        namespace, _unrecognized_args = self._parse_args(args, namespace)
+        return namespace
+
+[docs]    def parse_known_args(
+        self,
+        args: Optional[Sequence[str]] = None,
+        namespace: Optional[Namespace] = None,
+    ) -> Tuple[Namespace, List[str]]:
+        namespace, unrecognized_args = self._parse_args(
+            args,
+            namespace,
+            ignore_unknown_options=True,
+        )
+        return namespace, unrecognized_args
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/cli/extensions/verbose_option.html b/_modules/koapy/cli/extensions/verbose_option.html new file mode 100644 index 00000000..583bfe42 --- /dev/null +++ b/_modules/koapy/cli/extensions/verbose_option.html @@ -0,0 +1,276 @@ + + + + + + + + koapy.cli.extensions.verbose_option — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.cli.extensions.verbose_option

+import click
+
+from click.parser import normalize_opt
+
+from koapy.cli.extensions.functools import update_wrapper_with_click_params
+
+
+[docs]class VerboseOption(click.Option):
+    def __init__(self, *decls, **attrs):
+        self._flag_value = attrs.pop("flag_value", None)
+        super().__init__(*decls, **attrs)
+        self._parser = None
+        self._parser__match_long_opt = None
+        self._parser__match_short_opt = None
+        self._parser__get_value_from_state = None
+
+    def _match_long_opt(self, opt, explicit_value, state):
+        # pylint: disable=protected-access
+        if opt in self.opts and opt in self._parser._long_opt:
+            option = self._parser._long_opt[opt]
+            option.action = "store"
+        self._parser__match_long_opt(opt, explicit_value, state)
+
+    def _match_short_opt(self, arg, state):
+        # pylint: disable=protected-access
+        prefix = arg[0]
+        for ch in arg[1:]:
+            opt = normalize_opt(f"{prefix}{ch}", self._parser.ctx)
+            if opt in self.opts and opt in self._parser._short_opt:
+                option = self._parser._short_opt[opt]
+                option.action = "count"
+        self._parser__match_short_opt(arg, state)
+
+    def _get_value_from_state(self, option_name, option, state):
+        # pylint: disable=protected-access
+        try:
+            value = self._parser__get_value_from_state(option_name, option, state)
+        except click.BadOptionUsage:
+            value = self._flag_value
+        else:
+            if option_name in self.opts:
+                if (
+                    isinstance(value, str)
+                    and value[:1] in self._parser._opt_prefixes
+                    and len(value) > 1
+                ):
+                    state.rargs.insert(0, value)
+                    value = self._flag_value
+        return value
+
+    def _patch_parser(self, parser):
+        # pylint: disable=protected-access
+        self._parser = parser
+        self._parser__match_short_opt = self._parser._match_short_opt
+        self._parser._match_short_opt = self._match_short_opt
+        self._parser__match_long_opt = self._parser._match_long_opt
+        self._parser._match_long_opt = self._match_long_opt
+        self._parser__get_value_from_state = self._parser._get_value_from_state
+        self._parser._get_value_from_state = self._get_value_from_state
+
+[docs]    def add_to_parser(self, parser, ctx):
+        self._patch_parser(parser)
+        super().add_to_parser(parser, ctx)
+
+
+[docs]def verbose_flag_option(
+    default=0,
+    flag_value=1,
+    show_default=False,
+    metavar="[0...5]",
+    help="Set verbosity level.",
+):
+    # pylint: disable=redefined-builtin
+    return click.option(
+        "-v",
+        "--verbose",
+        type=int,
+        default=default,
+        flag_value=flag_value,
+        show_default=show_default,
+        metavar=metavar,
+        help=help,
+        cls=VerboseOption,
+    )
+
+
+[docs]def no_verbose_flag_option(
+    help="Force zero verbosity.",
+):
+    # pylint: disable=redefined-builtin
+    return click.option(
+        "-s",
+        "--no-verbose",
+        "--slient",
+        is_flag=True,
+        default=False,
+        help=help,
+    )
+
+
+[docs]def verbose_option(
+    dest="verbose",
+    default=0,
+    flag_value=1,
+    callback=None,
+    expose_value=False,
+    show_default=False,
+):
+    def decorator(f):
+        @click.pass_context
+        @verbose_flag_option(
+            default=default,
+            flag_value=flag_value,
+            show_default=show_default,
+        )
+        @no_verbose_flag_option()
+        def new_func(ctx, *args, **kwargs):
+            verbose = kwargs.pop("verbose")
+            no_verbose = kwargs.pop("no_verbose")
+            if no_verbose:
+                verbose = 0
+            if expose_value:
+                kwargs[dest] = verbose
+            if callable(callback):
+                param = ctx.params.get("verbose")
+                value = verbose
+                callback(ctx, param, value)
+            return ctx.invoke(f, *args, **kwargs)
+
+        return update_wrapper_with_click_params(new_func, f)
+
+    return decorator
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/cli/utils/credentials.html b/_modules/koapy/cli/utils/credentials.html new file mode 100644 index 00000000..72a2eb5d --- /dev/null +++ b/_modules/koapy/cli/utils/credentials.html @@ -0,0 +1,250 @@ + + + + + + + + koapy.cli.utils.credentials — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.cli.utils.credentials

+import os
+
+import click
+
+from koapy.config import (
+    config,
+    config_from_dict,
+    default_user_config_filepath,
+    save_config,
+    user_config,
+)
+
+
+[docs]def prompt_credentials():
+    credentials = config.get("koapy.backend.kiwoom_open_api_plus.credentials")
+
+    default_user_id = credentials["user_id"]
+    default_user_password = credentials["user_password"]
+    default_server = "simulation" if credentials["is_simulation"] else "real"
+    default_cert_password = credentials["cert_password"]
+
+    user_id = click.prompt("User ID", default=default_user_id)
+    user_password = click.prompt(
+        "User Password",
+        hide_input=True,
+        default=default_user_password,
+        show_default=False,
+    )
+    is_simulation = (
+        click.prompt(
+            "Server Type",
+            type=click.Choice(["real", "simulation"], case_sensitive=False),
+            default=default_server,
+        )
+        == "simulation"
+    )
+    if is_simulation:
+        cert_password = default_cert_password
+    else:
+        cert_password = click.prompt(
+            "Cert Password",
+            hide_input=True,
+            default=default_cert_password,
+            show_default=False,
+        )
+    account_count = click.prompt("Account Count", type=int, default=1)
+    account_passwords = {}
+    for _ in range(account_count):
+        account_number = click.prompt("Account Number", default="0000000000")
+        account_password = click.prompt(
+            "Account Password",
+            hide_input=True,
+            default="0000",
+            show_default=False,
+        )
+        account_passwords[account_number] = account_password
+
+    credentials = {
+        "user_id": user_id,
+        "user_password": user_password,
+        "cert_password": cert_password,
+        "is_simulation": is_simulation,
+        "account_passwords": account_passwords,
+    }
+    credentials = config_from_dict(credentials)
+
+    return credentials
+
+
+[docs]def get_credentials(interactive=False):
+    if not interactive:
+        credentials = config.get("koapy.backend.kiwoom_open_api_plus.credentials")
+    else:
+        credentials = prompt_credentials()
+        save_credentials = (
+            click.prompt(
+                "Save credentials info into a config file?",
+                type=click.Choice(["y", "n"], case_sensitive=False),
+                default="n",
+            )
+            == "y"
+        )
+        if save_credentials:
+            config_path = click.prompt(
+                "Path to save config file", default=default_user_config_filepath
+            )
+
+            if os.path.exists(config_path):
+                should_write = (
+                    click.prompt(
+                        "The file already exists, overwrite?",
+                        type=click.Choice(["y", "n"], case_sensitive=False),
+                        default="n",
+                    )
+                    == "y"
+                )
+            else:
+                should_write = True
+
+            if should_write:
+                user_config.put(
+                    "koapy.backend.kiwoom_open_api_plus.credentials", credentials
+                )
+                save_config(config_path, user_config)
+
+    return credentials
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/cli/utils/fail_with_usage.html b/_modules/koapy/cli/utils/fail_with_usage.html new file mode 100644 index 00000000..bbdb4f0e --- /dev/null +++ b/_modules/koapy/cli/utils/fail_with_usage.html @@ -0,0 +1,171 @@ + + + + + + + + koapy.cli.utils.fail_with_usage — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.cli.utils.fail_with_usage

+import click
+
+
+[docs]def get_help(ctx):
+    return ctx.get_help()
+
+
+[docs]def get_help_without_usage(ctx):
+    formatter = ctx.make_formatter()
+    command = ctx.command
+    command.format_help_text(ctx, formatter)
+    command.format_options(ctx, formatter)
+    command.format_epilog(ctx, formatter)
+    help_without_usage = formatter.getvalue().rstrip("\n")
+    return help_without_usage
+
+
+[docs]def fail_with_usage(message=None, ctx=None):
+    if ctx is None:
+        ctx = click.get_current_context()
+    if message is not None:
+        click.UsageError(message, ctx).show()
+        click.echo()
+        click.echo(get_help_without_usage(ctx))
+    else:
+        click.echo(get_help(ctx))
+    ctx.exit(click.UsageError.exit_code)
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/cli/utils/grpc_options.html b/_modules/koapy/cli/utils/grpc_options.html new file mode 100644 index 00000000..9cb80d68 --- /dev/null +++ b/_modules/koapy/cli/utils/grpc_options.html @@ -0,0 +1,528 @@ + + + + + + + + koapy.cli.utils.grpc_options — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.cli.utils.grpc_options

+import click
+
+from koapy.cli.extensions.functools import update_wrapper_with_click_params
+from koapy.cli.extensions.parser import ClickArgumentParser
+from koapy.cli.utils.verbose_option import full_verbose_option
+from koapy.config import config
+
+# grpc configs for default values
+[docs]grpc_config = config.get("koapy.backend.kiwoom_open_api_plus.grpc")
+
+[docs]default_server_bind_address = (
+    grpc_config.get("server.bind_address")
+    or grpc_config.get("server.host")
+    or grpc_config.get("host")
+)
+[docs]default_server_host = default_server_bind_address
+[docs]default_server_port = grpc_config.get("server.port") or grpc_config.get("port")
+
+[docs]default_client_host = grpc_config.get("client.host") or grpc_config.get("host")
+[docs]default_client_port = grpc_config.get("client.port") or grpc_config.get("port")
+
+[docs]default_common_host = grpc_config.get("host") or grpc_config.get("client.host")
+[docs]default_common_port = (
+    grpc_config.get("port")
+    or grpc_config.get("server.port")
+    or grpc_config.get("client.port")
+)
+
+
+# server specific options
+[docs]server_bind_address_option = click.option(
+    "--bind-address",
+    "--host",
+    metavar="ADDRESS",
+    help="Host address of gRPC server to bind.",
+    default=default_server_bind_address,
+    show_default=True,
+)
+[docs]server_port_option = click.option(
+    "--port",
+    metavar="PORT",
+    type=int,
+    help="Port number of gRPC server to bind.",
+    default=default_server_port,
+    show_default=True,
+)
+[docs]server_key_file_option = click.option(
+    "--key-file",
+    type=click.Path(),
+    help="PEM encoded private key file for server SSL/TLS.",
+)
+[docs]server_cert_file_option = click.option(
+    "--cert-file",
+    type=click.Path(),
+    help="PEM encoded certificate chain file for server SSL/TLS.",
+)
+[docs]server_root_certs_file_option = click.option(
+    "--root-certs-file",
+    type=click.Path(),
+    help="""
+    PEM encoded client root certificates file for client authentication.
+    Assumes --require-client-auth flag is set if this option is given,
+    unless --no-require-client-auth flag is set explicitly.
+    """,
+)
+[docs]server_require_client_auth_option = click.option(
+    "--require-client-auth",
+    help="Require clients to be authenticated, root certificates are required.",
+    is_flag=True,
+)
+[docs]server_no_require_client_auth_option = click.option(
+    "--no-require-client-auth",
+    help="Force not to require clients to be authenticated, even if root certificates are given.",
+    is_flag=True,
+)
+
+[docs]server_options = [
+    server_bind_address_option,
+    server_port_option,
+    server_key_file_option,
+    server_cert_file_option,
+    server_root_certs_file_option,
+    server_require_client_auth_option,
+    server_no_require_client_auth_option,
+]
+
+
+# client specific options
+[docs]client_host_option = click.option(
+    "--host",
+    metavar="ADDRESS",
+    help="Host address of gRPC server to connect.",
+    default=default_client_host,
+    show_default=True,
+)
+[docs]client_port_option = click.option(
+    "--port",
+    metavar="PORT",
+    type=int,
+    help="Port number of gRPC server to connect.",
+    default=default_client_port,
+    show_default=True,
+)
+[docs]client_enable_ssl_option = click.option(
+    "--enable-ssl",
+    help="""
+    Enable SSL/TLS for gRPC connection.
+    If --root-certs-file option is not given,
+    will retrieve them from a default location chosen by gRPC runtime.
+    """,
+    is_flag=True,
+)
+[docs]client_root_certs_file_option = click.option(
+    "--root-certs-file",
+    type=click.Path(),
+    help="PEM encoded root certificates file for SSL/TLS.",
+)
+[docs]client_key_file_option = click.option(
+    "--key-file",
+    type=click.Path(),
+    help="PEM encoded private key file for client authentication.",
+)
+[docs]client_cert_file_option = click.option(
+    "--cert-file",
+    type=click.Path(),
+    help="PEM encoded certificate chain file for client authentication.",
+)
+
+[docs]client_options = [
+    client_host_option,
+    client_port_option,
+    client_enable_ssl_option,
+    client_root_certs_file_option,
+    client_key_file_option,
+    client_cert_file_option,
+]
+
+
+# server and client options (resolving option conflicts)
+[docs]server_and_client_bind_address_option = click.option(
+    "--bind-address",
+    "--server-host",
+    metavar="ADDRESS",
+    help="Host address of gRPC server to bind.",
+    default=default_server_bind_address,
+    show_default=True,
+)
+[docs]server_and_client_host_option = click.option(
+    "--host",
+    "--client-host",
+    metavar="ADDRESS",
+    help="Host address of gRPC server to connect.",
+    default=default_client_host,
+    show_default=True,
+)
+[docs]server_and_client_port_option = click.option(
+    "--port",
+    metavar="PORT",
+    type=int,
+    help="Port number of gRPC server to bind and connect.",
+    default=default_common_port,
+    show_default=True,
+)
+[docs]server_and_client_enable_ssl_option = click.option(
+    "--enable-ssl",
+    help="""
+    Enable SSL/TLS for gRPC connection.
+    If --client-root-certs-file option is not given,
+    will retrieve them from a default location chosen by gRPC runtime.
+    """,
+    is_flag=True,
+    show_default=True,
+)
+[docs]server_and_client_server_key_file_option = click.option(
+    "--server-key-file",
+    type=click.Path(),
+    help="PEM encoded private key file for server SSL/TLS.",
+)
+[docs]server_and_client_server_cert_file_option = click.option(
+    "--server-cert-file",
+    type=click.Path(),
+    help="PEM encoded certificate chain file for server SSL/TLS.",
+)
+[docs]server_and_client_server_root_certs_file_option = click.option(
+    "--server-root-certs-file",
+    type=click.Path(),
+    help="""
+    PEM encoded client root certificates file for client authentication.
+    Assumes --require-client-auth flag is set if this option is given,
+    unless --no-require-client-auth flag is set explicitly.
+    """,
+)
+[docs]server_and_client_require_client_auth_option = click.option(
+    "--require-client-auth",
+    help="Require clients to be authenticated, root certificates are required.",
+    is_flag=True,
+)
+[docs]server_and_client_no_require_client_auth_option = click.option(
+    "--no-require-client-auth",
+    help="Foce not to require clients to be authenticated, even if root certificates are given.",
+    is_flag=True,
+)
+[docs]server_and_client_client_root_certs_file_option = click.option(
+    "--client-root-certs-file",
+    type=click.Path(),
+    help="PEM encoded root certificates file for SSL/TLS.",
+)
+[docs]server_and_client_client_key_file_option = click.option(
+    "--client-key-file",
+    type=click.Path(),
+    help="PEM encoded private key file for client authentication.",
+)
+[docs]server_and_client_client_cert_file_option = click.option(
+    "--client-cert-file",
+    type=click.Path(),
+    help="PEM encoded certificate chain file for client authentication.",
+)
+
+[docs]server_and_client_options = [
+    server_and_client_bind_address_option,
+    server_and_client_host_option,
+    server_and_client_port_option,
+    server_and_client_enable_ssl_option,
+    server_and_client_server_key_file_option,
+    server_and_client_server_cert_file_option,
+    server_and_client_server_root_certs_file_option,
+    server_and_client_require_client_auth_option,
+    server_and_client_no_require_client_auth_option,
+    server_and_client_client_root_certs_file_option,
+    server_and_client_client_key_file_option,
+    server_and_client_client_cert_file_option,
+]
+
+
+[docs]def grpc_server_options():
+    def decorator(f):
+        @click.pass_context
+        @server_bind_address_option
+        @server_port_option
+        @server_key_file_option
+        @server_cert_file_option
+        @server_root_certs_file_option
+        @server_require_client_auth_option
+        @server_no_require_client_auth_option
+        def new_func(ctx: click.Context, *args, **kwargs):
+            key_file = kwargs.get("key_file")
+            cert_file = kwargs.get("cert_file")
+            root_certs_file = kwargs.get("root_certs_file")
+            require_client_auth = kwargs.get("require_client_auth")
+            no_require_client_auth = kwargs.pop("no_require_client_auth")
+
+            # both --key-file and --cert-file should be given
+            if bool(key_file) != bool(cert_file):
+                ctx.fail("both --key-file and --cert-file should be given.")
+
+            # assume --require-client-auth flag is set if --root-certs-file is given
+            if root_certs_file is not None:
+                require_client_auth = True
+                kwargs["require_client_auth"] = require_client_auth
+
+            # value of --require-client-auth flag should be false if --no-require-client-auth flag is set
+            if no_require_client_auth:
+                require_client_auth = False
+                kwargs["require_client_auth"] = require_client_auth
+
+            # --require-client-auth flag is set but no --root-certs-file was given
+            if require_client_auth and root_certs_file is None:
+                ctx.fail(
+                    "--require-client-auth flag is set but no --root-certs-file was  given."
+                )
+
+            return ctx.invoke(f, *args, **kwargs)
+
+        return update_wrapper_with_click_params(new_func, f)
+
+    return decorator
+
+
+[docs]def grpc_client_options():
+    def decorator(f):
+        @click.pass_context
+        @client_host_option
+        @client_port_option
+        @client_enable_ssl_option
+        @client_root_certs_file_option
+        @client_key_file_option
+        @client_cert_file_option
+        def new_func(ctx: click.Context, *args, **kwargs):
+            enable_ssl = kwargs.get("enable_ssl")
+            root_certs_file = kwargs.get("root_certs_file")
+            key_file = kwargs.get("key_file")
+            cert_file = kwargs.get("cert_file")
+
+            # assume --enable-ssl flag is set if --root-certs-file is given
+            if root_certs_file is not None:
+                enable_ssl = True
+                kwargs["enable_ssl"] = enable_ssl
+
+            # both --key-file and --cert-file should be given
+            if bool(key_file) != bool(cert_file):
+                ctx.fail("both --key-file and --cert-file should be given.")
+
+            return ctx.invoke(f, *args, **kwargs)
+
+        return update_wrapper_with_click_params(new_func, f)
+
+    return decorator
+
+
+[docs]def grpc_server_and_client_options():
+    def decorator(f):
+        @click.pass_context
+        @server_and_client_bind_address_option
+        @server_and_client_host_option
+        @server_and_client_port_option
+        @server_and_client_enable_ssl_option
+        @server_and_client_server_key_file_option
+        @server_and_client_server_cert_file_option
+        @server_and_client_server_root_certs_file_option
+        @server_and_client_require_client_auth_option
+        @server_and_client_no_require_client_auth_option
+        @server_and_client_client_root_certs_file_option
+        @server_and_client_client_key_file_option
+        @server_and_client_client_cert_file_option
+        def new_func(ctx: click.Context, *args, **kwargs):
+            # server related options and logics
+            key_file = kwargs.get("server_key_file")
+            cert_file = kwargs.get("server_cert_file")
+            root_certs_file = kwargs.get("server_root_certs_file")
+            require_client_auth = kwargs.get("require_client_auth")
+            no_require_client_auth = kwargs.pop("no_require_client_auth")
+
+            # both --key-file and --cert-file should be given
+            if bool(key_file) != bool(cert_file):
+                ctx.fail(
+                    "both --server-key-file and --server-cert-file should be given."
+                )
+
+            # assume --require-client-auth flag is set if --root-certs-file is given
+            if root_certs_file is not None:
+                require_client_auth = True
+                kwargs["require_client_auth"] = require_client_auth
+
+            # value of --require-client-auth flag should be false if --no-require-client-auth flag is set
+            if no_require_client_auth:
+                require_client_auth = False
+                kwargs["require_client_auth"] = require_client_auth
+
+            # --require-client-auth flag is set but no --root-certs-file was given
+            if require_client_auth and root_certs_file is None:
+                ctx.fail(
+                    "--require-client-auth flag is set but no --server-root-certs-file was  given."
+                )
+
+            # client related options and logics
+            enable_ssl = kwargs.get("enable_ssl")
+            root_certs_file = kwargs.get("client_root_certs_file")
+            key_file = kwargs.get("client_key_file")
+            cert_file = kwargs.get("client_cert_file")
+
+            # assume --enable-ssl flag is set if --root-certs-file is given
+            if root_certs_file is not None:
+                enable_ssl = True
+                kwargs["enable_ssl"] = enable_ssl
+
+            # both --key-file and --cert-file should be given
+            if bool(key_file) != bool(cert_file):
+                ctx.fail(
+                    "both --client-key-file and --client-cert-file should be given."
+                )
+
+            return ctx.invoke(f, *args, **kwargs)
+
+        return update_wrapper_with_click_params(new_func, f)
+
+    return decorator
+
+
+[docs]server_argument_parser = ClickArgumentParser(server_options + [full_verbose_option()])
+[docs]client_argument_parser = ClickArgumentParser(client_options + [full_verbose_option()])
+
+[docs]server_and_client_argument_parser = ClickArgumentParser(
+    server_and_client_options + [full_verbose_option()]
+)
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/cli/utils/openapi.html b/_modules/koapy/cli/utils/openapi.html new file mode 100644 index 00000000..b6cb5787 --- /dev/null +++ b/_modules/koapy/cli/utils/openapi.html @@ -0,0 +1,216 @@ + + + + + + + + koapy.cli.utils.openapi — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.cli.utils.openapi

+import os
+import shutil
+import subprocess
+
+import requests
+
+from koapy.utils.logging import get_logger
+from koapy.utils.subprocess import quote
+
+[docs]logger = get_logger(__name__)
+
+[docs]iss_file_encoding = "euc-kr"
+
+
+[docs]def download_openapi_installer(filepath):
+    url = "https://download.kiwoom.com/web/openapi/OpenAPISetup.exe"
+    response = requests.get(url)
+    with open(filepath, "wb") as f:
+        f.write(response.content)
+
+
+[docs]def prepare_issfile_for_install(filepath, target=None):
+    iss_filedir = os.path.join(
+        os.path.dirname(__file__),
+        "../../backend/kiwoom_open_api_plus/data/scripts/",
+    )
+    iss_filename = "install.iss"
+    iss_filepath = os.path.join(iss_filedir, iss_filename)
+    shutil.copy(iss_filepath, filepath)
+    if target is not None:
+        with open(filepath, "r", encoding=iss_file_encoding) as f:
+            lines = [line for line in f]
+        for i, line in enumerate(lines):
+            if line.startswith("szDir="):
+                lines[i] = "szDir={}\n".format(target)
+                break
+        with open(filepath, "w", encoding=iss_file_encoding) as f:
+            for line in lines:
+                f.write(line)
+
+
+[docs]def prepare_issfile_for_uninstall(filepath, reboot=False):
+    iss_filedir = os.path.join(
+        os.path.dirname(__file__),
+        "../../backend/kiwoom_open_api_plus/data/scripts/",
+    )
+    iss_filename = "uninstall.iss"
+    iss_filepath = os.path.join(iss_filedir, iss_filename)
+    shutil.copy(iss_filepath, filepath)
+    if reboot:
+        with open(filepath, "r", encoding=iss_file_encoding) as f:
+            lines = [line for line in f]
+        for i, line in enumerate(lines):
+            if line.startswith("BootOption="):
+                boot_option = 3
+                lines[i] = "BootOption={}\n".format(boot_option)
+                break
+        with open(filepath, "w", encoding=iss_file_encoding) as f:
+            for line in lines:
+                f.write(line)
+
+
+[docs]def run_installer_with_issfile(installer, issfile, logfile=None, cwd=None):
+    cmd = [quote(installer), "/s", "/f1{}".format(quote(issfile))]
+    if logfile is not None:
+        cmd.extend(["/f2{}".format(quote(logfile))])
+    # should use shell=True in order not to escape quotes in args
+    logger.info("Running command: %s", " ".join(cmd))
+    proc = subprocess.run(" ".join(cmd), shell=True, check=False, cwd=cwd)
+    if proc.returncode < 0:
+        raise subprocess.CalledProcessError(proc.returncode, " ".join(cmd))
+    return proc.returncode
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/cli/utils/pywin32.html b/_modules/koapy/cli/utils/pywin32.html new file mode 100644 index 00000000..138659cc --- /dev/null +++ b/_modules/koapy/cli/utils/pywin32.html @@ -0,0 +1,191 @@ + + + + + + + + koapy.cli.utils.pywin32 — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.cli.utils.pywin32

+import os
+import subprocess
+import sys
+import tempfile
+
+import requests
+
+from koapy.utils.logging import get_logger
+
+[docs]logger = get_logger(__name__)
+
+
+[docs]def get_pywin32_postinstall_script(filepath):
+    url = (
+        "https://raw.githubusercontent.com/mhammond/pywin32/main/pywin32_postinstall.py"
+    )
+    response = requests.get(url)
+    with open(filepath, "wb") as f:
+        f.write(response.content)
+
+
+[docs]def install_pywin32(version=None):
+    if version is None:
+        version = "304"
+    cmd = ["pip", "install", "pywin32>={}".format(version)]
+    logger.info("Running command: %s", subprocess.list2cmdline(cmd))
+    subprocess.check_call(cmd)
+    with tempfile.TemporaryDirectory() as tempdir:
+        script_filename = "pywin32_postinstall.py"
+        script_filepath = os.path.join(tempdir, script_filename)
+        get_pywin32_postinstall_script(script_filepath)
+        cmd = [sys.executable, script_filepath, "-install"]
+        logger.info("Running command: %s", subprocess.list2cmdline(cmd))
+        subprocess.check_call(cmd)
+
+
+[docs]def uninstall_pywin32():
+    with tempfile.TemporaryDirectory() as tempdir:
+        script_filename = "pywin32_postinstall.py"
+        script_filepath = os.path.join(tempdir, script_filename)
+        get_pywin32_postinstall_script(script_filepath)
+        cmd = [sys.executable, script_filepath, "-remove"]
+        logger.info("Running command: %s", subprocess.list2cmdline(cmd))
+        subprocess.check_call(cmd)
+    cmd = ["pip", "uninstall", "pywin32"]
+    logger.info("Running command: %s", subprocess.list2cmdline(cmd))
+    subprocess.check_call(cmd)
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/cli/utils/verbose_option.html b/_modules/koapy/cli/utils/verbose_option.html new file mode 100644 index 00000000..8f89843b --- /dev/null +++ b/_modules/koapy/cli/utils/verbose_option.html @@ -0,0 +1,171 @@ + + + + + + + + koapy.cli.utils.verbose_option — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.cli.utils.verbose_option

+from koapy.cli.extensions.verbose_option import (
+    verbose_option as extensions_verbose_option,
+)
+from koapy.utils.logging import set_verbosity
+
+[docs]full_verbosity = 5
+
+
+[docs]def verbose_option_callback(ctx, param, value):
+    set_verbosity(value)
+
+
+[docs]def verbose_option(*args, **kwargs):
+    if "callback" not in kwargs:
+        kwargs["callback"] = verbose_option_callback
+    return extensions_verbose_option(*args, **kwargs)
+
+
+[docs]def full_verbose_option(*args, **kwargs):
+    default_kwargs = dict(
+        default=full_verbosity,
+        show_default=True,
+        expose_value=True,
+    )
+    kwargs = dict(kwargs)
+    kwargs.update(default_kwargs)
+    return verbose_option(*args, **kwargs)
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/compat/pyside2.html b/_modules/koapy/compat/pyside2.html new file mode 100644 index 00000000..e7771010 --- /dev/null +++ b/_modules/koapy/compat/pyside2.html @@ -0,0 +1,175 @@ + + + + + + + + koapy.compat.pyside2 — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.compat.pyside2

+import os
+
+from koapy.config import config, debug
+from koapy.utils.logging import get_logger
+
+[docs]logger = get_logger(__name__)
+
+# Set QT_API environment variable for correct Qt backend usage
+os.environ["QT_API"] = config.get("koapy.qtpy.qt_api", "pyside2")
+
+# Import proper Qt binding using qtpy
+from qtpy import *
+from qtpy import PYQT5, PYSIDE2, PythonQtError
+
+# Check Qt backend
+if PYQT5:
+    if debug:
+        logger.debug("Using PyQt5 as Qt backend")
+elif PYSIDE2:
+    if debug:
+        logger.debug("Using PySide2 as Qt backend")
+else:
+    raise PythonQtError("No Qt bindings could be found")
+
+# PySide2 patch
+if PYSIDE2:
+    import PySide2
+
+    if hasattr(PySide2, "__file__"):
+[docs]        QT_QPA_PLATFORM_PLUGIN_PATH = os.path.join(
+            os.path.dirname(PySide2.__file__), "plugins", "platforms"
+        )
+        os.environ["QT_QPA_PLATFORM_PLUGIN_PATH"] = QT_QPA_PLATFORM_PLUGIN_PATH
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/compat/pywinauto/importlib.html b/_modules/koapy/compat/pywinauto/importlib.html new file mode 100644 index 00000000..06472ee0 --- /dev/null +++ b/_modules/koapy/compat/pywinauto/importlib.html @@ -0,0 +1,200 @@ + + + + + + + + koapy.compat.pywinauto.importlib — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.compat.pywinauto.importlib

+import importlib
+import sys
+import warnings
+
+from importlib.abc import Loader, MetaPathFinder
+
+import pythoncom
+
+
+[docs]class PyWinAutoFinder(MetaPathFinder):
+[docs]    def find_spec(self, fullname, path, target=None):
+        if fullname == "pywinauto":
+            self.unregister()
+            spec = importlib.util.find_spec(fullname)
+            spec.loader = PyWinAutoLoader()
+            return spec
+
+    @classmethod
+[docs]    def register(cls):
+        sys.meta_path = [cls()] + sys.meta_path
+
+    @classmethod
+[docs]    def unregister(cls):
+        sys.meta_path = [x for x in sys.meta_path if not isinstance(x, cls)]
+
+
+[docs]class PyWinAutoLoader(Loader):
+    def __init__(self):
+        self._original_coinit_flags_defined = False
+        self._original_coinit_flags = None
+
+[docs]    def set_sys_coinit_flags(self):
+        self._original_coinit_flags_defined = hasattr(sys, "coinit_flags")
+        self._original_coinit_flags = getattr(sys, "coinit_flags", None)
+        sys.coinit_flags = pythoncom.COINIT_APARTMENTTHREADED
+
+[docs]    def reset_sys_coinit_flags(self):
+        if not self._original_coinit_flags_defined:
+            del sys.coinit_flags
+        else:
+            sys.coinit_flags = self._original_coinit_flags
+
+[docs]    def create_module(self, spec):
+        # set sys.coinit_flags = 2
+        # check https://github.com/pywinauto/pywinauto/issues/472 for more information
+        self.set_sys_coinit_flags()
+
+        # ensure that qt binding is imported before pywinauto import
+        from koapy.compat import pyside2
+
+        # import pywinauto
+        with warnings.catch_warnings():
+            warnings.simplefilter("ignore", UserWarning)
+            module = importlib.import_module(spec.name)
+        return module
+
+[docs]    def exec_module(self, module):
+        pass
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/config.html b/_modules/koapy/config.html new file mode 100644 index 00000000..23f8f802 --- /dev/null +++ b/_modules/koapy/config.html @@ -0,0 +1,452 @@ + + + + + + + + koapy.config — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.config

+import subprocess
+import sys
+
+from os import PathLike
+from pathlib import Path
+from typing import Any, Mapping, Optional, Union
+
+from pyhocon import ConfigFactory
+from pyhocon.config_tree import ConfigTree
+from pyhocon.converter import HOCONConverter
+
+from koapy.utils.platform import is_32bit, is_64bit
+
+# Type alias for config object
+[docs]Config = ConfigTree
+
+
+# Paths related to default config file
+# bundled with this package for fallback
+[docs]default_config_filename = "config.conf"
+[docs]default_config_file_directory = Path(__file__).parent
+[docs]default_config_filepath = default_config_file_directory / default_config_filename
+
+
+# Paths related to user config file
+# for use customization
+[docs]current_working_directory = Path.cwd()
+[docs]home_directory = Path.home()
+
+[docs]default_user_config_filename = "koapy.conf"
+
+[docs]user_config_filename_cadidates = [
+    default_user_config_filename,
+    "." + default_user_config_filename,
+]
+
+[docs]default_user_config_filepath = home_directory / default_user_config_filename
+
+
+# Default encoding for all file read/writes across this package
+[docs]default_encoding = "utf-8"
+
+
+# Function for reading configs
+[docs]def read_config(
+    filename: Optional[Union[PathLike, str]] = None,
+    encoding: Optional[str] = None,
+) -> Config:
+    if filename is None:
+        filename = default_user_config_filepath
+    if isinstance(filename, str):
+        filename = Path(filename)
+    if encoding is None:
+        encoding = default_encoding
+    # pylint: disable=redefined-outer-name
+    config = ConfigFactory.parse_file(filename, encoding=encoding)
+    return config
+
+
+# Function for create configs from dict
+[docs]def config_from_dict(dictionary: Mapping[str, Any]) -> Config:
+    # pylint: disable=redefined-outer-name
+    config = ConfigFactory.from_dict(dictionary)
+    return config
+
+
+# Load default config bundled with this package for fallback
+[docs]default_config = read_config(default_config_filepath)
+
+
+# Try to read user config file from candidate paths
+#   1. Starting from current directory, search for a user config file until reaching the root directory, with specific name patterns
+#   2. In terms of user config filename pattern, visible filename takes precedence to hidden filename (hidden that starts with a dot)
+#   3. If fails to find a user config file even in the root directory, finally check user home directory for a user config file
+
+
+# Search for a user config file in a given directory
+[docs]def find_user_config_file_in(
+    searching_directory: Optional[Union[PathLike, str]] = None,
+) -> Optional[Path]:
+    if searching_directory is None:
+        # pylint: disable=redefined-outer-name
+        current_working_directory = Path.cwd()
+        searching_directory = current_working_directory
+    searching_directory_path = Path(searching_directory).resolve()
+    for config_filename in user_config_filename_cadidates:
+        config_filepath = searching_directory_path / config_filename
+        if config_filepath.exists():
+            return config_filepath
+
+
+# Search for a user config file from a given directory to the root directory
+[docs]def find_user_config_file_from(
+    starting_directory: Optional[Union[PathLike, str]] = None,
+) -> Optional[Path]:
+    if starting_directory is None:
+        # pylint: disable=redefined-outer-name
+        current_working_directory = Path.cwd()
+        starting_directory = current_working_directory
+    searching_directory_path = Path(starting_directory).resolve()
+    should_stop = False
+    while not should_stop:
+        config_filepath = find_user_config_file_in(searching_directory_path)
+        if config_filepath:
+            return config_filepath
+        has_no_more_parent = (
+            str(searching_directory_path) == searching_directory_path.anchor
+        )
+        should_stop = has_no_more_parent
+        searching_directory_path = searching_directory_path.parent
+
+
+# Empty config for internal usage
+[docs]empty_config = config_from_dict({})
+
+# Prepare user config before reading actual user config file (which may not exist)
+[docs]user_config = empty_config
+
+# Main config object for general use
+# User config takes precedence and fallbacks to default config for missing entries
+[docs]config = user_config.with_fallback(default_config)
+
+
+# Helper function for updating `user_config`, mostly for internal use
+# This also consequently updates `config` global variable
+[docs]def set_user_config(c: Config) -> Config:
+    global user_config  # pylint: disable=global-statement
+    global config  # pylint: disable=global-statement
+    user_config = c
+    config = user_config.with_fallback(default_config)
+    return user_config
+
+
+# Function for config initialization
+[docs]def initialize_config_from_given_path(
+    filename: Optional[Union[PathLike, str]] = None
+) -> bool:
+    user_config_filepath: Optional[PathLike] = None
+    initialized = False
+
+    # Use given filepath if possible
+    if not user_config_filepath:
+        if filename:
+            filepath = Path(filename).resolve()
+            if filepath.exists():
+                user_config_filepath = filepath
+
+    if user_config_filepath:
+        # pylint: disable=redefined-outer-name
+        user_config = read_config(user_config_filepath)
+        set_user_config(user_config)
+        initialized = True
+
+    return initialized
+
+
+# Function for config initialization
+[docs]def initialize_config_from_expected_paths() -> bool:
+    user_config_filepath: Optional[PathLike] = None
+    initialized = False
+
+    # Try searching starting from current directory to root
+    if not user_config_filepath:
+        user_config_filepath = find_user_config_file_from(current_working_directory)
+
+    # Try searching in home directory
+    if not user_config_filepath:
+        user_config_filepath = find_user_config_file_in(home_directory)
+
+    # If user config file is found, read the config file
+    # This overwrites previously declared emtpy `user_config` global variable
+    if user_config_filepath:
+        # pylint: disable=redefined-outer-name
+        user_config = read_config(user_config_filepath)
+        set_user_config(user_config)
+        initialized = True
+
+    return initialized
+
+
+# Just run basic initializtion for the first time
+initialize_config_from_expected_paths()
+
+
+# Simple helper function for getting config
+[docs]def get_config() -> Config:
+    return config
+
+
+# Simple helper function for getting user config
+[docs]def get_user_config() -> Config:
+    return user_config
+
+
+# Flag value for additional logging for debugging purpose (mainly in development process)
+[docs]debug = False
+
+
+# Dump config object to string
+[docs]def dump_config(
+    config: Config,
+    compact: bool = False,
+    indent: int = 4,
+) -> str:
+    # pylint: disable=redefined-outer-name
+    hocon = HOCONConverter.to_hocon(config, compact=compact, indent=indent)
+    return hocon
+
+
+# Save config to file
+[docs]def save_config(
+    filename: Union[PathLike, str],
+    config: Optional[Config] = None,
+    compact: bool = False,
+    indent: int = 4,
+    encoding: Optional[str] = None,
+):
+    # pylint: disable=redefined-outer-name
+    if config is None:
+        config = get_config()
+    if encoding is None:
+        encoding = default_encoding
+    hocon = dump_config(config, compact=compact, indent=indent)
+    with open(filename, "w", encoding=encoding) as f:
+        f.write(hocon)
+
+
+# Save user config to file (without default fallbacks)
+[docs]def save_user_config(
+    filename: Optional[Union[PathLike, str]] = None,
+    user_config: Optional[Config] = None,
+    compact: bool = False,
+    indent: int = 4,
+    encoding: Optional[str] = None,
+):
+    # pylint: disable=redefined-outer-name
+    if filename is None:
+        filename = default_user_config_filepath
+    if user_config is None:
+        user_config = get_user_config()
+    if encoding is None:
+        encoding = default_encoding
+    save_config(filename, user_config, compact, indent, encoding)
+
+
+# Helper functions for getting python executables below
+[docs]def get_executable_from_conda_envname(envname: str) -> str:
+    return subprocess.check_output(
+        [
+            "conda",
+            "run",
+            "-n",
+            envname,
+            "python",
+            "-c",
+            "import sys; print(sys.executable)",
+        ],
+        encoding=sys.stdout.encoding,
+        creationflags=subprocess.CREATE_NO_WINDOW,
+    ).strip()
+
+
+[docs]def get_executable_from_conda_envpath(envpath: str) -> str:
+    return subprocess.check_output(
+        [
+            "conda",
+            "run",
+            "-p",
+            envpath,
+            "python",
+            "-c",
+            "import sys; print(sys.executable)",
+        ],
+        encoding=sys.stdout.encoding,
+        creationflags=subprocess.CREATE_NO_WINDOW,
+    ).strip()
+
+
+[docs]def get_executable_from_executable_config(executable_config: Config) -> Optional[str]:
+    if isinstance(executable_config, str):
+        return executable_config
+    if isinstance(executable_config, dict):
+        if "path" in executable_config:
+            return executable_config["path"]
+        if "conda" in executable_config:
+            conda_config = executable_config["conda"]
+            if isinstance(conda_config, str):
+                envname = conda_config
+                return get_executable_from_conda_envname(envname)
+            if isinstance(conda_config, dict):
+                if "name" in conda_config:
+                    envname = conda_config["name"]
+                    return get_executable_from_conda_envname(envname)
+                if "path" in conda_config:
+                    envpath = conda_config["path"]
+                    return get_executable_from_conda_envpath(envpath)
+
+
+[docs]def get_32bit_executable() -> Optional[str]:
+    if is_32bit():
+        return sys.executable
+    executable_config = config.get("koapy.python.executable.32bit")
+    return get_executable_from_executable_config(executable_config)
+
+
+[docs]def get_64bit_executable() -> Optional[str]:
+    if is_64bit():
+        return sys.executable
+    executable_config = config.get("koapy.python.executable.64bit")
+    return get_executable_from_executable_config(executable_config)
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/utils/builtin.html b/_modules/koapy/utils/builtin.html new file mode 100644 index 00000000..452c034f --- /dev/null +++ b/_modules/koapy/utils/builtin.html @@ -0,0 +1,144 @@ + + + + + + + + koapy.utils.builtin — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.utils.builtin

+[docs]def dir_public(*args):
+    return [name for name in dir(*args) if not name.startswith("_")]
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/utils/ctypes.html b/_modules/koapy/utils/ctypes.html new file mode 100644 index 00000000..e4619e5f --- /dev/null +++ b/_modules/koapy/utils/ctypes.html @@ -0,0 +1,147 @@ + + + + + + + + koapy.utils.ctypes — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.utils.ctypes

+import ctypes
+
+
+[docs]def is_admin():
+    return ctypes.windll.shell32.IsUserAnAdmin() != 0
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/utils/data/KrxHistoricalDailyPriceDataDownloader.html b/_modules/koapy/utils/data/KrxHistoricalDailyPriceDataDownloader.html new file mode 100644 index 00000000..9864e2d8 --- /dev/null +++ b/_modules/koapy/utils/data/KrxHistoricalDailyPriceDataDownloader.html @@ -0,0 +1,304 @@ + + + + + + + + koapy.utils.data.KrxHistoricalDailyPriceDataDownloader — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.utils.data.KrxHistoricalDailyPriceDataDownloader

+import pandas as pd
+import requests
+
+from exchange_calendars import get_calendar
+
+
+[docs]class KrxHistoricalDailyPriceDataDownloader:
+    def __init__(self):
+        self._headers = {
+            "Accept": "application/json, text/javascript, */*; q=0.01",
+            "Accept-Encoding": "gzip, deflate",
+            "Accept-Language": "en-US,en;q=0.9,ko;q=0.8,fr;q=0.7,ja;q=0.6,zh-CN;q=0.5,zh;q=0.4",
+            "Host": "data.krx.co.kr",
+            "Origin": "http://data.krx.co.kr",
+            "Referer": "http://data.krx.co.kr/contents/MDC/MDI/mdiLoader/index.cmd?menuId=MDC0201020103",
+            "User-Agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/92.0.4515.131 Safari/537.36",
+            "X-Requested-With": "XMLHttpRequest",
+        }
+
+        self._stocks = None
+        self._stocks_delisted = None
+
+        self._bld = "dbms/MDC/STAT/standard/MDCSTAT01701"
+        self._isuCd = ""
+
+        self._calendar = get_calendar("XKRX")
+        self._start_date = self._calendar.first_session.astimezone(
+            self._calendar.tz
+        ).normalize()
+
+[docs]    def get_stocks(self):
+        data = {
+            "mktsel": "ALL",
+            "typeNo": "0",
+            "searchText": "",
+            "bld": "dbms/comm/finder/finder_stkisu",
+        }
+        url = "http://data.krx.co.kr/comm/bldAttendant/getJsonData.cmd"
+        response = requests.post(url, data, headers=self._headers)
+        df = pd.json_normalize(response.json()["block1"])
+        df = df.set_index("short_code")
+        return df
+
+[docs]    def get_stocks_delisted(self):
+        data = {
+            "mktsel": "ALL",
+            "searchText": "",
+            "bld": "dbms/comm/finder/finder_listdelisu",
+        }
+        url = "http://data.krx.co.kr/comm/bldAttendant/getJsonData.cmd"
+        response = requests.post(url, data, headers=self._headers)
+        df = pd.json_normalize(response.json()["block1"])
+        df = df.set_index("short_code")
+        return df
+
+    @property
+[docs]    def stocks(self):
+        if self._stocks is None:
+            self._stocks = self.get_stocks()
+        return self._stocks
+
+    @property
+[docs]    def stocks_delisted(self):
+        if self._stocks_delisted is None:
+            self._stocks_delisted = self.get_stocks_delisted()
+        return self._stocks_delisted
+
+[docs]    def get_full_code(self, symbol):
+        if symbol in self.stocks.index:
+            return self.stocks.loc[symbol]["full_code"]
+        if symbol in self.stocks_delisted.index:
+            return self.stocks_delisted.loc[symbol]["full_code"]
+        raise ValueError("No full_code found for given symbol %s" % symbol)
+
+[docs]    def get_name(self, symbol):
+        if symbol in self.stocks.index:
+            return self.stocks.loc[symbol]["codeName"]
+        if symbol in self.stocks_delisted.index:
+            return self.stocks_delisted.loc[symbol]["codeName"]
+        raise ValueError("No name found for given symbol %s" % symbol)
+
+[docs]    def download(self, symbol, start_date=None, end_date=None):
+        if start_date is None:
+            start_date = self._start_date
+        if end_date is None:
+            now = pd.Timestamp.now(self._calendar.tz)
+            end_date = (
+                self._calendar.previous_close(now)
+                .astimezone(self._calendar.tz)
+                .normalize()
+            )
+
+        full_code = self.get_full_code(symbol)
+        name = self.get_name(symbol)
+
+        url = "http://data.krx.co.kr/comm/bldAttendant/getJsonData.cmd"
+        data = {
+            "bld": self._bld,
+            "tboxisuCd_finder_stkisu0_0": "{}/{}".format(symbol, name),
+            "isuCd": full_code,
+            "isuCd2": self._isuCd,
+            "codeNmisuCd_finder_stkisu0_0": name,
+            "param1isuCd_finder_stkisu0_0": "ALL",
+            "strtDd": start_date.strftime("%Y%m%d"),
+            "endDd": end_date.strftime("%Y%m%d"),
+            "share": "1",
+            "money": "1",
+            "csvxls_isNo": "false",
+        }
+        self._isuCd = full_code
+
+        response = requests.post(url, data, headers=self._headers)
+        output = response.json()["output"]
+
+        if len(output) == 0:
+            return None
+
+        df = pd.json_normalize(output)
+
+        column_names = {
+            "TRD_DD": "Date",
+            "ISU_CD": "Code",
+            "ISU_NM": "Name",
+            "MKT_NM": "Market",
+            "SECUGRP_NM": "SecuGroup",
+            "TDD_CLSPRC": "Close",
+            "FLUC_TP_CD": "UpDown",
+            "CMPPRVDD_PRC": "Change",
+            "FLUC_RT": "ChangeRate",
+            "TDD_OPNPRC": "Open",
+            "TDD_HGPRC": "High",
+            "TDD_LWPRC": "Low",
+            "ACC_TRDVOL": "Volume",
+            "ACC_TRDVAL": "Amount",
+            "MKTCAP": "MarCap",
+            "CMPPREVDD_PRC": "Change",
+            "LIST_SHRS": "Shares",
+        }
+        df.rename(columns=column_names, inplace=True)
+
+        int_columns = [
+            "Close",
+            "UpDown",
+            "Change",
+            "ChangeRate",
+            "Open",
+            "High",
+            "Low",
+            "Volume",
+            "Amount",
+            "MarCap",
+            "Shares",
+        ]
+
+        for col in int_columns:
+            if col in df.columns:
+                df[col] = pd.to_numeric(df[col].str.replace(",", ""), errors="coerce")
+
+        df["Date"] = pd.to_datetime(df["Date"])
+        df.set_index("Date", inplace=True)
+
+        return df
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/utils/data/KrxHistoricalDailyPriceDataForBacktestLoader.html b/_modules/koapy/utils/data/KrxHistoricalDailyPriceDataForBacktestLoader.html new file mode 100644 index 00000000..9d872035 --- /dev/null +++ b/_modules/koapy/utils/data/KrxHistoricalDailyPriceDataForBacktestLoader.html @@ -0,0 +1,277 @@ + + + + + + + + koapy.utils.data.KrxHistoricalDailyPriceDataForBacktestLoader — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.utils.data.KrxHistoricalDailyPriceDataForBacktestLoader

+import numpy as np
+import pandas as pd
+
+from exchange_calendars import get_calendar
+from tqdm import tqdm
+
+from ..store import SQLiteStore
+from .KrxHistoricalDailyPriceDataLoader import KrxHistoricalDailyPriceDataLoader
+
+
+[docs]class KrxHistoricalDailyPriceDataForBacktestLoader:
+    def __init__(self, filename, library=None):
+        self._loader = KrxHistoricalDailyPriceDataLoader(filename)
+        self._store = SQLiteStore(filename)
+        self._calendar = get_calendar("XKRX")
+
+        if library is None:
+            library = "XKRX-ALL-BACKTEST"
+
+        self._library = self._store.get_or_create_library(library)
+
+    @classmethod
+[docs]    def get_adjust_ratios(cls, data, sort=True):
+        if sort:
+            data = data.sort_index(ascending=False)
+        adjust_ratios = []
+        last_close = data["Close"].iloc[0]
+        last_adjust_ratio = 1.0
+        adjust_ratios.append(last_adjust_ratio)
+        eleven_days = pd.Timedelta(11, unit="D")
+        for i in range(data.shape[0] - 1):
+            if data.index[i] - data.index[i + 1] > eleven_days:
+                last_close = data["Close"].iloc[i + 1]
+                last_adjust_ratio = 1.0
+            else:
+                last_close = last_close - data["Change"].iloc[i] * last_adjust_ratio
+                last_adjust_ratio = last_close / data["Close"].iloc[i + 1]
+            adjust_ratios.append(last_adjust_ratio)
+        adjust_ratios = np.array(adjust_ratios)
+        return adjust_ratios
+
+    @classmethod
+[docs]    def adjust_data(cls, data, sort=True):
+        if sort:
+            data = data.sort_index(ascending=False)
+        adjust_ratios = cls.get_adjust_ratios(data, sort=False)
+        data["Open"] = data["Open"] * adjust_ratios
+        data["High"] = data["High"] * adjust_ratios
+        data["Low"] = data["Low"] * adjust_ratios
+        data["Close"] = data["Close"] * adjust_ratios
+        data["Volume"] = data["Volume"] / adjust_ratios
+        return data
+
+[docs]    def get_symbols(self):
+        return self._library.list_symbols()
+
+[docs]    def update(self, download=False, progress_bar=False):
+        now = pd.Timestamp.now(self._calendar.tz)
+        end_date = (
+            self._calendar.previous_close(now).astimezone(self._calendar.tz).normalize()
+        )
+
+        symbols_with_delisted = {}
+
+        for symbol in self._loader.symbols:
+            symbols_with_delisted.setdefault(symbol, False)
+        for symbol in self._loader.symbols_delisted:
+            symbols_with_delisted.setdefault(symbol, True)
+
+        entire_index = pd.DatetimeIndex([], name="Date")
+
+        entire_data = {}
+        entire_data_converted = {}
+
+        progress = tqdm(symbols_with_delisted.items(), disable=not progress_bar)
+        for symbol, is_delisted in progress:
+            progress.set_description("Loading Symbol [%s]" % symbol)
+            if download:
+                versioned_item = self._loader.load_or_download(
+                    symbol, is_delisted=is_delisted, end_date=end_date
+                )
+            else:
+                versioned_item = self._loader.load_from_database(
+                    symbol, is_delisted=is_delisted
+                )
+            if versioned_item is not None:
+                entire_data[symbol] = versioned_item.data
+
+        progress = tqdm(entire_data.items(), disable=not progress_bar)
+        for symbol, data in progress:
+            progress.set_description("Adjusting Symbol [%s]" % symbol)
+            entire_index = entire_index.union(data.index)
+            data = data[data["Close"] > 0]
+            if data.shape[0] > 0:
+                data = self.adjust_data(data)
+                data = data.sort_index()
+                columns = [
+                    "Open",
+                    "High",
+                    "Low",
+                    "Close",
+                    "Volume",
+                    "Amount",
+                    "MarCap",
+                    "Shares",
+                ]
+                data = data[columns]
+                entire_data_converted[symbol] = data
+
+        progress = tqdm(entire_data_converted.items(), disable=not progress_bar)
+        for symbol, data in progress:
+            progress.set_description("Saving Symbol [%s]" % symbol)
+            data = data.reindex(entire_index)
+            data = data.fillna(0)
+            self._library.write(symbol, data)
+
+[docs]    def load(self, symbol, start_time=None, end_time=None):
+        if self._library.has_symbol(symbol):
+            versioned_item = self._library.read(
+                symbol, start_time=start_time, end_time=end_time
+            )
+            if (
+                versioned_item is not None
+                and versioned_item.data is not None
+                and versioned_item.data.shape[0] > 0
+            ):
+                return versioned_item.data
+
+[docs]    def load_as_cursor(self, symbol, start_time=None, end_time=None):
+        if self._library.has_symbol(symbol):
+            versioned_item = self._library.read_as_cursor(
+                symbol, start_time=start_time, end_time=end_time
+            )
+            if versioned_item is not None and versioned_item.data is not None:
+                return versioned_item.data
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/utils/data/KrxHistoricalDailyPriceDataLoader.html b/_modules/koapy/utils/data/KrxHistoricalDailyPriceDataLoader.html new file mode 100644 index 00000000..b52bca85 --- /dev/null +++ b/_modules/koapy/utils/data/KrxHistoricalDailyPriceDataLoader.html @@ -0,0 +1,263 @@ + + + + + + + + koapy.utils.data.KrxHistoricalDailyPriceDataLoader — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.utils.data.KrxHistoricalDailyPriceDataLoader

+import pandas as pd
+
+from exchange_calendars import get_calendar
+from tqdm import tqdm
+
+from ..store import SQLiteStore
+from .KrxHistoricalDailyPriceDataDownloader import KrxHistoricalDailyPriceDataDownloader
+
+
+[docs]class KrxHistoricalDailyPriceDataLoader:
+    def __init__(self, filename, library=None, library_delisted=None):
+        self._downloader = KrxHistoricalDailyPriceDataDownloader()
+        self._store = SQLiteStore(filename)
+        self._calendar = get_calendar("XKRX")
+
+        if library is None:
+            library = "XKRX"
+        if library_delisted is None:
+            library_delisted = "XKRX-DELISTED"
+
+        self._library = self._store.get_or_create_library(library)
+        self._library_delisted = self._store.get_or_create_library(library_delisted)
+
+    @property
+[docs]    def symbols(self):
+        return self._downloader.stocks.index
+
+    @property
+[docs]    def symbols_delisted(self):
+        return self._downloader.stocks_delisted.index
+
+[docs]    def load_from_database(self, symbol, is_delisted=None):
+        if is_delisted is None:
+            is_delisted = symbol not in self.symbols
+
+        library = self._library if not is_delisted else self._library_delisted
+
+        if library.has_symbol(symbol):
+            versioned_item = library.read(symbol)
+            if versioned_item.data is not None and versioned_item.data.shape[0] > 0:
+                return versioned_item
+
+[docs]    def load_or_download(
+        self, symbol, is_delisted=None, start_date=None, end_date=None
+    ):
+        if is_delisted is None:
+            is_delisted = symbol not in self.symbols
+
+        library = self._library
+        now = pd.Timestamp.now(self._calendar.tz)
+
+        if is_delisted:
+            library = self._library_delisted
+
+        if library.has_symbol(symbol):
+            versioned_item = self.load_from_database(symbol, is_delisted=is_delisted)
+            if not is_delisted and versioned_item is not None:
+                if start_date is None:
+                    start_date = (
+                        versioned_item.data.index.max().tz_localize(self._calendar.tz)
+                        + self._calendar.day
+                    )
+                if end_date is None:
+                    end_date = (
+                        self._calendar.previous_close(now)
+                        .astimezone(self._calendar.tz)
+                        .normalize()
+                    )
+                if start_date <= end_date:
+                    recent_data = self._downloader.download(
+                        symbol, start_date=start_date
+                    )
+                    if recent_data is not None and recent_data.shape[0] > 0:
+                        data = versioned_item.data
+                        data = data.combine_first(recent_data)[data.columns]
+                        data = data.convert_dtypes(convert_floating=False)
+                        data = data.sort_index()
+                        versioned_item = library.write(symbol, data)
+            return versioned_item
+        else:
+            data = self._downloader.download(
+                symbol, start_date=start_date, end_date=end_date
+            )
+            if data is not None and data.shape[0] > 0:
+                data = data.convert_dtypes(convert_floating=False)
+                data = data.sort_index()
+                versioned_item = library.write(symbol, data)
+                return versioned_item
+
+[docs]    def load(
+        self, symbol, is_delisted=None, start_date=None, end_date=None, download=True
+    ):
+        if download:
+            return self.load_or_download(
+                symbol,
+                is_delisted=is_delisted,
+                start_date=start_date,
+                end_date=end_date,
+            )
+        else:
+            return self.load_from_database(symbol, is_delisted=is_delisted)
+
+[docs]    def update(self, progress_bar=False):
+        now = pd.Timestamp.now(self._calendar.tz)
+        end_date = (
+            self._calendar.previous_close(now).astimezone(self._calendar.tz).normalize()
+        )
+
+        symbols_with_delisted = {}
+
+        for symbol in self.symbols:
+            symbols_with_delisted.setdefault(symbol, False)
+        for symbol in self.symbols_delisted:
+            symbols_with_delisted.setdefault(symbol, True)
+
+        progress = tqdm(symbols_with_delisted.items(), disable=not progress_bar)
+        for symbol, is_delisted in progress:
+            progress.set_description("Updating Symbol [%s]" % symbol)
+            _versioned_item = self.load_or_download(
+                symbol, is_delisted=is_delisted, end_date=end_date
+            )
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/utils/data/YahooFinanceKrxHistoricalDailyPriceDataDownloader.html b/_modules/koapy/utils/data/YahooFinanceKrxHistoricalDailyPriceDataDownloader.html new file mode 100644 index 00000000..17f38c0f --- /dev/null +++ b/_modules/koapy/utils/data/YahooFinanceKrxHistoricalDailyPriceDataDownloader.html @@ -0,0 +1,181 @@ + + + + + + + + koapy.utils.data.YahooFinanceKrxHistoricalDailyPriceDataDownloader — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.utils.data.YahooFinanceKrxHistoricalDailyPriceDataDownloader

+import io
+
+import pandas as pd
+import requests
+
+
+[docs]class YahooFinanceKrxHistoricalDailyPriceDataDownloader:
+    def __init__(self):
+        self._headers = {
+            "User-Agent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/87.0.4280.141 Safari/537.36",
+        }
+
+[docs]    def download(self, symbol, start_date=None, end_date=None):
+        if start_date is None:
+            start_date = pd.Timestamp(1980, 1, 1)
+        elif not isinstance(start_date, pd.Timestamp):
+            start_date = pd.Timestamp(start_date)
+        if end_date is None:
+            end_date = pd.Timestamp.now().normalize() + pd.Timedelta(1, unit="day")
+        elif not isinstance(end_date, pd.Timestamp):
+            end_date = pd.Timestamp(end_date)
+
+        url = (
+            "https://query1.finance.yahoo.com/v7/finance/download/%s.KS"
+            % symbol.upper()
+        )
+        params = {
+            "period1": int(start_date.timestamp()),
+            "period2": int(end_date.timestamp()),
+            "interval": "1d",
+            "events": "history",
+            "includeAdjustedClose": "true",
+        }
+        response = requests.get(url, params=params, headers=self._headers)
+        df = pd.read_csv(
+            io.BytesIO(response.content), parse_dates=["Date"], index_col="Date"
+        )
+
+        return df
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/utils/datetime.html b/_modules/koapy/utils/datetime.html new file mode 100644 index 00000000..c864bbd1 --- /dev/null +++ b/_modules/koapy/utils/datetime.html @@ -0,0 +1,152 @@ + + + + + + + + koapy.utils.datetime — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.utils.datetime

+[docs]def is_naive(dt):
+    return dt.tzinfo is None or dt.tzinfo.utcoffset(dt) is None
+
+
+[docs]def localize(dt, tz):
+    if is_naive(dt):
+        dt = tz.localize(dt)
+    else:
+        dt = dt.astimezone(tz)
+    return dt
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/utils/exchange_calendars.html b/_modules/koapy/utils/exchange_calendars.html new file mode 100644 index 00000000..edc8b7a0 --- /dev/null +++ b/_modules/koapy/utils/exchange_calendars.html @@ -0,0 +1,162 @@ + + + + + + + + koapy.utils.exchange_calendars — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.utils.exchange_calendars

+from exchange_calendars import get_calendar
+from pandas import Timestamp
+
+[docs]name = "XKRX"
+[docs]calendar = get_calendar(name)
+[docs]day = calendar.day
+
+
+[docs]def is_currently_in_session() -> bool:
+    now = Timestamp.now(calendar.tz).floor("T")
+    previous_open = calendar.previous_open(now).astimezone(calendar.tz)
+    next_close = calendar.next_close(previous_open).astimezone(calendar.tz)
+    return previous_open <= now <= next_close
+
+
+[docs]def get_last_session_date() -> Timestamp:
+    now = Timestamp.now(calendar.tz).floor("T")
+    previous_close = calendar.previous_close(now).astimezone(calendar.tz)
+    previous_open = calendar.previous_open(previous_close).astimezone(calendar.tz)
+    return previous_open.normalize()
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/utils/grpc.html b/_modules/koapy/utils/grpc.html new file mode 100644 index 00000000..b09b25e6 --- /dev/null +++ b/_modules/koapy/utils/grpc.html @@ -0,0 +1,176 @@ + + + + + + + + koapy.utils.grpc — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.utils.grpc

+import contextlib
+import threading
+import warnings
+
+from pprint import PrettyPrinter
+
+import grpc
+
+from google.protobuf.json_format import MessageToDict
+
+
+@contextlib.contextmanager
+[docs]def warn_on_rpc_error_context():
+    try:
+        yield
+    except grpc.RpcError as e:
+        warnings.warn(str(e))
+
+
+[docs]def warn_on_rpc_error(stream):
+    with warn_on_rpc_error_context():
+        for event in stream:
+            yield event
+
+
+[docs]def cancel_after(stream, after):
+    timer = threading.Timer(after, stream.cancel)
+    timer.start()
+    return warn_on_rpc_error(stream)
+
+
+[docs]def pprint_message(message):
+    pp = PrettyPrinter()
+    pp.pprint(MessageToDict(message, preserving_proto_field_name=True))
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/utils/itertools.html b/_modules/koapy/utils/itertools.html new file mode 100644 index 00000000..d1e68cc6 --- /dev/null +++ b/_modules/koapy/utils/itertools.html @@ -0,0 +1,151 @@ + + + + + + + + koapy.utils.itertools — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.utils.itertools

+import itertools
+
+
+[docs]def chunk(iterable, n):
+    fillvalue = object()
+    args = [iter(iterable)] * n
+    it = itertools.zip_longest(fillvalue=fillvalue, *args)
+    it = map(lambda items: [item for item in items if item is not fillvalue], it)
+    return it
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/utils/logging.html b/_modules/koapy/utils/logging.html new file mode 100644 index 00000000..90daae97 --- /dev/null +++ b/_modules/koapy/utils/logging.html @@ -0,0 +1,183 @@ + + + + + + + + koapy.utils.logging — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.utils.logging

+from .Logging import Logging
+
+
+[docs]def get_logger(name=None):
+    return Logging.get_logger(name)
+
+
+[docs]def verbosity_to_loglevel(verbosity):
+    return Logging.verbosity_to_loglevel(verbosity)
+
+
+[docs]def loglevel_to_verbosity(loglevel):
+    return Logging.loglevel_to_verbosity(loglevel)
+
+
+[docs]def get_package_logger():
+    root_package_name = __name__.split(".", maxsplit=1)[0]
+    logger = get_logger(root_package_name)
+    return logger
+
+
+[docs]def set_loglevel(loglevel):
+    logger = get_package_logger()
+    logger.setLevel(loglevel)
+
+
+[docs]def set_verbosity(verbosity):
+    loglevel = verbosity_to_loglevel(verbosity)
+    set_loglevel(loglevel)
+
+
+[docs]def get_loglevel():
+    logger = get_package_logger()
+    loglevel = logger.level
+    return loglevel
+
+
+[docs]def get_verbosity():
+    loglevel = get_loglevel()
+    verbosity = loglevel_to_verbosity(loglevel)
+    return verbosity
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/utils/logging/Logging.html b/_modules/koapy/utils/logging/Logging.html new file mode 100644 index 00000000..e9be42e0 --- /dev/null +++ b/_modules/koapy/utils/logging/Logging.html @@ -0,0 +1,295 @@ + + + + + + + + koapy.utils.logging.Logging — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.utils.logging.Logging

+import inspect
+import logging
+import logging.config
+import threading
+
+
+[docs]class LoggingMeta(type):
+
+    __default_config = {
+        "version": 1,
+        "formatters": {
+            "default": {
+                "format": "%(asctime)s [%(levelname)s] %(message)s - %(filename)s:%(lineno)d",
+            },
+        },
+        "handlers": {
+            "console": {
+                "class": "logging.StreamHandler",
+                "level": "NOTSET",
+                "formatter": "default",
+            },
+        },
+        "loggers": {
+            "koapy": {
+                "level": "DEBUG",
+                "propagate": False,
+                "handlers": ["console"],
+            },
+        },
+        "incremental": False,
+        "disable_existing_loggers": False,
+    }
+
+    __config_key = "koapy.utils.logging.config"
+
+    __initialized = False
+    __init_lock = threading.RLock()
+
+    def __initialize_if_necessary(cls):
+        if not LoggingMeta.__initialized:
+            with LoggingMeta.__init_lock:
+                if not LoggingMeta.__initialized:
+                    LoggingMeta.__initialize(cls)
+
+    def __initialize(cls):
+        from koapy.config import config
+
+        logging_config_dict = config.get(
+            LoggingMeta.__config_key, LoggingMeta.__default_config
+        )
+
+        logging.basicConfig()
+        logging.config.dictConfig(logging_config_dict)
+        LoggingMeta.__initialized = True
+
+    def __new__(cls, clsname, bases, dct):
+        return super().__new__(cls, clsname, bases, dct)
+
+    def __init__(cls, clsname, bases, dct):
+        super().__init__(clsname, bases, dct)
+        cls.__logger = None
+
+[docs]    def get_logger(cls, name=None):
+        LoggingMeta.__initialize_if_necessary(cls)
+        logger = logging.getLogger(name)
+        return logger
+
+    def __module_name(cls):
+        module = inspect.getmodule(cls)
+        module_name = module.__spec__ and module.__spec__.name or module.__name__
+        return module_name
+
+    def __class_name(cls):
+        class_name = cls.__name__
+        if hasattr(cls, "__outer_class__"):
+            class_name = "{}.{}".format(
+                LoggingMeta.__class_name(cls.__outer_class__),
+                class_name,
+            )
+        return class_name
+
+    def __logger_name(cls):
+        module_name = LoggingMeta.__module_name(cls)
+        class_name = LoggingMeta.__class_name(cls)
+        logger_name = "{}.{}".format(module_name, class_name)
+        return logger_name
+
+[docs]    def get_class_logger(cls):
+        name = LoggingMeta.__logger_name(cls)
+        logger = LoggingMeta.get_logger(cls, name)
+        return logger
+
+[docs]    def get_module_logger(cls):
+        name = LoggingMeta.__module_name(cls)
+        logger = LoggingMeta.get_logger(cls, name)
+        return logger
+
+[docs]    def get_package_logger(cls):
+        name = LoggingMeta.__module_name(cls)
+        name = name.split(".", maxsplit=1)[0]
+        logger = LoggingMeta.get_logger(cls, name)
+        return logger
+
+    def _logger(cls):
+        if cls.__logger is None:
+            cls.__logger = LoggingMeta.get_class_logger(cls)
+        return cls.__logger
+
+    @property
+[docs]    def logger(cls):
+        return LoggingMeta._logger(cls)
+
+[docs]    def verbosity_to_loglevel(cls, verbosity):
+        verbosity = verbosity or 0
+        levels = [
+            logging.WARNING,
+            logging.INFO,
+            logging.DEBUG,
+        ]
+        if verbosity >= len(levels):
+            verbosity = -1
+        level = levels[verbosity]
+        return level
+
+[docs]    def loglevel_to_verbosity(cls, loglevel):
+        verbosity = 3 - (loglevel + 9) // 10
+        if verbosity < 0:
+            verbosity = 0
+        return verbosity
+
+[docs]    def set_loglevel(cls, loglevel=logging.WARNING):
+        return LoggingMeta._logger(cls).setLevel(loglevel)
+
+[docs]    def set_verbosity(cls, verbosity=0):
+        loglevel = LoggingMeta.verbosity_to_loglevel(cls, verbosity)
+        LoggingMeta.set_loglevel(cls, loglevel)
+        return loglevel
+
+[docs]    def get_loglevel(cls):
+        return LoggingMeta._logger(cls).level
+
+[docs]    def get_verbosity(cls):
+        loglevel = LoggingMeta.get_loglevel(cls)
+        verbosity = LoggingMeta.loglevel_to_verbosity(cls, loglevel)
+        return verbosity
+
+
+[docs]class Logging(metaclass=LoggingMeta):
+    @property
+[docs]    def logger(self):
+        return type(self)._logger()
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/utils/logging/pyside2/QAbstractSocketLogging.html b/_modules/koapy/utils/logging/pyside2/QAbstractSocketLogging.html new file mode 100644 index 00000000..2c149b8c --- /dev/null +++ b/_modules/koapy/utils/logging/pyside2/QAbstractSocketLogging.html @@ -0,0 +1,158 @@ + + + + + + + + koapy.utils.logging.pyside2.QAbstractSocketLogging — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.utils.logging.pyside2.QAbstractSocketLogging

+from koapy.compat.pyside2.QtNetwork import QAbstractSocket
+from koapy.utils.logging.Logging import Logging
+
+
+[docs]class QAbstractSocketLoggingMeta(type(Logging), type(QAbstractSocket)):
+    pass
+
+
+[docs]class QAbstractSocketLogging(
+    QAbstractSocket, Logging, metaclass=QAbstractSocketLoggingMeta
+):
+    def __init__(self, *args, **kwargs):
+        QAbstractSocket.__init__(self, *args, **kwargs)
+        Logging.__init__(self)
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/utils/logging/pyside2/QObjectLogging.html b/_modules/koapy/utils/logging/pyside2/QObjectLogging.html new file mode 100644 index 00000000..a2e3613a --- /dev/null +++ b/_modules/koapy/utils/logging/pyside2/QObjectLogging.html @@ -0,0 +1,156 @@ + + + + + + + + koapy.utils.logging.pyside2.QObjectLogging — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.utils.logging.pyside2.QObjectLogging

+from koapy.compat.pyside2.QtCore import QObject
+from koapy.utils.logging.Logging import Logging
+
+
+[docs]class QObjectLoggingMeta(type(Logging), type(QObject)):
+    pass
+
+
+[docs]class QObjectLogging(QObject, Logging, metaclass=QObjectLoggingMeta):
+    def __init__(self, *args, **kwargs):
+        QObject.__init__(self, *args, **kwargs)
+        Logging.__init__(self)
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/utils/logging/pyside2/QThreadLogging.html b/_modules/koapy/utils/logging/pyside2/QThreadLogging.html new file mode 100644 index 00000000..5eb72106 --- /dev/null +++ b/_modules/koapy/utils/logging/pyside2/QThreadLogging.html @@ -0,0 +1,156 @@ + + + + + + + + koapy.utils.logging.pyside2.QThreadLogging — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.utils.logging.pyside2.QThreadLogging

+from koapy.compat.pyside2.QtCore import QThread
+from koapy.utils.logging.Logging import Logging
+
+
+[docs]class QThreadLoggingMeta(type(Logging), type(QThread)):
+    pass
+
+
+[docs]class QThreadLogging(QThread, Logging, metaclass=QThreadLoggingMeta):
+    def __init__(self, *args, **kwargs):
+        QThread.__init__(self, *args, **kwargs)
+        Logging.__init__(self)
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/utils/logging/pyside2/QWidgetLogging.html b/_modules/koapy/utils/logging/pyside2/QWidgetLogging.html new file mode 100644 index 00000000..e8ac0baf --- /dev/null +++ b/_modules/koapy/utils/logging/pyside2/QWidgetLogging.html @@ -0,0 +1,156 @@ + + + + + + + + koapy.utils.logging.pyside2.QWidgetLogging — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.utils.logging.pyside2.QWidgetLogging

+from koapy.compat.pyside2.QtWidgets import QWidget
+from koapy.utils.logging.Logging import Logging
+
+
+[docs]class QWidgetLoggingMeta(type(Logging), type(QWidget)):
+    pass
+
+
+[docs]class QWidgetLogging(QWidget, Logging, metaclass=QWidgetLoggingMeta):
+    def __init__(self, *args, **kwargs):
+        QWidget.__init__(self, *args, **kwargs)
+        Logging.__init__(self)
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/utils/logging/tqdm/TqdmStreamHandler.html b/_modules/koapy/utils/logging/tqdm/TqdmStreamHandler.html new file mode 100644 index 00000000..d113a04e --- /dev/null +++ b/_modules/koapy/utils/logging/tqdm/TqdmStreamHandler.html @@ -0,0 +1,157 @@ + + + + + + + + koapy.utils.logging.tqdm.TqdmStreamHandler — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.utils.logging.tqdm.TqdmStreamHandler

+import sys
+
+from logging import StreamHandler
+
+from tqdm.contrib import DummyTqdmFile
+
+
+[docs]class TqdmStreamHandler(StreamHandler):
+    def __init__(self, stream=None):
+        if stream is None:
+            stream = sys.stderr
+        stream = DummyTqdmFile(stream)
+        StreamHandler.__init__(self, stream)
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/utils/messaging/DiscordMessenger.html b/_modules/koapy/utils/messaging/DiscordMessenger.html new file mode 100644 index 00000000..8c233ea0 --- /dev/null +++ b/_modules/koapy/utils/messaging/DiscordMessenger.html @@ -0,0 +1,183 @@ + + + + + + + + koapy.utils.messaging.DiscordMessenger — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.utils.messaging.DiscordMessenger

+import json
+
+import requests
+
+from discord import RequestsWebhookAdapter, Webhook
+
+from koapy.config import config
+from koapy.utils.messaging.Messenger import Messenger
+
+
+[docs]class DiscordWebhookMessenger(Messenger):
+    def __init__(self, url=None):
+        self._url = url or config.get_string(
+            "koapy.utils.messaging.discord.webhook_url"
+        )
+        assert self._url is not None and len(self._url) > 0
+        self._webhook = Webhook.from_url(self._url, adapter=RequestsWebhookAdapter())
+
+[docs]    def send_message(self, content):
+        return self._webhook.send(content)
+
+
+[docs]class DoItYourselfDiscordWebhookMessenger(Messenger):
+    def __init__(self, url=None):
+        self._url = url or config.get_string(
+            "koapy.utils.messaging.discord.webhook_url"
+        )
+        assert self._url is not None and len(self._url) > 0
+
+[docs]    def send_message(self, content):
+        headers = {
+            "Content-Type": "application/json",
+        }
+        data = {
+            "content": content,
+        }
+        data = json.dumps(data)
+        response = requests.post(
+            self._url, headers=headers, data=data, params={"wait": "true"}
+        )
+        return response
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/utils/messaging/Messenger.html b/_modules/koapy/utils/messaging/Messenger.html new file mode 100644 index 00000000..481aaabd --- /dev/null +++ b/_modules/koapy/utils/messaging/Messenger.html @@ -0,0 +1,151 @@ + + + + + + + + koapy.utils.messaging.Messenger — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.utils.messaging.Messenger

+from abc import ABC, abstractmethod
+
+
+[docs]class Messenger(ABC):
+    """ """
+
+    @abstractmethod
+[docs]    def send_message(self, content):
+        raise NotImplementedError
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/utils/networking.html b/_modules/koapy/utils/networking.html new file mode 100644 index 00000000..df0b8fa4 --- /dev/null +++ b/_modules/koapy/utils/networking.html @@ -0,0 +1,177 @@ + + + + + + + + koapy.utils.networking — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.utils.networking

+import ipaddress
+import socket
+
+from contextlib import closing
+
+from wrapt import synchronized
+
+
+@synchronized
+[docs]def find_free_port_for_host(host):
+    sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+    with closing(sock) as sock:
+        sock.bind((host, 0))
+        host, port = sock.getsockname()
+        return port
+
+
+[docs]def get_free_localhost_port():
+    return find_free_port_for_host("localhost")
+
+
+[docs]def is_in_private_network(host):
+    host = socket.gethostbyname(host)
+    ip_address = ipaddress.ip_address(host)
+    private_networks = [
+        "10.0.0.0/8",
+        "127.0.0.0/8",
+        "172.16.0.0/12",
+        "192.168.0.0/16",
+    ]
+    private_networks = [ipaddress.ip_network(network) for network in private_networks]
+    for private_network in private_networks:
+        if ip_address in private_network:
+            return True
+    return False
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/utils/notimplemented.html b/_modules/koapy/utils/notimplemented.html new file mode 100644 index 00000000..d7d4304e --- /dev/null +++ b/_modules/koapy/utils/notimplemented.html @@ -0,0 +1,153 @@ + + + + + + + + koapy.utils.notimplemented — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.utils.notimplemented

+[docs]def notimplemented(func):
+    func.__isnotimplemented__ = True
+    return func
+
+
+[docs]def isnotimplemented(func):
+    return getattr(func, "__isnotimplemented__", False)
+
+
+[docs]def isimplemented(func):
+    return not isnotimplemented(func)
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/utils/platform.html b/_modules/koapy/utils/platform.html new file mode 100644 index 00000000..3697a6fa --- /dev/null +++ b/_modules/koapy/utils/platform.html @@ -0,0 +1,156 @@ + + + + + + + + koapy.utils.platform — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.utils.platform

+import platform
+import sys
+
+
+[docs]def is_windows():
+    return sys.platform == "win32"
+
+
+[docs]def is_32bit():
+    return platform.architecture()[0] == "32bit"
+
+
+[docs]def is_64bit():
+    return platform.architecture()[0] == "64bit"
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/utils/pywin32.html b/_modules/koapy/utils/pywin32.html new file mode 100644 index 00000000..e9e799c0 --- /dev/null +++ b/_modules/koapy/utils/pywin32.html @@ -0,0 +1,290 @@ + + + + + + + + koapy.utils.pywin32 — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.utils.pywin32

+from typing import Dict, List, Optional, Sequence, Tuple, Union
+
+try:
+    from typing import TypeGuard
+except ImportError:
+    from typing_extensions import TypeGuard
+
+import pythoncom
+import win32api
+import win32con
+
+from pywintypes import IIDType
+from win32com.client.genpy import (
+    DispatchItem,
+    EnumerationItem,
+    Generator,
+    RecordItem,
+    VTableItem,
+)
+from win32com.client.selecttlb import EnumKeys, TypelibSpec
+
+[docs]PyIID = IIDType
+[docs]PyITypeLib = "PyITypeLib"
+
+[docs]PyIIDLike = Union[PyIID, str]
+
+
+[docs]def IsPyIID(value) -> TypeGuard[PyIID]:
+    return isinstance(value, IIDType)
+
+
+[docs]def IsPyITypeLib(value) -> TypeGuard[PyITypeLib]:
+    return type(value).__name__ == PyITypeLib
+
+
+[docs]def IsPyIIDLike(value) -> TypeGuard[PyIIDLike]:
+    return IsPyIID(value) or isinstance(value, str)
+
+
+[docs]def GetTypelibSpecs(iid: PyIIDLike) -> List[TypelibSpec]:
+    specs: List[TypelibSpec] = []
+
+    try:
+        key = win32api.RegOpenKey(win32con.HKEY_CLASSES_ROOT, "TypeLib")
+        key2 = win32api.RegOpenKey(key, str(iid))
+    except win32api.error:
+        enum_keys = []
+    else:
+        enum_keys = EnumKeys(key2)
+
+    for version, tlbdesc in enum_keys:
+        major_minor = version.split(".", 1)
+        if len(major_minor) < 2:
+            major_minor.append("0")
+        major = major_minor[0]
+        minor = major_minor[1]
+        key3 = win32api.RegOpenKey(key2, str(version))
+        try:
+            flags = int(win32api.RegQueryValue(key3, "FLAGS"))
+        except (win32api.error, ValueError):
+            flags = 0
+        for lcid, _ in EnumKeys(key3):
+            try:
+                lcid = int(lcid)
+            except ValueError:
+                continue
+            try:
+                key4 = win32api.RegOpenKey(key3, "{}\\win32".format(lcid))
+            except win32api.error:
+                try:
+                    key4 = win32api.RegOpenKey(key3, "{}\\win64".format(lcid))
+                except win32api.error:
+                    continue
+            try:
+                dll, typ = win32api.RegQueryValueEx(key4, None)
+                if typ == win32con.REG_EXPAND_SZ:
+                    dll = win32api.ExpandEnvironmentStrings(dll)
+            except win32api.error:
+                dll = None
+            spec = TypelibSpec(iid, lcid, major, minor, flags)
+            spec.dll = dll
+            spec.desc = tlbdesc
+            spec.ver_desc = tlbdesc + " (" + version + ")"
+            specs.append(spec)
+
+    return specs
+
+
+[docs]def GetLatestTypelibSpec(
+    specs: Union[Sequence[TypelibSpec], PyIIDLike]
+) -> Optional[TypelibSpec]:
+    spec: Optional[TypelibSpec] = None
+
+    if IsPyIIDLike(specs):
+        specs = GetTypelibSpecs(specs)
+
+    if len(specs) > 0:
+        specs = sorted(specs)
+        spec = specs[-1]
+
+    return spec
+
+
+[docs]def LoadTypeLib(spec: Union[TypelibSpec, PyIIDLike]) -> Optional[PyITypeLib]:
+    tlb: Optional[PyITypeLib] = None
+
+    if IsPyIIDLike(spec):
+        spec = GetLatestTypelibSpec(spec)
+
+    if spec:
+        if spec.dll:
+            tlb = pythoncom.LoadTypeLib(spec.dll)
+        else:
+            tlb = pythoncom.LoadRegTypeLib(
+                spec.clsid,
+                spec.major,
+                spec.minor,
+                spec.lcid,
+            )
+
+    return tlb
+
+
+[docs]def BuildOleItems(
+    spec: Union[TypelibSpec, PyIIDLike],
+    tlb: Optional[PyITypeLib] = None,
+) -> Tuple[
+    Dict[PyIID, DispatchItem],
+    Dict[PyIID, EnumerationItem],
+    Dict[PyIID, RecordItem],
+    Dict[PyIID, VTableItem],
+]:
+    oleItems: Dict[PyIID, DispatchItem] = {}
+    enumItems: Dict[PyIID, EnumerationItem] = {}
+    recordItems: Dict[PyIID, RecordItem] = {}
+    vtableItems: Dict[PyIID, VTableItem] = {}
+
+    if IsPyIIDLike(spec):
+        spec = GetLatestTypelibSpec(spec)
+
+    if spec:
+        if not tlb:
+            tlb = LoadTypeLib(spec)
+        progressInstance = None
+        gen = Generator(tlb, spec.dll, progressInstance, bBuildHidden=1)
+        oleItems, enumItems, recordItems, vtableItems = gen.BuildOleItemsFromType()
+
+    return oleItems, enumItems, recordItems, vtableItems
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/utils/rate_limiting/RateLimiter.html b/_modules/koapy/utils/rate_limiting/RateLimiter.html new file mode 100644 index 00000000..e9a1bd72 --- /dev/null +++ b/_modules/koapy/utils/rate_limiting/RateLimiter.html @@ -0,0 +1,235 @@ + + + + + + + + koapy.utils.rate_limiting.RateLimiter — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.utils.rate_limiting.RateLimiter

+import collections
+import threading
+import time
+
+from functools import wraps
+from typing import List
+
+from koapy.utils.logging.Logging import Logging
+
+
+[docs]class RateLimiter:
+[docs]    def check_sleep_seconds(self, *args, **kwargs):
+        return 0
+
+[docs]    def add_call_history(self, *args, **kwargs):
+        pass
+
+[docs]    def sleep_if_necessary(self, *args, **kwargs):
+        sleep_seconds = self.check_sleep_seconds(*args, **kwargs)
+        if sleep_seconds > 0:
+            time.sleep(sleep_seconds)
+
+[docs]    def wrap(self, func):
+        @wraps(func)
+        def wrapper(*args, **kwargs):
+            self.sleep_if_necessary(func, *args, **kwargs)
+            self.add_call_history(func, *args, **kwargs)
+            return func(*args, **kwargs)
+
+        return wrapper
+
+    def __call__(self, func):
+        return self.wrap(func)
+
+
+[docs]class TimeWindowRateLimiter(RateLimiter, Logging):
+    def __init__(self, period, calls):
+        super().__init__()
+
+        self._period = period
+        self._calls = calls
+
+        self._lock = threading.RLock()
+        self._clock = time.time
+
+        if hasattr(time, "monotonic"):
+            self._clock = time.monotonic
+
+        self._call_history = collections.deque(maxlen=self._calls)
+
+[docs]    def check_sleep_seconds(self, *args, **kwargs):
+        with self._lock:
+            if len(self._call_history) < self._calls:
+                return 0
+            clock = self._clock()
+            remaining = self._call_history[0] + self._period - clock
+            return remaining
+
+[docs]    def add_call_history(self, *args, **kwargs):
+        with self._lock:
+            return self._call_history.append(self._clock())
+
+[docs]    def sleep_if_necessary(self, *args, **kwargs):
+        with self._lock:
+            sleep_seconds = self.check_sleep_seconds(*args, **kwargs)
+            if sleep_seconds > 0:
+                time.sleep(sleep_seconds)
+
+
+[docs]class CompositeTimeWindowRateLimiter(RateLimiter):
+    def __init__(self, limiters: List[RateLimiter]):
+        super().__init__()
+
+        self._lock = threading.RLock()
+        self._limiters = limiters
+
+[docs]    def check_sleep_seconds(self, *args, **kwargs):
+        with self._lock:
+            return max(
+                limiter.check_sleep_seconds(*args, **kwargs)
+                for limiter in self._limiters
+            )
+
+[docs]    def add_call_history(self, *args, **kwargs):
+        with self._lock:
+            for limiter in self._limiters:
+                limiter.add_call_history(*args, **kwargs)
+
+[docs]    def sleep_if_necessary(self, *args, **kwargs):
+        with self._lock:
+            sleep_seconds = self.check_sleep_seconds(*args, **kwargs)
+            if sleep_seconds > 0:
+                time.sleep(sleep_seconds)
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/utils/rate_limiting/pyside2/QRateLimitedExecutor.html b/_modules/koapy/utils/rate_limiting/pyside2/QRateLimitedExecutor.html new file mode 100644 index 00000000..84deab4b --- /dev/null +++ b/_modules/koapy/utils/rate_limiting/pyside2/QRateLimitedExecutor.html @@ -0,0 +1,296 @@ + + + + + + + + koapy.utils.rate_limiting.pyside2.QRateLimitedExecutor — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.utils.rate_limiting.pyside2.QRateLimitedExecutor

+import atexit
+import functools
+import queue
+
+from concurrent.futures import Executor, Future
+from queue import Queue
+from threading import RLock
+from typing import Any, Callable, Dict, List, Optional, Tuple, Union
+
+from koapy.compat.pyside2.QtCore import QObject, Qt, Signal
+from koapy.utils.logging.pyside2.QThreadLogging import QThreadLogging
+from koapy.utils.rate_limiting.RateLimiter import RateLimiter
+
+
+[docs]class QRateLimitedExecutorRunnable:
+    def __init__(
+        self,
+        limiter: RateLimiter,
+        future: Future,
+        fn: Callable[..., Any],
+        args: Union[Tuple[Any], List[Any]],
+        kwargs: Dict[str, Any],
+    ):
+        self._limiter = limiter
+        self._future = future
+        self._fn = fn
+        self._args = args
+        self._kwargs = kwargs
+
+[docs]    def check_sleep_seconds(self):
+        return self._limiter.check_sleep_seconds(self._fn, *self._args, **self._kwargs)
+
+[docs]    def add_call_history(self):
+        return self._limiter.add_call_history(self._fn, *self._args, **self._kwargs)
+
+[docs]    def sleep_if_necessary(self):
+        return self._limiter.sleep_if_necessary(self._fn, *self._args, **self._kwargs)
+
+[docs]    def run(self):
+        if not self._future.set_running_or_notify_cancel():
+            return
+        try:
+            self.add_call_history()
+            result = self._fn(*self._args, **self._kwargs)
+        except BaseException as exc:  # pylint: disable=broad-except
+            self._future.set_exception(exc)
+            # break a reference cycle with the exception 'exc'
+            self = None  # pylint: disable=self-cls-assignment
+        else:
+            self._future.set_result(result)
+
+[docs]    def cancel(self):
+        return self._future.cancel()
+
+[docs]    def result(self):
+        return self._future.result()
+
+
+[docs]class QRateLimitedExecutorDecoratedFunction:
+    def __init__(self, func, limiter: RateLimiter, executor: Executor):
+        self._func = func
+        self._limiter = limiter
+        self._executor = executor
+
+        functools.update_wrapper(self, func)
+        self._func_limited = self._limiter.wrap(self._func)
+
+[docs]    def call(self, *args, **kwargs):
+        return self._func_limited(*args, **kwargs)
+
+[docs]    def async_call(self, *args, **kwargs):
+        return self._executor.submit(self._func, *args, **kwargs)
+
+    def __call__(self, *args, **kwargs):
+        return self.call(*args, **kwargs)
+
+
+[docs]class QRateLimitedExecutor(QThreadLogging, Executor):
+
+[docs]    readyRunnable = Signal(QRateLimitedExecutorRunnable)
+
+    def __init__(self, limiter: RateLimiter, parent: Optional[QObject] = None):
+        QThreadLogging.__init__(self, parent)
+        Executor.__init__(self)
+
+        self._limiter = limiter
+        self._parent = parent
+
+        self._runnable_queue: Queue = Queue()
+        self._sentinel = object()
+
+        self._shutdown = False
+        self._shutdown_lock = RLock()
+
+        self.readyRunnable.connect(self.onReadyRunnable, Qt.QueuedConnection)
+
+        atexit.register(self.shutdown)
+
+    def __del__(self):
+        atexit.unregister(self.shutdown)
+
+[docs]    def run(self):
+        while True:
+            runnable = self._runnable_queue.get()
+            if runnable is not self._sentinel:
+                runnable.sleep_if_necessary()
+                self.readyRunnable.emit(runnable)
+                try:
+                    runnable.result()  # wait until the emitted runnable finishes
+                except:  # pylint: disable=bare-except
+                    pass
+                del runnable
+                continue
+            if self._shutdown:
+                return
+
+[docs]    def onReadyRunnable(self, runnable: QRateLimitedExecutorRunnable):
+        runnable.run()
+
+[docs]    def submit(
+        self, fn: Callable[..., Any], *args, **kwargs
+    ):  # pylint: disable=arguments-differ
+        with self._shutdown_lock:
+            if self._shutdown:
+                raise RuntimeError("Cannot schedule new futures after shutdown")
+            future = Future()
+            runnable = QRateLimitedExecutorRunnable(
+                self._limiter, future, fn, args, kwargs
+            )
+            self._runnable_queue.put(runnable)
+            return future
+
+[docs]    def shutdown(
+        self, wait: bool = True, cancel_futures: bool = False
+    ):  # pylint: disable=arguments-differ
+        with self._shutdown_lock:
+            self._shutdown = True
+            if cancel_futures:
+                while True:
+                    try:
+                        runnable = self._runnable_queue.get_nowait()
+                    except queue.Empty:
+                        break
+                    if runnable is not self._sentinel:
+                        runnable.cancel()
+            self._runnable_queue.put(self._sentinel)
+        if wait:
+            self.wait()
+
+[docs]    def wrap(self, func: Callable[..., Any]):
+        return QRateLimitedExecutorDecoratedFunction(func, self._limiter, self)
+
+    def __call__(self, func: Callable[..., Any]):
+        return self.wrap(func)
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/utils/recursion.html b/_modules/koapy/utils/recursion.html new file mode 100644 index 00000000..e9d45db8 --- /dev/null +++ b/_modules/koapy/utils/recursion.html @@ -0,0 +1,190 @@ + + + + + + + + koapy.utils.recursion — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.utils.recursion

+"""
+"""
+
+"""
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to <http://unlicense.org/>
+"""
+
+# https://github.com/andrewp-as-is/recursion-detect.py
+
+import inspect
+
+
+[docs]def depth():
+    """return recursion depth. 0 if no recursion"""
+    counter = 0
+    frames = inspect.getouterframes(inspect.currentframe())[1:]
+    top_frame = inspect.getframeinfo(frames[0][0])
+    for frame, _, _, _, _, _ in frames[1:]:
+        (path, line_number, func_name, lines, index) = inspect.getframeinfo(frame)
+        if path == top_frame[0] and func_name == top_frame[2]:
+            counter += 1
+    return counter
+
+
+__all__ = ["depth"]
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/utils/serialization.html b/_modules/koapy/utils/serialization.html new file mode 100644 index 00000000..023a6582 --- /dev/null +++ b/_modules/koapy/utils/serialization.html @@ -0,0 +1,184 @@ + + + + + + + + koapy.utils.serialization — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.utils.serialization

+import io
+import json
+import os
+
+
+[docs]class JsonSerializable:
+[docs]    def to_dict(self):
+        return dict(self.__dict__)
+
+    @classmethod
+[docs]    def from_dict(cls, dic):
+        output = cls()
+        for name in output.__dict__:
+            setattr(output, name, dic.get(name))
+        return output
+
+[docs]    def to_json(self, f=None, encoding=None):
+        if f is None:
+            return json.dumps(self.to_dict())
+        elif isinstance(f, str):
+            with open(f, "w", encoding=encoding) as f:
+                return json.dump(self.to_dict(), f)
+        elif isinstance(f, io.TextIOBase):
+            return json.dump(self.to_dict(), f)
+        else:
+            raise ValueError("Unsupported argument type: %s" % type(f))
+
+    @classmethod
+[docs]    def from_json(cls, jsn, encoding=None):
+        if isinstance(jsn, str):
+            if jsn.startswith("{") and jsn.endswith("}"):
+                dic = json.loads(jsn)
+            elif os.path.exists(jsn):
+                with open(jsn, "r", encoding=encoding) as f:
+                    dic = json.load(f)
+            else:
+                dic = json.loads(jsn)
+        elif isinstance(jsn, io.TextIOBase):
+            dic = json.load(jsn)
+        else:
+            raise ValueError("Unsupported argument type: %s" % type(jsn))
+        return cls.from_dict(dic)
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/utils/store/SQLiteFileLibrary.html b/_modules/koapy/utils/store/SQLiteFileLibrary.html new file mode 100644 index 00000000..05ad44ca --- /dev/null +++ b/_modules/koapy/utils/store/SQLiteFileLibrary.html @@ -0,0 +1,283 @@ + + + + + + + + koapy.utils.store.SQLiteFileLibrary — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.utils.store.SQLiteFileLibrary

+import pandas as pd
+import pytz
+
+from sqlalchemy import create_engine, inspect, select
+from sqlalchemy.schema import DropTable, MetaData, Table
+
+from .sqlalchemy.Timestamp import Timestamp
+
+
+[docs]class SQLiteFileLibrary:
+    def __init__(self, filename):
+        self._engine = create_engine("sqlite:///" + filename)
+        self._inspector = inspect(self._engine)
+
+[docs]    def list_symbols(self):
+        return self._inspector.get_table_names()
+
+[docs]    def has_symbol(self, symbol):
+        return self._inspector.has_table(symbol)
+
+[docs]    def write(self, symbol, data):
+        index_original_names = [name for name in data.index.names]
+        index_table_names = [
+            name if name is not None else "index_%d" % i
+            for i, name in enumerate(data.index.names)
+        ]
+
+        datetime_columns = [
+            (name, dtype)
+            for name, dtype in data.dtypes.items()
+            if pd.api.types.is_datetime64_any_dtype(dtype)
+        ]
+        column_timezones = {
+            name: str(dtype.tz)
+            for name, dtype in datetime_columns
+            if hasattr(dtype, "tz")
+        }
+
+        index_label = index_table_names
+        dtype = {
+            name: Timestamp(getattr(dtype, "tz", False))
+            for name, dtype in datetime_columns
+        }
+
+        index_col = index_table_names
+        parse_dates = [name for name, dtype in datetime_columns]
+
+        pandas_metadata = {
+            "read_sql_table": {
+                "index_col": index_col,
+                "parse_dates": parse_dates,
+                "index_names": index_original_names,
+                "column_timezones": column_timezones,
+            },
+        }
+
+        to_sql_kwargs = {
+            "index_label": index_label,
+            "dtype": dtype,
+            "if_exists": "replace",
+        }
+        data.to_sql(symbol, self._engine, **to_sql_kwargs)
+
+        return data
+
+[docs]    def read_as_dataframe(
+        self, symbol, time_column=None, start_time=None, end_time=None
+    ):
+        index_col = ["Date"]
+        parse_dates = ["Date"]
+        read_sql_table_kwargs = {
+            "index_col": index_col,
+            "parse_dates": parse_dates,
+        }
+        data = pd.read_sql_table(symbol, self._engine, **read_sql_table_kwargs)
+        index_names = index_col
+        index_names = tuple(index_names)
+        if len(data.index.names) == 1:
+            index_names = index_names[0]
+        data.index.rename(index_names, inplace=True)
+        column_timezones = {}
+        for column_name in parse_dates:
+            timezone = column_timezones.get(column_name, Timestamp.local_timezone)
+            if isinstance(timezone, str):
+                timezone = pytz.timezone(timezone)
+            data[column_name] = (
+                data[column_name].dt.tz_localize(Timestamp.utc).dt.tz_convert(timezone)
+            )
+            if column_name not in column_timezones:
+                data[column_name] = data[column_name].dt.tz_localize(None)
+        return data
+
+[docs]    def read_as_cursor(self, symbol, time_column=None, start_time=None, end_time=None):
+        records = Table(symbol, MetaData(), autoload_with=self._engine)
+        statement = select(records)
+
+        if time_column is not None:
+            time_column = records.columns[
+                time_column
+            ]  # pylint: disable=unsubscriptable-object
+            statement = statement.order_by(time_column)
+
+        if start_time is not None:
+            start_time = pd.Timestamp(start_time)
+            if time_column is None:
+                time_column = 0
+                time_column = records.columns[
+                    time_column
+                ]  # pylint: disable=unsubscriptable-object
+                statement = statement.order_by(time_column)
+            if Timestamp.is_naive(start_time):
+                start_time = start_time.tz_localize(Timestamp.local_timezone)
+            start_time = start_time.astimezone(Timestamp.utc)
+            statement = statement.where(
+                time_column >= start_time
+            )  # pylint: disable=unsubscriptable-object
+
+        if end_time is not None:
+            end_time = pd.Timestamp(end_time)
+            if time_column is None:
+                time_column = 0
+                time_column = records.columns[
+                    time_column
+                ]  # pylint: disable=unsubscriptable-object
+                statement = statement.order_by(time_column)
+            if Timestamp.is_naive(end_time):
+                end_time = end_time.tz_localize(Timestamp.local_timezone)
+            end_time = end_time.astimezone(Timestamp.utc)
+            statement = statement.where(
+                time_column <= end_time
+            )  # pylint: disable=unsubscriptable-object
+
+        data = self._engine.execute(statement)
+        return data
+
+[docs]    def read(self, *args, **kwargs):
+        return self.read_as_dataframe(*args, **kwargs)
+
+[docs]    def delete(self, symbol):
+        table = Table(symbol, MetaData(), autoload_with=self._engine)
+        self._engine.execute(DropTable(table), if_exists=True)
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/utils/store/SQLiteStore.html b/_modules/koapy/utils/store/SQLiteStore.html new file mode 100644 index 00000000..88d8f4e9 --- /dev/null +++ b/_modules/koapy/utils/store/SQLiteStore.html @@ -0,0 +1,224 @@ + + + + + + + + koapy.utils.store.SQLiteStore — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.utils.store.SQLiteStore

+from sqlalchemy import create_engine, inspect
+
+from .sqlalchemy.Base import Base
+from .sqlalchemy.Library import Library
+from .sqlalchemy.Session import Session
+from .SQLiteStoreLibrary import SQLiteStoreLibrary
+
+
+[docs]class SQLiteStore:
+    def __init__(self, filename):
+        self._filename = filename
+        self._engine = create_engine("sqlite:///" + self._filename)
+
+        Session.configure(bind=self._engine)
+
+        inspector = inspect(self._engine)
+        table_names = inspector.get_table_names()
+
+        if len(table_names) == 0:
+            Base.metadata.create_all(self._engine)
+            inspector = inspect(self._engine)
+            table_names = inspector.get_table_names()
+
+        assert all(table_name in table_names for table_name in Base.metadata.tables)
+
+        self._session = Session()
+        self._library_cache = {}
+
+[docs]    def list_libraries(self):
+        libraries = self._session.query(Library).all()
+        libraries = [library.name for library in libraries]
+        return libraries
+
+    def _get_library(self, library):
+        library = self._session.query(Library).filter(Library.name == library).one()
+        return library
+
+[docs]    def library_exists(self, library):
+        try:
+            _library = self._get_library(library)
+            return True
+        except:
+            return False
+
+[docs]    def initialize_library(self, library):
+        library_name = library
+        if not self.library_exists(library_name):
+            library = Library(name=library_name)
+            try:
+                self._session.add(library)
+                self._session.commit()
+            except:
+                self._session.rollback()
+                raise
+
+[docs]    def get_library(self, library):
+        library_name = library
+        if library_name in self._library_cache:
+            return self._library_cache[library_name]
+        library = self._get_library(library)
+        library = SQLiteStoreLibrary(self, library)
+        self._library_cache[library_name] = library
+        return library
+
+[docs]    def get_or_create_library(self, library):
+        if not self.library_exists(library):
+            self.initialize_library(library)
+        library = self.get_library(library)
+        return library
+
+[docs]    def delete_library(self, library):
+        library_name = library
+        library = self._get_library(library_name)
+        try:
+            library.delete()
+            self._session.commit()
+        except:
+            self._session.rollback()
+            raise
+
+    def __getitem__(self, library):
+        return self.get_library(library)
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/utils/store/SQLiteStoreLibrary.html b/_modules/koapy/utils/store/SQLiteStoreLibrary.html new file mode 100644 index 00000000..38c77e08 --- /dev/null +++ b/_modules/koapy/utils/store/SQLiteStoreLibrary.html @@ -0,0 +1,454 @@ + + + + + + + + koapy.utils.store.SQLiteStoreLibrary — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.utils.store.SQLiteStoreLibrary

+import hashlib
+
+import pandas as pd
+import pytz
+
+from sqlalchemy import select
+from sqlalchemy.orm.exc import NoResultFound
+from sqlalchemy.schema import MetaData, Table
+
+from .misc.VersionedItem import VersionedItem
+from .sqlalchemy.Timestamp import Timestamp
+
+
+[docs]class SQLiteStoreLibrary:
+    def __init__(self, store, library):
+        self._store = store
+        self._library = library
+
+        self._engine = self._store._engine
+        self._session = self._store._session
+
+[docs]    def list_symbols(self, all_symbols=False, snapshot=None):
+        if snapshot is not None:
+            snapshot = self._library.get_snapshot(snapshot)
+            symbols = snapshot.get_symbols()
+        else:
+            symbols = self._library.get_symbols(deleted=all_symbols)
+        symbols = [symbol.name for symbol in symbols]
+        return symbols
+
+[docs]    def has_symbol(self, symbol):
+        try:
+            _symbol = self._library.get_symbol(symbol)
+            return True
+        except NoResultFound:
+            return False
+
+[docs]    def list_versions(self, symbol=None, snapshot=None, latest_only=False):
+        if symbol is not None:
+            symbol = self._library.get_symbol(symbol)
+            versions = symbol.get_versions()
+        elif snapshot is not None:
+            snapshot = self._library.get_snapshot(snapshot)
+            versions = snapshot.get_versions()
+        elif latest_only:
+            versions = self._library.get_latest_versions()
+        else:
+            versions = self._library.get_versions()
+        versions = [
+            {
+                "symbol": version.symbol.name,
+                "version": version.version,
+                "deleted": version.deleted,
+                "timestamp": version.timestamp,
+                "snapshots": [snapshot.name for snapshot in version.get_snapshots()],
+            }
+            for version in versions
+        ]
+        return versions
+
+    def _hash_data(self, data):
+        return hashlib.sha256(
+            pd.util.hash_pandas_object(data).values.tobytes()
+        ).hexdigest()
+
+[docs]    def write(self, symbol, data, metadata=None, prune_previous_version=True, **kwargs):
+        symbol_name = symbol
+        try:
+            symbol = self._library.get_or_create_symbol(symbol_name)
+
+            if data is None:
+                _version = symbol.create_new_version(
+                    user_metadata=metadata, deleted=metadata and metadata.get("deleted")
+                )
+                self._session.commit()
+            else:
+                index_original_names = [name for name in data.index.names]
+                index_table_names = [
+                    name if name is not None else "index_%d" % i
+                    for i, name in enumerate(data.index.names)
+                ]
+
+                datetime_columns = [
+                    (name, dtype)
+                    for name, dtype in data.dtypes.items()
+                    if pd.api.types.is_datetime64_any_dtype(dtype)
+                ]
+                column_timezones = {
+                    name: str(dtype.tz)
+                    for name, dtype in datetime_columns
+                    if hasattr(dtype, "tz")
+                }
+
+                index_label = index_table_names
+                dtype = {
+                    name: Timestamp(getattr(dtype, "tz", False))
+                    for name, dtype in datetime_columns
+                }
+
+                index_col = index_table_names
+                parse_dates = [name for name, dtype in datetime_columns]
+
+                pandas_metadata = {
+                    "read_sql_table": {
+                        "index_col": index_col,
+                        "parse_dates": parse_dates,
+                        "index_names": index_original_names,
+                        "column_timezones": column_timezones,
+                    },
+                }
+
+                table_name = self._hash_data(data)
+                _version = symbol.create_new_version(
+                    table_name=table_name,
+                    user_metadata=metadata,
+                    pandas_metadata=pandas_metadata,
+                    deleted=metadata and metadata.get("deleted"),
+                )
+                self._session.commit()
+
+                to_sql_kwargs = {
+                    "index_label": index_label,
+                    "dtype": dtype,
+                    "if_exists": "replace",
+                }
+                data.to_sql(table_name, self._engine, **to_sql_kwargs)
+        except:
+            self._session.rollback()
+            raise
+
+        if prune_previous_version:
+            self._prune_previous_versions(symbol_name, **kwargs)
+
+        return self.read(symbol_name)
+
+    def _get_version(self, symbol, as_of=None):
+        symbol_name = symbol
+        symbol = self._library.get_symbol(symbol_name)
+
+        if as_of is None:
+            version = symbol.get_latest_version()
+        elif isinstance(as_of, int):
+            version = symbol.get_version_by_number(as_of)
+        elif isinstance(as_of, str):
+            snapshot = self._library.get_snapshot(as_of)
+            version = snapshot.get_version_of_symbol(symbol)
+        else:
+            raise ValueError("Invalid as_of argument")
+
+        return version
+
+[docs]    def read_as_dataframe(
+        self, symbol, as_of=None, time_column=None, start_time=None, end_time=None
+    ):
+        symbol_name = symbol
+        version = self._get_version(symbol_name, as_of)
+
+        data = None
+
+        if version.table_name is not None:
+            read_sql_table_kwargs = {
+                "index_col": version.pandas_metadata["read_sql_table"]["index_col"],
+                "parse_dates": version.pandas_metadata["read_sql_table"]["parse_dates"],
+            }
+            data = pd.read_sql_table(
+                version.table_name, self._engine, **read_sql_table_kwargs
+            )
+            index_names = version.pandas_metadata["read_sql_table"]["index_names"]
+            index_names = tuple(index_names)
+            if len(data.index.names) == 1:
+                index_names = index_names[0]
+            data.index.rename(index_names, inplace=True)  # pylint: disable=no-member
+            column_timezones = version.pandas_metadata["read_sql_table"][
+                "column_timezones"
+            ]
+            for column_name in version.pandas_metadata["read_sql_table"]["parse_dates"]:
+                timezone = column_timezones.get(column_name, Timestamp.local_timezone)
+                if isinstance(timezone, str):
+                    timezone = pytz.timezone(timezone)
+                data[column_name] = (
+                    data[column_name]
+                    .dt.tz_localize(Timestamp.utc)
+                    .dt.tz_convert(timezone)
+                )
+                if column_name not in column_timezones:
+                    data[column_name] = data[column_name].dt.tz_localize(None)
+
+        return VersionedItem(
+            self._library.name,
+            symbol_name,
+            version.version,
+            version.timestamp,
+            data,
+            version.user_metadata,
+        )
+
+[docs]    def read_as_cursor(
+        self, symbol, as_of=None, time_column=None, start_time=None, end_time=None
+    ):
+        symbol_name = symbol
+        version = self._get_version(symbol_name, as_of)
+
+        cursor = None
+
+        if version.table_name is not None:
+            records = Table(version.table_name, MetaData(), autoload_with=self._engine)
+            statement = select(records)
+
+            if time_column is not None:
+                time_column = records.columns[
+                    time_column
+                ]  # pylint: disable=unsubscriptable-object
+                statement = statement.order_by(time_column)
+
+            if start_time is not None:
+                start_time = pd.Timestamp(start_time)
+                if time_column is None:
+                    time_column = 0
+                    time_column = records.columns[
+                        time_column
+                    ]  # pylint: disable=unsubscriptable-object
+                    statement = statement.order_by(time_column)
+                if Timestamp.is_naive(start_time):
+                    start_time = start_time.tz_localize(Timestamp.local_timezone)
+                start_time = start_time.astimezone(Timestamp.utc)
+                statement = statement.where(
+                    time_column >= start_time
+                )  # pylint: disable=unsubscriptable-object
+
+            if end_time is not None:
+                end_time = pd.Timestamp(end_time)
+                if time_column is None:
+                    time_column = 0
+                    time_column = records.columns[
+                        time_column
+                    ]  # pylint: disable=unsubscriptable-object
+                    statement = statement.order_by(time_column)
+                if Timestamp.is_naive(end_time):
+                    end_time = end_time.tz_localize(Timestamp.local_timezone)
+                end_time = end_time.astimezone(Timestamp.utc)
+                statement = statement.where(
+                    time_column <= end_time
+                )  # pylint: disable=unsubscriptable-object
+
+            statement = statement.execution_options(stream_results=True)
+
+            cursor = self._session.execute(statement)
+
+        return VersionedItem(
+            self._library.name,
+            symbol_name,
+            version.version,
+            version.timestamp,
+            cursor,
+            version.user_metadata,
+        )
+
+[docs]    def read(self, *args, **kwargs):
+        return self.read_as_dataframe(*args, **kwargs)
+
+    def _prune_previous_versions(self, symbol, keep_mins=120):
+        symbol_name = symbol
+        symbol = self._library.get_symbol(symbol_name)
+        prunable_verions = symbol.get_prunable_versions(keep_mins)
+        try:
+            for version in prunable_verions:
+                version.delete()
+            self._session.commit()
+        except:
+            self._session.rollback()
+            raise
+
+    def _delete_version(self, symbol, version):
+        symbol = self._library.get_symbol(symbol)
+        version = symbol.get_version_by_number(version, deleted=True)
+        try:
+            version.delete()
+            self._session.commit()
+        except:
+            self._session.rollback()
+            raise
+
+[docs]    def delete(self, symbol):
+        symbol_name = symbol
+        symbol = self._library.get_symbol(symbol_name)
+        _sentinel = self.write(
+            symbol_name, None, prune_previous_version=False, metadata={"deleted": True}
+        )
+        self._prune_previous_versions(symbol_name, 0)
+        assert not self.has_symbol(symbol_name)
+
+[docs]    def list_snapshots(self):
+        snapshots = self._library.snapshots
+        snapshots = [snapshot.name for snapshot in snapshots]
+        return snapshots
+
+[docs]    def snapshot(self, snapshot):
+        try:
+            self._library.create_snapshot(snapshot)
+            self._session.commit()
+        except:
+            self._session.rollback()
+            raise
+
+[docs]    def delete_snapshot(self, snapshot):
+        snapshot = self._library.get_snapshot(snapshot)
+        try:
+            snapshot.delete()
+            self._session.commit()
+        except:
+            self._session.rollback()
+            raise
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/utils/store/misc/VersionedItem.html b/_modules/koapy/utils/store/misc/VersionedItem.html new file mode 100644 index 00000000..58af9d29 --- /dev/null +++ b/_modules/koapy/utils/store/misc/VersionedItem.html @@ -0,0 +1,162 @@ + + + + + + + + koapy.utils.store.misc.VersionedItem — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.utils.store.misc.VersionedItem

+[docs]class VersionedItem:
+    def __init__(self, library, symbol, version, timestamp, data, metadata):
+        self.library = library
+        self.symbol = symbol
+        self.version = version
+        self.timestamp = timestamp
+        self.data = data
+        self.metadata = metadata
+
+    def __repr__(self):
+        return "<VersionedItem(library={!r}, symbol={!r}, version={!r}, timestamp='{}', data=<{}.{} at {}>, metadata={!r})>".format(
+            self.library,
+            self.symbol,
+            self.version,
+            self.timestamp,
+            type(self.data).__module__,
+            type(self.data).__name__,
+            hex(id(self.data)),
+            self.metadata,
+        )
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/utils/store/sqlalchemy/Base.html b/_modules/koapy/utils/store/sqlalchemy/Base.html new file mode 100644 index 00000000..cc55c189 --- /dev/null +++ b/_modules/koapy/utils/store/sqlalchemy/Base.html @@ -0,0 +1,145 @@ + + + + + + + + koapy.utils.store.sqlalchemy.Base — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.utils.store.sqlalchemy.Base

+from sqlalchemy.orm import declarative_base
+
+[docs]Base = declarative_base()
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/utils/store/sqlalchemy/Library.html b/_modules/koapy/utils/store/sqlalchemy/Library.html new file mode 100644 index 00000000..76b55cbc --- /dev/null +++ b/_modules/koapy/utils/store/sqlalchemy/Library.html @@ -0,0 +1,271 @@ + + + + + + + + koapy.utils.store.sqlalchemy.Library — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.utils.store.sqlalchemy.Library

+from sqlalchemy import Column, Integer, String, func
+from sqlalchemy.orm import aliased, object_session, relationship
+from sqlalchemy.orm.exc import NoResultFound
+
+from .Base import Base
+from .Snapshot import Snapshot
+from .SnapshotAssociation import SnapshotAssociation
+from .Symbol import Symbol
+from .Version import Version
+
+
+[docs]class Library(Base):
+    __tablename__ = "libraries"
+
+[docs]    id = Column(Integer, primary_key=True)
+[docs]    name = Column(String, unique=True, index=True, nullable=False)
+
+[docs]    symbols = relationship("Symbol", back_populates="library")
+[docs]    snapshots = relationship("Snapshot", back_populates="library")
+
+[docs]    def get_symbol(self, symbol, deleted=False):
+        symbol_name = symbol
+        session = object_session(self)
+        symbol = (
+            session.query(Symbol).with_parent(self).filter(Symbol.name == symbol_name)
+        )
+        symbol = symbol.one()
+        if not deleted:
+            _version = symbol.get_latest_version()
+        return symbol
+
+[docs]    def get_or_create_symbol(self, symbol):
+        symbol_name = symbol
+        try:
+            symbol = self.get_symbol(symbol_name, deleted=True)
+        except NoResultFound:
+            symbol = Symbol(name=symbol_name)
+            self.symbols.append(symbol)
+        return symbol
+
+[docs]    def get_symbols(self, deleted=False):
+        if deleted:
+            return self.symbols
+
+        session = object_session(self)
+
+        symbols = session.query(Symbol).with_parent(self)
+
+        versions = session.query(Version, func.max(Version.version)).group_by(
+            Version.symbol_id
+        )
+        version = aliased(Version, alias=versions.subquery())
+        versions = session.query(version)
+
+        if not deleted:
+            versions = versions.filter(version.deleted != True)
+
+        symbols = symbols.join(versions.subquery())
+        symbols = symbols.all()
+        return symbols
+
+[docs]    def get_versions(self, deleted=False):
+        session = object_session(self)
+
+        symbols = session.query(Symbol).with_parent(self)
+        versions = session.query(Version).join(symbols.subquery())
+
+        if not deleted:
+            versions = versions.filter(Version.deleted != True)
+
+        versions = versions.all()
+        return versions
+
+[docs]    def get_latest_versions(self, deleted=False):
+        session = object_session(self)
+
+        symbols = session.query(Symbol).with_parent(self)
+
+        versions = session.query(Version, func.max(Version.version)).group_by(
+            Version.symbol_id
+        )
+        version = aliased(Version, alias=versions.subquery())
+        versions = session.query(version)
+
+        if not deleted:
+            versions = versions.filter(version.deleted != True)
+
+        versions = versions.join(symbols.subquery())
+        versions = versions.all()
+        return versions
+
+[docs]    def get_snapshot(self, snapshot):
+        snapshot_name = snapshot
+        session = object_session(self)
+        snapshot = (
+            session.query(Snapshot)
+            .with_parent(self)
+            .filter(Snapshot.name == snapshot_name)
+            .one()
+        )
+        return snapshot
+
+[docs]    def create_snapshot(self, snapshot):
+        snapshot_name = snapshot
+        snapshot = Snapshot(name=snapshot_name)
+
+        versions = self.get_latest_versions()
+        associations = [SnapshotAssociation(version=version) for version in versions]
+        snapshot.versions.extend(associations)
+
+        self.snapshots.append(snapshot)
+        return snapshot
+
+[docs]    def delete(self):
+        session = object_session(self)
+
+        symbols = session.query(Symbol).with_parent(self)
+        versions = session.query(Version).join(symbols)
+
+        snapshots = session.query(Snapshot).with_parent(self)
+        associations = session.query(SnapshotAssociation).join(snapshots)
+
+        associations.delete()
+        snapshots.delete()
+
+        versions.delete()
+        symbols.delete()
+
+        session.delete(self)
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/utils/store/sqlalchemy/Session.html b/_modules/koapy/utils/store/sqlalchemy/Session.html new file mode 100644 index 00000000..78e4aaeb --- /dev/null +++ b/_modules/koapy/utils/store/sqlalchemy/Session.html @@ -0,0 +1,145 @@ + + + + + + + + koapy.utils.store.sqlalchemy.Session — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.utils.store.sqlalchemy.Session

+from sqlalchemy.orm import sessionmaker
+
+[docs]Session = sessionmaker()
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/utils/store/sqlalchemy/Snapshot.html b/_modules/koapy/utils/store/sqlalchemy/Snapshot.html new file mode 100644 index 00000000..6e1b3589 --- /dev/null +++ b/_modules/koapy/utils/store/sqlalchemy/Snapshot.html @@ -0,0 +1,205 @@ + + + + + + + + koapy.utils.store.sqlalchemy.Snapshot — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.utils.store.sqlalchemy.Snapshot

+from sqlalchemy import Column, ForeignKey, Integer, String, UniqueConstraint
+from sqlalchemy.orm import object_session, relationship
+from sqlalchemy.sql.functions import current_timestamp
+
+from .Base import Base
+from .SnapshotAssociation import SnapshotAssociation
+from .Symbol import Symbol
+from .Timestamp import Timestamp
+from .Version import Version
+
+
+[docs]class Snapshot(Base):
+    __tablename__ = "snapshots"
+
+[docs]    id = Column(Integer, primary_key=True)
+[docs]    name = Column(String, index=True, nullable=False)
+
+[docs]    timestamp = Column(Timestamp(timezone=True), server_default=current_timestamp())
+
+[docs]    library_id = Column(Integer, ForeignKey("libraries.id"), nullable=False)
+[docs]    library = relationship("Library", back_populates="snapshots")
+
+[docs]    versions = relationship("SnapshotAssociation", back_populates="snapshot")
+
+    __table_args__ = (UniqueConstraint("library_id", "name"),)
+
+[docs]    def get_symbols(self):
+        session = object_session(self)
+        associations = session.query(SnapshotAssociation).with_parent(self)
+        versions = session.query(Version).join(associations.subquery())
+        symbols = session.query(Symbol).join(versions.subquery())
+        symbols = symbols.all()
+        return symbols
+
+[docs]    def get_versions(self):
+        session = object_session(self)
+        associations = session.query(SnapshotAssociation).with_parent(self)
+        versions = session.query(Version).join(associations.subquery())
+        versions = versions.all()
+        return versions
+
+[docs]    def get_version_of_symbol(self, symbol):
+        session = object_session(self)
+        if isinstance(symbol, str):
+            symbol = (
+                session.query(Symbol)
+                .filter(Symbol.library_id == self.library_id and Symbol.name == symbol)
+                .one()
+            )
+        associations = session.query(SnapshotAssociation).with_parent(self)
+        version = (
+            session.query(Version)
+            .with_parent(symbol)
+            .join(associations.subquery())
+            .one()
+        )
+        return version
+
+[docs]    def delete(self):
+        session = object_session(self)
+        associations = session.query(SnapshotAssociation).with_parent(self)
+        associations.delete()
+        session.delete(self)
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/utils/store/sqlalchemy/SnapshotAssociation.html b/_modules/koapy/utils/store/sqlalchemy/SnapshotAssociation.html new file mode 100644 index 00000000..e3982a9f --- /dev/null +++ b/_modules/koapy/utils/store/sqlalchemy/SnapshotAssociation.html @@ -0,0 +1,156 @@ + + + + + + + + koapy.utils.store.sqlalchemy.SnapshotAssociation — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.utils.store.sqlalchemy.SnapshotAssociation

+from sqlalchemy import Column, ForeignKey, Integer
+from sqlalchemy.orm import relationship
+
+from .Base import Base
+
+
+[docs]class SnapshotAssociation(Base):
+    __tablename__ = "snapshot_associations"
+
+[docs]    snapshot_id = Column(Integer, ForeignKey("snapshots.id"), primary_key=True)
+[docs]    version_id = Column(Integer, ForeignKey("versions.id"), primary_key=True)
+
+[docs]    snapshot = relationship("Snapshot", back_populates="versions")
+[docs]    version = relationship("Version", back_populates="snapshots")
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/utils/store/sqlalchemy/Symbol.html b/_modules/koapy/utils/store/sqlalchemy/Symbol.html new file mode 100644 index 00000000..2dae836e --- /dev/null +++ b/_modules/koapy/utils/store/sqlalchemy/Symbol.html @@ -0,0 +1,249 @@ + + + + + + + + koapy.utils.store.sqlalchemy.Symbol — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.utils.store.sqlalchemy.Symbol

+import pandas as pd
+
+from sqlalchemy import Column, ForeignKey, Integer, String, UniqueConstraint, func
+from sqlalchemy.orm import aliased, object_session, relationship
+from sqlalchemy.orm.exc import NoResultFound
+
+from .Base import Base
+from .SnapshotAssociation import SnapshotAssociation
+from .Version import Version
+
+
+[docs]class Symbol(Base):
+    __tablename__ = "symbols"
+
+[docs]    id = Column(Integer, primary_key=True)
+[docs]    name = Column(String, index=True, nullable=False)
+
+[docs]    library_id = Column(Integer, ForeignKey("libraries.id"), nullable=False)
+[docs]    library = relationship("Library", back_populates="symbols")
+
+[docs]    versions = relationship(
+        "Version", back_populates="symbol", order_by="Version.version"
+    )
+
+    __table_args__ = (UniqueConstraint("library_id", "name"),)
+
+[docs]    def get_versions(self, deleted=False):
+        """
+        versions = self.versions
+        if not deleted:
+            versions = [version for version in versions if not version.deleted]
+        """
+        session = object_session(self)
+        versions = session.query(Version).with_parent(self)
+        version = aliased(Version, alias=versions.subquery())
+        versions = session.query(version)
+        if not deleted:
+            versions = versions.filter(version.deleted != True)
+        versions = versions.order_by(version.version)
+        versions = versions.all()
+        return versions
+
+[docs]    def get_latest_version(self, deleted=False):
+        """
+        versions = self.versions
+        if len(versions) == 0:
+            raise NoResultFound
+        latest_version = self.versions[-1]
+        if not deleted and latest_version.deleted:
+            raise NoResultFound
+        """
+        session = object_session(self)
+        latest_version = session.query(Version, func.max(Version.version)).with_parent(
+            self
+        )
+        version = aliased(Version, alias=latest_version.subquery())
+        latest_version = session.query(version)
+        if not deleted:
+            latest_version = latest_version.filter(version.deleted != True)
+        latest_version = latest_version.one()
+        return latest_version
+
+[docs]    def create_new_version(
+        self, table_name=None, user_metadata=None, pandas_metadata=None, deleted=None
+    ):
+        try:
+            latest_version = self.get_latest_version()
+        except NoResultFound:
+            next_version = 0
+        else:
+            next_version = latest_version.version + 1
+        new_version = Version(
+            version=next_version,
+            table_name=table_name,
+            user_metadata=user_metadata,
+            pandas_metadata=pandas_metadata,
+            deleted=deleted,
+        )
+        self.versions.append(new_version)
+        return new_version
+
+[docs]    def get_version_by_number(self, version_number, deleted=False):
+        session = object_session(self)
+        version = (
+            session.query(Version)
+            .with_parent(self)
+            .filter(Version.version == version_number)
+        )
+        if not deleted:
+            version = version.filter(Version.deleted != True)
+        version = version.one()
+        return version
+
+[docs]    def get_prunable_versions(self, keep_mins=120):
+        session = object_session(self)
+        versions = session.query(Version).with_parent(self)
+        latest_version = self.get_latest_version(deleted=True)
+        keep_mins_seconds = keep_mins * 60
+        latest_timestamp = latest_version.timestamp
+        oldest_timestamp = latest_timestamp - pd.Timedelta(keep_mins_seconds, unit="s")
+        prunable_verions = (
+            versions.outerjoin(SnapshotAssociation)
+            .filter(SnapshotAssociation.version_id == None)
+            .filter(Version.timestamp < oldest_timestamp)
+        )
+        prunable_verions = prunable_verions.all()
+        return prunable_verions
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/utils/store/sqlalchemy/Timestamp.html b/_modules/koapy/utils/store/sqlalchemy/Timestamp.html new file mode 100644 index 00000000..2d4345ac --- /dev/null +++ b/_modules/koapy/utils/store/sqlalchemy/Timestamp.html @@ -0,0 +1,189 @@ + + + + + + + + koapy.utils.store.sqlalchemy.Timestamp — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.utils.store.sqlalchemy.Timestamp

+import datetime
+import inspect
+
+import pytz
+
+from sqlalchemy import DateTime
+from sqlalchemy.types import TypeDecorator
+
+
+[docs]class Timestamp(TypeDecorator):  # pylint: disable=abstract-method
+
+[docs]    impl = DateTime
+[docs]    cache_ok = True
+
+[docs]    signature = inspect.signature(impl)
+
+[docs]    utc = datetime.timezone.utc
+[docs]    local_timezone = datetime.datetime.now().astimezone().tzinfo
+
+    def __init__(self, *args, **kwargs):
+        self._timezone = self.local_timezone
+        bound = self.signature.bind(*args, **kwargs)
+        bound.apply_defaults()
+        if bound.arguments["timezone"]:
+            if not isinstance(bound.arguments["timezone"], bool):
+                self._timezone = bound.arguments["timezone"]
+                bound.arguments["timezone"] = True
+                if isinstance(self._timezone, str):
+                    self._timezone = pytz.timezone(self._timezone)
+        super().__init__(*bound.args, **bound.kwargs)
+
+    @classmethod
+[docs]    def is_naive(cls, value):
+        return value.tzinfo is None or value.tzinfo.utcoffset(value) is None
+
+[docs]    def process_bind_param(self, value, dialect):
+        if self.is_naive(value):
+            value = value.replace(tzinfo=self.local_timezone)
+        return value.astimezone(self.utc)
+
+[docs]    def process_result_value(self, value, dialect):
+        if self.is_naive(value):
+            value = value.replace(tzinfo=self.utc)
+        value = value.astimezone(self._timezone)
+        if not self.timezone:
+            value = value.replace(tzinfo=None)
+        return value
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/utils/store/sqlalchemy/Version.html b/_modules/koapy/utils/store/sqlalchemy/Version.html new file mode 100644 index 00000000..bdae35ce --- /dev/null +++ b/_modules/koapy/utils/store/sqlalchemy/Version.html @@ -0,0 +1,204 @@ + + + + + + + + koapy.utils.store.sqlalchemy.Version — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.utils.store.sqlalchemy.Version

+from sqlalchemy import (
+    Boolean,
+    Column,
+    ForeignKey,
+    Integer,
+    PickleType,
+    String,
+    UniqueConstraint,
+)
+from sqlalchemy.orm import object_session, relationship
+from sqlalchemy.schema import DropTable, MetaData, Table
+from sqlalchemy.sql.functions import current_timestamp
+
+from .Base import Base
+from .Timestamp import Timestamp
+
+
+[docs]class Version(Base):
+    __tablename__ = "versions"
+
+[docs]    id = Column(Integer, primary_key=True)
+[docs]    version = Column(Integer, nullable=False)
+
+[docs]    table_name = Column(String)
+[docs]    user_metadata = Column(PickleType)
+[docs]    pandas_metadata = Column(PickleType)
+
+[docs]    deleted = Column(Boolean, default=False)
+
+[docs]    timestamp = Column(Timestamp(timezone=True), server_default=current_timestamp())
+
+[docs]    symbol_id = Column(Integer, ForeignKey("symbols.id"))
+[docs]    symbol = relationship("Symbol", back_populates="versions")
+
+[docs]    snapshots = relationship("SnapshotAssociation", back_populates="version")
+
+    __table_args__ = (UniqueConstraint("symbol_id", "version"),)
+
+[docs]    def get_snapshots(self):
+        # quick fix fir circular dependency
+        from .Snapshot import Snapshot
+        from .SnapshotAssociation import SnapshotAssociation
+
+        session = object_session(self)
+        snapshots = session.query(SnapshotAssociation).with_parent(self)
+        snapshots = session.query(Snapshot).join(snapshots.subquery())
+        snapshots = snapshots.all()
+        return snapshots
+
+[docs]    def delete(self):
+        session = object_session(self)
+        if self.table_name is not None:
+            table_reference_count = (
+                session.query(Version)
+                .filter(Version.table_name == self.table_name)
+                .count()
+            )
+            if table_reference_count <= 1:
+                session.execute(
+                    DropTable(Table(self.table_name, MetaData()), if_exists=True)
+                )
+        session.delete(self)
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/utils/subprocess.html b/_modules/koapy/utils/subprocess.html new file mode 100644 index 00000000..eaff76ff --- /dev/null +++ b/_modules/koapy/utils/subprocess.html @@ -0,0 +1,294 @@ + + + + + + + + koapy.utils.subprocess — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.utils.subprocess

+import inspect
+import subprocess
+import sys
+import textwrap
+
+from koapy.utils.logging import get_logger
+
+[docs]logger = get_logger(__name__)
+
+
+[docs]def function_to_script(func):
+    function_sig = inspect.signature(func)
+    assert all(
+        p.default != p.empty for p in function_sig.parameters
+    ), "Function should not require any parameters"
+
+    function_name = func.__name__
+    function_impl = inspect.getsource(func)
+    function_impl = textwrap.dedent(function_impl)
+
+    script = (
+        textwrap.dedent(
+            """
+    %s
+
+    if __name__ == '__main__':
+        %s()
+    """
+        )
+        % (function_impl, function_name)
+    )
+
+    return script
+
+
+[docs]def function_to_subprocess_args(func, executable=None):
+    if executable is None:
+        executable = sys.executable
+    script = function_to_script(func)
+    args = [executable, "-c", script]
+    return args
+
+
+[docs]def run_file(filename, *args, executable=None, **kwargs):
+    if executable is None:
+        executable = sys.executable
+    cmd = [executable, filename]
+    return subprocess.check_call(cmd, *args, **kwargs)
+
+
+[docs]def run_script(script, *args, executable=None, **kwargs):
+    if executable is None:
+        executable = sys.executable
+    cmd = [executable, "-c", script]
+    return subprocess.check_call(cmd, *args, **kwargs)
+
+
+[docs]def run_function(function, *args, executable=None, **kwargs):
+    script = function_to_script(function)
+    return run_script(script, *args, executable=executable, **kwargs)
+
+
+[docs]def quote(s):
+    return '"' + s.replace('"', '`"') + '"'
+
+
+[docs]def run_as_admin(cmd, cwd=None, check=True, wait=True):
+    import win32con
+    import win32event
+    import win32process
+
+    # pyright: reportMissingImports=false
+    # pylint: disable=import-error,no-name-in-module
+    from win32com.shell import shellcon
+    from win32com.shell.shell import ShellExecuteEx
+
+    kwargs = dict(
+        nShow=win32con.SW_SHOWNORMAL,
+        fMask=shellcon.SEE_MASK_NOCLOSEPROCESS,
+        lpVerb="runas",
+        lpFile=cmd[0],
+        lpParameters=" ".join(cmd[1:]),
+    )
+
+    if cwd is not None:
+        kwargs["lpDirectory"] = cwd
+
+    logger.info("Running command: %s", " ".join(cmd))
+    procInfo = ShellExecuteEx(**kwargs)
+
+    if check or wait:
+        procHandle = procInfo["hProcess"]
+        _ = win32event.WaitForSingleObject(procHandle, win32event.INFINITE)
+        rc = win32process.GetExitCodeProcess(procHandle)
+        logger.info("Process handle %s returned code %d", procHandle, rc)
+        if check and rc < 0:
+            raise subprocess.CalledProcessError(rc, cmd)
+    else:
+        rc = None
+
+    return rc
+
+
+[docs]def create_job_object_for_cleanup():
+    # https://stackoverflow.com/questions/23434842/python-how-to-kill-child-processes-when-parent-dies/23587108#23587108s
+    import win32job
+
+    jobAttributes = None
+    jobName = ""
+    hJob = win32job.CreateJobObject(jobAttributes, jobName)
+    extendedInfo = win32job.QueryInformationJobObject(
+        hJob, win32job.JobObjectExtendedLimitInformation
+    )
+    basicLimitInformation = extendedInfo["BasicLimitInformation"]
+    basicLimitInformation["LimitFlags"] = win32job.JOB_OBJECT_LIMIT_KILL_ON_JOB_CLOSE
+    win32job.SetInformationJobObject(
+        hJob,
+        win32job.JobObjectExtendedLimitInformation,
+        extendedInfo,
+    )
+    return hJob
+
+
+[docs]job_handle = create_job_object_for_cleanup()
+
+
+[docs]def make_process_die_when_parent_dies(pid):
+    assert pid != 0
+
+    # https://stackoverflow.com/questions/23434842/python-how-to-kill-child-processes-when-parent-dies/23587108#23587108s
+    import win32api
+    import win32con
+    import win32job
+
+    desiredAccess = win32con.PROCESS_TERMINATE | win32con.PROCESS_SET_QUOTA
+    inheritHandle = False
+    hProcess = win32api.OpenProcess(
+        desiredAccess,
+        inheritHandle,
+        pid,
+    )
+    # process will be terminated when job is destroyed
+    # job will be destroyed when its last handle is closed
+    # job handle will be closed when it loses its reference, hJob in this case
+    hJob = job_handle
+    win32job.AssignProcessToJobObject(hJob, hProcess)
+
+
+[docs]class Popen(subprocess.Popen):
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        make_process_die_when_parent_dies(self.pid)
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/_modules/koapy/utils/threading.html b/_modules/koapy/utils/threading.html new file mode 100644 index 00000000..c6e0922d --- /dev/null +++ b/_modules/koapy/utils/threading.html @@ -0,0 +1,161 @@ + + + + + + + + koapy.utils.threading — KOAPY 0.8.3 documentation + + + + + + + + + + + + + +

+ + +

+ +

Source code for koapy.utils.threading

+import threading
+
+
+[docs]class Singleton:
+
+    _instance = None
+    _lock = threading.RLock()
+
+    @classmethod
+    def _get_instance_without_check(cls, *args, **kwargs):
+        return cls._instance
+
+    @classmethod
+[docs]    def get_instance(cls, *args, **kwargs):
+        with cls._lock:
+            if not isinstance(cls._instance, cls):
+                cls._instance = cls(*args, **kwargs)
+            cls.get_instance = cls._get_instance_without_check
+            return cls._instance
+

+ +

+ + + + +

+ + + + + + + + \ No newline at end of file diff --git a/docs/source/authors.rst b/_sources/authors.rst similarity index 100% rename from docs/source/authors.rst rename to _sources/authors.rst diff --git a/_sources/autoapi/index.rst b/_sources/autoapi/index.rst new file mode 100644 index 00000000..94c54c1e --- /dev/null +++ b/_sources/autoapi/index.rst @@ -0,0 +1,11 @@ +API Reference +============= + +This page contains auto-generated API reference documentation [#f1]_. + +.. toctree:: + :titlesonly: + + /autoapi/koapy/index + +.. [#f1] Created with `sphinx-autoapi `_ \ No newline at end of file diff --git a/_sources/autoapi/koapy/backend/daishin_cybos_plus/core/CybosPlusEntrypoint/index.rst b/_sources/autoapi/koapy/backend/daishin_cybos_plus/core/CybosPlusEntrypoint/index.rst new file mode 100644 index 00000000..e5bcd363 --- /dev/null +++ b/_sources/autoapi/koapy/backend/daishin_cybos_plus/core/CybosPlusEntrypoint/index.rst @@ -0,0 +1,34 @@ +:py:mod:`koapy.backend.daishin_cybos_plus.core.CybosPlusEntrypoint` +=================================================================== + +.. py:module:: koapy.backend.daishin_cybos_plus.core.CybosPlusEntrypoint + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backend.daishin_cybos_plus.core.CybosPlusEntrypoint.CybosPlusDispatch + koapy.backend.daishin_cybos_plus.core.CybosPlusEntrypoint.CybosPlusIncompleteProgID + koapy.backend.daishin_cybos_plus.core.CybosPlusEntrypoint.CybosPlusEntrypoint + + + + +.. py:class:: CybosPlusDispatch(entrypoint, progid) + + +.. py:class:: CybosPlusIncompleteProgID(entrypoint, prefix) + + +.. py:class:: CybosPlusEntrypoint + + Bases: :py:obj:`koapy.backend.daishin_cybos_plus.core.CybosPlusEntrypointMixin.CybosPlusEntrypointMixin` + + http://cybosplus.github.io/ + + diff --git a/_sources/autoapi/koapy/backend/daishin_cybos_plus/core/CybosPlusEntrypointMixin/index.rst b/_sources/autoapi/koapy/backend/daishin_cybos_plus/core/CybosPlusEntrypointMixin/index.rst new file mode 100644 index 00000000..1599b824 --- /dev/null +++ b/_sources/autoapi/koapy/backend/daishin_cybos_plus/core/CybosPlusEntrypointMixin/index.rst @@ -0,0 +1,86 @@ +:py:mod:`koapy.backend.daishin_cybos_plus.core.CybosPlusEntrypointMixin` +======================================================================== + +.. py:module:: koapy.backend.daishin_cybos_plus.core.CybosPlusEntrypointMixin + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backend.daishin_cybos_plus.core.CybosPlusEntrypointMixin.CybosPlusEntrypointMixin + + + + +.. py:class:: CybosPlusEntrypointMixin + + Bases: :py:obj:`koapy.utils.logging.Logging.Logging` + + .. py:method:: GetConnectState(self) + + + .. py:method:: ConnectUsingPywinauto_Impl(cls, credentials=None) + :classmethod: + + https://github.com/ippoeyeslhw/cppy/blob/master/cp_luncher.py + + + .. py:method:: ConnectUsingPywinauto_RunScriptInSubprocess(cls, credentials=None) + :classmethod: + + + .. py:method:: ConnectUsingPywinauto(self, credentials=None) + + + .. py:method:: Connect(self, credentials=None) + + + .. py:method:: CommConnect(self, credentials=None) + + + .. py:method:: EnsureConnected(self, credentials=None) + + + .. py:method:: GetCodeListByMarketAsList(self, market) + + 0: 구분없음 + 1: 거래소 + 2: 코스닥 + 3: 프리보드 + 4: KRX + + + .. py:method:: GetKospiCodeList(self) + + + .. py:method:: GetKosdaqCodeList(self) + + + .. py:method:: GetGeneralCodeList(self, include_preferred_stock=False, include_etn=False, include_etf=False, include_mutual_fund=False, include_reits=False, include_kosdaq=False) + + + .. py:method:: GetStockDataAsDataFrame(self, code, chart_type, interval, start_date=None, end_date=None, adjusted_price=False, adjustement_only=False) + + http://cybosplus.github.io/cpsysdib_rtf_1_/stockchart.htm + + + .. py:method:: GetDailyStockDataAsDataFrame(self, code, start_date=None, end_date=None, adjusted_price=False) + + + .. py:method:: GetMinuteStockDataAsDataFrame(self, code, interval, start_date=None, end_date=None, adjusted_price=False) + + + .. py:method:: GetDailyAdjustmentRatioAsDataFrame(self, code, start_date=None, end_date=None) + + + .. py:method:: GetCurrentStockDataAsDataFrame(self, codes) + + http://cybosplus.github.io/cpdib_rtf_1_/stockmst2.htm + + + diff --git a/_sources/autoapi/koapy/backend/daishin_cybos_plus/core/CybosPlusError/index.rst b/_sources/autoapi/koapy/backend/daishin_cybos_plus/core/CybosPlusError/index.rst new file mode 100644 index 00000000..e7af86e2 --- /dev/null +++ b/_sources/autoapi/koapy/backend/daishin_cybos_plus/core/CybosPlusError/index.rst @@ -0,0 +1,53 @@ +:py:mod:`koapy.backend.daishin_cybos_plus.core.CybosPlusError` +============================================================== + +.. py:module:: koapy.backend.daishin_cybos_plus.core.CybosPlusError + + +Module Contents +--------------- + +.. py:exception:: CybosPlusError + + Bases: :py:obj:`Exception` + + Common base class for all non-exit exceptions. + + +.. py:exception:: CybosPlusRequestError(code, message=None) + + Bases: :py:obj:`CybosPlusError` + + 아래 문서에서 [BlockRequest/Blockrequest2/Request의 리턴값] 내용 참조 + http://cybosplus.github.io/cputil_rtf_1_/cybosplus_interface.htm + + .. py:attribute:: ERROR_MESSAGE_BY_CODE + + + + + .. py:method:: get_error_message_by_code(cls, code, default=None) + :classmethod: + + + .. py:method:: check_code_or_raise(cls, code) + :classmethod: + + + .. py:method:: wrap_to_check_code_or_raise(cls, func) + :classmethod: + + + .. py:method:: try_or_raise(cls, arg) + :classmethod: + + + .. py:method:: code(self) + :property: + + + .. py:method:: message(self) + :property: + + + diff --git a/_sources/autoapi/koapy/backend/daishin_cybos_plus/core/CybosPlusRateLimiter/index.rst b/_sources/autoapi/koapy/backend/daishin_cybos_plus/core/CybosPlusRateLimiter/index.rst new file mode 100644 index 00000000..5aed88ed --- /dev/null +++ b/_sources/autoapi/koapy/backend/daishin_cybos_plus/core/CybosPlusRateLimiter/index.rst @@ -0,0 +1,40 @@ +:py:mod:`koapy.backend.daishin_cybos_plus.core.CybosPlusRateLimiter` +==================================================================== + +.. py:module:: koapy.backend.daishin_cybos_plus.core.CybosPlusRateLimiter + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backend.daishin_cybos_plus.core.CybosPlusRateLimiter.CybosPlusLookupRequestRateLimiter + koapy.backend.daishin_cybos_plus.core.CybosPlusRateLimiter.CybosPlusTradeRequestRateLimiter + + + + +.. py:class:: CybosPlusLookupRequestRateLimiter + + Bases: :py:obj:`koapy.utils.rate_limiting.RateLimiter.TimeWindowRateLimiter` + + 시세 오브젝트 조회 제한: 15초에 최대 60건으로제한 + + Q. 플러스 데이터 요청 사용 제한에 대해 알고 싶습니다. + http://money2.daishin.com/e5/mboard/ptype_accordion/plusFAQ/DW_Basic_List.aspx?boardseq=298&m=9508&p=8835&v=8640 + + +.. py:class:: CybosPlusTradeRequestRateLimiter + + Bases: :py:obj:`koapy.utils.rate_limiting.RateLimiter.TimeWindowRateLimiter` + + 주문관련 오브젝트 조회 제한: 15초에 최대 20건으로제한 + + Q. 플러스 데이터 요청 사용 제한에 대해 알고 싶습니다. + http://money2.daishin.com/e5/mboard/ptype_accordion/plusFAQ/DW_Basic_List.aspx?boardseq=298&m=9508&p=8835&v=8640 + + diff --git a/_sources/autoapi/koapy/backend/daishin_cybos_plus/core/index.rst b/_sources/autoapi/koapy/backend/daishin_cybos_plus/core/index.rst new file mode 100644 index 00000000..9c891abe --- /dev/null +++ b/_sources/autoapi/koapy/backend/daishin_cybos_plus/core/index.rst @@ -0,0 +1,18 @@ +:py:mod:`koapy.backend.daishin_cybos_plus.core` +=============================================== + +.. py:module:: koapy.backend.daishin_cybos_plus.core + + +Submodules +---------- +.. toctree:: + :titlesonly: + :maxdepth: 1 + + CybosPlusEntrypoint/index.rst + CybosPlusEntrypointMixin/index.rst + CybosPlusError/index.rst + CybosPlusRateLimiter/index.rst + + diff --git a/_sources/autoapi/koapy/backend/daishin_cybos_plus/index.rst b/_sources/autoapi/koapy/backend/daishin_cybos_plus/index.rst new file mode 100644 index 00000000..63853179 --- /dev/null +++ b/_sources/autoapi/koapy/backend/daishin_cybos_plus/index.rst @@ -0,0 +1,16 @@ +:py:mod:`koapy.backend.daishin_cybos_plus` +========================================== + +.. py:module:: koapy.backend.daishin_cybos_plus + + +Subpackages +----------- +.. toctree:: + :titlesonly: + :maxdepth: 3 + + core/index.rst + proxy/index.rst + + diff --git a/_sources/autoapi/koapy/backend/daishin_cybos_plus/proxy/CybosPlusEntrypointProxy/index.rst b/_sources/autoapi/koapy/backend/daishin_cybos_plus/proxy/CybosPlusEntrypointProxy/index.rst new file mode 100644 index 00000000..7ff961aa --- /dev/null +++ b/_sources/autoapi/koapy/backend/daishin_cybos_plus/proxy/CybosPlusEntrypointProxy/index.rst @@ -0,0 +1,38 @@ +:py:mod:`koapy.backend.daishin_cybos_plus.proxy.CybosPlusEntrypointProxy` +========================================================================= + +.. py:module:: koapy.backend.daishin_cybos_plus.proxy.CybosPlusEntrypointProxy + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backend.daishin_cybos_plus.proxy.CybosPlusEntrypointProxy.CybosPlusDispatchProxyMethod + koapy.backend.daishin_cybos_plus.proxy.CybosPlusEntrypointProxy.CybosPlusDispatchProxy + koapy.backend.daishin_cybos_plus.proxy.CybosPlusEntrypointProxy.CybosPlusIncompleteProgIDProxy + koapy.backend.daishin_cybos_plus.proxy.CybosPlusEntrypointProxy.CybosPlusEntrypointProxy + + + + +.. py:class:: CybosPlusDispatchProxyMethod(proxy, name) + + +.. py:class:: CybosPlusDispatchProxy(proxy, progid) + + Bases: :py:obj:`koapy.utils.logging.Logging.Logging` + + +.. py:class:: CybosPlusIncompleteProgIDProxy(proxy, prefix) + + +.. py:class:: CybosPlusEntrypointProxy(host=None, port=None) + + Bases: :py:obj:`koapy.backend.daishin_cybos_plus.core.CybosPlusEntrypointMixin.CybosPlusEntrypointMixin` + + diff --git a/_sources/autoapi/koapy/backend/daishin_cybos_plus/proxy/CybosPlusProxyService/index.rst b/_sources/autoapi/koapy/backend/daishin_cybos_plus/proxy/CybosPlusProxyService/index.rst new file mode 100644 index 00000000..0746c84a --- /dev/null +++ b/_sources/autoapi/koapy/backend/daishin_cybos_plus/proxy/CybosPlusProxyService/index.rst @@ -0,0 +1,33 @@ +:py:mod:`koapy.backend.daishin_cybos_plus.proxy.CybosPlusProxyService` +====================================================================== + +.. py:module:: koapy.backend.daishin_cybos_plus.proxy.CybosPlusProxyService + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backend.daishin_cybos_plus.proxy.CybosPlusProxyService.CybosPlusProxyService + + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + koapy.backend.daishin_cybos_plus.proxy.CybosPlusProxyService.main + + + +.. py:class:: CybosPlusProxyService(host=None, port=None, max_workers=None) + + +.. py:function:: main() + + diff --git a/_sources/autoapi/koapy/backend/daishin_cybos_plus/proxy/CybosPlusProxyServiceMessageUtils/index.rst b/_sources/autoapi/koapy/backend/daishin_cybos_plus/proxy/CybosPlusProxyServiceMessageUtils/index.rst new file mode 100644 index 00000000..efaee07e --- /dev/null +++ b/_sources/autoapi/koapy/backend/daishin_cybos_plus/proxy/CybosPlusProxyServiceMessageUtils/index.rst @@ -0,0 +1,30 @@ +:py:mod:`koapy.backend.daishin_cybos_plus.proxy.CybosPlusProxyServiceMessageUtils` +================================================================================== + +.. py:module:: koapy.backend.daishin_cybos_plus.proxy.CybosPlusProxyServiceMessageUtils + + +Module Contents +--------------- + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + koapy.backend.daishin_cybos_plus.proxy.CybosPlusProxyServiceMessageUtils.AssignPrimitive + koapy.backend.daishin_cybos_plus.proxy.CybosPlusProxyServiceMessageUtils.ExtractPrimitive + koapy.backend.daishin_cybos_plus.proxy.CybosPlusProxyServiceMessageUtils.Protoc + + + +.. py:function:: AssignPrimitive(message, value) + + +.. py:function:: ExtractPrimitive(message) + + +.. py:function:: Protoc() + + diff --git a/_sources/autoapi/koapy/backend/daishin_cybos_plus/proxy/CybosPlusProxyServiceServicer/index.rst b/_sources/autoapi/koapy/backend/daishin_cybos_plus/proxy/CybosPlusProxyServiceServicer/index.rst new file mode 100644 index 00000000..d7d051ef --- /dev/null +++ b/_sources/autoapi/koapy/backend/daishin_cybos_plus/proxy/CybosPlusProxyServiceServicer/index.rst @@ -0,0 +1,70 @@ +:py:mod:`koapy.backend.daishin_cybos_plus.proxy.CybosPlusProxyServiceServicer` +============================================================================== + +.. py:module:: koapy.backend.daishin_cybos_plus.proxy.CybosPlusProxyServiceServicer + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backend.daishin_cybos_plus.proxy.CybosPlusProxyServiceServicer.CybosPlusEvent + koapy.backend.daishin_cybos_plus.proxy.CybosPlusProxyServiceServicer.CybosPlusEventIterator + koapy.backend.daishin_cybos_plus.proxy.CybosPlusProxyServiceServicer.CybosPlusEventHandler + koapy.backend.daishin_cybos_plus.proxy.CybosPlusProxyServiceServicer.CybosPlusProxyServiceServicer + + + + +.. py:class:: CybosPlusEvent(iterator) + + .. py:method:: done(self) + + + .. py:method:: wait_for_done(self) + + + +.. py:class:: CybosPlusEventIterator(handler) + + .. py:method:: notify(self) + + + +.. py:class:: CybosPlusEventHandler + + .. py:method:: OnRecieved(self) + + + +.. py:class:: CybosPlusProxyServiceServicer + + Bases: :py:obj:`koapy.backend.daishin_cybos_plus.proxy.CybosPlusProxyService_pb2_grpc.CybosPlusProxyServiceServicer` + + Missing associated documentation comment in .proto file. + + .. py:method:: Dispatch(self, request, context) + + Missing associated documentation comment in .proto file. + + + .. py:method:: Property(self, request, context) + + Missing associated documentation comment in .proto file. + + + .. py:method:: Method(self, request, context) + + Missing associated documentation comment in .proto file. + + + .. py:method:: Event(self, request_iterator, context) + + Missing associated documentation comment in .proto file. + + + diff --git a/_sources/autoapi/koapy/backend/daishin_cybos_plus/proxy/CybosPlusProxyService_pb2/index.rst b/_sources/autoapi/koapy/backend/daishin_cybos_plus/proxy/CybosPlusProxyService_pb2/index.rst new file mode 100644 index 00000000..cd29d386 --- /dev/null +++ b/_sources/autoapi/koapy/backend/daishin_cybos_plus/proxy/CybosPlusProxyService_pb2/index.rst @@ -0,0 +1,204 @@ +:py:mod:`koapy.backend.daishin_cybos_plus.proxy.CybosPlusProxyService_pb2` +========================================================================== + +.. py:module:: koapy.backend.daishin_cybos_plus.proxy.CybosPlusProxyService_pb2 + +.. autoapi-nested-parse:: + + Generated protocol buffer code. + + + +Module Contents +--------------- + +.. py:data:: DESCRIPTOR + + + + +.. py:data:: message_type + + + + +.. py:data:: message_type + + + + +.. py:data:: message_type + + + + +.. py:data:: containing_oneof + + + + +.. py:data:: containing_oneof + + + + +.. py:data:: containing_oneof + + + + +.. py:data:: containing_oneof + + + + +.. py:data:: containing_oneof + + + + +.. py:data:: containing_oneof + + + + +.. py:data:: message_type + + + + +.. py:data:: message_type + + + + +.. py:data:: message_type + + + + +.. py:data:: message_type + + + + +.. py:data:: message_type + + + + +.. py:data:: message_type + + + + +.. py:data:: message_type + + + + +.. py:data:: message_type + + + + +.. py:data:: message_type + + + + +.. py:data:: message_type + + + + +.. py:data:: containing_oneof + + + + +.. py:data:: containing_oneof + + + + +.. py:data:: DispatchRequest + + + + +.. py:data:: DispatchResponse + + + + +.. py:data:: PropertyRequest + + + + +.. py:data:: PrimitiveValueArray + + + + +.. py:data:: PrimitiveValue + + + + +.. py:data:: PropertyResponse + + + + +.. py:data:: Argument + + + + +.. py:data:: MethodRequest + + + + +.. py:data:: MethodResponse + + + + +.. py:data:: EventStartRequest + + + + +.. py:data:: EventDoneRequest + + + + +.. py:data:: EventStopRequest + + + + +.. py:data:: EventRequest + + + + +.. py:data:: EventStartedResponse + + + + +.. py:data:: EventFiredResponse + + + + +.. py:data:: EventResponse + + + + diff --git a/_sources/autoapi/koapy/backend/daishin_cybos_plus/proxy/CybosPlusProxyService_pb2_grpc/index.rst b/_sources/autoapi/koapy/backend/daishin_cybos_plus/proxy/CybosPlusProxyService_pb2_grpc/index.rst new file mode 100644 index 00000000..92319f55 --- /dev/null +++ b/_sources/autoapi/koapy/backend/daishin_cybos_plus/proxy/CybosPlusProxyService_pb2_grpc/index.rst @@ -0,0 +1,94 @@ +:py:mod:`koapy.backend.daishin_cybos_plus.proxy.CybosPlusProxyService_pb2_grpc` +=============================================================================== + +.. py:module:: koapy.backend.daishin_cybos_plus.proxy.CybosPlusProxyService_pb2_grpc + +.. autoapi-nested-parse:: + + Client and server classes corresponding to protobuf-defined services. + + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backend.daishin_cybos_plus.proxy.CybosPlusProxyService_pb2_grpc.CybosPlusProxyServiceStub + koapy.backend.daishin_cybos_plus.proxy.CybosPlusProxyService_pb2_grpc.CybosPlusProxyServiceServicer + koapy.backend.daishin_cybos_plus.proxy.CybosPlusProxyService_pb2_grpc.CybosPlusProxyService + + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + koapy.backend.daishin_cybos_plus.proxy.CybosPlusProxyService_pb2_grpc.add_CybosPlusProxyServiceServicer_to_server + + + +.. py:class:: CybosPlusProxyServiceStub(channel) + + Bases: :py:obj:`object` + + Missing associated documentation comment in .proto file. + + +.. py:class:: CybosPlusProxyServiceServicer + + Bases: :py:obj:`object` + + Missing associated documentation comment in .proto file. + + .. py:method:: Dispatch(self, request, context) + + Missing associated documentation comment in .proto file. + + + .. py:method:: Property(self, request, context) + + Missing associated documentation comment in .proto file. + + + .. py:method:: Method(self, request, context) + + Missing associated documentation comment in .proto file. + + + .. py:method:: Event(self, request_iterator, context) + + Missing associated documentation comment in .proto file. + + + +.. py:function:: add_CybosPlusProxyServiceServicer_to_server(servicer, server) + + +.. py:class:: CybosPlusProxyService + + Bases: :py:obj:`object` + + Missing associated documentation comment in .proto file. + + .. py:method:: Dispatch(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None) + :staticmethod: + + + .. py:method:: Property(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None) + :staticmethod: + + + .. py:method:: Method(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None) + :staticmethod: + + + .. py:method:: Event(request_iterator, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None) + :staticmethod: + + + diff --git a/_sources/autoapi/koapy/backend/daishin_cybos_plus/proxy/index.rst b/_sources/autoapi/koapy/backend/daishin_cybos_plus/proxy/index.rst new file mode 100644 index 00000000..4f1b767f --- /dev/null +++ b/_sources/autoapi/koapy/backend/daishin_cybos_plus/proxy/index.rst @@ -0,0 +1,20 @@ +:py:mod:`koapy.backend.daishin_cybos_plus.proxy` +================================================ + +.. py:module:: koapy.backend.daishin_cybos_plus.proxy + + +Submodules +---------- +.. toctree:: + :titlesonly: + :maxdepth: 1 + + CybosPlusEntrypointProxy/index.rst + CybosPlusProxyService/index.rst + CybosPlusProxyServiceMessageUtils/index.rst + CybosPlusProxyServiceServicer/index.rst + CybosPlusProxyService_pb2/index.rst + CybosPlusProxyService_pb2_grpc/index.rst + + diff --git a/_sources/autoapi/koapy/backend/index.rst b/_sources/autoapi/koapy/backend/index.rst new file mode 100644 index 00000000..fc4dc0d2 --- /dev/null +++ b/_sources/autoapi/koapy/backend/index.rst @@ -0,0 +1,17 @@ +:py:mod:`koapy.backend` +======================= + +.. py:module:: koapy.backend + + +Subpackages +----------- +.. toctree:: + :titlesonly: + :maxdepth: 3 + + daishin_cybos_plus/index.rst + kiwoom_open_api_plus/index.rst + kiwoom_open_api_w/index.rst + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusCondition/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusCondition/index.rst new file mode 100644 index 00000000..af3d394b --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusCondition/index.rst @@ -0,0 +1,34 @@ +:py:mod:`koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusCondition` +============================================================================ + +.. py:module:: koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusCondition + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusCondition.KiwoomOpenApiPlusConditionEntry + koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusCondition.KiwoomOpenApiPlusConditionFile + + + + +.. py:class:: KiwoomOpenApiPlusConditionEntry(header, item_id, group_id, group_name, group_tp, name, group_id_small, order_no, type_position, upjong, portfolio, recommend, acc, group, excepts, month, exp, count, rules) + + .. py:method:: from_datfile(cls, f: TextIO) + :classmethod: + + + +.. py:class:: KiwoomOpenApiPlusConditionFile(version: str, entries: Sequence[KiwoomOpenApiPlusConditionEntry]) + + .. py:method:: from_datfile(cls, f: Union[str, os.PathLike, TextIO], encoding: Optional[str] = None) + :classmethod: + + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusDispatchFunctions/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusDispatchFunctions/index.rst new file mode 100644 index 00000000..44117e51 --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusDispatchFunctions/index.rst @@ -0,0 +1,1217 @@ +:py:mod:`koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusDispatchFunctions` +==================================================================================== + +.. py:module:: koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusDispatchFunctions + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusDispatchFunctions.KiwoomOpenApiPlusDispatchFunctions + + + + +.. py:class:: KiwoomOpenApiPlusDispatchFunctions + + .. py:method:: CommConnect(self) -> int + + 로그인 윈도우를 실행한다. + + 수동 로그인 설정인 경우 로그인창을 출력. + 자동 로그인 설정인 경우 로그인창에서 자동으로 로그인을 시도합니다. + + 로그인이 성공하거나 실패하는 경우 OnEventConnect() 이벤트가 발생하고 이벤트의 + 인자 값으로 로그인 성공 여부를 알 수 있다. + + :returns: 에러코드, 성공하면 0 을, 실패하면 음수를 반환 + :rtype: int + + + .. py:method:: CommTerminate(self) -> None + + 더 이상 지원하지 않는 함수. + + 프로그램 종료없이 서버와의 접속만 단절시키는 함수입니다. + ※ 함수 사용 후 사용자의 오해소지가 생기는 이유로 더 이상 사용할 수 없는 함수입니다. + + 통신 연결 상태는 GetConnectState() 메소드로 알 수 있다. + + + .. py:method:: CommRqData(self, sRQName: str, sTrCode: str, nPrevNext: int, sScreenNo: str) -> int + + 통신 데이터를 서버로 전송한다. + + 반환 코드 구분: + - OP_ERR_NONE(0): 정상처리 + - OP_ERR_SISE_OVERFLOW(-200): 과도한 시세조회로 인한 통신불가 + - OP_ERR_RQ_STRUCT_FAIL(-201): 입력 구조체 생성 실패 + - OP_ERR_RQ_STRING_FAIL(-202): 요청전문 작성 실패 + + :param sRQName: 사용자 구분명 (임의로 지정, 한글 지원) + :type sRQName: str + :param sTrCode: 조회하려는 TR 코드 + :type sTrCode: str + :param nPrevNext: 연속조회 여부 (0:조회, 2:연속) + :type nPrevNext: int + :param sScreenNo: 화면번호 (4자리 숫자 임의로 지정) + :type sScreenNo: str + + :returns: 에러코드, 성공하면 0 을, 실패하면 음수를 반환 + :rtype: int + + + .. py:method:: GetLoginInfo(self, sTag: str) -> str + + 로그인한 사용자 정보를 반환한다. + + 태그값 구분: + - "ACCOUNT_CNT": 전체 보유계좌 개수를 반환합니다. + - "ACCLIST" 또는 "ACCNO": 구분자 ';' 로 연결된 전체 보유계좌 목록을 반환합니다. + - "USER_ID": 사용자 ID를 반환합니다. + - "USER_NAME": 사용자 이름을 반환합니다. + - "KEY_BSECGB": 키보드 보안 해지 여부를 반환합니다. (0:정상, 1:해지) + - "FIREW_SECGB": 방화벽 설정 여부를 반환합니다. (0:미설정, 1:설정, 2:해지) + - "GetServerGubun": 접속서버 구분을 반환합니다. (1:모의투자, 나머지:실거래서버) + + :param sTag: 사용자 정보 구분 태그 값 + :type sTag: str + + :returns: 태그값에 따른 데이터 반환 + :rtype: str + + + .. py:method:: SendOrder(self, sRQName: str, sScreenNo: str, sAccNo: str, nOrderType: int, sCode: str, nQty: int, nPrice: int, sHogaGb: str, sOrgOrderNo: str) -> int + + 주식 주문을 서버로 전송한다. + + 서버에 주문을 전송하는 함수 입니다. + 9개 인자값을 가진 주식주문 함수이며 리턴값이 0이면 성공이며 나머지는 에러입니다. + 1초에 5회만 주문가능하며 그 이상 주문요청하면 에러 -308을 리턴합니다. + + ※ 시장가, 최유리지정가, 최우선지정가, 시장가IOC, 최유리IOC, 시장가FOK, 최유리FOK, 장전시간외, 장후시간외 주문시 주문가격은 0으로 입력합니다. + ※ 취소 주문일때 주문가격은 0으로 입력합니다. + + 거래 구분: + - 00: 지정가 + - 03: 시장가 + - 05: 조건부지정가 + - 06: 최유리지정가 + - 07: 최우선지정가 + - 10: 지정가IOC + - 13: 시장가IOC + - 16: 최유리IOC + - 20: 지정가FOK + - 23: 시장가FOK + - 26: 최유리FOK + - 61: 장전시간외종가 + - 62: 시간외단일가매매 + - 81: 장후시간외종가 + + ※ 모의투자에서는 지정가 주문과 시장가 주문만 가능합니다. + + 정규장 외 주문: + - 장전 동시호가 주문 + - 08:30 ~ 09:00. 거래구분 00:지정가/03:시장가 (일반주문처럼) + - ※ 08:20 ~ 08:30 시간의 주문은 키움에서 대기하여 08:30 에 순서대로 거래소로 전송합니다. + - 장전시간외 종가 + - 08:30 ~ 08:40. 거래구분 61:장전시간외종가. 가격 0입력 + - ※ 전일 종가로 거래. 미체결시 자동취소되지 않음 + - 장마감 동시호가 주문 + - 15:20 ~ 15:30. 거래구분 00:지정가/03:시장가 (일반주문처럼) + - 장후 시간외 종가 + - 15:40 ~ 16:00. 거래구분 81:장후시간외종가. 가격 0입력 + - ※ 당일 종가로 거래 + - 시간외 단일가 + - 16:00 ~ 18:00. 거래구분 62:시간외단일가. 가격 입력 + - ※ 10분 단위로 체결, 당일 종가대비 +-10% 가격으로 거래 + + 주문 유형: + - 1: 신규매수 + - 2: 신규매도 + - 3: 매수취소 + - 4: 매도취소 + - 5: 매수정정 + - 6: 매도정정 + + :param sRQName: 사용자 구분 요청명 + :type sRQName: str + :param sScreenNo: 화면번호 (4자리) + :type sScreenNo: str + :param sAccNo: 계좌번호 (10자리) + :type sAccNo: str + :param nOrderType: 주문유형 (1:신규매수, 2:신규매도, 3:매수취소, 4:매도취소, 5:매수정정, 6:매도정정) + :type nOrderType: int + :param sCode: 종목코드 (6자리) + :type sCode: str + :param nQty: 주문수량 + :type nQty: int + :param nPrice: 주문단가 + :type nPrice: int + :param sHogaGb: 거래구분 (혹은 호가구분) + :type sHogaGb: str + :param sOrgOrderNo: 원주문번호, 신규주문에는 공백 입력, 정정/취소시 입력합니다. + :type sOrgOrderNo: str + + :returns: 에러코드, 성공하면 0 을, 실패하면 음수를 반환 + :rtype: int + + + .. py:method:: SendOrderFO(self, sRQName: str, sScreenNo: str, sAccNo: str, sCode: str, lOrdKind: int, sSlbyTp: str, sOrdTp: str, lQty: int, sPrice: str, sOrgOrdNo: str) -> int + + 선물/옵션 주문을 서버로 전송한다. + + 서버에 주문을 전송하는 함수 입니다. + 코스피지수200 선물옵션 전용 주문함수입니다. + + 거래 구분: + - 1: 지정가 + - 2: 조건부지정가 + - 3: 시장가 + - 4: 최유리지정가 + - 5: 지정가(IOC) + - 6: 지정가(FOK) + - 7: 시장가(IOC) + - 8: 시장가(FOK) + - 9: 최유리지정가(IOC) + - A: 최유리지정가(FOK) + + ※ 장종료 후 시간외 주문은 지정가 선택 + + :param sRQName: 사용자 구분명 + :type sRQName: str + :param sScreenNo: 화면번호 + :type sScreenNo: str + :param sAccNo: 계좌번호 (10자리) + :type sAccNo: str + :param sCode: 종목코드 + :type sCode: str + :param lOrdKind: 주문종류 (1:신규매매, 2:정정, 3:취소) + :type lOrdKind: int + :param sSlbyTp: 매매구분 (1:매도, 2:매수) + :type sSlbyTp: str + :param sOrdTp: 거래구분 + :type sOrdTp: str + :param lQty: 주문수량 + :type lQty: int + :param sPrice: 주문가격 + :type sPrice: str + :param sOrgOrdNo: 원주문번호 + :type sOrgOrdNo: str + + :returns: 에러코드, 성공하면 0 을, 실패하면 음수를 반환 + :rtype: int + + + .. py:method:: SetInputValue(self, sID: str, sValue: str) -> None + + TR 입력 값을 서버통신 전에 입력한다. + + 조회요청시 TR의 Input값을 지정하는 함수입니다. + CommRqData() 호출 전에 입력값들을 셋팅합니다. + 각 TR마다 Input 항목이 다릅니다. 순서에 맞게 Input 값들을 셋팅해야 합니다. + + :param sID: TR에 명시된 Input 이름 + :type sID: str + :param sValue: Input 이름으로 지정한 값 + :type sValue: str + + + .. py:method:: SetOutputFID(self, sID: str) -> int + + 1.0.0.1 버전 이후 사용하지 않음. + + + .. py:method:: CommGetData(self, sJongmokCode: str, sRealType: str, sFieldName: str, nIndex: int, sInnerFieldName: str) -> str + + 이 함수는 지원하지 않을 것이므로 용도에 맞는 전용 함수를 사용할 것. (비고참고) + + 일부 TR에서 사용상 제약이 있으므로 이 함수 대신 GetCommData() 함수를 사용하시기 바랍니다. + + 비고: + - 조회 정보 요청: GetCommData(strTrCode: str, strRecordName: str, nIndex: int, strItemName: str) + - 실시간 정보 요청: GetCommRealData(sTrCode: str, nFid: int) + - 체결 정보 요청: GetChejanData(nFid: int) + + + .. py:method:: DisconnectRealData(self, sScnNo: str) -> None + + 화면 내 모든 리얼데이터 요청을 제거한다. + + 시세데이터를 요청할때 사용된 화면번호를 이용하여 + 해당 화면번호로 등록되어져 있는 종목의 실시간시세를 서버에 등록해지 요청합니다. + 이후 해당 종목의 실시간시세는 수신되지 않습니다. + 단, 해당 종목이 또다른 화면번호로 실시간 등록되어 있는 경우 해당종목에대한 실시간시세 데이터는 계속 수신됩니다. + + 화면을 종료할 때 반드시 위 함수를 호출해야 한다. + + :param sScnNo: 화면번호 (4자리) + + + .. py:method:: GetRepeatCnt(self, sTrCode: str, sRecordName: str) -> int + + 레코드 반복횟수를 반환한다. + + 데이터 수신시 멀티데이터의 갯수(반복수)를 얻을수 있습니다. + 예를 들어 차트조회는 한번에 최대 900개 데이터를 수신할 수 있는데 + 이렇게 수신한 데이터갯수를 얻을때 사용합니다. + 이 함수는 OnReceiveTRData() 이벤트가 발생될때 그 안에서 사용해야 합니다. + + :param sTrCode: TR 이름 + :type sTrCode: str + :param sRecordName: 레코드 이름 + :type sRecordName: str + + :returns: 레코드의 반복횟수 + :rtype: int + + + .. py:method:: CommKwRqData(self, sArrCode: str, bNext: int, nCodeCount: int, nTypeFlag: int, sRQName: str, sScreenNo: str) -> int + + 복수종목조회 요청을 서버로 송신한다. + + 한번에 100종목까지 조회할 수 있는 복수종목 조회함수 입니다. + 함수인자로 사용하는 종목코드 리스트는 조회하려는 종목코드 사이에 구분자 ';' 를 추가해서 만들면 됩니다. + 수신되는 데이터는 TR목록에서 복수종목정보요청(OPTKWFID) Output을 참고하시면 됩니다. + + ※ OPTKWFID TR은 CommKwRqData() 함수 전용으로, CommRqData 로는 사용할 수 없습니다. + ※ OPTKWFID TR은 영웅문4 HTS의 관심종목과는 무관합니다. + + 반환 코드 구분: + - OP_ERR_NONE(0): 정상처리 + - OP_ERR_SISE_OVERFLOW(-200): 과도한 시세조회로 인한 통신불가 + - OP_ERR_RQ_STRUCT_FAIL(-201): 입력 구조체 생성 실패 + - OP_ERR_RQ_STRING_FAIL(-202): 요청전문 작성 실패 + + :param sArrCode: 종목리스트 + :type sArrCode: str + :param bNext: 연속조회 여부 (0:기본값, 1:연속조회(지원안함)) + :type bNext: int + :param nCodeCount: 종목개수 + :type nCodeCount: int + :param nTypeFlag: 조회구분 (0:주식 종목, 3:선물옵션 종목) + :type nTypeFlag: int + :param sRQName: 사용자 구분명 + :type sRQName: str + :param sScreenNo: 화면번호 (4자리) + :type sScreenNo: str + + :returns: 에러코드, 성공하면 0 을, 실패하면 음수를 반환 + :rtype: int + + + .. py:method:: GetAPIModulePath(self) -> str + + OpenAPI 모듈의 경로를 반환한다. + + :returns: OpenAPI 모듈의 설치 경로 + :rtype: str + + + .. py:method:: GetCodeListByMarket(self, sMarket: str) -> str + + 시장구분에 따른 종목코드를 반환한다. + + 주식 시장별 종목코드 리스트를 ';' 로 구분해서 전달합니다. + 시장구분값을 "" 공백으로 하면 전체시장 코드리스트를 전달합니다. + + 로그인 한 후에 사용할 수 있는 함수입니다. + + 시장 구분: + - 0: 장내 + - 3: ELW + - 4: 뮤추얼펀드 + - 5: 신주인수권 + - 6: 리츠 + - 8: ETF + - 9: 하이일드펀드 + - 10: 코스닥 + - 30: K-OTC + - 50: 코넥스 (KONEX) + + :param sMarket: 시장 구분값 + :type sMarket: str + + :returns: 종목코드 리스트, 종목간 구분은 ';' 이다. + :rtype: str + + + .. py:method:: GetConnectState(self) -> int + + 현재 접속상태를 반환한다. + + 서버와 현재 접속 상태를 알려줍니다. + + :returns: 접속상태, 1:연결, 0:연결안됨 + :rtype: int + + + .. py:method:: GetMasterCodeName(self, sTrCode: str) -> str + + 종목코드의 한글명을 반환한다. + + 종목코드에 해당하는 종목명을 전달합니다. + + 로그인 한 후에 사용할 수 있는 함수입니다. + + 장내외, 지수선옵, 주식선옵 검색 가능. + + :param sTrCode: 종목코드 (4자리) + :type sTrCode: str + + :returns: 종목 한글명 + :rtype: str + + + .. py:method:: GetMasterListedStockCnt(self, sTrCode: str) -> int + + 종목코드의 상장주식수를 반환한다. + + 입력한 종목코드에 해당하는 종목 상장주식수를 전달합니다. + + 로그인 한 후에 사용할 수 있는 함수입니다. + + :param sTrCode: 종목코드 (4자리) + :type sTrCode: str + + :returns: 상장주식수 + :rtype: int + + + .. py:method:: GetMasterConstruction(self, sTrCode: str) -> str + + 종목코드의 감리구분을 반환한다. + + 입력한 종목코드에 해당하는 종목의 감리구분을 전달합니다. + (정상, 투자주의, 투자경고, 투자위험, 투자주의환기종목) + + 로그인 한 후에 사용할 수 있는 함수입니다. + + 감리 구분: + - 정상 + - 투자주의 + - 투자경고 + - 투자위험 + - 투자주의환기종목 + + :param sTrCode: 종목코드 (4자리) + :type sTrCode: str + + :returns: 감리구분 (정상, 투자주의, 투자경고, 투자위험, 투자주의환기종목) + :rtype: str + + + .. py:method:: GetMasterListedStockDate(self, sTrCode: str) -> str + + 종목코드의 상장일을 반환한다. + + 입력한 종목의 상장일을 전달합니다. + + 로그인 한 후에 사용할 수 있는 함수입니다. + + :param sTrCode: 종목코드 (4자리) + :type sTrCode: str + + :returns: 상장일 (8자리, YYYYMMDD) + :rtype: str + + + .. py:method:: GetMasterLastPrice(self, sTrCode: str) -> str + + 종목코드의 전일가를 반환한다. + + 입력한 종목의 당일 기준가를 전달합니다. + + 로그인 한 후에 사용할 수 있는 함수입니다. + + :param sTrCode: 종목코드 (4자리) + :type sTrCode: str + + :returns: 전일가 + :rtype: str + + + .. py:method:: GetMasterStockState(self, sTrCode: str) -> str + + 종목코드의 종목상태를 반환한다. + + 입력한 종목의 증거금 비율, 거래정지, 관리종목, 감리종목, 투자유의종목, 담보대출, 액면분할, 신용가능 여부를 전달합니다. + + 로그인 한 후에 사용할 수 있는 함수입니다. + + :param sTrCode: 종목코드 (4자리) + :type sTrCode: str + + :returns: 종목상태 (정상, 증거금N%, 거래정지, 관리종목, 감리종목, 투자유의종목, 담보대출, 액면분할, 신용가능) + :rtype: str + + + .. py:method:: GetDataCount(self, strRecordName: str) -> int + + 레코드의 반복개수를 반환한다. + + ※ 문서상으로만 존재하고 KOAStudio 에서는 확인 안되는 것으로 보아 일반적인 상황에선 + 해당 함수 대신 GetRepeatCnt() 를 사용하는게 더 바람직할 듯 + + :param strRecordName: 레코드 명 + :type strRecordName: str + + :returns: 레코드 반복개수 + :rtype: str + + + .. py:method:: GetOutputValue(self, strRecordName: str, nRepeatIdx: int, nItemIdx: int) -> str + + 레코드의 반복순서와 아이템의 출력순서에 따라 수신데이터를 반환한다. + + ※ 문서상으로만 존재하고 KOAStudio 에서는 확인 안되는 것으로 보아 일반적인 상황에선 + 해당 함수 대신 GetCommData() 를 사용하는게 더 바람직할 듯 + + :param strRecordName: 레코드 명 + :type strRecordName: str + :param nRepeatIdx: 반복 순서 + :type nRepeatIdx: int + :param nItemIdx: 아이템 순서 + :type nItemIdx: int + + :returns: 수신 데이터 + :rtype: str + + + .. py:method:: GetCommData(self, strTrCode: str, strRecordName: str, nIndex: int, strItemName: str) -> str + + 수신 데이터를 반환한다. + + OnReceiveTRData() 이벤트가 발생될때 수신한 데이터를 얻어오는 함수입니다. + 이 함수는 OnReceiveTRData() 이벤트가 발생될때 그 안에서 사용해야 합니다. + + :param strTrCode: TR코드 + :type strTrCode: str + :param strRecordName: 레코드명 + :type strRecordName: str + :param nIndex: 복수데이터 인덱스 + :type nIndex: int + :param strItemName: 아이템명 (TR별 출력항목 이름) + :type strItemName: str + + :returns: 수신 데이터 + :rtype: str + + + .. py:method:: GetCommRealData(self, sTrCode: str, nFid: int) -> str + + 실시간 시세 데이터를 반환한다. + + 실시간시세 데이터 수신 이벤트인 OnReceiveRealData() 가 발생될때 실시간데이터를 얻어오는 함수입니다. + 이 함수는 OnReceiveRealData() 이벤트가 발생될때 그 안에서 사용해야 합니다. + FID 값은 KOAStudio 의 "실시간목록" 탭에서 확인할 수 있습니다. + + 일반적으로 strTrCode 는 OnReceiveRealData() 이벤트 함수의 첫번째 매개변수를 사용한다. + + :param strTrCode: TR코드 + :type strTrCode: str + :param nFid: 실시간 아이템 + :type nFid: int + + :returns: 수신 데이터 + :rtype: str + + + .. py:method:: GetChejanData(self, nFid: int) -> str + + 체결잔고 데이터를 반환한다. + + OnReceiveChejan() 이벤트가 발생될때 FID 에 해당되는 값을 구하는 함수입니다. + 이 함수는 OnReceiveChejan() 이벤트 안에서 사용해야 합니다. + Ex) 체결가 = GetChejanData(910) + + :param nFid: 체결잔고 아이템 + :type nFid: int + + :returns: 수신 데이터 + :rtype: str + + + .. py:method:: GetThemeGroupList(self, nType: int) -> str + + 테마코드와 테마명을 반환한다. + + 반환값의 코드와 코드명 구분은 '|', 코드의 구분은 ';' + Ex) 100|태양광_폴리실리콘;152|합성섬유 + + :param nType: 정렬순서 (0:코드순, 1:테마순) + :type nType: int + + :returns: 코드와 코드명 리스트 + :rtype: str + + + .. py:method:: GetThemeGroupCode(self, strThemeCode: str) -> str + + 테마코드에 소속된 종목코드를 반환한다. + + 반환값의 종목코드간 구분은 ';' + Ex) A000660;A005930 + + :param strThemeCode: 테마코드 + :type strThemeCode: str + + :returns: 종목코드 리스트 + :rtype: str + + + .. py:method:: GetFutureList(self) -> str + + 지수선물 리스트를 반환한다. + + 지수선물 종목코드 리스트를 ';'로 구분해서 전달합니다. + + 로그인 한 후에 사용할 수 있는 함수입니다. + + 반환값의 종목코드간 구분은 ';' + Ex) 101J9000;101JC000 + + :returns: 종목코드 리스트 + :rtype: str + + + .. py:method:: GetFutureCodeByIndex(self, nIndex: int) -> str + + 지수선물 코드를 반환한다. + + Ex) 최근월선물 = GetFutureCodeByIndex(0) + 최근월스프레드 = GetFutureCodeByIndex(4) + + :param nIndex: 0 ~ 3: 지수선물코드, 4 ~ 7: 지수스프레드 + :type nIndex: int + + :returns: 종목코드 + :rtype: str + + + .. py:method:: GetActPriceList(self) -> str + + 지수옵션 행사가 리스트를 반환한다. + + 지수옵션 행사가에 100을 곱해서 소수점이 없는 값을 ';' 로 구분해서 전달합니다. + + 로그인 한 후에 사용할 수 있는 함수입니다. + + ※ PDF 문서상의 예시에서는 소수점 아래가 존재하는 예시지만, KOAStudio 의 설명과 예시에서는 그렇지 않음. + 아마도 KOAStudio 의 설명을 따르는게 더 바람직할 듯. + + :returns: 행사가 + :rtype: str + + + .. py:method:: GetMonthList(self) -> str + + 지수옵션 월물 리스트를 반환한다. + + 지수옵션 월물정보를 ';' 로 구분해서 전달하는데 순서는 콜 11월물 ~ 콜 최근월물 풋 최근월물 ~ 풋 최근월물가 됩니다. + + 로그인 한 후에 사용할 수 있는 함수입니다. + + 반환값의 월물간 구분은 ';' + Ex) 201412;201409;201408;201407;201407;201408;201409;201412 + + :returns: 월물 (YYYYMM;YYYYMM;...) + :rtype: str + + + .. py:method:: GetOptionCode(self, strActPrice: str, nCp: int, strMonth: str) -> str + + 행사가와 월물 콜풋으로 종목코드를 구한다. + + 인자로 지정한 지수옵션 코드를 전달합니다. + + 로그인 한 후에 사용할 수 있는 함수입니다. + + :param strActPrice: 행사가 (소수점 포함) + :type strActPrice: str + :param nCp: 콜/풋 구분 (2:콜, 3:풋) + :type nCp: int + :param strMonth: 월물 (6자리, YYYYMM) + :type strMonth: str + + :returns: 종목코드 + :rtype: str + + .. rubric:: Examples + + >>> GetOptionCode("260.00", 2, "201407") + + + .. py:method:: GetOptionCodeByMonth(self, sTrCode: str, nCp: int, strMonth: str) -> str + + 입력된 종목코드와 동일한 행사가의 코드중 입력한 월물의 코드를 구한다. + + :param sTrCode: 종목코드 + :type sTrCode: str + :param nCp: 콜/풋 구분 (2:콜, 3:풋) + :type nCp: int + :param strMonth: 월물 (6자리, YYYYMM) + :type strMonth: str + + :returns: 종목코드 + :rtype: str + + .. rubric:: Examples + + >>> GetOptionCodeByMonth("201J7260", 2, "201412") + "201JC260" + + + .. py:method:: GetOptionCodeByActPrice(self, sTrCode: str, nCp: int, nTick: int) -> str + + 입력된 종목코드와 동일한 월물의 코드중 입력한 틱만큼 벌어진 코드를 구한다. + + :param sTrCode: 종목코드 + :type sTrCode: str + :param nCp: 콜/풋 구분 (2:콜, 3:풋) + :type nCp: int + :param nTick: 행사가 틱 + :type nTick: int + + :returns: 종목코드 + :rtype: str + + .. rubric:: Examples + + >>> GetOptionCodeByActPrice("201J7260", 2, -1) + "201J7262" + + + .. py:method:: GetSFutureList(self, strBaseAssetCode: str) -> str + + 주식선물 코드 리스트를 반환한다. + + 출력값의 코드간 구분은 ';' 이다. + + :param strBaseAssetCode: 기초자산코드 + :type strBaseAssetCode: str + + :returns: 종목코드 리스트 + :rtype: str + + + .. py:method:: GetSFutureCodeByIndex(self, strBaseAssetCode: str, nIndex: int) -> str + + 주식선물 코드를 반환한다. + + :param strBaseAssetCode: 기초자산코드 + :type strBaseAssetCode: str + :param nIndex: 0 ~ 3: 지수선물코드, 4 ~ 7: 지수스프레드, 8 ~ 11: 스타 선물, 12 ~ : 스타 스프레드 + :type nIndex: int + + :returns: 종목코드 리스트 + :rtype: str + + .. rubric:: Examples + + >>> GetSFutureCodeByIndex("11", 0) + + + .. py:method:: GetSActPriceList(self, strBaseAssetGb: str) -> str + + 주식옵션 행사가 리스트를 반환한다. + + :param strBaseAssetGb: 기초자산코드구분 + :type strBaseAssetGb: str + + :returns: 행사가 리스트, 행사가간 구분은 ';' + :rtype: str + + .. rubric:: Examples + + >>> GetSActPriceList("11") + + + .. py:method:: GetSMonthList(self, strBaseAssetGb: str) -> str + + 주식옵션 월물 리스트를 반환한다. + + :param strBaseAssetGb: 기초자산코드구분 + :type strBaseAssetGb: str + + :returns: 월물 리스트, 월물간 구분은 ';' + :rtype: str + + .. rubric:: Examples + + >>> GetSMonthList("11") + + + .. py:method:: GetSOptionCode(self, strBaseAssetGb: str, strActPrice: str, nCp: int, strMonth: str) -> str + + 주식옵션 코드를 반환한다. + + :param strBaseAssetGb: 기초자산코드구분 + :type strBaseAssetGb: str + :param strActPrice: 행사가 (소수점 포함) + :type strActPrice: str + :param nCp: 콜/풋 구분 (2:콜, 3:풋) + :type nCp: int + :param strMonth: 월물 (6자리, YYYYMM) + :type strMonth: str + + :returns: 주식옵션 코드 + :rtype: str + + .. rubric:: Examples + + >>> GetSOptionCode("11", "1300000", 2, "1412") + + + .. py:method:: GetSOptionCodeByMonth(self, strBaseAssetGb: str, sTrCode: str, nCp: int, strMonth: str) -> str + + 입력한 주식옵션 코드에서 월물만 변경하여 반환한다. + + :param strBaseAssetGb: 기초자산코드구분 + :type strBaseAssetGb: str + :param sTrCode: 종목코드 + :type sTrCode: str + :param nCp: 콜/풋 구분 (2:콜, 3:풋) + :type nCp: int + :param strMonth: 월물 (6자리, YYYYMM) + :type strMonth: str + + :returns: 주식옵션 코드 + :rtype: str + + .. rubric:: Examples + + >>> GetSOptionCodeByMonth("11", "211J8045", 2, "1412") + + + .. py:method:: GetSOptionCodeByActPrice(self, strBaseAssetGb: str, sTrCode: str, nCp: int, nTick: int) -> str + + 입력한 주식옵션 코드에서 행사가만 변경하여 반환한다. + + :param strBaseAssetGb: 기초자산코드구분 + :type strBaseAssetGb: str + :param sTrCode: 종목코드 + :type sTrCode: str + :param nCp: 콜/풋 구분 (2:콜, 3:풋) + :type nCp: int + :param nTick: 행사가 틱 + :type nTick: int + + :returns: 주식옵션 코드 + :rtype: str + + .. rubric:: Examples + + >>> GetSOptionCodeByActPrice("11", "211J8045", 2, 4); + + + .. py:method:: GetSFOBasisAssetList(self) -> str + + 주식선옵 기초자산코드/종목명을 반환한다. + + :returns: 기초자산코드/종목명, 코드와 종목명 구분은 '|', 코드간 구분은 ';' + :rtype: str + + + .. py:method:: GetOptionATM(self) -> str + + 지수옵션 ATM을 반환한다. + + :returns: ATM + :rtype: str + + + .. py:method:: GetSOptionATM(self, strBaseAssetGb: str) -> str + + 주식옵션 ATM을 반환한다. + + :returns: ATM + :rtype: str + + + .. py:method:: GetBranchCodeName(self) -> str + + 회원사 코드와 이름을 반환합니다. + + :returns: 회원사코드/회원사명, 코드와 이름 구분은 '|', 코드간 구분은 ';' (회원사코드|회원사명;회원사코드|회원사명;...) + :rtype: str + + + .. py:method:: CommInvestRqData(self, sMarketGb: str, sRQName: str, sScreenNo: str) -> int + + 지원하지 않는 함수. + + 시장 구분: + - 001: 코스피 + - 002: 코스닥 + - 003: 선물 + - 004: 콜옵션 + - 005: 풋옵션 + - 006: 스타선물 + - 007: 주식선물 + - 008: 3년국채 + - 009: 5년국채 + - 010: 10년국채 + - 011: 달러선물 + - 012: 엔선물 + - 013: 유로선물 + - 014: 미니금선물 + - 015: 금선물 + - 016: 돈육선물 + - 017: 달러콜옵션 + - 018: 달러풋옵션 + + :param sMarketGb: 시장구분 + :type sMarketGb: str + :param sRQName: 사용자 구분값 + :type sRQName: str + :param sScreenNo: 화면번호 (4자리) + :type sScreenNo: str + + :returns: 통신결과 + :rtype: str + + .. rubric:: Examples + + >>> CommInvestRqData("T00108;T00109", 0, 2, "RQ_1", "0101") + + + .. py:method:: SendOrderCredit(self, sRQName: str, sScreenNo: str, sAccNo: str, nOrderType: int, sCode: str, nQty: int, nPrice: int, sHogaGb: str, sCreditGb: str, sLoanDate: str, sOrgOrderNo: str) -> int + + 신용주식 주문을 서버로 전송한다. + + 서버에 주문을 전송하는 함수 입니다. + 국내주식 신용주문 전용함수입니다. 대주거래는 지원하지 않습니다. + + 거래 구분: + - 00: 지정가 + - 03: 시장가 + - 05: 조건부지정가 + - 06: 최유리지정가 + - 07: 최우선지정가 + - 10: 지정가IOC + - 13: 시장가IOC + - 16: 최유리IOC + - 20: 지정가FOK + - 23: 시장가FOK + - 26: 최유리FOK + - 61: 장전시간외종가 + - 62: 시간외단일가매매 + - 81: 장후시간외종가 + + ※ 모의투자에서는 지정가 주문과 시장가 주문만 가능합니다. + + 신용거래 구분: + - 03: 신용매수 주문 \- 자기융자 + - 대출일은 공백 입력 + - 33: 신용매도 융자상환 주문 \- 자기융자 + - 대출일은 종목별 대출일 입력 + - OPW00005/OPW00004 TR조회로 대출일 조회 + - 99: 신용매도 자기융자 합 + - 대출일은 "99991231" 입력 + - 단, 신용잔고 5개 까지만 융자합 주문 가능 + + 대출일은 YYYYMMDD 형식입니다. + 신용매도 - 자기융자 일때는 종목별 대출일을 입력하고 신용매도 - 융자합이면 "99991231"을 입력합니다. + + :param sRQName: 사용자 구분 요청명 + :type sRQName: str + :param sScreenNo: 화면번호 (4자리) + :type sScreenNo: str + :param sAccNo: 계좌번호 (10자리) + :type sAccNo: str + :param nOrderType: 주문유형 (1:신규매수, 2:신규매도, 3:매수취소, 4:매도취소, 5:매수정정, 6:매도정정) + :type nOrderType: int + :param sCode: 종목코드 (6자리) + :type sCode: str + :param nQty: 주문수량 + :type nQty: int + :param nPrice: 주문단가 + :type nPrice: int + :param sHogaGb: 거래구분 + :type sHogaGb: str + :param sCreditGb: 신용구분 + :type sCreditGb: str + :param sLoanDate: 대출일 (8자리, YYYYMMDD) + :type sLoanDate: str + :param sOrgOrderNo: 원주문번호 + :type sOrgOrderNo: str + + :returns: 에러코드, 성공하면 0 을, 실패하면 음수를 반환 + :rtype: int + + + .. py:method:: KOA_Functions(self, sFunctionName: str, sParam: str) -> str + + OpenAPI 기본 기능 이외의 기능들을 제공하는 헬퍼 함수. + + KOA_Function() 함수는 OpenAPI 기본 기능 이외의 기능을 사용하기 쉽도록 만든 함수입니다. + 두 개의 인자값을 사용합니다. + + 기능 목록: + + 1. 계좌 비밀번호 입력창 출력 + + >>> KOA_Functions("ShowAccountWindow", "") + + 2. 접속 서버 확인 (1:모의투자, 나머지:실서버) + + >>> KOA_Functions("GetServerGubun", "") + + 3. 주식종목 시장구분, 종목분류등 정보제공 (구분자는 '|' 와 ';') + 호출결과는 입력한 종목에 대한 대분류, 중분류, 업종구분값을 구분자로 연결한 문자열입니다. + + >>> KOA_Functions("GetMasterStockInfo", "039490") + "시장구분0|거래소;시장구분1|중형주;업종구분|금융업;" + + 4. 조건검색 종목코드와 현재가 수신 (실시간 조건검색은 사용할 수 없음) + 조건검색결과에 종목코드와 그 종목의 현재가를 함께 수신하는 방법이며 실시간 조건검색에서는 사용할 수 없고 오직 조건검색에만 사용할수 있습니다. + + >>> KOA_Functions("SetConditionSearchFlag", "AddPrice") # 현재가 포함하도록 설정 + + 현재가 포함으로 설정시 OnReceiveTrCondition() 이벤트에 "종목코드1^현재가1;종목코드2^현재가2;...종목코드n^현재가n" 형식으로 전달됨. + + >>> KOA_Functions("SetConditionSearchFlag", "DelPrice") # 현재가 미포함 (원래 상태로 전환) + + 현재가 미포함시 기존처럼 "종목코드1^종목코드2...종목코드n" 형식으로 전달므로 설정에 따라 수신데이터 처리방법이 달라져야 하므로 주의하셔야 합니다. + + 5. 업종코드목록 획득 + + >>> KOA_Functions("GetUpjongCode", "0") + + 두번째 인자로 사용할 수 있는 값은 0, 1, 2, 4, 7 입니다. + 0:코스피, 1: 코스닥, 2:KOSPI200, 4:KOSPI100(KOSPI50), 7:KRX100 + + 함수반환값은 "시장구분값,업종코드,업종명|시장구분값,업종코드,업종명|...|시장구분값,업종코드,업종명" 형식입니다. + 즉 하나의 업종코드는 입력한 시장구분값과 업종코드 그리고 그 업종명이 쉼표(,)로 구분되며 각 업종코드는 '|'로 구분됩니다. + + 6. 업종이름 획득 + + >>> KOA_Functions("GetUpjongNameByCode", "업종코드입력") + + 7. ETF 투자유의 종목 여부 (2020/09/17 적용) + 거래소 제도개선으로 ETF/ETN 종목 중 투자유의 종목을 매수주문하는 경우 경고 메세지 창이 출력되도록 기능이 추가 되었습니다. + (경고 창 출력 시 주문을 중지/전송 선택 가능합니다.) + 주문 함수를 호출하기 전에 특정 종목이 투자유의종목인지 아래와 같은 방법으로 확인할 수 있습니다. + + >>> KOA_Functions("IsOrderWarningETF", "종목코드(6자리)") + + 투자유의 종목인 경우 "1" 값이 리턴, 그렇지 않은 경우 "0" 값 리턴. (ETF가 아닌 종목을 입력시 "0" 값 리턴.) + + 8. 주식 전종목대상 투자유의 종목 여부 (2020/11/26 적용) + 거래소 제도개선으로 주식 종목 중 정리매매/단기과열/투자위험/투자경고 종목을 매수주문하는 경우 + 경고 메세지 창이 출력되도록 기능이 추가 되었습니다. (경고 창 출력 시 주문을 중지/전송 선택 가능합니다.) + 주문 함수를 호출하기 전에 특정 종목이 투자유의종목인지 아래와 같은 방법으로 확인할 수 있습니다. + + >>> KOA_Functions("IsOrderWarningStock", "종목코드(6자리)") + + 리턴 값 - "0":해당없음, "2":정리매매, "3":단기과열, "4":투자위험, "5":투자경고 + + 9. 상장주식수 구하기 (2021/04/08 적용) + 상장주식수를 구하는 GetMasterListedStockCnt() 기존 함수 사용시 특정 종목 데이터가 long 형을 Overflow 하는 현상이 있습니다. + 이에, 상장주식수를 구하는 기능을 신규 추가 합니다. 사용법은 아래와 같습니다. + + >>> KOA_Functions("GetMasterListedStockCntEx", "종목코드(6자리)") + + :param sFunctionName: 함수이름 혹은 기능이름 + :type sFunctionName: str + :param sParam: 함수 매개변수 + :type sParam: str + + :returns: 결과 데이터 + :rtype: str + + + .. py:method:: SetInfoData(self, sInfoData: str) -> int + + 다수의 아이디로 자동로그인이 필요할 때 사용한다. + + :param sInfoData: 아이디 + :type sInfoData: str + + :returns: 통신결과 + :rtype: int + + .. rubric:: Examples + + >>> SetInfoData("UserID") + + + .. py:method:: SetRealReg(self, strScreenNo: str, strCodeList: str, strFidList: str, strOptType: str) -> int + + 실시간 등록을 한다. + + 종목코드와 FID 리스트를 이용해서 실시간 시세를 등록하는 함수입니다. + 한번에 등록가능한 종목과 FID갯수는 100종목, 100개 입니다. + 실시간 등록타입을 0으로 설정하면 등록한 종목들은 실시간 해지되고 등록한 종목만 실시간 시세가 등록됩니다. + 실시간 등록타입을 1로 설정하면 먼저 등록한 종목들과 함께 실시간 시세가 등록됩니다 + + strOptType 이 "0" 으로 하면 같은 화면에서 다른 종목 코드로 실시간 등록을 하게 되면 + 마지막에 사용한 종목코드만 실시간 등록이 되고 기존에 있던 종목은 실시간이 자동 해지됨. + "1" 로 하면 같은 화면에서 다른 종목들을 추가하게 되면 기존에 등록한 종목도 함께 실시간 시세를 받을 수 있음. + 꼭 같은 화면이여야 하고 최초 실시간 등록은 "0" 으로 하고 이후부터 "1" 로 등록해야함. + + :param strScreenNo: 화면번호 (4자리) + :type strScreenNo: str + :param strCodeList: 종목코드 (복수종목가능, ';' 구분자) + :type strCodeList: str + :param strFidList: FID (';' 구분자) + :type strFidList: str + :param strOptType: 등록타입 (0:최초 등록시, 혹은 기존 등록된 종목 해지하고 등록 1:기존 등록된 종목 유지하고 등록) + :type strOptType: str + + :returns: 통신결과 + :rtype: int + + + .. py:method:: GetConditionLoad(self) -> int + + 서버에 저장된 사용자 조건식을 조회해서 임시로 파일에 저장. + + 서버에 저장된 사용자 조건검색 목록을 요청합니다. + 조건검색 목록을 모두 수신하면 OnReceiveConditionVer() 이벤트가 발생됩니다. + 조건검색 목록 요청을 성공하면 1, 아니면 0을 리턴합니다. + + System 폴더에 아이디_NewSaveIndex.dat 파일로 저장된다. OCX 가 종료되면 삭제시킨다. + 조건검색 사용시 이 함수를 최소 한번은 호출해야 조건검색을 할 수 있다. + 영웅문에서 사용자 조건을 수정 및 추가하였을 경우에도 최신의 사용자 조건을 받고 싶으면 다시 + 조회해야한다. + + :returns: 성공하면 1, 아니면 0을 반환 + :rtype: int + + + .. py:method:: GetConditionNameList(self) -> str + + 조건검색 조건명 리스트를 받아온다. + + 서버에서 수신한 사용자 조건식을 조건식의 고유번호와 조건식 이름을 한 쌍으로 하는 문자열들로 전달합니다. + 조건식 하나는 조건식의 고유번호와 조건식 이름이 구분자 '^' 로 나뉘어져 있으며 각 조건식은 ';' 로 나뉘어져 있습니다. + 이 함수는 OnReceiveConditionVer() 이벤트에서 사용해야 합니다. + + :returns: 조건명 리스트 문자열 + :rtype: str + + .. rubric:: Examples + + >>> GetConditionNameList() + "1^내조건식1;2^내조건식2;5^내조건식3;..." + + + .. py:method:: SendCondition(self, strScrNo: str, strConditionName: str, nIndex: int, nSearch: int) -> int + + 조건검색 종목조회TR을 송신한다. + + 서버에 조건검색을 요청하는 함수입니다. + 마지막 인자값으로 조건검색만 할것인지 실시간 조건검색도 수신할 것인지를 지정할 수 있습니다. + GetConditionNameList() 함수로 얻은 조건식 이름과 고유번호의 쌍을 맞춰서 사용해야 합니다. + 리턴값 1이면 성공이며, 0이면 실패입니다. + 요청한 조건식이 없거나 조건 고유번호와 조건명이 서로 안맞거나 조회횟수를 초과하는 경우 실패하게 됩니다. + + 단순 조건식에 맞는 종목을 조회하기 위해서는 조회구분을 0으로 하고, + 실시간 조건검색을 하기 위해서는 조회구분을 1로 한다. + OnReceiveTrCondition() 으로 결과값이 온다. + 연속조회가 필요한 경우에는 응답받는 곳에서 연속조회 여부에 따라 연속조회를 송신하면된다. + + :param strScrNo: 화면번호 + :type strScrNo: str + :param strConditionName: 조건식 이름 + :type strConditionName: str + :param nIndex: 조건식 인덱스 + :type nIndex: int + :param nSearch: 조회구분 (0:일반조회, 1:실시간조회 (최초 일반조회 + 이후 실시간조회), 2:연속조회) + :type nSearch: int + + :returns: 성공하면 1, 아니면 0을 반환 + :rtype: int + + + .. py:method:: SendConditionStop(self, strScrNo: str, strConditionName: str, nIndex: int) -> None + + 조건검색 실시간 중지TR을 송신한다. + + 실시간 조건검색을 중지할 때 사용하는 함수입니다. + 조건식 조회할때 얻는 조건식 이름과 고유번호의 쌍을 맞춰서 사용해야 합니다. + + 해당 조건명의 실시간 조건검색을 중지하거나, + 다른 조건명으로 바꿀 때 이전 조건명으로 실시간 조건검색을 반드시 중지해야한다. + 화면 종료시에도 실시간 조건검색을 한 조건명으로 전부 중지해줘야 한다. + + :param strScrNo: 화면번호 + :type strScrNo: str + :param strConditionName: 조건식 이름 + :type strConditionName: str + :param nIndex: 조건식 인덱스 + :type nIndex: int + + :returns: None + + + .. py:method:: GetCommDataEx(self, strTrCode: str, strRecordName: str) + + 차트 조회 데이터를 배열로 받아온다. + + 조회 수신데이터 크기가 큰 차트데이터를 한번에 가져올 목적으로 만든 차트조회 전용함수입니다. + + 조회 데이터가 많은 차트 경우 GetCommData()로 항목당 하나씩 받아오는 것 보다 + 한번에 데이터 전부를 받아서 사용자가 처리할 수 있도록 배열로 받는다. + + ※ Qt 기준으로 QVariant 타입의 배열을 반환하지만 PySide2 에서는 완전히 똑같이 지원하진 않습니다. + + :param strTrCode: TR코드 + :type strTrCode: str + :param strRecordName: 레코드명 + :type strRecordName: str + + :returns: 조회 데이터 배열 + :rtype: QVariant + + + .. py:method:: SetRealRemove(self, strScrNo: str, strDelCode: str) -> None + + 종목별 실시간 해제. + + 실시간시세 해지 함수이며 화면번호와 종목코드를 이용해서 상세하게 설정할 수 있습니다. + + ※ A종목에 대한 실시간이 여러 화면번호로 중복 등록되어 있는 경우 특정 화면번호를 이용한 + SetRealRemove() 함수호출시 A종목의 실시간시세는 해지되지 않습니다. + + SetRealReg() 함수로 실시간 등록한 종목만 실시간 해제 할 수 있다. + + :param strScrNo: 화면번호 (4자리) 또는 "ALL" + :type strScrNo: str + :param strDelCode: 종목코드 또는 "ALL" + :type strDelCode: str + + :returns: None + + + .. py:method:: GetMarketType(self, sTrCode: str) -> int + + 주어진 종목코드의 시장구분값을 가져온다. + + 시장 구분: + - 0: 장내 + - 3: ELW + - 4: 뮤추얼펀드 + - 5: 신주인수권 + - 6: 리츠 + - 8: ETF + - 9: 하이일드펀드 + - 10: 코스닥 + - 30: K-OTC + - 50: 코넥스 (KONEX) + + :param sTrCode: 종목코드 + :type sTrCode: str + + :returns: 시장 구분값 + :rtype: int + + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusDispatchSignature/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusDispatchSignature/index.rst new file mode 100644 index 00000000..adab42cd --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusDispatchSignature/index.rst @@ -0,0 +1,58 @@ +:py:mod:`koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusDispatchSignature` +==================================================================================== + +.. py:module:: koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusDispatchSignature + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusDispatchSignature.KiwoomOpenApiPlusDispatchSignature + + + + +.. py:class:: KiwoomOpenApiPlusDispatchSignature(name: str, parameters: Dict[str, inspect.Parameter] = None, return_annotation=Signature.empty) + + Bases: :py:obj:`koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusSignature.KiwoomOpenApiPlusSignature` + + A Signature object represents the overall signature of a function. + It stores a Parameter object for each parameter accepted by the + function, as well as information specific to the function itself. + + A Signature object has the following public attributes and methods: + + * parameters : OrderedDict + An ordered mapping of parameters' names to the corresponding + Parameter objects (keyword-only arguments are in the same order + as listed in `code.co_varnames`). + * return_annotation : object + The annotation for the return type of the function if specified. + If the function has no annotation for its return type, this + attribute is set to `Signature.empty`. + * bind(*args, **kwargs) -> BoundArguments + Creates a mapping from positional and keyword arguments to + parameters. + * bind_partial(*args, **kwargs) -> BoundArguments + Creates a partial mapping from positional and keyword arguments + to parameters (simulating 'functools.partial' behavior.) + + .. py:attribute:: DISPATCH_SIGNATURES_BY_NAME + :annotation: :Dict[str, KiwoomOpenApiPlusDispatchSignature] + + + + .. py:method:: from_name(cls, name: str) -> KiwoomOpenApiPlusDispatchSignature + :classmethod: + + + .. py:method:: names(cls) -> List[str] + :classmethod: + + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusDynamicCallable/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusDynamicCallable/index.rst new file mode 100644 index 00000000..4b1e4ac9 --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusDynamicCallable/index.rst @@ -0,0 +1,101 @@ +:py:mod:`koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusDynamicCallable` +================================================================================== + +.. py:module:: koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusDynamicCallable + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusDynamicCallable.KiwoomOpenApiPlusDynamicCallableRunnable + koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusDynamicCallable.KiwoomOpenApiPlusDynamicCallable + + + + +Attributes +~~~~~~~~~~ + +.. autoapisummary:: + + koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusDynamicCallable.P + koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusDynamicCallable.R + + +.. py:data:: P + + + + +.. py:data:: R + + + + +.. py:class:: KiwoomOpenApiPlusDynamicCallableRunnable(future: concurrent.futures.Future, fn: Callable[Ellipsis, Any], args: Sequence[Any]) + + .. py:method:: run(self) + + + .. py:method:: cancel(self) + + + +.. py:class:: KiwoomOpenApiPlusDynamicCallable(control: koapy.compat.pyside2.QtAxContainer.QAxWidget, name: str, parent: Optional[koapy.compat.pyside2.QtCore.QObject] = None) + + Bases: :py:obj:`koapy.compat.pyside2.QtCore.QObject`, :py:obj:`Generic`\ [\ :py:obj:`P`\ , :py:obj:`R`\ ] + + Abstract base class for generic types. + + A generic type is typically declared by inheriting from + this class parameterized with one or more type variables. + For example, a generic mapping type might be defined as:: + + class Mapping(Generic[KT, VT]): + def __getitem__(self, key: KT) -> VT: + ... + # Etc. + + This class can then be used as follows:: + + def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT: + try: + return mapping[key] + except KeyError: + return default + + .. py:attribute:: ready_runnable + + + + + .. py:method:: bind_dynamic_call_args(self, *args, **kwargs) -> List[Any] + + + .. py:method:: is_valid_return_type(self, result: Any) -> bool + + + .. py:method:: check_return_value(self, result: Any) + + + .. py:method:: dynamic_call(self, args: Sequence[Any]) -> R + + + .. py:method:: dynamic_call_and_check(self, args: Sequence[Any]) -> R + + + .. py:method:: call(self, *args: P, **kwargs: P) -> R + + + .. py:method:: async_call(self, *args: P, **kwargs: P) -> concurrent.futures.Future + + + .. py:method:: on_ready_runnable(self, runnable: KiwoomOpenApiPlusDynamicCallableRunnable) + + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusEntrypoint/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusEntrypoint/index.rst new file mode 100644 index 00000000..aa3d5fb9 --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusEntrypoint/index.rst @@ -0,0 +1,36 @@ +:py:mod:`koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusEntrypoint` +============================================================================= + +.. py:module:: koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusEntrypoint + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusEntrypoint.KiwoomOpenApiPlusEntrypoint + + + + +.. py:class:: KiwoomOpenApiPlusEntrypoint(port=None, client_check_timeout=None) + + Bases: :py:obj:`koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusEntrypointMixin.KiwoomOpenApiPlusEntrypointMixin`, :py:obj:`koapy.utils.logging.Logging.Logging` + + .. py:method:: get_stub(self) + + + .. py:method:: close_client(self) + + + .. py:method:: close_server_proc(self) + + + .. py:method:: close(self) + + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusEntrypointMixin/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusEntrypointMixin/index.rst new file mode 100644 index 00000000..326093f6 --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusEntrypointMixin/index.rst @@ -0,0 +1,22 @@ +:py:mod:`koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusEntrypointMixin` +================================================================================== + +.. py:module:: koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusEntrypointMixin + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusEntrypointMixin.KiwoomOpenApiPlusEntrypointMixin + + + + +.. py:class:: KiwoomOpenApiPlusEntrypointMixin + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusError/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusError/index.rst new file mode 100644 index 00000000..7a410ebf --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusError/index.rst @@ -0,0 +1,472 @@ +:py:mod:`koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusError` +======================================================================== + +.. py:module:: koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusError + + +Module Contents +--------------- + +.. py:data:: CallableReturnsInt + + + + +.. py:data:: IntOrBool + + + + +.. py:data:: CallableReturnsIntOrBool + + + + +.. py:data:: IntCompatible + + + + +.. py:data:: BoolCompatible + + + + +.. py:exception:: KiwoomOpenApiPlusError(message: Optional[str] = None) + + Bases: :py:obj:`Exception` + + Common base class for all non-exit exceptions. + + .. py:method:: message(self) + :property: + + + .. py:method:: try_or_raise(cls, arg: IntCompatible, message: Optional[str] = None, except_callback: Optional[Callable] = None) -> IntCompatible + :classmethod: + + + .. py:method:: try_or_raise_boolean(cls, arg: BoolCompatible, message: str, except_callback: Optional[Callable] = None) -> BoolCompatible + :classmethod: + + + .. py:method:: get_error_message_by_code(cls, code: int, default: Optional[str] = None) + :classmethod: + + + +.. py:exception:: KiwoomOpenApiPlusNegativeReturnCodeError(code: int, message: Optional[str] = None) + + Bases: :py:obj:`KiwoomOpenApiPlusError` + + Common base class for all non-exit exceptions. + + .. py:attribute:: OP_ERR_NONE + :annotation: = 0 + + + + .. py:attribute:: OP_ERR_FAIL + + + + + .. py:attribute:: OP_ERR_COND_NOTFOUND + + + + + .. py:attribute:: OP_ERR_COND_MISMATCH + + + + + .. py:attribute:: OP_ERR_COND_OVERFLOW + + + + + .. py:attribute:: OP_ERR_TR_FAIL + + + + + .. py:attribute:: OP_ERR_LOGIN + + + + + .. py:attribute:: OP_ERR_CONNECT + + + + + .. py:attribute:: OP_ERR_VERSION + + + + + .. py:attribute:: OP_ERR_FIREWALL + + + + + .. py:attribute:: OP_ERR_MEMORY + + + + + .. py:attribute:: OP_ERR_INPUT + + + + + .. py:attribute:: OP_ERR_SOCKET_CLOSED + + + + + .. py:attribute:: OP_ERR_SISE_OVERFLOW + + + + + .. py:attribute:: OP_ERR_RQ_STRUCT_FAIL + + + + + .. py:attribute:: OP_ERR_RQ_STRING_FAIL + + + + + .. py:attribute:: OP_ERR_NO_DATA + + + + + .. py:attribute:: OP_ERR_OVER_MAX_DATA + + + + + .. py:attribute:: OP_ERR_DATA_RCV_FAIL + + + + + .. py:attribute:: OP_ERR_OVER_MAX_FID + + + + + .. py:attribute:: OP_ERR_REAL_CANCEL + + + + + .. py:attribute:: OP_ERR_ORD_WRONG_INPUT + + + + + .. py:attribute:: OP_ERR_ORD_WRONG_ACCTNO + + + + + .. py:attribute:: OP_ERR_OTHER_ACC_USE + + + + + .. py:attribute:: OP_ERR_MIS_2BILL_EXC + + + + + .. py:attribute:: OP_ERR_MIS_5BILL_EXC + + + + + .. py:attribute:: OP_ERR_MIS_1PER_EXC + + + + + .. py:attribute:: OP_ERR_MIS_3PER_EXC + + + + + .. py:attribute:: OP_ERR_SEND_FAIL + + + + + .. py:attribute:: OP_ERR_ORD_OVERFLOW + + + + + .. py:attribute:: OP_ERR_ORD_OVERFLOW2 + + + + + .. py:attribute:: OP_ERR_MIS_300CNT_EXC + + + + + .. py:attribute:: OP_ERR_MIS_500CNT_EXC + + + + + .. py:attribute:: OP_ERR_ORD_WRONG_ACCTINFO + + + + + .. py:attribute:: OP_ERR_ORD_SYMCODE_EMPTY + + + + + .. py:attribute:: MSG_ERR_NONE + :annotation: = 정상처리 + + + + .. py:attribute:: MSG_ERR_FAIL + :annotation: = 실패 + + + + .. py:attribute:: MSG_ERR_COND_NOTFOUND + :annotation: = 조건번호 없음 + + + + .. py:attribute:: MSG_ERR_COND_MISMATCH + :annotation: = 조건번호와 조건식 틀림 + + + + .. py:attribute:: MSG_ERR_COND_OVERFLOW + :annotation: = 조건검색 조회요청 초과 + + + + .. py:attribute:: MSG_ERR_TR_FAIL + :annotation: = 전문 처리 실패 + + + + .. py:attribute:: MSG_ERR_LOGIN + :annotation: = 사용자정보 교환 실패 + + + + .. py:attribute:: MSG_ERR_CONNECT + :annotation: = 서버접속 실패 + + + + .. py:attribute:: MSG_ERR_VERSION + :annotation: = 버전처리 실패 + + + + .. py:attribute:: MSG_ERR_FIREWALL + :annotation: = 개인방화벽 실패 + + + + .. py:attribute:: MSG_ERR_MEMORY + :annotation: = 메모리보호 실패 + + + + .. py:attribute:: MSG_ERR_INPUT + :annotation: = 함수입력값 오류 + + + + .. py:attribute:: MSG_ERR_SOCKET_CLOSED + :annotation: = 통신 연결종료 + + + + .. py:attribute:: MSG_ERR_SISE_OVERFLOW + :annotation: = 시세조회 과부하 + + + + .. py:attribute:: MSG_ERR_RQ_STRUCT_FAIL + :annotation: = 전문작성 초기화 실패 + + + + .. py:attribute:: MSG_ERR_RQ_STRING_FAIL + :annotation: = 전문작성 입력값 오류 + + + + .. py:attribute:: MSG_ERR_NO_DATA + :annotation: = 데이터 없음 + + + + .. py:attribute:: MSG_ERR_OVER_MAX_DATA + :annotation: = 조회 가능한 종목수 초과 + + + + .. py:attribute:: MSG_ERR_DATA_RCV_FAIL + :annotation: = 데이터수신 실패 + + + + .. py:attribute:: MSG_ERR_OVER_MAX_FID + :annotation: = 조회 가능한 FID수 초과 + + + + .. py:attribute:: MSG_ERR_REAL_CANCEL + :annotation: = 실시간 해제 오류 + + + + .. py:attribute:: MSG_ERR_ORD_WRONG_INPUT + :annotation: = 입력값 오류 + + + + .. py:attribute:: MSG_ERR_ORD_WRONG_ACCTNO + :annotation: = 계좌 비밀번호 없음 + + + + .. py:attribute:: MSG_ERR_OTHER_ACC_USE + :annotation: = 타인계좌사용 오류 + + + + .. py:attribute:: MSG_ERR_MIS_2BILL_EXC + :annotation: = 주문가격이 20억원을 초과 + + + + .. py:attribute:: MSG_ERR_MIS_5BILL_EXC + :annotation: = 주문가격이 50억원을 초과 + + + + .. py:attribute:: MSG_ERR_MIS_1PER_EXC + :annotation: = 주문수량이 총발행주수의 1%초과오류 + + + + .. py:attribute:: MSG_ERR_MIS_3PER_EXC + :annotation: = 주문수량이 총발행주수의 3%초과오류 + + + + .. py:attribute:: MSG_ERR_SEND_FAIL + :annotation: = 주문전송 실패 + + + + .. py:attribute:: MSG_ERR_ORD_OVERFLOW + :annotation: = 주문전송 과부하 + + + + .. py:attribute:: MSG_ERR_ORD_OVERFLOW2 + :annotation: = 주문전송 과부하 + + + + .. py:attribute:: MSG_ERR_MIS_300CNT_EXC + :annotation: = 주문수량 300계약 초과 + + + + .. py:attribute:: MSG_ERR_MIS_500CNT_EXC + :annotation: = 주문수량 500계약 초과 + + + + .. py:attribute:: MSG_ERR_ORD_WRONG_ACCTINFO + :annotation: = 계좌정보없음 + + + + .. py:attribute:: MSG_ERR_ORD_SYMCODE_EMPTY + :annotation: = 종목코드없음 + + + + .. py:attribute:: ERROR_MESSAGE_BY_CODE + + + + + .. py:method:: get_error_message_by_code(cls, code: int, default: Optional[str] = None) + :classmethod: + + + .. py:method:: check_code_or_raise(cls, code: int) + :classmethod: + + + .. py:method:: wrap_to_check_code_or_raise(cls, func: CallableReturnsInt) -> CallableReturnsInt + :classmethod: + + + .. py:method:: try_or_raise(cls, arg: IntCompatible, message: Optional[str] = None, except_callback: Optional[Callable] = None) -> IntCompatible + :classmethod: + + + .. py:method:: code(self) + :property: + + + +.. py:exception:: KiwoomOpenApiPlusBooleanReturnCodeError(code: Union[int, bool], message: Optional[str] = None) + + Bases: :py:obj:`KiwoomOpenApiPlusError` + + Common base class for all non-exit exceptions. + + .. py:attribute:: OP_ERR_SUCCESS + :annotation: = 1 + + + + .. py:attribute:: OP_ERR_FAILURE + :annotation: = 0 + + + + .. py:method:: check_code_or_raise(cls, code: IntOrBool, message: Optional[str] = None) -> IntOrBool + :classmethod: + + + .. py:method:: wrap_to_check_code_or_raise(cls, func: CallableReturnsIntOrBool, message: Optional[str] = None) -> CallableReturnsIntOrBool + :classmethod: + + + .. py:method:: try_or_raise(cls, arg: BoolCompatible, message: Optional[str] = None, except_callback: Optional[Callable] = None) -> BoolCompatible + :classmethod: + + + .. py:method:: code(self) + :property: + + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusEventFunctions/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusEventFunctions/index.rst new file mode 100644 index 00000000..4fe81447 --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusEventFunctions/index.rst @@ -0,0 +1,192 @@ +:py:mod:`koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusEventFunctions` +================================================================================= + +.. py:module:: koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusEventFunctions + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusEventFunctions.KiwoomOpenApiPlusEventFunctions + + + + +.. py:class:: KiwoomOpenApiPlusEventFunctions + + .. py:method:: OnReceiveTrData(self, sScrNo: str, sRQName: str, sTrCode: str, sRecordName: str, sPrevNext: str, nDataLength: int, sErrorCode: str, sMessage: str, sSplmMsg: str) -> None + + 서버통신 후 데이터를 받은 시점을 알려준다. + + 요청했던 조회데이터를 수신했을때 발생됩니다. + 수신된 데이터는 이 이벤트내부에서 GetCommData() 함수를 이용해서 얻어올 수 있습니다. + + 파라미터 매핑: + - sRQName = CommRqData() 의 sRQName과 매핑되는 이름이다. + - sTrCode = CommRqData() 의 sTrCode과 매핑되는 이름이다. + + :param sScrNo: 화면번호 + :type sScrNo: str + :param sRQName: 사용자 구분명 + :type sRQName: str + :param sTrCode: TR 코드 + :type sTrCode: str + :param sRecordName: 레코드 명 + :type sRecordName: str + :param sPrevNext: 연속조회 유무 (0:추가조회 데이터 없음, 2:추가조회 데이터 있음) + :type sPrevNext: str + :param nDataLength: 사용안함 + :type nDataLength: str + :param sErrorCode: 사용안함 + :type sErrorCode: str + :param sMessage: 사용안함 + :type sMessage: str + :param sSplmMsg: 사용안함 + :type sSplmMsg: str + + :returns: None + + + .. py:method:: OnReceiveRealData(self, sRealKey: str, sRealType: str, sRealData: str) -> None + + 실시간데이터를 받은 시점을 알려준다. + + 실시간시세 데이터가 수신될때마다 종목단위로 발생됩니다. + SetRealReg() 함수로 등록한 실시간 데이터도 이 이벤트로 전달됩니다. + GetCommRealData() 함수를 이용해서 수신된 데이터를 얻을수 있습니다. + + :param sRealKey: 종목코드 + :type sRealKey: str + :param sRealType: 실시간 타입 + :type sRealType: str + :param sRealData: 실시간 데이터전문 (사용불가) + :type sRealData: str + + :returns: None + + + .. py:method:: OnReceiveMsg(self, sScrNo: str, sRQName: str, sTrCode: str, sMsg: str) -> None + + 서버통신 후 메시지를 받은 시점을 알려준다. + + 주문전송 또는 데이터 조회요청 후 서버 메시지가 수신됩니다. + ※ 메시지에 포함된 6자리 코드번호는 변경될 수 있으니, 여기에 수신된 코드번호를 특정 용도로 사용하지 마시기 바랍니다. + + 파라미터 매핑: + - sScrNo = CommRqData() 의 sScrNo와 매핑된다. + - sRQName = CommRqData() 의 sRQName 와 매핑된다. + - sTrCode = CommRqData() 의 sTrCode 와 매핑된다. + + 메시지 예시: + - "조회가 완료되었습니다." + - "증거금 부족으로 주문이 거부되었습니다." + - "정정할 원주문 내역이 없습니다." + - "비밀번호 입력을 확인해주시기 바랍니다." + + :param sScrNo: str, sRQName: str, sTrCode: str, sMsg: str + + :returns: None + + + .. py:method:: OnReceiveChejanData(self, sGubun: str, nItemCnt: int, sFIdList: str) -> None + + 체결데이터를 받은 시점을 알려준다. + + 주문전송 후 주문접수, 체결통보, 잔고통보를 수신할 때 마다 발생됩니다. + GetChejanData() 함수를 이용해서 FID 항목별 값을 얻을수 있습니다. + + :param sGubun: 체결구분 (0:주문체결통보, 1:국내주식 잔고통보, 4:파생상품 잔고통보) + :type sGubun: str + :param nItemCnt: 아이템 개수 + :type nItemCnt: int + :param sFIdList: 데이터 리스트 (';' 구분자) + :type sFIdList: str + + :returns: None + + + .. py:method:: OnEventConnect(self, nErrCode: int) -> None + + 서버 접속 관련 이벤트. + + 로그인 처리 이벤트입니다. 성공이면 인자값 nErrCode가 0이며 에러는 다음과 같은 값이 전달됩니다. + + 에러코드 구분: + - OP_ERR_LOGIN(-100): 사용자 정보교환 실패 + - OP_ERR_CONNECT(-101): 서버접속 실패 + - OP_ERR_VERSION(-102): 버전처리 실패 + + :param nErrCode: 에러코드 (0:로그인 성공, 음수:실패) + :type nErrCode: int + + :returns: None + + + .. py:method:: OnReceiveInvestRealData(self, sRealKey: str) -> None + + 더 이상 지원하지 않는 함수. + + + .. py:method:: OnReceiveRealCondition(self, sTrCode: str, strType: str, strConditionName: str, strConditionIndex: str) -> None + + 조건검색 실시간 편입,이탈 종목을 받을 시점을 알려준다. + + 실시간 조건검색 요청으로 신규종목이 편입되거나 기존 종목이 이탈될때 마다 발생됩니다. + ※ 편입되었다가 순간적으로 다시 이탈되는 종목에대한 신호는 조건검색 서버마다 차이가 발생할 수 있습니다. + + strConditionName 에 해당하는 종목이 실시간으로 들어옴. + strType 으로 편입된 종목인지 이탈된 종목인지 구분한다. + + :param sTrCode: 종목코드 + :type sTrCode: str + :param strType: 편입/이탈 구분 (I:편입, D:이탈) + :type strType: str + :param strConditionName: 조건식 이름 + :type strConditionName: str + :param strConditionIndex: 조건식 인덱스 + :type strConditionIndex: str + + :returns: None + + + .. py:method:: OnReceiveTrCondition(self, sScrNo: str, strCodeList: str, strConditionName: str, nIndex: int, nNext: int) -> None + + 조건검색 조회응답으로 종목리스트를 받는 시점. + + 조건검색 요청에대한 서버 응답 수신시 발생하는 이벤트입니다. + 종목코드 리스트는 각 종목코드가 ';' 로 구분되서 전달됩니다. + + :param sScrNo: 화면번호 + :type sScrNo: str + :param strCodeList: 종목리스트 (';' 구분자) + :type strCodeList: str + :param strConditionName: 조건식 이름 + :type strConditionName: str + :param nIndex: 조건식 인덱스 + :type nIndex: int + :param nNext: 연속조회 여부 (2:연속조회, 0:연속조회 없음) + :type nNext: int + + :returns: None + + + .. py:method:: OnReceiveConditionVer(self, lRet: int, sMsg: str) -> None + + 로컬에 사용자 조건식 저장 성공 여부를 확인하는 시점. + + 저장된 사용자 조건식 불러오기 요청에 대한 응답 수신시 발생되는 이벤트입니다. + + :param lRet: 사용자 조건식 저장 성공여부 (1:성공, 나머지:실패) + :type lRet: int + :param sMsg: 호출결과 메시지 + :type sMsg: str + + :returns: None + + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusEventHandler/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusEventHandler/index.rst new file mode 100644 index 00000000..b12bf0d8 --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusEventHandler/index.rst @@ -0,0 +1,66 @@ +:py:mod:`koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusEventHandler` +=============================================================================== + +.. py:module:: koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusEventHandler + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusEventHandler.KiwoomOpenApiPlusEventHandler + + + + +.. py:class:: KiwoomOpenApiPlusEventHandler(control) + + Bases: :py:obj:`koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusEventHandlerFunctions.KiwoomOpenApiPlusEventHandlerFunctions` + + .. py:method:: control(self) + :property: + + + .. py:method:: observer(self) + :property: + + + .. py:method:: names(cls) + :classmethod: + + + .. py:method:: slots(self) + + + .. py:method:: connect(self) + + + .. py:method:: disconnect(self) + + + .. py:method:: on_enter(self) + + + .. py:method:: on_exit(self, exc_type=None, exc_value=None, traceback=None) + + + .. py:method:: add_callback(self, callback, *args, **kwargs) + + + .. py:method:: enter(self) + + + .. py:method:: exit(self, exc_type=None, exc_value=None, traceback=None) + + + .. py:method:: stop(self) + + + .. py:method:: close(self) + + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusEventHandlerFunctions/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusEventHandlerFunctions/index.rst new file mode 100644 index 00000000..a4ca5120 --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusEventHandlerFunctions/index.rst @@ -0,0 +1,54 @@ +:py:mod:`koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusEventHandlerFunctions` +======================================================================================== + +.. py:module:: koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusEventHandlerFunctions + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusEventHandlerFunctions.KiwoomOpenApiPlusEventHandlerFunctions + + + + +.. py:class:: KiwoomOpenApiPlusEventHandlerFunctions + + .. py:method:: OnEventConnect(self, errcode) + :abstractmethod: + + + .. py:method:: OnReceiveMsg(self, scrnno, rqname, trcode, msg) + :abstractmethod: + + + .. py:method:: OnReceiveTrData(self, scrnno, rqname, trcode, recordname, prevnext, datalength, errorcode, message, splmmsg) + :abstractmethod: + + + .. py:method:: OnReceiveRealData(self, code, realtype, realdata) + :abstractmethod: + + + .. py:method:: OnReceiveChejanData(self, gubun, itemcnt, fidlist) + :abstractmethod: + + + .. py:method:: OnReceiveConditionVer(self, ret, msg) + :abstractmethod: + + + .. py:method:: OnReceiveTrCondition(self, scrnno, codelist, condition_name, condition_index, prevnext) + :abstractmethod: + + + .. py:method:: OnReceiveRealCondition(self, code, condition_type, condition_name, condition_index) + :abstractmethod: + + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusEventHandlerSignature/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusEventHandlerSignature/index.rst new file mode 100644 index 00000000..d5df769f --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusEventHandlerSignature/index.rst @@ -0,0 +1,58 @@ +:py:mod:`koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusEventHandlerSignature` +======================================================================================== + +.. py:module:: koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusEventHandlerSignature + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusEventHandlerSignature.KiwoomOpenApiPlusEventHandlerSignature + + + + +.. py:class:: KiwoomOpenApiPlusEventHandlerSignature(name: str, parameters: Dict[str, inspect.Parameter] = None, return_annotation=Signature.empty) + + Bases: :py:obj:`koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusSignature.KiwoomOpenApiPlusSignature` + + A Signature object represents the overall signature of a function. + It stores a Parameter object for each parameter accepted by the + function, as well as information specific to the function itself. + + A Signature object has the following public attributes and methods: + + * parameters : OrderedDict + An ordered mapping of parameters' names to the corresponding + Parameter objects (keyword-only arguments are in the same order + as listed in `code.co_varnames`). + * return_annotation : object + The annotation for the return type of the function if specified. + If the function has no annotation for its return type, this + attribute is set to `Signature.empty`. + * bind(*args, **kwargs) -> BoundArguments + Creates a mapping from positional and keyword arguments to + parameters. + * bind_partial(*args, **kwargs) -> BoundArguments + Creates a partial mapping from positional and keyword arguments + to parameters (simulating 'functools.partial' behavior.) + + .. py:attribute:: EVENT_HANDLER_SIGNATURES_BY_NAME + :annotation: :Dict[str, KiwoomOpenApiPlusEventHandlerSignature] + + + + .. py:method:: from_name(cls, name: str) -> KiwoomOpenApiPlusEventHandlerSignature + :classmethod: + + + .. py:method:: names(cls) -> List[str] + :classmethod: + + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusLoggingEventHandler/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusLoggingEventHandler/index.rst new file mode 100644 index 00000000..52d06377 --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusLoggingEventHandler/index.rst @@ -0,0 +1,61 @@ +:py:mod:`koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusLoggingEventHandler` +====================================================================================== + +.. py:module:: koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusLoggingEventHandler + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusLoggingEventHandler.KiwoomOpenApiPlusLoggingEventHandler + + + + +.. py:class:: KiwoomOpenApiPlusLoggingEventHandler(control) + + Bases: :py:obj:`koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusEventHandler.KiwoomOpenApiPlusEventHandler`, :py:obj:`koapy.utils.logging.Logging.Logging` + + .. py:method:: OnReceiveTrData(self, scrnno, rqname, trcode, recordname, prevnext, _datalength, _errorcode, _message, _splmmsg) + + + .. py:method:: OnReceiveRealData(self, code, realtype, realdata) + + + .. py:method:: OnReceiveMsg(self, scrnno, rqname, trcode, msg) + + [OnReceiveMsg()이벤트] + + OnReceiveMsg( + BSTR sScrNo, // 화면번호 + BSTR sRQName, // 사용자 구분명 + BSTR sTrCode, // TR이름 + BSTR sMsg // 서버에서 전달하는 메시지 + ) + + 서버통신 후 수신한 메시지를 알려줍니다. + 메시지에는 6자리 코드번호가 포함되는데 이 코드번호는 통보없이 수시로 변경될 수 있습니다. 따라서 주문이나 오류관련처리를 + 이 코드번호로 분류하시면 안됩니다. + + + .. py:method:: OnReceiveChejanData(self, gubun, itemcnt, fidlist) + + + .. py:method:: OnEventConnect(self, errcode) + + + .. py:method:: OnReceiveRealCondition(self, code, condition_type, condition_name, condition_index) + + + .. py:method:: OnReceiveTrCondition(self, scrnno, codelist, condition_name, condition_index, prevnext) + + + .. py:method:: OnReceiveConditionVer(self, ret, msg) + + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusQAxWidget/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusQAxWidget/index.rst new file mode 100644 index 00000000..49de484b --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusQAxWidget/index.rst @@ -0,0 +1,53 @@ +:py:mod:`koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusQAxWidget` +============================================================================ + +.. py:module:: koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusQAxWidget + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusQAxWidget.KiwoomOpenApiPlusQAxWidget + + + + +.. py:class:: KiwoomOpenApiPlusQAxWidget(c: Optional[str] = None, parent: Optional[koapy.compat.pyside2.QtWidgets.QWidget] = None, f: koapy.compat.pyside2.QtCore.Qt.WindowFlags = Qt.WindowFlags()) KiwoomOpenApiPlusQAxWidget(parent: Optional[koapy.compat.pyside2.QtWidgets.QWidget] = None, f: koapy.compat.pyside2.QtCore.Qt.WindowFlags = Qt.WindowFlags()) + + Bases: :py:obj:`koapy.utils.logging.pyside2.QWidgetLogging.QWidgetLogging`, :py:obj:`koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusQAxWidgetMixin.KiwoomOpenApiPlusQAxWidgetMixin` + + KiwoomOpenApiPlusQAxWidgetUniversalMixin, KiwoomOpenApiPlusQAxWidgetServerSideMixin 구현이 포함된 + KiwoomOpenApiPlusQAxWidget 객체를 위한 Mixin 입니다. + + .. py:attribute:: CLSID + :annotation: = {A1574A0D-6BFA-4BD7-9020-DED88711818D} + + + + .. py:attribute:: PROGID + :annotation: = KHOPENAPI.KHOpenApiCtrl.1 + + + + .. py:attribute:: METHOD_NAMES + + + + + .. py:attribute:: EVENT_NAMES + + + + + .. py:method:: changeEvent(self, event) + + + .. py:method:: closeEvent(self, event) + + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusQAxWidgetMixin/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusQAxWidgetMixin/index.rst new file mode 100644 index 00000000..c16713b9 --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusQAxWidgetMixin/index.rst @@ -0,0 +1,421 @@ +:py:mod:`koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusQAxWidgetMixin` +================================================================================= + +.. py:module:: koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusQAxWidgetMixin + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusQAxWidgetMixin.KiwoomOpenApiPlusQAxWidgetUniversalMixin + koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusQAxWidgetMixin.KiwoomOpenApiPlusQAxWidgetServerSideMixin + koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusQAxWidgetMixin.KiwoomOpenApiPlusQAxWidgetMixin + + + + +.. py:class:: KiwoomOpenApiPlusQAxWidgetUniversalMixin + + Bases: :py:obj:`koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusDispatchFunctions.KiwoomOpenApiPlusDispatchFunctions` + + 일차적으로 KiwoomOpenApiPlusQAxWidget 객체에 대해 사용될 수 있는 Mixin 이지만, + 넓게는 다른 KiwoomOpenApiPlusDispatchFunctions 인터페이스를 지원하는 모든 객체에서 사용될 수 있는, + 단순하면서도 유니버셜한 메소드들이 구현되어 있는 Mixin 입니다. + + .. py:method:: IsConnected(self) + + 키움증권 서버에 접속되었는지 여부를 반환합니다. + + + .. py:method:: ShowAccountWindow(self) + + 계좌 비밀번호 및 자동 로그인 처리 관련 설정창을 표시합니다. + + + .. py:method:: GetServerGubun(self) + + 접속된 서버의 종류를 확인해 구분값을 반환합니다. + + + .. py:method:: IsSimulationServer(self) + + 모의투자 서버 접속 여부를 확인해 반환합니다. + + + .. py:method:: IsRealServer(self) + + 실 서버 접속 여부를 확인해 반환합니다. + + + .. py:method:: GetMasterStockInfo(self, code) + + 주식의 종목분류, 시장구분등의 정보를 제공합니다. + + + .. py:method:: GetMasterStockInfoAsDict(self, code) + + 주식의 종목분류, 시장구분등의 정보를 딕셔너리 형태로 가공하여 제공합니다. + + + .. py:method:: SetConditionSearchFlag(self, flag) + + 조건 검색시 동작과 관련된 플래그를 설정합니다. + + + .. py:method:: AddPriceToConditionSearchResult(self) + + 조건 검색시 현재가를 함께 수신하도록 설정합니다. + + + .. py:method:: DelPriceFromConditionSearchResult(self) + + 조건 검색시 현재가를 함께 수신하지 않도록 설정합니다. + + + .. py:method:: GetUpjongCode(self, code) + + 업종코드 목록을 반환합니다. + + 인자로 사용할 수 있는 값은 0, 1, 2, 4, 7 입니다. + 0:코스피, 1: 코스닥, 2:KOSPI200, 4:KOSPI100(KOSPI50), 7:KRX100 + + + .. py:method:: GetUpjongCodeAsList(self, code) + + 업종코드 목록을 리스트 형태로 가공하여 반환합니다. + + 인자로 사용할 수 있는 값은 0, 1, 2, 4, 7 입니다. + 0:코스피, 1: 코스닥, 2:KOSPI200, 4:KOSPI100(KOSPI50), 7:KRX100 + + + .. py:method:: GetUpjongNameByCode(self, code) + + 주어진 업종코드의 이름을 반환합니다. + + + .. py:method:: IsOrderWarningETF(self, code) + + ETF 의 투자유의 종목 여부를 반환합니다. + + 투자유의 종목인 경우 "1" 값이 리턴, + 그렇지 않은 경우 "0" 값 리턴. + ETF가 아닌 종목을 입력시 "0" 값 리턴. + + + .. py:method:: IsOrderWarningETFAsBoolean(self, code) + + ETF 의 투자유의 종목 여부를 불리언 형태로 변환하여 반환합니다. + + + .. py:method:: IsOrderWarningStock(self, code) + + 주식 전종목 대상 투자유의 종목 여부를 반환합니다. + + 리턴 값 - "0":해당없음, "2":정리매매, "3":단기과열, "4":투자위험, "5":투자경고 + + + .. py:method:: IsOrderWarningStockAsBoolean(self, code) + + 주식 전종목 대상 투자유의 종목 여부를 불리언 형태로 변환하여 반환합니다. + + + .. py:method:: GetMasterListedStockCntEx(self, code) + + 종목의 상장 주식수를 반환합니다. + + 기존의 GetMasterListedStockCnt() 함수 사용시 발생할 수 있는 오버플로우 문제를 해결합니다. + + + .. py:method:: GetMasterListedStockCntExAsInt(self, code) + + 종목의 상장 주식수를 정수 형태로 변환하여 반환합니다. + + + .. py:method:: GetCodeListByMarketAsList(self, market: Optional[Union[str, int]] = None) + + 시장의 종목 코드 목록를 리스트 형태로 가공하여 반환합니다. + + + .. py:method:: GetNameListByMarketAsList(self, market: Optional[Union[str, int]] = None) + + 시장의 종목 이름 목록를 리스트 형태로 가공하여 반환합니다. + + + .. py:method:: GetUserId(self) + + 사용자 ID 를 반환합니다. + + + .. py:method:: GetUserName(self) + + 사용자 이름을 반환합니다. + + + .. py:method:: GetAccountCount(self) + + 계좌 개수를 반환합니다. + + + .. py:method:: GetAccountList(self) + + 계좌 목록을 리스트 형태로 가공하여 반환합니다. + + + .. py:method:: GetKeyboardSecurityStatus(self) + + 키보드 보안 설정 상태를 반환합니다. + + + .. py:method:: IsKeyboardSecurityEnabled(self) + + 키보드 보안 설정 상태를 불리언 형태로 변환하여 반환합니다. + + + .. py:method:: GetFirewallStatus(self) + + 방화벽 설정 상태를 반환합니다. + + + .. py:method:: IsFirewallEnabled(self) + + 방화벽 설정 상태를 불리언 형태로 변환하여 반환합니다. + + + .. py:method:: GetFirstAvailableAccount(self) + + 확인 가능한 첫번째 계좌번호를 반환합니다. + + + .. py:method:: GetMasterStockStateAsList(self, code: str) + + 입력한 종목의 증거금 비율, 거래정지, 관리종목, 감리종목, 투자융의종목, 담보대출, 액면분할, 신용가능 여부를 + 리스트 형태로 가공하여 전달합니다. + + + .. py:method:: GetKospiCodeList(self) + + 장내 종목 코드 목록을 반환합니다. + + + .. py:method:: GetKosdaqCodeList(self) + + 코스닥 시장내 종목 코드 목록을 반환합니다. + + + .. py:method:: GetGeneralCodeList(self, include_preferred_stock: bool = False, include_etn: bool = False, include_etf: bool = False, include_mutual_fund: bool = False, include_reits: bool = False, include_kosdaq: bool = False) + + 장내 종목 코드 목록중 특정 그룹을 포함시키고 혹은 제거하고 반환합니다. + + + .. py:method:: GetStockStates(self, code: str) + + 입력한 종목의 증거금 비율, 거래정지, 관리종목, 감리종목, 투자유의종목, 담보대출, 액면분할, 신용가능 여부를 전달합니다. + + + .. py:method:: GetSurveillanceFlag(self, code: str) + + 입력한 종목코드에 해당하는 종목의 감리구분을 전달합니다. (정상, 투자주의, 투자경고, 투자위험, 투자주의환기종목) + + + .. py:method:: IsSuspended(self, code: str) + + 거래정지 여부를 반환합니다. + + + .. py:method:: IsUnderSurveillance(self, code: str) + + 감리종목 여부를 반환합니다. + + + .. py:method:: IsUnderAdministration(self, code: str) + + 관리종목 여부를 반환합니다. + + + .. py:method:: IsFlaggedForCaution(self, code: str) + + 감리구분이 정상이 아니거나 상태값중 투자유의종목으로 지정된 경우 참을 반환합니다. + + + .. py:method:: IsNotNormal(self, code: str) + + 감리구분이 정상이 아니거나 상태값중 거래정지, 감리종목, 관리종목, 투자유의종목 등으로 지정된 경우 참을 반환합니다. + + + .. py:method:: IsNormal(self, code: str) + + 감리구분이 정상이고 별다른 이상 상태값이 없는 경우 참을 반환합니다. + + + .. py:method:: GetConditionFilePath(self) + + 조건식 데이터를 로드한 후 생성되는 조건검색 관련 데이터 파일의 경로를 반환합니다. + + + .. py:method:: GetConditionNameListAsList(self) + + 조건식 데이터를 로드한 후 확인 가능한 조건식 목록을 리스트 형태로 가공하여 반환합니다. + + + .. py:method:: GetAutoLoginDatPath(self) + + 자동 로그인 설정시 생성되는 자동 로그인 관련 데이터 파일의 경로를 반환합니다. + + + .. py:method:: IsAutoLoginEnabled(self) + + 자동 로그인 설정 여부를 반환합니다. + + 자동 로그인 설정시 생성되는 자동 로그인 관련 데이터 파일 경로에 파일이 존재하는지의 여부를 확인합니다. + + + .. py:method:: DisableAutoLogin(self) + + 자동 로그인 설정을 해제합니다. + + 자동 로그인 설정시 생성되는 자동 로그인 관련 데이터 파일 경로에 파일이 존재하는 경우 해당 파일을 삭제합니다. + + + .. py:method:: RunScriptInSubprocess_WithData(cls, main: Callable[Ellipsis, Any], data: Optional[Mapping[str, Any]] = None, wait: bool = False, timeout: bool = None, check: bool = False, stdin: Optional[int] = subprocess.PIPE, stdout: Optional[int] = None) + :classmethod: + + + .. py:method:: LoginUsingPywinauto_Impl(cls, credentials: Optional[Mapping[str, Any]] = None) + :classmethod: + + + .. py:method:: LoginUsingPywinauto_RunScriptInSubprocess(cls, credentials: Optional[Mapping[str, Any]] = None, wait: bool = False, timeout: bool = None, check: bool = False) + :classmethod: + + + .. py:method:: LoginUsingPywinauto(self, credentials: Optional[Mapping[str, Any]] = None, wait: bool = True, timeout: bool = None, check: bool = True) + + 자식 프로세스 내에서 pywinauto 를 사용해 로그인 처리를 자동으로 진행합니다. + + + .. py:method:: CommConnectAndThen(self, credentials: Mapping[str, Any], callback: Callable[[int], Any]) -> int + CommConnectAndThen(self, credentials: Mapping[str, Any]) -> int + CommConnectAndThen(self, callback: Callable[[int], Any]) -> int + CommConnectAndThen(self) -> int + + 로그인 처리를 진행하고 이후 발생하는 이벤트 함수내에서 특정 콜백 함수를 실행합니다. + + + .. py:method:: Connect(self, credentials: Optional[Mapping[str, Any]] = None) -> int + + 로그인 처리를 진행하고 이후 발생하는 이벤트 함수내에서 확인 가능한 에러코드 값을 반환합니다. + + + .. py:method:: EnsureConnectedAndThen(self, credentials: Mapping[str, Any], callback: Callable[[int], Any]) -> bool + EnsureConnectedAndThen(self, credentials: Mapping[str, Any]) -> bool + EnsureConnectedAndThen(self, callback: Callable[[int], Any]) -> bool + EnsureConnectedAndThen(self) -> bool + + 로그인 여부를 확인하고 로그인 상태를 보장한 뒤에 주어진 콜백 함수를 실행합니다. + + 로그인 여부 확인시 로그인 되어있지 않다면 로그인을 진행한 뒤 주어진 콜백 함수를 실행합니다. + 이미 로그인이 되어있다면 즉시 주어진 콜백 함수를 실행합니다. + + + .. py:method:: EnsureConnected(self, credentials: Optional[Mapping[str, Any]] = None) -> bool + + 로그인 상태를 보장하도록 합니다. + + 이미 로그인이 되어있는 경우 별다른 처리를 하지 않습니다. + 로그인이 되어있지 않다면 로그인을 수행합니다. + + + .. py:method:: EnableAutoLoginUsingPywinauto_Impl(cls, account_passwords: Optional[Mapping[str, Any]] = None) + :classmethod: + + + .. py:method:: EnableAutoLoginUsingPywinauto_RunScriptInSubprocess(cls, account_passwords: Optional[Mapping[str, Any]] = None, wait: bool = False, timeout: bool = None, check: bool = False) + :classmethod: + + + .. py:method:: EnableAutoLoginUsingPywinauto(self, credentials: Optional[Mapping[str, Any]] = None, wait: bool = True, timeout: bool = None, check: bool = True) + + 자식 프로세스 내에서 pywinauto 를 사용해 자동 로그인 설정을 자동으로 진행합니다. + + + .. py:method:: EnableAutoLogin(self, credentials: Optional[Mapping[str, Any]] = None) + + 자동 로그인을 설정합니다. + + + .. py:method:: EnsureAutoLoginEnabled(self, credentials: Optional[Mapping[str, Any]] = None) -> bool + + 자동 로그인이 설정되어 있음을 보장하도록 합니다. + + 이미 자동 로그인이 설정 되어있는 경우 별다른 처리를 하지 않습니다. + 자동 로그인이 설정되어 있지 않다면 자동 로그인을 설정을 처리합니다. + + + .. py:method:: HandleVersionUpgradeUsingPywinauto_Impl(cls, pid) + :classmethod: + + + .. py:method:: HandleVersionUpgradeUsingPywinauto_RunScriptInSubprocess(cls, pid: int, wait: bool = False, timeout: bool = None, check: bool = False) + :classmethod: + + + .. py:method:: HandleVersionUpgradeUsingPywinauto(self, pid: int, wait: bool = True, timeout: bool = None, check: bool = True) + + 자식 프로세스 내에서 pywinauto 를 사용해 버전 업그레이드 처리를 자동으로 진행합니다. + + + +.. py:class:: KiwoomOpenApiPlusQAxWidgetServerSideMixin + + Bases: :py:obj:`koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusDispatchFunctions.KiwoomOpenApiPlusDispatchFunctions`, :py:obj:`koapy.utils.logging.Logging.Logging` + + KiwoomOpenApiPlusQAxWidget 객체에 대해 Server-Side 에서만 사용되는 Mixin 입니다. + + 주로 서버 환경에서만 확인하거나 처리가 가능한 아래 기능들을 커버합니다: + + - 조건검색식 로드 + - 조회 횟수 제한 회피 기능 + + .. py:method:: LoadCondition(self) -> int + + 조건검색 관련 조건식을 불러옵니다. + + + .. py:method:: IsConditionLoaded(self) -> bool + + 조건식이 로드 되었는지 여부를 반환합니다. + + + .. py:method:: EnsureConditionLoaded(self, force: bool = False) -> int + + 조건식이 로드됨을 보장하도록 합니다. + + 이미 조건식을 불러온 경우 별다른 처리를 하지 않습니다. + 조건식을 불러오지 않았다면 조건식을 불러오도록 처리합니다. + + + .. py:method:: CommRqDataWithInputs(self, rqname: str, trcode: str, prevnext: Union[str, int], scrnno: str, inputs: Optional[Dict[str, str]] = None) -> int + + CommRqData() 호출 이전에 주어진 입력값을로 SetInputValue() 호출을 통한 입력값 설정을 진행합니다. + 이후 CommRqData() 를 호출합니다. + + + .. py:method:: AtomicCommRqData(self, rqname: str, trcode: str, prevnext: Union[str, int], scrnno: str, inputs: Optional[Dict[str, str]] = None) -> int + + SetInputValue() 호출을 통한 입력값 설정 및 CommRqData() 호출을 하나의 단위로 처리할 수 있도록 Lock 을 걸고 처리합니다. + + + +.. py:class:: KiwoomOpenApiPlusQAxWidgetMixin + + Bases: :py:obj:`KiwoomOpenApiPlusQAxWidgetUniversalMixin`, :py:obj:`KiwoomOpenApiPlusQAxWidgetServerSideMixin` + + KiwoomOpenApiPlusQAxWidgetUniversalMixin, KiwoomOpenApiPlusQAxWidgetServerSideMixin 구현이 포함된 + KiwoomOpenApiPlusQAxWidget 객체를 위한 Mixin 입니다. + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusRateLimiter/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusRateLimiter/index.rst new file mode 100644 index 00000000..52eb0aec --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusRateLimiter/index.rst @@ -0,0 +1,62 @@ +:py:mod:`koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusRateLimiter` +============================================================================== + +.. py:module:: koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusRateLimiter + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusRateLimiter.KiwoomOpenApiPlusCommRqDataRateLimiter + koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusRateLimiter.KiwoomOpenApiPlusSendOrderRateLimiter + koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusRateLimiter.KiwoomOpenApiPlusSendConditionRateLimiter + + + + +.. py:class:: KiwoomOpenApiPlusCommRqDataRateLimiter + + Bases: :py:obj:`koapy.utils.rate_limiting.RateLimiter.CompositeTimeWindowRateLimiter` + + [조회횟수 제한 관련 가이드] + - 1초당 5회 조회를 1번 발생시킨 경우 : 17초대기 + - 1초당 5회 조회를 5연속 발생시킨 경우 : 90초대기 + - 1초당 5회 조회를 10연속 발생시킨 경우 : 3분(180초)대기 + + +.. py:class:: KiwoomOpenApiPlusSendOrderRateLimiter + + Bases: :py:obj:`koapy.utils.rate_limiting.RateLimiter.TimeWindowRateLimiter` + + +.. py:class:: KiwoomOpenApiPlusSendConditionRateLimiter(comm_rate_limiter) + + Bases: :py:obj:`koapy.utils.rate_limiting.RateLimiter.RateLimiter` + + [조건검색 제한] + - 조건검색(실시간 조건검색 포함)은 시세조회와 관심종목조회와 합산해서 1초에 5회만 요청 가능하며 1분에 1회로 조건검색 제한됩니다. + + [조건검색 제한] + 조건검색 요청은 1초당 5회 조회횟수 제한에 포함됩니다. + 동일 조건식에 대한 조건검색 요청은 1분에 1회로 제한됩니다. + 조건검색 결과가 100종목을 넘게 되면 해당조건은 실시간 조건검색 신호를 수신할 수 없습니다. + 실시간 조건검색은 최대 10개까지 사용 가능합니다. + + .. py:method:: get_limiter_per_condition(self, condition_name, condition_index) + + + .. py:method:: check_sleep_seconds(self, fn, *args, **kwargs) + + + .. py:method:: add_call_history(self, fn, *args, **kwargs) + + + .. py:method:: sleep_if_necessary(self, fn, *args, **kwargs) + + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusRealType/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusRealType/index.rst new file mode 100644 index 00000000..82784ca5 --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusRealType/index.rst @@ -0,0 +1,174 @@ +:py:mod:`koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusRealType` +=========================================================================== + +.. py:module:: koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusRealType + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusRealType.KiwoomOpenApiPlusRealType + + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusRealType.main + + + +.. py:class:: KiwoomOpenApiPlusRealType(gidc: Optional[str] = None, desc: Optional[str] = None, nfid: Optional[int] = None, fids: Optional[List[int]] = None) + + Bases: :py:obj:`koapy.utils.serialization.JsonSerializable`, :py:obj:`koapy.utils.logging.Logging.Logging` + + .. py:class:: Fid(fid: Optional[int] = None, name: Optional[str] = None) + + Bases: :py:obj:`koapy.utils.serialization.JsonSerializable` + + .. py:attribute:: FID_DUMP_FILEDIR + + + + + .. py:attribute:: FID_DUMP_FILENAME + :annotation: = fid.csv + + + + .. py:attribute:: FID_DUMP_FILEPATH + + + + + .. py:attribute:: FID_DUMP_PROCESSOR + + + + + .. py:attribute:: FID_BY_FID + :annotation: :Dict[int, KiwoomOpenApiPlusRealType] + + + + .. py:attribute:: FID_BY_NAME + :annotation: :Dict[str, KiwoomOpenApiPlusRealType] + + + + .. py:method:: fids_from_dump_file(cls, dump_file: Optional[Union[str, os.PathLike]] = None, encoding: Optional[str] = None) -> Dict[int, str] + :classmethod: + + + .. py:method:: load_from_dump_file(cls, dump_file: Optional[Union[str, os.PathLike]] = None) + :classmethod: + + + .. py:method:: from_fid(cls, fid: Union[str, int]) -> Optional[KiwoomOpenApiPlusRealType] + :classmethod: + + + .. py:method:: from_name(cls, name: str) -> Optional[KiwoomOpenApiPlusRealType] + :classmethod: + + + .. py:method:: get_name_by_fid(cls, fid: Union[str, int], default: Optional[str] = None) -> Optional[str] + :classmethod: + + + + .. py:attribute:: REALTYPE_BY_DESC_DUMP_FILEDIR + + + + + .. py:attribute:: REALTYPE_BY_DESC_DUMP_FILENAME + :annotation: = realtype_by_desc.json + + + + .. py:attribute:: REALTYPE_BY_DESC_DUMP_FILEPATH + + + + + .. py:attribute:: REALTYPE_BY_DESC + :annotation: :Dict[str, KiwoomOpenApiPlusRealType] + + + + .. py:method:: get_realtype_name_list(cls) + :classmethod: + + + .. py:method:: get_realtype_info_list(cls) + :classmethod: + + + .. py:method:: get_realtype_info_by_desc(cls, desc: str) -> Optional[KiwoomOpenApiPlusRealType] + :classmethod: + + + .. py:method:: get_realtype_info_by_name(cls, name: str) -> Optional[KiwoomOpenApiPlusRealType] + :classmethod: + + + .. py:method:: get_realtype_info_by_realtype_name(cls, name: str) -> Optional[KiwoomOpenApiPlusRealType] + :classmethod: + + + .. py:method:: from_name(cls, name: str) -> Optional[KiwoomOpenApiPlusRealType] + :classmethod: + + + .. py:method:: get_fids_by_realtype_name(cls, name: str) -> Optional[List[int]] + :classmethod: + + + .. py:method:: get_fids_by_realtype_name_as_string(cls, name: str) -> Optional[str] + :classmethod: + + + .. py:method:: get_field_names_by_realtype_name(cls, name: str) -> Optional[List[str]] + :classmethod: + + + .. py:method:: realtypes_from_datfile(cls, dat_file: Optional[Union[str, os.PathLike, BinaryIO]] = None, encoding: Optional[str] = None, module_path: Optional[str] = None) -> List[KiwoomOpenApiPlusRealType] + :classmethod: + + + .. py:method:: realtype_by_desc_from_datfile(cls, dat_file: Optional[Union[str, os.PathLike, BinaryIO]] = None) -> Dict[str, KiwoomOpenApiPlusRealType] + :classmethod: + + + .. py:method:: dump_realtype_by_desc(cls, dump_file: Optional[Union[str, os.PathLike, TextIO]] = None, dat_file: Optional[Union[str, os.PathLike, BinaryIO]] = None, encoding: Optional[str] = None) + :classmethod: + + + .. py:method:: realtype_by_desc_from_dump_file(cls, dump_file: Optional[Union[str, os.PathLike, TextIO]] = None, encoding: Optional[str] = None) -> Dict[str, KiwoomOpenApiPlusRealType] + :classmethod: + + + .. py:method:: load_from_dump_file(cls, dump_file: Optional[Union[str, os.PathLike, TextIO]] = None) + :classmethod: + + + .. py:method:: load_from_datfile(cls, dat_file: Optional[Union[str, os.PathLike, BinaryIO]] = None) + :classmethod: + + + .. py:method:: load(cls) + :classmethod: + + + +.. py:function:: main() + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusScreenManager/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusScreenManager/index.rst new file mode 100644 index 00000000..e18edeab --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusScreenManager/index.rst @@ -0,0 +1,55 @@ +:py:mod:`koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusScreenManager` +================================================================================ + +.. py:module:: koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusScreenManager + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusScreenManager.KiwoomOpenApiPlusScreenManager + + + + +.. py:class:: KiwoomOpenApiPlusScreenManager(control: Optional[koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusDispatchFunctions.KiwoomOpenApiPlusDispatchFunctions] = None) + + Bases: :py:obj:`koapy.utils.logging.Logging.Logging` + + .. py:attribute:: MAXIMUM_NUMBER_OF_SCREENS + :annotation: = 200 + + + + .. py:method:: number_to_screen_no(number: int) -> str + :staticmethod: + + + .. py:method:: screen_no_to_number(screen_no: str) -> int + :staticmethod: + + + .. py:method:: is_inuse(self, screen_no: str) -> bool + + + .. py:method:: get_single_free_screen(self, exclude: Optional[Collection[str]] = None) -> str + + + .. py:method:: get_multiple_free_screens(self, count: int) -> List[str] + + + .. py:method:: get_free_screen(self, count: Optional[int] = None) -> Union[str, List[str]] + + + .. py:method:: borrow_screen(self, screen_no: Optional[str] = None, reuse: bool = True, pop: bool = True) -> str + + + .. py:method:: return_screen(self, screen_no: str) -> bool + + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusSignalConnector/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusSignalConnector/index.rst new file mode 100644 index 00000000..20fe4810 --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusSignalConnector/index.rst @@ -0,0 +1,80 @@ +:py:mod:`koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusSignalConnector` +================================================================================== + +.. py:module:: koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusSignalConnector + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusSignalConnector.KiwoomOpenApiPlusSignalConnector + + + + +Attributes +~~~~~~~~~~ + +.. autoapisummary:: + + koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusSignalConnector.P + koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusSignalConnector.R + + +.. py:data:: P + + + + +.. py:data:: R + + + + +.. py:class:: KiwoomOpenApiPlusSignalConnector(name: str) + + Bases: :py:obj:`koapy.utils.logging.Logging.Logging`, :py:obj:`Generic`\ [\ :py:obj:`P`\ , :py:obj:`R`\ ] + + Abstract base class for generic types. + + A generic type is typically declared by inheriting from + this class parameterized with one or more type variables. + For example, a generic mapping type might be defined as:: + + class Mapping(Generic[KT, VT]): + def __getitem__(self, key: KT) -> VT: + ... + # Etc. + + This class can then be used as follows:: + + def lookup_name(mapping: Mapping[KT, VT], key: KT, default: VT) -> VT: + try: + return mapping[key] + except KeyError: + return default + + .. py:method:: is_valid_slot(self, slot: Callable[Ellipsis, Any]) -> bool + + + .. py:method:: connect_to(self, control: koapy.compat.pyside2.QtAxContainer.QAxWidget) + + + .. py:method:: disconnect_from(self, control: koapy.compat.pyside2.QtAxContainer.QAxWidget) + + + .. py:method:: connect(self, slot: Callable[Ellipsis, Any]) + + + .. py:method:: disconnect(self, slot: Optional[Callable[Ellipsis, Any]] = None) + + + .. py:method:: call(self, *args: P, **kwargs: P) -> R + + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusSignature/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusSignature/index.rst new file mode 100644 index 00000000..5897cbef --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusSignature/index.rst @@ -0,0 +1,75 @@ +:py:mod:`koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusSignature` +============================================================================ + +.. py:module:: koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusSignature + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusSignature.KiwoomOpenApiPlusSignature + + + + +Attributes +~~~~~~~~~~ + +.. autoapisummary:: + + koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusSignature.NoneType + + +.. py:data:: NoneType + + + + +.. py:class:: KiwoomOpenApiPlusSignature(name: str, parameters: Dict[str, inspect.Parameter] = None, return_annotation=Signature.empty) + + Bases: :py:obj:`inspect.Signature` + + A Signature object represents the overall signature of a function. + It stores a Parameter object for each parameter accepted by the + function, as well as information specific to the function itself. + + A Signature object has the following public attributes and methods: + + * parameters : OrderedDict + An ordered mapping of parameters' names to the corresponding + Parameter objects (keyword-only arguments are in the same order + as listed in `code.co_varnames`). + * return_annotation : object + The annotation for the return type of the function if specified. + If the function has no annotation for its return type, this + attribute is set to `Signature.empty`. + * bind(*args, **kwargs) -> BoundArguments + Creates a mapping from positional and keyword arguments to + parameters. + * bind_partial(*args, **kwargs) -> BoundArguments + Creates a partial mapping from positional and keyword arguments + to parameters (simulating 'functools.partial' behavior.) + + .. py:attribute:: PYTHONTYPE_TO_QTTYPE + + + + + .. py:attribute:: COMTYPE_TO_PYTHONTYPE + + + + + .. py:method:: name(self) -> str + :property: + + + .. py:method:: to_pyside2_function_prototype(self) -> str + + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusTrInfo/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusTrInfo/index.rst new file mode 100644 index 00000000..0d8dcf04 --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusTrInfo/index.rst @@ -0,0 +1,137 @@ +:py:mod:`koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusTrInfo` +========================================================================= + +.. py:module:: koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusTrInfo + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusTrInfo.KiwoomOpenApiPlusTrInfo + + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusTrInfo.main + koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusTrInfo.infer_fids_by_tr_outputs + + + +.. py:class:: KiwoomOpenApiPlusTrInfo(tr_code: Optional[str] = None, name: Optional[str] = None, tr_name: Optional[str] = None, tr_names_svr: Optional[str] = None, tr_type: Optional[str] = None, gfid: Optional[str] = None, inputs: Optional[Sequence[Field]] = None, single_outputs_name: Optional[str] = None, single_outputs: Optional[Sequence[Field]] = None, multi_outputs_name: Optional[str] = None, multi_outputs: Optional[Sequence[Field]] = None) + + Bases: :py:obj:`koapy.utils.serialization.JsonSerializable`, :py:obj:`koapy.utils.logging.Logging.Logging` + + .. py:class:: Field(name: Optional[str] = None, start: Optional[int] = None, offset: Optional[int] = None, fid: Optional[int] = None) + + Bases: :py:obj:`koapy.utils.serialization.JsonSerializable` + + + .. py:attribute:: TRINFO_BY_CODE_DUMP_FILEDIR + + + + + .. py:attribute:: TRINFO_BY_CODE_DUMP_FILENAME + :annotation: = trinfo_by_code.json + + + + .. py:attribute:: TRINFO_BY_CODE_DUMP_FILEPATH + + + + + .. py:attribute:: TRINFO_BY_CODE + :annotation: :Dict[str, KiwoomOpenApiPlusTrInfo] + + + + .. py:attribute:: SINGLE_TO_MULTI_TRCODES + :annotation: = ['opt10072', 'opt10073', 'opt10075', 'opt10076', 'opt10085', 'optkwfid', 'optkwinv', 'optkwpro'] + + + + .. py:method:: to_dict(self) -> Dict[str, Any] + + + .. py:method:: from_dict(cls, dic: Dict[str, Any]) -> KiwoomOpenApiPlusTrInfo + :classmethod: + + + .. py:method:: get_input_names(self) -> List[str] + + + .. py:method:: get_single_output_names(self) -> List[str] + + + .. py:method:: get_multi_output_names(self) -> List[str] + + + .. py:method:: get_trcode_list(cls) -> List[str] + :classmethod: + + + .. py:method:: get_trinfo_list(cls) -> List[KiwoomOpenApiPlusTrInfo] + :classmethod: + + + .. py:method:: get_trinfo_by_code(cls, trcode: str) -> Optional[KiwoomOpenApiPlusTrInfo] + :classmethod: + + + .. py:method:: from_code(cls, trcode: str) -> Optional[KiwoomOpenApiPlusTrInfo] + :classmethod: + + + .. py:method:: from_encfile(cls, f: Union[str, os.PathLike, TextIO], tr_code: Optional[str] = None, encoding: Optional[str] = None) -> KiwoomOpenApiPlusTrInfo + :classmethod: + + + .. py:method:: infos_from_data_dir(cls, data_dir: Optional[Union[str, os.PathLike]] = None, encoding: Optional[str] = None, module_path: Optional[str] = None) -> List[KiwoomOpenApiPlusTrInfo] + :classmethod: + + + .. py:method:: swap_output_types(cls, item: KiwoomOpenApiPlusTrInfo) -> KiwoomOpenApiPlusTrInfo + :classmethod: + + + .. py:method:: trinfo_by_code_from_data_dir(cls, data_dir: Optional[Union[str, os.PathLike]] = None, post_process: bool = True) -> Dict[str, KiwoomOpenApiPlusTrInfo] + :classmethod: + + + .. py:method:: dump_trinfo_by_code(cls, dump_file: Optional[Union[str, os.PathLike, TextIO]] = None, data_dir: Optional[str] = None, encoding: Optional[str] = None) + :classmethod: + + + .. py:method:: trinfo_by_code_from_dump_file(cls, dump_file: Optional[Union[str, os.PathLike, TextIO]] = None, encoding: Optional[str] = None) -> Dict[str, KiwoomOpenApiPlusTrInfo] + :classmethod: + + + .. py:method:: load_from_dump_file(cls, dump_file: Optional[Union[str, os.PathLike, TextIO]] = None) + :classmethod: + + + .. py:method:: load_from_data_dir(cls, data_dir: Optional[Union[str, os.PathLike]] = None) + :classmethod: + + + .. py:method:: load(cls) + :classmethod: + + + +.. py:function:: main() + + +.. py:function:: infer_fids_by_tr_outputs(output_filename=None) + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusTypeLib/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusTypeLib/index.rst new file mode 100644 index 00000000..0e3f02e0 --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusTypeLib/index.rst @@ -0,0 +1,24 @@ +:py:mod:`koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusTypeLib` +========================================================================== + +.. py:module:: koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusTypeLib + + +Module Contents +--------------- + +.. py:data:: TYPELIB + + + + +.. py:data:: DISPATCH_OLE_ITEM + + + + +.. py:data:: EVENT_OLE_ITEM + + + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusTypeLibSpec/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusTypeLibSpec/index.rst new file mode 100644 index 00000000..596d2a5b --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusTypeLibSpec/index.rst @@ -0,0 +1,64 @@ +:py:mod:`koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusTypeLibSpec` +============================================================================== + +.. py:module:: koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusTypeLibSpec + + +Module Contents +--------------- + +.. py:data:: CONTROL_PROGID + :annotation: = KHOPENAPI.KHOpenApiCtrl.1 + + + +.. py:data:: CONTROL_CLSID + + + + +.. py:data:: DISPATCH_CLSID + + + + +.. py:data:: EVENT_CLSID + + + + +.. py:data:: MODULE_CLSID + + + + +.. py:data:: TYPELIB_SPECS + + + + +.. py:data:: TYPELIB_SPEC + + + + +.. py:data:: TYPELIB_DLL_PATH + + + + +.. py:data:: API_MODULE_PATH_FROM_DEFAULT_INSTALLATION + + + + +.. py:data:: API_MODULE_PATH_FROM_TYPELIB_DLL + + + + +.. py:data:: API_MODULE_PATH + + + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusVersionUpdater/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusVersionUpdater/index.rst new file mode 100644 index 00000000..43d186d5 --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/KiwoomOpenApiPlusVersionUpdater/index.rst @@ -0,0 +1,75 @@ +:py:mod:`koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusVersionUpdater` +================================================================================= + +.. py:module:: koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusVersionUpdater + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusVersionUpdater.KiwoomOpenApiPlusVersionUpdater + + + + +.. py:class:: KiwoomOpenApiPlusVersionUpdater(credentials) + + Bases: :py:obj:`koapy.utils.logging.Logging.Logging` + + .. py:method:: get_api_module_path(self) + + + .. py:method:: get_autologin_dat(self) + + + .. py:method:: is_autologin_enabled(self) + + + .. py:method:: disable_autologin(self) + + + .. py:method:: open_login_window_impl(cls) + :classmethod: + + + .. py:method:: open_login_window(self) + + + .. py:method:: show_account_window_impl(cls) + :classmethod: + + + .. py:method:: show_account_window(self) + + + .. py:method:: check_apply_simulation_window(cls) + :classmethod: + + + .. py:method:: login_using_pywinauto(cls, credentials) + :classmethod: + + + .. py:method:: enable_autologin_using_pywinauto(cls, credentials) + :classmethod: + + + .. py:method:: enable_autologin(self) + + + .. py:method:: handle_version_upgrade_using_pywinauto(cls, pid) + :classmethod: + + + .. py:method:: try_version_update_using_pywinauto(self) + + + .. py:method:: update_version_if_necessary(self) + + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/index.rst new file mode 100644 index 00000000..d015c9f5 --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/index.rst @@ -0,0 +1,46 @@ +:py:mod:`koapy.backend.kiwoom_open_api_plus.core` +================================================= + +.. py:module:: koapy.backend.kiwoom_open_api_plus.core + + +Subpackages +----------- +.. toctree:: + :titlesonly: + :maxdepth: 3 + + tools/index.rst + + +Submodules +---------- +.. toctree:: + :titlesonly: + :maxdepth: 1 + + KiwoomOpenApiPlusCondition/index.rst + KiwoomOpenApiPlusDispatchFunctions/index.rst + KiwoomOpenApiPlusDispatchSignature/index.rst + KiwoomOpenApiPlusDynamicCallable/index.rst + KiwoomOpenApiPlusEntrypoint/index.rst + KiwoomOpenApiPlusEntrypointMixin/index.rst + KiwoomOpenApiPlusError/index.rst + KiwoomOpenApiPlusEventFunctions/index.rst + KiwoomOpenApiPlusEventHandler/index.rst + KiwoomOpenApiPlusEventHandlerFunctions/index.rst + KiwoomOpenApiPlusEventHandlerSignature/index.rst + KiwoomOpenApiPlusLoggingEventHandler/index.rst + KiwoomOpenApiPlusQAxWidget/index.rst + KiwoomOpenApiPlusQAxWidgetMixin/index.rst + KiwoomOpenApiPlusRateLimiter/index.rst + KiwoomOpenApiPlusRealType/index.rst + KiwoomOpenApiPlusScreenManager/index.rst + KiwoomOpenApiPlusSignalConnector/index.rst + KiwoomOpenApiPlusSignature/index.rst + KiwoomOpenApiPlusTrInfo/index.rst + KiwoomOpenApiPlusTypeLib/index.rst + KiwoomOpenApiPlusTypeLibSpec/index.rst + KiwoomOpenApiPlusVersionUpdater/index.rst + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/tools/generate_python_stubs/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/tools/generate_python_stubs/index.rst new file mode 100644 index 00000000..d5a6a776 --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/tools/generate_python_stubs/index.rst @@ -0,0 +1,22 @@ +:py:mod:`koapy.backend.kiwoom_open_api_plus.core.tools.generate_python_stubs` +============================================================================= + +.. py:module:: koapy.backend.kiwoom_open_api_plus.core.tools.generate_python_stubs + + +Module Contents +--------------- + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + koapy.backend.kiwoom_open_api_plus.core.tools.generate_python_stubs.generate_python_stubs + + + +.. py:function:: generate_python_stubs(dispatch_class_name=None, dispatch_file_path=None, event_class_name=None, event_file_path=None, encoding=None, force_overwrite=False) + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/tools/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/tools/index.rst new file mode 100644 index 00000000..a6701055 --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/core/tools/index.rst @@ -0,0 +1,15 @@ +:py:mod:`koapy.backend.kiwoom_open_api_plus.core.tools` +======================================================= + +.. py:module:: koapy.backend.kiwoom_open_api_plus.core.tools + + +Submodules +---------- +.. toctree:: + :titlesonly: + :maxdepth: 1 + + generate_python_stubs/index.rst + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/grpc/KiwoomOpenApiPlusServiceClient/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/grpc/KiwoomOpenApiPlusServiceClient/index.rst new file mode 100644 index 00000000..f157714a --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/grpc/KiwoomOpenApiPlusServiceClient/index.rst @@ -0,0 +1,34 @@ +:py:mod:`koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusServiceClient` +================================================================================ + +.. py:module:: koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusServiceClient + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusServiceClient.KiwoomOpenApiPlusServiceClient + + + + +.. py:class:: KiwoomOpenApiPlusServiceClient(host=None, port=None, credentials=None, thread_pool=None, check_timeout=None, **kwargs) + + .. py:method:: is_ready(self, timeout=None) + + + .. py:method:: get_grpc_stub(self) + + + .. py:method:: get_stub(self) + + + .. py:method:: close(self) + + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/grpc/KiwoomOpenApiPlusServiceClientSideDynamicCallable/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/grpc/KiwoomOpenApiPlusServiceClientSideDynamicCallable/index.rst new file mode 100644 index 00000000..fb9869e9 --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/grpc/KiwoomOpenApiPlusServiceClientSideDynamicCallable/index.rst @@ -0,0 +1,22 @@ +:py:mod:`koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusServiceClientSideDynamicCallable` +=================================================================================================== + +.. py:module:: koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusServiceClientSideDynamicCallable + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusServiceClientSideDynamicCallable.KiwoomOpenApiPlusServiceClientSideDynamicCallable + + + + +.. py:class:: KiwoomOpenApiPlusServiceClientSideDynamicCallable(stub, name) + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/grpc/KiwoomOpenApiPlusServiceClientSideSignalConnector/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/grpc/KiwoomOpenApiPlusServiceClientSideSignalConnector/index.rst new file mode 100644 index 00000000..1ad864aa --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/grpc/KiwoomOpenApiPlusServiceClientSideSignalConnector/index.rst @@ -0,0 +1,31 @@ +:py:mod:`koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusServiceClientSideSignalConnector` +=================================================================================================== + +.. py:module:: koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusServiceClientSideSignalConnector + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusServiceClientSideSignalConnector.KiwoomOpenApiPlusServiceClientSideSignalConnector + + + + +.. py:class:: KiwoomOpenApiPlusServiceClientSideSignalConnector(stub, name, executor) + + .. py:method:: shutdown(self) + + + .. py:method:: connect(self, callback) + + + .. py:method:: disconnect(self, callback) + + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/grpc/KiwoomOpenApiPlusServiceClientStubWrapper/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/grpc/KiwoomOpenApiPlusServiceClientStubWrapper/index.rst new file mode 100644 index 00000000..0140b97c --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/grpc/KiwoomOpenApiPlusServiceClientStubWrapper/index.rst @@ -0,0 +1,421 @@ +:py:mod:`koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusServiceClientStubWrapper` +=========================================================================================== + +.. py:module:: koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusServiceClientStubWrapper + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusServiceClientStubWrapper.KiwoomOpenApiPlusServiceClientStubCoreWrapper + koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusServiceClientStubWrapper.KiwoomOpenApiPlusServiceClientStubExtendedWrapper + koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusServiceClientStubWrapper.KiwoomOpenApiPlusServiceClientStubWrapper + + + + +.. py:class:: KiwoomOpenApiPlusServiceClientStubCoreWrapper(stub, executor) + + Bases: :py:obj:`koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusQAxWidgetMixin.KiwoomOpenApiPlusQAxWidgetUniversalMixin` + + KiwoomOpenApiPlusServiceServicer 에서 구현되어 이후 Stub 을 통해 제공되는 + RPC 들을 클라이언트에서 좀 더 쉽게 사용하기 위한 래퍼 함수들을 제공합니다. + + .. py:attribute:: METHOD_NAMES + + + + + .. py:attribute:: EVENT_NAMES + + + + + .. py:method:: Call(self, name, *args) + + 임의의 함수 호출을 위한 RPC 입니다. + + 함수의 이름과 파라미터를 요청 메시지를 통해 전달받아 서버측에서 해당 함수를 호출하고 + 호출결과를 응답 메시지를 통해 전달합니다. + + 함수의 파라미터와 리턴값은 문자열/숫자/불리언 등의 단순한 타입만 지원합니다. + + + .. py:method:: LoginCall(self, credentials=None) + + 키움증권 서버 연결 시나리오에 해당하는 RPC 입니다. + + CommConnect() 메소드 호출 이후 발생하는 OnEventConnect() 이벤트를 처리하고 + 클라이언트에도 해당 이벤트 내용을 전달합니다. + + + .. py:method:: TransactionCall(self, rqname, trcode, scrno, inputs, stop_condition=None) + + TR 요청에 해당하는 RPC 입니다. + + CommRqData() 메소드 호출 이후 발생하는 OnReceiveTrData() 이벤트를 처리하고 + 클라이언트에도 해당 이벤트 내용을 전달합니다. + + OnReceiveTrData() 이벤트 핸들러 함수 내부에서 요청받은 TR 에 따라 관련된 데이터를 + 추가로 읽어 들인 뒤 알맞은 응답형태로 가공하여 클라이언트에 반환합니다. + 해당 과정에서 GetRepeatCnt() 및 GetCommData() 메소드를 내부적으로 호출합니다. + + 경우에 따라 연속조회가 필요하다면 OnReceiveTrData() 이벤트 핸들러 함수 내부에서 + 추가적인 SetInputValue() 및 CommRqData() 호출이 발생할 수 있습니다. + + 일반적인 TR 이 아닌 관심종목 관련 TR 의 경우 CommRqData() 대신 CommKwRqData() 가 + 내부적으로 호출됩니다. + + 서버측에서 CommRqData() 혹은 CommKwRqData() 호출시 내부적으로 호출제한 회피를 위한 + 대기시간이 발생할 수 있습니다. + + 최초 TR 요청 이후 특정 TR 들에서는 그와 관련된 실시간 데이터가 (OpenAPI+ 레벨에서) 자동으로 등록될 수 있습니다. + 몇몇 상황에서는 해당 실시간 데이터가 유용할 수 있으나 현재 KOAPY 에서는 별도로 사용하진 않고 있으며, + TR 에 대한 응답처리가 모두 완료된 이후에는 해당 실시간 데이터를 등록 해제하도록 처리하고 있습니다. + + + .. py:method:: OrderCall(self, rqname, scrno, account, order_type, code, quantity, price, quote_type, original_order_no=None) + + 주문 요청에 해당하는 RPC 입니다. + + SendOrder() 메소드 호출 이후 발생하는 OnReceiveTrData() 및 OnReceiveChejanData() 이벤트를 처리하고 + 클라이언트에도 해당 이벤트 내용을 전달합니다. + + SendOrder() 메소드 호출 이후 발생하는 OnReceiveTrData() 이벤트에서 + 주문번호가 확인 가능해야지만 정상주문으로 처리하고 그렇지 않다면 에러를 발생시킵니다. + + 일반적으로는 OnReceiveTrData() 이벤트가 먼저 발생하고 이후 OnReceiveChejanData() 이벤트가 접수/체결/잔고확인에 각각 발생합니다. + 다만 주문건수가 폭증하는 경우 OnReceiveChejan() 이벤트가 OnReceiveTrData() 이벤트보다 앞서 수신될 수 있습니다. + + 이외에 주문거부등의 케이스에서 주문거부 사유 등이 OnReceiveMsg() 이벤트로 반환됩니다. + + 기본적으로 매수/매도 주문의 경우 주문받은 수량이 모두 체결될때까지 이벤트를 처리해 전달합니다. + + 거래 구분: + - 00: 지정가 + - 03: 시장가 + - 05: 조건부지정가 + - 06: 최유리지정가 + - 07: 최우선지정가 + - 10: 지정가IOC + - 13: 시장가IOC + - 16: 최유리IOC + - 20: 지정가FOK + - 23: 시장가FOK + - 26: 최유리FOK + - 61: 장전시간외종가 + - 62: 시간외단일가매매 + - 81: 장후시간외종가 + + ※ 모의투자에서는 지정가 주문과 시장가 주문만 가능합니다. + + 주문 유형: + - 1: 신규매수 + - 2: 신규매도 + - 3: 매수취소 + - 4: 매도취소 + - 5: 매수정정 + - 6: 매도정정 + + :param rqname: 사용자 구분 요청명 + :type rqname: str + :param scrno: 화면번호 (4자리) + :type scrno: str + :param account: 계좌번호 (10자리) + :type account: str + :param order_type: 주문유형 (1:신규매수, 2:신규매도, 3:매수취소, 4:매도취소, 5:매수정정, 6:매도정정) + :type order_type: int + :param code: 종목코드 (6자리) + :type code: str + :param quantity: 주문수량 + :type quantity: int + :param price: 주문단가 + :type price: int + :param quote_type: 거래구분 (혹은 호가구분) + :type quote_type: str + :param original_order_no: 원주문번호, 신규주문에는 공백 입력, 정정/취소시 입력합니다. + :type original_order_no: str + + + .. py:method:: RealCall(self, scrno, codes, fids, opt_type=None, infer_fids=False, readable_names=False, fast_parse=False) + + 실시간 데이터 요청에 해당하는 RPC 입니다. + + SetRealReg() 메소드 호출 이후 발생하는 OnReceiveRealData() 이벤트를 처리하고 + 클라이언트에도 해당 이벤트 내용을 전달합니다. + + OnReceiveRealData() 이벤트 핸들러 함수 내부에서 앞서 요청받은 실시간 데이터 FID 목록 혹은 + 직접 이벤트 핸들러 함수에서 확인 가능한 FID 목록에 따라 관련된 데이터를 + 추가로 읽어 들인 뒤 알맞은 응답형태로 가공하여 클라이언트에 반환합니다. + 해당 과정에서 GetCommRealData() 메소드를 내부적으로 호출합니다. + + 해당 RPC 는 별도의 이벤트 종료 상황이 존재하지 않기 때문에 더이상 사용하지 않는 경우 + 클라이언트 측에서 해당 RPC 연결을 해제하는 식으로 더 이상 이벤트를 받지 않을 수 있습니다. + 이 경우 서버에서는 내부적으로 기 등록된 실시간 데이터에 대해 SetRealRemove() 가 호출됩니다. + + + .. py:method:: LoadConditionCall(self) + + 조건검색 기능 활용 이전에 먼저 조건식 목록을 불러오는데 사용할 수 있는 RPC 입니다. + + GetConditionLoad() 메소드 호출 이후 발생하는 OnReceiveConditionVer() 이벤트를 처리하고 + 클라이언트에도 해당 이벤트 내용을 전달합니다. + + + .. py:method:: ConditionCall(self, scrno, condition_name, condition_index, search_type, with_info=False, is_future_option=False, request_name=None) + + 조건검색 기능에 해당하는 RPC 입니다. + + SendCondition() 메소드 호출 이후 발생하는 OnReceiveTrCondition() 혹은 OnReceiveRealCondition() 이벤트를 + 처리하고 클라이언트에도 해당 이벤트 내용을 전달합니다. + + + .. py:method:: SetLogLevel(self, level, logger='') + + 서버에 존재하는 특정 로거의 로그레벨을 설정합니다. + + + .. py:method:: LoadCondition(self) + + 조건검색 관련 조건식을 불러옵니다. + + + .. py:method:: IsConditionLoaded(self) + + 조건식이 로드 되었는지 여부를 반환합니다. + + + .. py:method:: EnsureConditionLoaded(self, force=False) + + 조건식이 로드됨을 보장하도록 합니다. + + 이미 조건식을 불러온 경우 별다른 처리를 하지 않습니다. + 조건식을 불러오지 않았다면 조건식을 불러오도록 처리합니다. + + + .. py:method:: RateLimitedCommRqData(self, rqname, trcode, prevnext, scrno, inputs=None) + + CommRqData() 와 동일하지만 호출제한 회피를 위한 함수입니다. + 필요에 따라 호출제한을 회피하기 위해 실제 호출 전 대기할 수 있습니다. + + + .. py:method:: RateLimitedSendCondition(self, scrno, condition_name, condition_index, search_type) + + SendCondition() 과 동일하지만 호출제한 회피를 위한 함수입니다. + 필요에 따라 호출제한을 회피하기 위해 실제 호출 전 대기할 수 있습니다. + + + +.. py:class:: KiwoomOpenApiPlusServiceClientStubExtendedWrapper(stub, executor) + + Bases: :py:obj:`KiwoomOpenApiPlusServiceClientStubCoreWrapper`, :py:obj:`koapy.utils.logging.Logging.Logging` + + 제공되는 RPC 들을 활용한 여러 사용 케이스들을 구현합니다. + + .. py:method:: GetStockBasicInfoAsDict(self, code, rqname=None, scrno=None) + + 주식 종목의 기본정보를 딕셔너리 형태로 반환합니다. + + TR: OPT10001 + + + .. py:method:: GetStockBasicInfoAsSeries(self, code, rqname=None, scrno=None) + + 주식 종목의 기본정보를 pd.Series 형태로 반환합니다. + + TR: OPT10001 + + + .. py:method:: GetStockQuoteInfoAsDataFrame(self, codes=None, rqname=None, scrno=None) + + 복수개의 주식 종목들의 기본정보를 pd.DataFrame 형태로 반환합니다. + + TR: OPTKWFID + + + .. py:method:: GetTickStockDataAsDataFrame(self, code, interval, start_date=None, end_date=None, include_end=False, adjusted_price=False, rqname=None, scrno=None) + + 틱 단위 차트 데이터를 pd.DataFrame 형태로 반환합니다. + + TR: OPT10079 + + + .. py:method:: GetMinuteStockDataAsDataFrame(self, code, interval, start_date=None, end_date=None, include_end=False, adjusted_price=False, rqname=None, scrno=None) + + 분 단위 차트 데이터를 pd.DataFrame 형태로 반환합니다. + + TR: OPT10080 + + + .. py:method:: GetDailyStockDataAsDataFrame(self, code, start_date=None, end_date=None, include_end=False, adjusted_price=False, rqname=None, scrno=None) + + 일 단위 차트 데이터를 pd.DataFrame 형태로 반환합니다. + + TR: OPT10081 + + + .. py:method:: GetWeeklyStockDataAsDataFrame(self, code, start_date=None, end_date=None, include_end=False, adjusted_price=False, rqname=None, scrno=None) + + 주 단위 차트 데이터를 pd.DataFrame 형태로 반환합니다. + + TR: OPT10082 + + + .. py:method:: GetMonthlyStockDataAsDataFrame(self, code, start_date=None, end_date=None, include_end=False, adjusted_price=False, rqname=None, scrno=None) + + 월 단위 차트 데이터를 pd.DataFrame 형태로 반환합니다. + + TR: OPT10083 + + + .. py:method:: GetYearlyStockDataAsDataFrame(self, code, start_date=None, end_date=None, include_end=False, adjusted_price=False, rqname=None, scrno=None) + + 년 단위 차트 데이터를 pd.DataFrame 형태로 반환합니다. + + TR: OPT10094 + + + .. py:method:: GetDepositInfo(self, account_no, lookup_type=None, with_multi=False, rqname=None, scrno=None) + + 계좌의 예수금 정보를 반환합니다. + + TR: OPW00001 + + 조회구분 = 3:추정조회, 2:일반조회 + + + .. py:method:: GetStockQuotes(self, code, rqname=None, scrno=None) + + 주식의 호가정보를 반환합니다. + + TR: OPT10004 + + + .. py:method:: GetOrderLogAsDataFrame1(self, account_no, order_type=None, status_type=None, code=None, rqname=None, scrno=None) + + 미체결 주문 정보를 반환합니다. + + TR: OPT10075 + + 계좌번호 = 전문 조회할 보유계좌번호 + 전체종목구분 = 0:전체, 1:종목 + 매매구분 = 0:전체, 1:매도, 2:매수 + 종목코드 = 전문 조회할 종목코드 + 체결구분 = 0:전체, 2:체결, 1:미체결 + + + .. py:method:: GetOrderLogAsDataFrame2(self, account_no, order_type=None, status_type=None, code=None, order_no=None, rqname=None, scrno=None) + + 주문 체결 정보를 반환합니다. + + TR: OPT10076 + + 종목코드 = 전문 조회할 종목코드 + 조회구분 = 0:전체, 1:종목 + 매도수구분 = 0:전체, 1:매도, 2:매수 + 계좌번호 = 전문 조회할 보유계좌번호 + 비밀번호 = 사용안함(공백) + 주문번호 = 조회할 주문번호 + 체결구분 = 0:전체, 2:체결, 1:미체결 + + + .. py:method:: GetOrderLogAsDataFrame3(self, account_no, date=None, sort_type=None, asset_type=None, order_type=None, code=None, starting_order_no=None, rqname=None, scrno=None) + + 계좌별 주문 체결 내역을 반환합니다. + + TR: OPW00007 + + 주문일자 = YYYYMMDD (20170101 연도4자리, 월 2자리, 일 2자리 형식) + 계좌번호 = 전문 조회할 보유계좌번호 + 비밀번호 = 사용안함(공백) + 비밀번호입력매체구분 = 00 + 조회구분 = 1:주문순, 2:역순, 3:미체결, 4:체결내역만 + 주식채권구분 = 0:전체, 1:주식, 2:채권 + 매도수구분 = 0:전체, 1:매도, 2:매수 + 종목코드 + 시작주문번호 + + + .. py:method:: GetAccountRateOfReturnAsDataFrame(self, account_no, rqname=None, scrno=None) + + 계좌별 수익률 정보를 반환합니다. + + TR: OPT10085 + + + .. py:method:: GetAccountEvaluationStatusAsSeriesAndDataFrame(self, account_no, include_delisted=True, rqname=None, scrno=None) + + 계좌의 평가 현황 정보를 반환합니다. + + TR: OPW00004 + + + .. py:method:: GetAccountExecutionBalanceAsSeriesAndDataFrame(self, account_no, rqname=None, scrno=None) + + 계좌의 체결 잔고 정보를 반환합니다. + + TR: OPW00005 + + 모의투자에서는 지원하지 않는 TR 입니다. + + + .. py:method:: GetAccountEvaluationBalanceAsSeriesAndDataFrame(self, account_no, lookup_type=None, rqname=None, scrno=None) + + 계좌의 평가 잔고 내역 정보를 반환합니다. + + TR: OPW00018 + + 조회구분 = 1:합산, 2:개별 + + [ 주의 ] + "수익률%" 데이터는 모의투자에서는 소숫점표현, 실거래서버에서는 소숫점으로 변환 필요 합니다. + + + .. py:method:: GetMarketPriceInfo(self, code, rqname=None, scrno=None) + + 종목의 시세표성 정보를 반환합니다. + + TR: OPT10007 + + + .. py:method:: GetRealDataForCodesAsStream(self, codes, fids=None, opt_type=None, screen_no=None, infer_fids=False, readable_names=False, fast_parse=False) + + 실시간 데이터를 요청하고 스트림 형태로 반환받습니다. + + + .. py:method:: GetCodeListByCondition(self, condition_name, condition_index=None, with_info=False, is_future_option=False, request_name=None, screen_no=None) + + 주어진 조건식으로 조건검색을 수행하고 + 검색된 종목의 종목코드를 리스트로 반환받습니다. + + 파라미터 중 with_info 가 True 로 설정된 경우, + 검색된 종목들에 대한 기본 정보도 추가로 같이 반환됩니다. + + + .. py:method:: GetCodeListByConditionAsStream(self, condition_name, condition_index=None, with_info=False, is_future_option=False, request_name=None, screen_no=None, old_behavior=False) + + 주어진 조건식을 실시간 조건검색으로 등록합니다. + 이후 발생하는 이벤트들을 스트림 형태로 제공합니다. + + 최초 검색결과는 OnReceiveTrCondition() 이벤트로 반환되며 + 이후 종목의 추가/제외는 OnReceiveRealCondition() 이벤트로 반환됩니다. + + 만약 with_info 가 True 로 설정된 경우, + 검색된 종목마다 추가적인 정보가 OnReceiveTrData() 이벤트를 통해 반환됩니다. + + + +.. py:class:: KiwoomOpenApiPlusServiceClientStubWrapper(stub, executor) + + Bases: :py:obj:`KiwoomOpenApiPlusServiceClientStubExtendedWrapper` + + KiwoomOpenApiPlusServiceClientStubCoreWrapper, KiwoomOpenApiPlusServiceClientStubExtendedWrapper 의 구현 및 + KiwoomOpenApiPlusQAxWidgetUniversalMixin 의 구현들까지 최종적으로 포함된 + KiwoomOpenApiPlusServiceClientStub 객체를 위한 Mixin 래퍼 클래스 입니다. + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/grpc/KiwoomOpenApiPlusServiceMessageUtils/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/grpc/KiwoomOpenApiPlusServiceMessageUtils/index.rst new file mode 100644 index 00000000..97026411 --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/grpc/KiwoomOpenApiPlusServiceMessageUtils/index.rst @@ -0,0 +1,26 @@ +:py:mod:`koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusServiceMessageUtils` +====================================================================================== + +.. py:module:: koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusServiceMessageUtils + + +Module Contents +--------------- + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusServiceMessageUtils.convert_arguments_from_protobuf_to_python + koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusServiceMessageUtils.convert_arguments_from_python_to_protobuf + + + +.. py:function:: convert_arguments_from_protobuf_to_python(arguments) + + +.. py:function:: convert_arguments_from_python_to_protobuf(arguments, arguments_message) + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/grpc/KiwoomOpenApiPlusServiceServer/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/grpc/KiwoomOpenApiPlusServiceServer/index.rst new file mode 100644 index 00000000..4845744d --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/grpc/KiwoomOpenApiPlusServiceServer/index.rst @@ -0,0 +1,45 @@ +:py:mod:`koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusServiceServer` +================================================================================ + +.. py:module:: koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusServiceServer + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusServiceServer.KiwoomOpenApiPlusServiceServer + + + + +.. py:class:: KiwoomOpenApiPlusServiceServer(control, host=None, port=None, credentials=None, **kwargs) + + Bases: :py:obj:`koapy.utils.logging.Logging.Logging` + + .. py:method:: reinitialize_server(self) + + + .. py:method:: get_host(self) + + + .. py:method:: get_port(self) + + + .. py:method:: start(self) + + + .. py:method:: wait_for_termination(self, timeout=None) + + + .. py:method:: is_running(self) + + + .. py:method:: stop(self, grace=None) + + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/grpc/KiwoomOpenApiPlusServiceServicer/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/grpc/KiwoomOpenApiPlusServiceServicer/index.rst new file mode 100644 index 00000000..597ac0f5 --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/grpc/KiwoomOpenApiPlusServiceServicer/index.rst @@ -0,0 +1,195 @@ +:py:mod:`koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusServiceServicer` +================================================================================== + +.. py:module:: koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusServiceServicer + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusServiceServicer.KiwoomOpenApiPlusServiceServicer + + + + +.. py:class:: KiwoomOpenApiPlusServiceServicer(control) + + Bases: :py:obj:`koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService_pb2_grpc.KiwoomOpenApiPlusServiceServicer` + + KiwoomOpenApiPlusService RPC 의 구현체 입니다. + + .. py:method:: control(self) + :property: + + + .. py:method:: screen_manager(self) + :property: + + + .. py:method:: Call(self, request, context) + + 임의의 함수 호출을 위한 RPC 입니다. + + 함수의 이름과 파라미터를 요청 메시지를 통해 전달받아 서버측에서 해당 함수를 호출하고 + 호출결과를 응답 메시지를 통해 전달합니다. + + 함수의 파라미터와 리턴값은 문자열/숫자/불리언 등의 단순한 타입만 지원합니다. + + + .. py:method:: Listen(self, request, context) + + 단일 혹은 복수개의 이벤트에 대해 이벤트 발생시 해당 이벤트 내용을 전달하는 RPC 입니다. + + 전달받고자 하는 이벤트 이름 목록을 요청 메시지를 통해 전달받습니다. + 이후 서버에서 목록에 포함되는 이벤트가 발생하면 해당 이벤트의 내용을 응답 메세지를 통해 전달합니다. + + 서버측의 이벤트 핸들러 함수는 해당 이벤트를 클라이언트에 전송한 이후 즉시 종료됩니다. + + + .. py:method:: BidirectionalListen(self, request_iterator, context) + + 단일 혹은 복수개의 이벤트에 대해 이벤트 발생시 해당 이벤트 내용을 전달하는 RPC 입니다. + + 전달받고자 하는 이벤트 이름 목록을 요청 메시지를 통해 전달받습니다. + 이후 서버에서 목록에 포함되는 이벤트가 발생하면 해당 이벤트의 내용을 응답 메세지를 통해 전달합니다. + + 앞선 Listen() RPC 와 다르게 해당 RPC 는 이벤트 발생시 서버측에서는 이벤트 내용을 응답 메시지로 전달한 다음 + 다시 클라이언트 측에서 ACK 요청을 줄 때 까지 서버측 이벤트 핸들러 함수 내에서 대기합니다. + 따라서 클라이언트는 서버측 이벤트 핸들러 함수 컨텍스트 내에서 이벤트를 처리할 수 있고 + 처리를 완료하면 다시 서버측으로 ACK 요청을 보내 서버측 이벤트 핸들러가 완료될 수 있도록 해야 합니다. + + + .. py:method:: LoginCall(self, request, context) + + 키움증권 서버 연결 시나리오에 해당하는 RPC 입니다. + + CommConnect() 메소드 호출 이후 발생하는 OnEventConnect() 이벤트를 처리하고 + 클라이언트에도 해당 이벤트 내용을 전달합니다. + + + .. py:method:: TransactionCall(self, request, context) + + TR 요청에 해당하는 RPC 입니다. + + CommRqData() 메소드 호출 이후 발생하는 OnReceiveTrData() 이벤트를 처리하고 + 클라이언트에도 해당 이벤트 내용을 전달합니다. + + OnReceiveTrData() 이벤트 핸들러 함수 내부에서 요청받은 TR 에 따라 관련된 데이터를 + 추가로 읽어 들인 뒤 알맞은 응답형태로 가공하여 클라이언트에 반환합니다. + 해당 과정에서 GetRepeatCnt() 및 GetCommData() 메소드를 내부적으로 호출합니다. + + 경우에 따라 연속조회가 필요하다면 OnReceiveTrData() 이벤트 핸들러 함수 내부에서 + 추가적인 SetInputValue() 및 CommRqData() 호출이 발생할 수 있습니다. + + 일반적인 TR 이 아닌 관심종목 관련 TR 의 경우 CommRqData() 대신 CommKwRqData() 가 + 내부적으로 호출됩니다. + + 서버측에서 CommRqData() 혹은 CommKwRqData() 호출시 내부적으로 호출제한 회피를 위한 + 대기시간이 발생할 수 있습니다. + + 최초 TR 요청 이후 특정 TR 들에서는 그와 관련된 실시간 데이터가 (OpenAPI+ 레벨에서) 자동으로 등록될 수 있습니다. + 몇몇 상황에서는 해당 실시간 데이터가 유용할 수 있으나 현재 KOAPY 에서는 별도로 사용하진 않고 있으며, + TR 에 대한 응답처리가 모두 완료된 이후에는 해당 실시간 데이터를 등록 해제하도록 처리하고 있습니다. + + + .. py:method:: OrderCall(self, request, context) + + 주문 요청에 해당하는 RPC 입니다. + + SendOrder() 메소드 호출 이후 발생하는 OnReceiveTrData() 및 OnReceiveChejanData() 이벤트를 처리하고 + 클라이언트에도 해당 이벤트 내용을 전달합니다. + + SendOrder() 메소드 호출 이후 발생하는 OnReceiveTrData() 이벤트에서 + 주문번호가 확인 가능해야지만 정상주문으로 처리하고 그렇지 않다면 에러를 발생시킵니다. + + 일반적으로는 OnReceiveTrData() 이벤트가 먼저 발생하고 이후 OnReceiveChejanData() 이벤트가 접수/체결/잔고확인에 각각 발생합니다. + 다만 주문건수가 폭증하는 경우 OnReceiveChejan() 이벤트가 OnReceiveTrData() 이벤트보다 앞서 수신될 수 있습니다. + + 이외에 주문거부등의 케이스에서 주문거부 사유 등이 OnReceiveMsg() 이벤트로 반환됩니다. + + 기본적으로 매수/매도 주문의 경우 주문받은 수량이 모두 체결될때까지 이벤트를 처리해 전달합니다. + + + .. py:method:: RealCall(self, request, context) + + 실시간 데이터 요청에 해당하는 RPC 입니다. + + SetRealReg() 메소드 호출 이후 발생하는 OnReceiveRealData() 이벤트를 처리하고 + 클라이언트에도 해당 이벤트 내용을 전달합니다. + + OnReceiveRealData() 이벤트 핸들러 함수 내부에서 앞서 요청받은 실시간 데이터 FID 목록 혹은 + 직접 이벤트 핸들러 함수에서 확인 가능한 FID 목록에 따라 관련된 데이터를 + 추가로 읽어 들인 뒤 알맞은 응답형태로 가공하여 클라이언트에 반환합니다. + 해당 과정에서 GetCommRealData() 메소드를 내부적으로 호출합니다. + + 해당 RPC 는 별도의 이벤트 종료 상황이 존재하지 않기 때문에 더이상 사용하지 않는 경우 + 클라이언트 측에서 해당 RPC 연결을 해제하는 식으로 더 이상 이벤트를 받지 않을 수 있습니다. + 이 경우 서버에서는 내부적으로 기 등록된 실시간 데이터에 대해 SetRealRemove() 가 호출됩니다. + + + .. py:method:: LoadConditionCall(self, request, context) + + 조건검색 기능 활용 이전에 먼저 조건식 목록을 불러오는데 사용할 수 있는 RPC 입니다. + + GetConditionLoad() 메소드 호출 이후 발생하는 OnReceiveConditionVer() 이벤트를 처리하고 + 클라이언트에도 해당 이벤트 내용을 전달합니다. + + + .. py:method:: ConditionCall(self, request, context) + + 조건검색 기능에 해당하는 RPC 입니다. + + SendCondition() 메소드 호출 이후 발생하는 OnReceiveTrCondition() 혹은 OnReceiveRealCondition() 이벤트를 + 처리하고 클라이언트에도 해당 이벤트 내용을 전달합니다. + + + .. py:method:: BidirectionalRealCall(self, request_iterator, context) + + 실시간 데이터 요청에 해당하는 RPC 입니다. + + 기존의 RealCall() RPC 는 최초 실시간 데이터 등록 이후 이벤트를 듣는 것만 가능했다면 + 새로운 BidirectionalRealCall() 에서는 최초 설정된 이벤트 스트림을 계속 유지하면서 + 신규 실시간 데이터 등록 혹은 해지를 추가로 요청해 반영할 수 있습니다. + + + .. py:method:: OrderListen(self, request, context) + + 주문 이벤트를 듣고 싶을때 사용할 수 있는 RPC 입니다. + + 기존의 OrderCall() RPC 는 특정 주문을 수행하고 해당 주문과 관련된 이벤트들만 반환했다면 + 해당 RPC 는 특정 주문 수행 없이 모든 주문관련 이벤트를 듣고 싶을때 사용할 수 있습니다. + + + .. py:method:: CustomListen(self, request, context) + + 이벤트 처리와 관련해 특정 코드를 서버측에 실행시켜 그 로직에 따라 처리하도록 요청할 수 있습니다. + + 해당 코드에서는 KiwoomOpenApiPlusEventHandler 클래스를 구현해야하며, + 클래스 인스턴스 생성시 control, request, context 세가지 인자를 받아 처리할 수 있어야 합니다. + + 내부적으로 exec() 및 eval() 을 사용하기 때문에 실행될 코드의 보안 및 안정성에 주의가 필요합니다. + + + .. py:method:: CustomCallAndListen(self, request, context) + + 이벤트 처리와 관련해 특정 코드를 서버측에 실행시켜 그 로직에 따라 처리하도록 요청할 수 있습니다. + + 앞선 CustomListen() 과의 차이점은 요청시 특정 함수를 최초 1회 호출하고 이후 들어오는 이벤트를 처리한다는 점입니다. + + 해당 코드에서는 KiwoomOpenApiPlusEventHandler 클래스를 구현해야하며, + 클래스 인스턴스 생성시 control, request, context 세가지 인자를 받아 처리할 수 있어야 합니다. + + 내부적으로 exec() 및 eval() 을 사용하기 때문에 실행될 코드의 보안 및 안정성에 주의가 필요합니다. + + + .. py:method:: SetLogLevel(self, request, context) + + 서버에 존재하는 특정 로거의 로그레벨을 설정합니다. + + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/grpc/KiwoomOpenApiPlusService_pb2/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/grpc/KiwoomOpenApiPlusService_pb2/index.rst new file mode 100644 index 00000000..ba0d0774 --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/grpc/KiwoomOpenApiPlusService_pb2/index.rst @@ -0,0 +1,434 @@ +:py:mod:`koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService_pb2` +============================================================================== + +.. py:module:: koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService_pb2 + +.. autoapi-nested-parse:: + + Generated protocol buffer code. + + + +Module Contents +--------------- + +.. py:data:: DESCRIPTOR + + + + +.. py:data:: TransactionStopConditionCompartor + + + + +.. py:data:: LESS_THAN_OR_EQUAL_TO + :annotation: = 0 + + + +.. py:data:: LESS_THAN + :annotation: = 1 + + + +.. py:data:: GREATER_THAN_OR_EQUAL_TO + :annotation: = 2 + + + +.. py:data:: GREATER_THAN + :annotation: = 3 + + + +.. py:data:: EQUAL_TO + :annotation: = 4 + + + +.. py:data:: NOT_EQUAL_TO + :annotation: = 5 + + + +.. py:data:: containing_oneof + + + + +.. py:data:: containing_oneof + + + + +.. py:data:: containing_oneof + + + + +.. py:data:: message_type + + + + +.. py:data:: containing_oneof + + + + +.. py:data:: containing_oneof + + + + +.. py:data:: containing_oneof + + + + +.. py:data:: message_type + + + + +.. py:data:: message_type + + + + +.. py:data:: message_type + + + + +.. py:data:: message_type + + + + +.. py:data:: containing_oneof + + + + +.. py:data:: containing_oneof + + + + +.. py:data:: containing_oneof + + + + +.. py:data:: message_type + + + + +.. py:data:: message_type + + + + +.. py:data:: message_type + + + + +.. py:data:: message_type + + + + +.. py:data:: message_type + + + + +.. py:data:: message_type + + + + +.. py:data:: message_type + + + + +.. py:data:: message_type + + + + +.. py:data:: containing_oneof + + + + +.. py:data:: containing_oneof + + + + +.. py:data:: containing_type + + + + +.. py:data:: message_type + + + + +.. py:data:: message_type + + + + +.. py:data:: message_type + + + + +.. py:data:: enum_type + + + + +.. py:data:: containing_type + + + + +.. py:data:: message_type + + + + +.. py:data:: message_type + + + + +.. py:data:: message_type + + + + +.. py:data:: message_type + + + + +.. py:data:: message_type + + + + +.. py:data:: message_type + + + + +.. py:data:: message_type + + + + +.. py:data:: message_type + + + + +.. py:data:: message_type + + + + +.. py:data:: message_type + + + + +.. py:data:: containing_oneof + + + + +.. py:data:: containing_oneof + + + + +.. py:data:: containing_oneof + + + + +.. py:data:: containing_oneof + + + + +.. py:data:: Argument + + + + +.. py:data:: CallRequest + + + + +.. py:data:: ReturnValue + + + + +.. py:data:: CallResponse + + + + +.. py:data:: ListenRequest + + + + +.. py:data:: HandledRequest + + + + +.. py:data:: StopListenRequest + + + + +.. py:data:: BidirectionalListenRequest + + + + +.. py:data:: SingleData + + + + +.. py:data:: RepeatedString + + + + +.. py:data:: MultiData + + + + +.. py:data:: ListenResponse + + + + +.. py:data:: CallAndListenRequest + + + + +.. py:data:: CallAndListenResponse + + + + +.. py:data:: LoginCredentials + + + + +.. py:data:: LoginRequest + + + + +.. py:data:: RealRequestFlags + + + + +.. py:data:: RealRequest + + + + +.. py:data:: TransactionStopCondition + + + + +.. py:data:: TransactionRequest + + + + +.. py:data:: OrderSubscriptionTarget + + + + +.. py:data:: OrderRequest + + + + +.. py:data:: LoadConditionRequest + + + + +.. py:data:: ConditionRequestFlags + + + + +.. py:data:: ConditionRequest + + + + +.. py:data:: SetLogLevelRequest + + + + +.. py:data:: SetLogLevelResponse + + + + +.. py:data:: BidirectionalRealInitializeRequest + + + + +.. py:data:: BidirectionalRealRegisterRequest + + + + +.. py:data:: BidirectionalRealRemoveRequest + + + + +.. py:data:: BidirectionalRealStopRequest + + + + +.. py:data:: BidirectionalRealRequest + + + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/grpc/KiwoomOpenApiPlusService_pb2_grpc/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/grpc/KiwoomOpenApiPlusService_pb2_grpc/index.rst new file mode 100644 index 00000000..abb14a6b --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/grpc/KiwoomOpenApiPlusService_pb2_grpc/index.rst @@ -0,0 +1,223 @@ +:py:mod:`koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService_pb2_grpc` +=================================================================================== + +.. py:module:: koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService_pb2_grpc + +.. autoapi-nested-parse:: + + Client and server classes corresponding to protobuf-defined services. + + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService_pb2_grpc.KiwoomOpenApiPlusServiceStub + koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService_pb2_grpc.KiwoomOpenApiPlusServiceServicer + koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService_pb2_grpc.KiwoomOpenApiPlusService + + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + koapy.backend.kiwoom_open_api_plus.grpc.KiwoomOpenApiPlusService_pb2_grpc.add_KiwoomOpenApiPlusServiceServicer_to_server + + + +.. py:class:: KiwoomOpenApiPlusServiceStub(channel) + + Bases: :py:obj:`object` + + Missing associated documentation comment in .proto file. + + +.. py:class:: KiwoomOpenApiPlusServiceServicer + + Bases: :py:obj:`object` + + Missing associated documentation comment in .proto file. + + .. py:method:: Call(self, request, context) + + 1. rpcs for general function calls + + unary rpc for an arbitrary function call, + can invoke arbitrary function on the server side by giving its name and arguments, + currently only simple data types like str and int are supported for arguments and return values + + + .. py:method:: Listen(self, request, context) + + 2. rpcs for listening and handling events + + server streaming rpc usually for listening events, + server will simply send stream items to client whenever event that is being listened is triggered, + client can handle those events solely on its own on client side but there is no guarantee that it will be synced with the server, + which means that event handler on the server side will not wait for the client to finish handling each event + + + .. py:method:: BidirectionalListen(self, request_iterator, context) + + bidirectional streaming rpc usually for listening and handling events with proper callbacks, + server will send an stream item to client whenever an event is triggered and will wait for an client's ack, + so that following callbacks from the client can actually be processed inside the server's event handler context + + + .. py:method:: LoginCall(self, request, context) + + 3. rpcs for simple use cases that can be categorized into serveral distinct usage patterns + + server streaming rpc for login/connect scenario, + would invoke Connect() and wait for OnEventConnect() event to test its success + + + .. py:method:: TransactionCall(self, request, context) + + server streaming rpc for general transaction requests, + would invoke CommRqData() with several SetInputValue()s for a transaction request, + would wait for OnReceiveTrData() events, + would handle those events to gather results by invoking GetRepeatCnt() and GetCommData() inside, + might do additional CommRqData() and SetInputValue() inside event handler for possible consecutive lookups + + + .. py:method:: OrderCall(self, request, context) + + server streaming rpc for making orders (buy/sell + update/cancel), + would invoke SendOrder() for submitting an order, + would wait for OnReceiveTrData() and OnReceiveChejanData() events to track its progress + + + .. py:method:: RealCall(self, request, context) + + server streaming rpc for listening realtime data events, + certain transaction requests would also register some realtime data to be sent, + but usually would just call SetRealReg() to register desired realtime data to listen explicitly, + and would call SetRealRemove() to unregister them after done using, + would wait for OnReceiveRealData() events + + + .. py:method:: LoadConditionCall(self, request, context) + + server streaming rpc for loading condition settings for conditioned search, + would call GetConditionLoad() and wait for OnReceiveConditionVer() event to test its success + + + .. py:method:: ConditionCall(self, request, context) + + server streaming rpc for conditioned search (serching stocks with serveral conditions), + would call SendCondition() and wait for OnReceiveTrCondition() or OnReceiveRealCondition() based on its requested type + + + .. py:method:: BidirectionalRealCall(self, request_iterator, context) + + 4. rpcs for more complex use cases based on the previously categorized simple cases above + + bidirectional streaming rpc for listening realtime data events, + with capability of managing observation pool (what stocks, what fields to listen to) online, + those management requests would be sent over the client streaming line, + and ordinary realtime data events would be sent over the server streaming line + + + .. py:method:: OrderListen(self, request, context) + + server streaming rpc for just listening order events (without submiting any order request compared to the simple case), + this is one-sided streaming rpc (server streaming rpc) like Listen() rpc, + so server would just send stream items with no consideration on coordination with its client + + + .. py:method:: CustomListen(self, request, context) + + 5. rpcs for customized usage scenario (when there is no proper predefined interface to utilize) + + pretty much similar to server streaming Listen() rpc, + but event handler would be instantiated dynamically based on the code given through the request + + + .. py:method:: CustomCallAndListen(self, request, context) + + pretty much similar to server streaming XXXCall() rpcs (or even Call() rpc), + but event handler would be instantiated dynamically based on the code given through the request + + + .. py:method:: SetLogLevel(self, request, context) + + 6. rpcs for other mics scenarios + + would update log level of process that this grpc server lives + + + +.. py:function:: add_KiwoomOpenApiPlusServiceServicer_to_server(servicer, server) + + +.. py:class:: KiwoomOpenApiPlusService + + Bases: :py:obj:`object` + + Missing associated documentation comment in .proto file. + + .. py:method:: Call(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None) + :staticmethod: + + + .. py:method:: Listen(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None) + :staticmethod: + + + .. py:method:: BidirectionalListen(request_iterator, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None) + :staticmethod: + + + .. py:method:: LoginCall(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None) + :staticmethod: + + + .. py:method:: TransactionCall(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None) + :staticmethod: + + + .. py:method:: OrderCall(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None) + :staticmethod: + + + .. py:method:: RealCall(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None) + :staticmethod: + + + .. py:method:: LoadConditionCall(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None) + :staticmethod: + + + .. py:method:: ConditionCall(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None) + :staticmethod: + + + .. py:method:: BidirectionalRealCall(request_iterator, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None) + :staticmethod: + + + .. py:method:: OrderListen(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None) + :staticmethod: + + + .. py:method:: CustomListen(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None) + :staticmethod: + + + .. py:method:: CustomCallAndListen(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None) + :staticmethod: + + + .. py:method:: SetLogLevel(request, target, options=(), channel_credentials=None, call_credentials=None, insecure=False, compression=None, wait_for_ready=None, timeout=None, metadata=None) + :staticmethod: + + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/grpc/event/KiwoomOpenApiPlusConditionEventHandler/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/grpc/event/KiwoomOpenApiPlusConditionEventHandler/index.rst new file mode 100644 index 00000000..a14f7fa9 --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/grpc/event/KiwoomOpenApiPlusConditionEventHandler/index.rst @@ -0,0 +1,36 @@ +:py:mod:`koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusConditionEventHandler` +============================================================================================== + +.. py:module:: koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusConditionEventHandler + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusConditionEventHandler.KiwoomOpenApiPlusConditionEventHandler + + + + +.. py:class:: KiwoomOpenApiPlusConditionEventHandler(control, request, context, screen_manager) + + Bases: :py:obj:`koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusEventHandlerForGrpc.KiwoomOpenApiPlusEventHandlerForGrpc`, :py:obj:`koapy.utils.logging.Logging.Logging` + + .. py:method:: on_enter(self) + + + .. py:method:: OnReceiveTrCondition(self, scrnno, codelist, condition_name, condition_index, prevnext) + + + .. py:method:: OnReceiveRealCondition(self, code, condition_type, condition_name, condition_index) + + + .. py:method:: OnReceiveTrData(self, scrnno, rqname, trcode, recordname, prevnext, _datalength, _errorcode, _message, _splmmsg) + + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/grpc/event/KiwoomOpenApiPlusEventHandlerForGrpc/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/grpc/event/KiwoomOpenApiPlusEventHandlerForGrpc/index.rst new file mode 100644 index 00000000..37f29f2c --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/grpc/event/KiwoomOpenApiPlusEventHandlerForGrpc/index.rst @@ -0,0 +1,28 @@ +:py:mod:`koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusEventHandlerForGrpc` +============================================================================================ + +.. py:module:: koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusEventHandlerForGrpc + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusEventHandlerForGrpc.KiwoomOpenApiPlusEventHandlerForGrpc + + + + +.. py:class:: KiwoomOpenApiPlusEventHandlerForGrpc(control, context) + + Bases: :py:obj:`koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusEventHandler.KiwoomOpenApiPlusEventHandler` + + .. py:method:: context(self) + :property: + + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/grpc/event/KiwoomOpenApiPlusEventHandlers/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/grpc/event/KiwoomOpenApiPlusEventHandlers/index.rst new file mode 100644 index 00000000..cfb649c1 --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/grpc/event/KiwoomOpenApiPlusEventHandlers/index.rst @@ -0,0 +1,141 @@ +:py:mod:`koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusEventHandlers` +====================================================================================== + +.. py:module:: koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusEventHandlers + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusEventHandlers.KiwoomOpenApiPlusLazyAllEventHandler + koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusEventHandlers.KiwoomOpenApiPlusEagerAllEventHandler + koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusEventHandlers.KiwoomOpenApiPlusAllEventHandler + koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusEventHandlers.KiwoomOpenApiPlusLazySomeEventHandler + koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusEventHandlers.KiwoomOpenApiPlusEagerSomeEventHandler + koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusEventHandlers.KiwoomOpenApiPlusSomeEventHandler + koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusEventHandlers.KiwoomOpenApiPlusSomeBidirectionalEventHandler + + + + +.. py:class:: KiwoomOpenApiPlusLazyAllEventHandler(control, context) + + Bases: :py:obj:`koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusEventHandlerForGrpc.KiwoomOpenApiPlusEventHandlerForGrpc`, :py:obj:`koapy.utils.logging.Logging.Logging` + + .. py:method:: OnReceiveTrData(self, scrnno, rqname, trcode, recordname, prevnext, _datalength, _errorcode, _message, _splmmsg) + + + .. py:method:: OnReceiveRealData(self, code, realtype, realdata) + + + .. py:method:: OnReceiveMsg(self, scrnno, rqname, trcode, msg) + + + .. py:method:: OnReceiveChejanData(self, gubun, itemcnt, fidlist) + + + .. py:method:: OnEventConnect(self, errcode) + + + .. py:method:: OnReceiveRealCondition(self, code, condition_type, condition_name, condition_index) + + + .. py:method:: OnReceiveTrCondition(self, scrnno, codelist, condition_name, condition_index, prevnext) + + + .. py:method:: OnReceiveConditionVer(self, ret, msg) + + + +.. py:class:: KiwoomOpenApiPlusEagerAllEventHandler(control, context) + + Bases: :py:obj:`koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusEventHandlerForGrpc.KiwoomOpenApiPlusEventHandlerForGrpc`, :py:obj:`koapy.utils.logging.Logging.Logging` + + .. py:method:: OnReceiveTrData(self, scrnno, rqname, trcode, recordname, prevnext, _datalength, _errorcode, _message, _splmmsg) + + + .. py:method:: OnReceiveRealData(self, code, realtype, realdata) + + + .. py:method:: OnReceiveMsg(self, scrnno, rqname, trcode, msg) + + + .. py:method:: OnReceiveChejanData(self, gubun, itemcnt, fidlist) + + + .. py:method:: OnEventConnect(self, errcode) + + + .. py:method:: OnReceiveRealCondition(self, code, condition_type, condition_name, condition_index) + + + .. py:method:: OnReceiveTrCondition(self, scrnno, codelist, condition_name, condition_index, prevnext) + + + .. py:method:: OnReceiveConditionVer(self, ret, msg) + + + +.. py:class:: KiwoomOpenApiPlusAllEventHandler(control, context) + + Bases: :py:obj:`KiwoomOpenApiPlusEagerAllEventHandler` + + +.. py:class:: KiwoomOpenApiPlusLazySomeEventHandler(control, request, context) + + Bases: :py:obj:`KiwoomOpenApiPlusLazyAllEventHandler` + + .. py:method:: slots(self) + + + +.. py:class:: KiwoomOpenApiPlusEagerSomeEventHandler(control, request, context) + + Bases: :py:obj:`KiwoomOpenApiPlusEagerAllEventHandler` + + .. py:method:: slots(self) + + + +.. py:class:: KiwoomOpenApiPlusSomeEventHandler(control, request, context) + + Bases: :py:obj:`KiwoomOpenApiPlusEagerSomeEventHandler` + + +.. py:class:: KiwoomOpenApiPlusSomeBidirectionalEventHandler(control, request_iterator, context) + + Bases: :py:obj:`KiwoomOpenApiPlusLazySomeEventHandler` + + .. py:method:: await_handled(self) + + + .. py:method:: OnReceiveTrData(self, scrnno, rqname, trcode, recordname, prevnext, _datalength, _errorcode, _message, _splmmsg) + + + .. py:method:: OnReceiveRealData(self, code, realtype, realdata) + + + .. py:method:: OnReceiveMsg(self, scrnno, rqname, trcode, msg) + + + .. py:method:: OnReceiveChejanData(self, gubun, itemcnt, fidlist) + + + .. py:method:: OnEventConnect(self, errcode) + + + .. py:method:: OnReceiveRealCondition(self, code, condition_type, condition_name, condition_index) + + + .. py:method:: OnReceiveTrCondition(self, scrnno, codelist, condition_name, condition_index, prevnext) + + + .. py:method:: OnReceiveConditionVer(self, ret, msg) + + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/grpc/event/KiwoomOpenApiPlusKwTrEventHandler/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/grpc/event/KiwoomOpenApiPlusKwTrEventHandler/index.rst new file mode 100644 index 00000000..418872ed --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/grpc/event/KiwoomOpenApiPlusKwTrEventHandler/index.rst @@ -0,0 +1,36 @@ +:py:mod:`koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusKwTrEventHandler` +========================================================================================= + +.. py:module:: koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusKwTrEventHandler + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusKwTrEventHandler.KiwoomOpenApiPlusKwTrEventHandler + + + + +.. py:class:: KiwoomOpenApiPlusKwTrEventHandler(control, request, context, screen_manager) + + Bases: :py:obj:`koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusEventHandlerForGrpc.KiwoomOpenApiPlusEventHandlerForGrpc`, :py:obj:`koapy.utils.logging.Logging.Logging` + + .. py:method:: on_enter(self) + + + .. py:method:: OnReceiveTrData(self, scrnno, rqname, trcode, recordname, prevnext, datalength, errorcode, message, splmmsg) + + + .. py:method:: OnEventConnect(self, errcode) + + + .. py:method:: OnReceiveMsg(self, scrnno, rqname, trcode, msg) + + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/grpc/event/KiwoomOpenApiPlusLoadConditionEventHandler/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/grpc/event/KiwoomOpenApiPlusLoadConditionEventHandler/index.rst new file mode 100644 index 00000000..df48707b --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/grpc/event/KiwoomOpenApiPlusLoadConditionEventHandler/index.rst @@ -0,0 +1,30 @@ +:py:mod:`koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusLoadConditionEventHandler` +================================================================================================== + +.. py:module:: koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusLoadConditionEventHandler + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusLoadConditionEventHandler.KiwoomOpenApiPlusLoadConditionEventHandler + + + + +.. py:class:: KiwoomOpenApiPlusLoadConditionEventHandler(control, context, request) + + Bases: :py:obj:`koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusEventHandlerForGrpc.KiwoomOpenApiPlusEventHandlerForGrpc` + + .. py:method:: on_enter(self) + + + .. py:method:: OnReceiveConditionVer(self, ret, msg) + + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/grpc/event/KiwoomOpenApiPlusLoggingEventHandler/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/grpc/event/KiwoomOpenApiPlusLoggingEventHandler/index.rst new file mode 100644 index 00000000..44f8ca50 --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/grpc/event/KiwoomOpenApiPlusLoggingEventHandler/index.rst @@ -0,0 +1,61 @@ +:py:mod:`koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusLoggingEventHandler` +============================================================================================ + +.. py:module:: koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusLoggingEventHandler + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusLoggingEventHandler.KiwoomOpenApiPlusLoggingEventHandler + + + + +.. py:class:: KiwoomOpenApiPlusLoggingEventHandler(control) + + Bases: :py:obj:`koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusEventHandler.KiwoomOpenApiPlusEventHandler`, :py:obj:`koapy.utils.logging.Logging.Logging` + + .. py:method:: OnReceiveTrData(self, scrnno, rqname, trcode, recordname, prevnext, _datalength, _errorcode, _message, _splmmsg) + + + .. py:method:: OnReceiveRealData(self, code, realtype, realdata) + + + .. py:method:: OnReceiveMsg(self, scrnno, rqname, trcode, msg) + + [OnReceiveMsg()이벤트] + + OnReceiveMsg( + BSTR sScrNo, // 화면번호 + BSTR sRQName, // 사용자 구분명 + BSTR sTrCode, // TR이름 + BSTR sMsg // 서버에서 전달하는 메시지 + ) + + 서버통신 후 수신한 메시지를 알려줍니다. + 메시지에는 6자리 코드번호가 포함되는데 이 코드번호는 통보없이 수시로 변경될 수 있습니다. 따라서 주문이나 오류관련처리를 + 이 코드번호로 분류하시면 안됩니다. + + + .. py:method:: OnReceiveChejanData(self, gubun, itemcnt, fidlist) + + + .. py:method:: OnEventConnect(self, errcode) + + + .. py:method:: OnReceiveRealCondition(self, code, condition_type, condition_name, condition_index) + + + .. py:method:: OnReceiveTrCondition(self, scrnno, codelist, condition_name, condition_index, prevnext) + + + .. py:method:: OnReceiveConditionVer(self, ret, msg) + + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/grpc/event/KiwoomOpenApiPlusLoginEventHandler/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/grpc/event/KiwoomOpenApiPlusLoginEventHandler/index.rst new file mode 100644 index 00000000..c31360a1 --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/grpc/event/KiwoomOpenApiPlusLoginEventHandler/index.rst @@ -0,0 +1,30 @@ +:py:mod:`koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusLoginEventHandler` +========================================================================================== + +.. py:module:: koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusLoginEventHandler + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusLoginEventHandler.KiwoomOpenApiPlusLoginEventHandler + + + + +.. py:class:: KiwoomOpenApiPlusLoginEventHandler(control, request, context) + + Bases: :py:obj:`koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusEventHandlerForGrpc.KiwoomOpenApiPlusEventHandlerForGrpc` + + .. py:method:: on_enter(self) + + + .. py:method:: OnEventConnect(self, errcode) + + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/grpc/event/KiwoomOpenApiPlusOrderEventHandler/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/grpc/event/KiwoomOpenApiPlusOrderEventHandler/index.rst new file mode 100644 index 00000000..73464766 --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/grpc/event/KiwoomOpenApiPlusOrderEventHandler/index.rst @@ -0,0 +1,69 @@ +:py:mod:`koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusOrderEventHandler` +========================================================================================== + +.. py:module:: koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusOrderEventHandler + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusOrderEventHandler.KiwoomOpenApiPlusBaseOrderEventHandler + koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusOrderEventHandler.KiwoomOpenApiPlusAllOrderEventHandler + koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusOrderEventHandler.KiwoomOpenApiPlusOrderEventHandler + + + + +.. py:class:: KiwoomOpenApiPlusBaseOrderEventHandler(control, context) + + Bases: :py:obj:`koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusEventHandlerForGrpc.KiwoomOpenApiPlusEventHandlerForGrpc`, :py:obj:`koapy.utils.logging.Logging.Logging` + + .. py:method:: ResponseForOnReceiveMsg(self, scrnno, rqname, trcode, msg) + + + .. py:method:: OnReceiveMsg(self, scrnno, rqname, trcode, msg) + + + .. py:method:: ResponseForOnReceiveTrData(self, scrnno, rqname, trcode, recordname, prevnext, datalength, errorcode, message, splmmsg) + + + .. py:method:: OnReceiveTrData(self, scrnno, rqname, trcode, recordname, prevnext, datalength, errorcode, message, splmmsg) + + + .. py:method:: ResponseForOnReceiveChejanData(self, gubun, itemcnt, fidlist) + + + .. py:method:: OnReceiveChejanData(self, gubun, itemcnt, fidlist) + + + .. py:method:: OnEventConnect(self, errcode) + + + +.. py:class:: KiwoomOpenApiPlusAllOrderEventHandler(control, context) + + Bases: :py:obj:`KiwoomOpenApiPlusBaseOrderEventHandler` + + +.. py:class:: KiwoomOpenApiPlusOrderEventHandler(control, request, context, screen_manager) + + Bases: :py:obj:`KiwoomOpenApiPlusBaseOrderEventHandler`, :py:obj:`koapy.utils.logging.Logging.Logging` + + .. py:method:: on_enter(self) + + + .. py:method:: OnReceiveMsg(self, scrnno, rqname, trcode, msg) + + + .. py:method:: OnReceiveTrData(self, scrnno, rqname, trcode, recordname, prevnext, datalength, errorcode, message, splmmsg) + + + .. py:method:: OnReceiveChejanData(self, gubun, itemcnt, fidlist) + + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/grpc/event/KiwoomOpenApiPlusRealEventHandler/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/grpc/event/KiwoomOpenApiPlusRealEventHandler/index.rst new file mode 100644 index 00000000..f39fbb05 --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/grpc/event/KiwoomOpenApiPlusRealEventHandler/index.rst @@ -0,0 +1,69 @@ +:py:mod:`koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusRealEventHandler` +========================================================================================= + +.. py:module:: koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusRealEventHandler + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusRealEventHandler.KiwoomOpenApiPlusRealEventHandler + koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusRealEventHandler.KiwoomOpenApiPlusBidirectionalRealEventHandler + + + + +.. py:class:: KiwoomOpenApiPlusRealEventHandler(control, request, context, screen_manager) + + Bases: :py:obj:`koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusEventHandlerForGrpc.KiwoomOpenApiPlusEventHandlerForGrpc`, :py:obj:`koapy.utils.logging.Logging.Logging` + + .. py:method:: on_enter(self) + + + .. py:method:: OnReceiveRealData(self, code, realtype, realdata) + + + .. py:method:: OnEventConnect(self, errcode) + + + +.. py:class:: KiwoomOpenApiPlusBidirectionalRealEventHandler(control, request_iterator, context, screen_manager) + + Bases: :py:obj:`KiwoomOpenApiPlusRealEventHandler`, :py:obj:`koapy.utils.logging.Logging.Logging` + + .. py:method:: register_code(self, code, fid_list=None) + + + .. py:method:: remove_code(self, code) + + + .. py:method:: remove_all_codes(self) + + + .. py:method:: remove_all_screens(self) + + + .. py:method:: consume_request_iterator(self) + + + .. py:method:: stop_request_iterator_consumer(self) + + + .. py:method:: start_request_iterator_consumer(self) + + + .. py:method:: on_enter(self) + + + .. py:method:: on_exit(self, exc_type=None, exc_value=None, traceback=None) + + + .. py:method:: OnReceiveRealData(self, code, realtype, realdata) + + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/grpc/event/KiwoomOpenApiPlusTrEventHandler/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/grpc/event/KiwoomOpenApiPlusTrEventHandler/index.rst new file mode 100644 index 00000000..6421bd21 --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/grpc/event/KiwoomOpenApiPlusTrEventHandler/index.rst @@ -0,0 +1,36 @@ +:py:mod:`koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusTrEventHandler` +======================================================================================= + +.. py:module:: koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusTrEventHandler + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusTrEventHandler.KiwoomOpenApiPlusTrEventHandler + + + + +.. py:class:: KiwoomOpenApiPlusTrEventHandler(control, request, context, screen_manager) + + Bases: :py:obj:`koapy.backend.kiwoom_open_api_plus.grpc.event.KiwoomOpenApiPlusEventHandlerForGrpc.KiwoomOpenApiPlusEventHandlerForGrpc`, :py:obj:`koapy.utils.logging.Logging.Logging` + + .. py:method:: on_enter(self) + + + .. py:method:: OnReceiveTrData(self, scrnno, rqname, trcode, recordname, prevnext, datalength, errorcode, message, splmmsg) + + + .. py:method:: OnEventConnect(self, errcode) + + + .. py:method:: OnReceiveMsg(self, scrnno, rqname, trcode, msg) + + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/grpc/event/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/grpc/event/index.rst new file mode 100644 index 00000000..b537353a --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/grpc/event/index.rst @@ -0,0 +1,24 @@ +:py:mod:`koapy.backend.kiwoom_open_api_plus.grpc.event` +======================================================= + +.. py:module:: koapy.backend.kiwoom_open_api_plus.grpc.event + + +Submodules +---------- +.. toctree:: + :titlesonly: + :maxdepth: 1 + + KiwoomOpenApiPlusConditionEventHandler/index.rst + KiwoomOpenApiPlusEventHandlerForGrpc/index.rst + KiwoomOpenApiPlusEventHandlers/index.rst + KiwoomOpenApiPlusKwTrEventHandler/index.rst + KiwoomOpenApiPlusLoadConditionEventHandler/index.rst + KiwoomOpenApiPlusLoggingEventHandler/index.rst + KiwoomOpenApiPlusLoginEventHandler/index.rst + KiwoomOpenApiPlusOrderEventHandler/index.rst + KiwoomOpenApiPlusRealEventHandler/index.rst + KiwoomOpenApiPlusTrEventHandler/index.rst + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/grpc/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/grpc/index.rst new file mode 100644 index 00000000..76b9a2f9 --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/grpc/index.rst @@ -0,0 +1,33 @@ +:py:mod:`koapy.backend.kiwoom_open_api_plus.grpc` +================================================= + +.. py:module:: koapy.backend.kiwoom_open_api_plus.grpc + + +Subpackages +----------- +.. toctree:: + :titlesonly: + :maxdepth: 3 + + event/index.rst + tools/index.rst + + +Submodules +---------- +.. toctree:: + :titlesonly: + :maxdepth: 1 + + KiwoomOpenApiPlusServiceClient/index.rst + KiwoomOpenApiPlusServiceClientSideDynamicCallable/index.rst + KiwoomOpenApiPlusServiceClientSideSignalConnector/index.rst + KiwoomOpenApiPlusServiceClientStubWrapper/index.rst + KiwoomOpenApiPlusServiceMessageUtils/index.rst + KiwoomOpenApiPlusServiceServer/index.rst + KiwoomOpenApiPlusServiceServicer/index.rst + KiwoomOpenApiPlusService_pb2/index.rst + KiwoomOpenApiPlusService_pb2_grpc/index.rst + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/grpc/tools/compile_proto/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/grpc/tools/compile_proto/index.rst new file mode 100644 index 00000000..8e32dd50 --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/grpc/tools/compile_proto/index.rst @@ -0,0 +1,22 @@ +:py:mod:`koapy.backend.kiwoom_open_api_plus.grpc.tools.compile_proto` +===================================================================== + +.. py:module:: koapy.backend.kiwoom_open_api_plus.grpc.tools.compile_proto + + +Module Contents +--------------- + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + koapy.backend.kiwoom_open_api_plus.grpc.tools.compile_proto.compile_proto + + + +.. py:function:: compile_proto() + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/grpc/tools/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/grpc/tools/index.rst new file mode 100644 index 00000000..5eb0b0b0 --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/grpc/tools/index.rst @@ -0,0 +1,15 @@ +:py:mod:`koapy.backend.kiwoom_open_api_plus.grpc.tools` +======================================================= + +.. py:module:: koapy.backend.kiwoom_open_api_plus.grpc.tools + + +Submodules +---------- +.. toctree:: + :titlesonly: + :maxdepth: 1 + + compile_proto/index.rst + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/index.rst new file mode 100644 index 00000000..1679686f --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/index.rst @@ -0,0 +1,18 @@ +:py:mod:`koapy.backend.kiwoom_open_api_plus` +============================================ + +.. py:module:: koapy.backend.kiwoom_open_api_plus + + +Subpackages +----------- +.. toctree:: + :titlesonly: + :maxdepth: 3 + + core/index.rst + grpc/index.rst + pyside2/index.rst + utils/index.rst + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/pyside2/KiwoomOpenApiPlusDialogHandler/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/pyside2/KiwoomOpenApiPlusDialogHandler/index.rst new file mode 100644 index 00000000..b9bd4761 --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/pyside2/KiwoomOpenApiPlusDialogHandler/index.rst @@ -0,0 +1,70 @@ +:py:mod:`koapy.backend.kiwoom_open_api_plus.pyside2.KiwoomOpenApiPlusDialogHandler` +=================================================================================== + +.. py:module:: koapy.backend.kiwoom_open_api_plus.pyside2.KiwoomOpenApiPlusDialogHandler + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backend.kiwoom_open_api_plus.pyside2.KiwoomOpenApiPlusDialogHandler.DialogToHandle + koapy.backend.kiwoom_open_api_plus.pyside2.KiwoomOpenApiPlusDialogHandler.KiwoomOpenApiPlusDialogToHandle + koapy.backend.kiwoom_open_api_plus.pyside2.KiwoomOpenApiPlusDialogHandler.KiwoomOpenApiPlusDialogHandler + + + + +.. py:class:: DialogToHandle + + .. py:method:: should_handle(self, dialog: koapy.compat.pywinauto.WindowSpecification) -> bool + + + .. py:method:: handle(self, dialog: koapy.compat.pywinauto.WindowSpecification) + + + .. py:method:: handle_if_needed(self, dialog: koapy.compat.pywinauto.WindowSpecification) + + + +.. py:class:: KiwoomOpenApiPlusDialogToHandle(title: Optional[str] = None, time: Optional[datetime.time] = None, body: Optional[str] = None, app: Optional[koapy.backend.kiwoom_open_api_plus.pyside2.KiwoomOpenApiPlusManagerApplication.KiwoomOpenApiPlusManagerApplication] = None, restart_type: Optional[koapy.backend.kiwoom_open_api_plus.pyside2.KiwoomOpenApiPlusManagerApplication.KiwoomOpenApiPlusManagerApplication.RestartType] = None) + + Bases: :py:obj:`DialogToHandle`, :py:obj:`koapy.utils.logging.Logging.Logging` + + .. py:method:: should_handle_by_title(cls, dialog: koapy.compat.pywinauto.WindowSpecification, title: str) + :classmethod: + + + .. py:method:: handle_by_clicking_button(cls, dialog: koapy.compat.pywinauto.WindowSpecification) + :classmethod: + + + .. py:method:: handle_by_emiting_should_restart_signal(cls, app: koapy.backend.kiwoom_open_api_plus.pyside2.KiwoomOpenApiPlusManagerApplication.KiwoomOpenApiPlusManagerApplication, restart_type: koapy.backend.kiwoom_open_api_plus.pyside2.KiwoomOpenApiPlusManagerApplication.KiwoomOpenApiPlusManagerApplication.RestartType) + :classmethod: + + + .. py:method:: to_specification(self) -> koapy.compat.pywinauto.WindowSpecification + + + .. py:method:: should_handle(self, dialog: koapy.compat.pywinauto.WindowSpecification) -> bool + + + .. py:method:: handle(self, dialog: koapy.compat.pywinauto.WindowSpecification) + + + .. py:method:: handle_if_needed(self, dialog: koapy.compat.pywinauto.WindowSpecification) + + + +.. py:class:: KiwoomOpenApiPlusDialogHandler(app: koapy.backend.kiwoom_open_api_plus.pyside2.KiwoomOpenApiPlusManagerApplication.KiwoomOpenApiPlusManagerApplication, parent: Optional[koapy.compat.pyside2.QtCore.QObject] = None) + + Bases: :py:obj:`koapy.backend.kiwoom_open_api_plus.utils.pyside2.QDialogHandler.QDialogHandler` + + .. py:method:: onReadyDialog(self, dialog: koapy.compat.pywinauto.WindowSpecification) + + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/pyside2/KiwoomOpenApiPlusManagerApplication/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/pyside2/KiwoomOpenApiPlusManagerApplication/index.rst new file mode 100644 index 00000000..59fe8a55 --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/pyside2/KiwoomOpenApiPlusManagerApplication/index.rst @@ -0,0 +1,169 @@ +:py:mod:`koapy.backend.kiwoom_open_api_plus.pyside2.KiwoomOpenApiPlusManagerApplication` +======================================================================================== + +.. py:module:: koapy.backend.kiwoom_open_api_plus.pyside2.KiwoomOpenApiPlusManagerApplication + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backend.kiwoom_open_api_plus.pyside2.KiwoomOpenApiPlusManagerApplication.KiwoomOpenApiPlusManagerApplicationArgumentParser + koapy.backend.kiwoom_open_api_plus.pyside2.KiwoomOpenApiPlusManagerApplication.KiwoomOpenApiPlusServerApplicationProcess + koapy.backend.kiwoom_open_api_plus.pyside2.KiwoomOpenApiPlusManagerApplication.KiwoomOpenApiPlusServerApplicationSubprocess + koapy.backend.kiwoom_open_api_plus.pyside2.KiwoomOpenApiPlusManagerApplication.KiwoomOpenApiPlusManagerApplication + + + + +.. py:class:: KiwoomOpenApiPlusManagerApplicationArgumentParser + + Bases: :py:obj:`koapy.cli.extensions.parser.ArgumentParser` + + .. py:method:: parse_args(self, args: Optional[Sequence[str]] = None, namespace: Optional[argparse.Namespace] = None) -> argparse.Namespace + + + .. py:method:: parse_known_args(self, args: Optional[Sequence[str]] = None, namespace: Optional[argparse.Namespace] = None) -> Tuple[argparse.Namespace, List[str]] + + + +.. py:class:: KiwoomOpenApiPlusServerApplicationProcess(args, parent=None) + + Bases: :py:obj:`koapy.compat.pyside2.QtCore.QProcess` + + +.. py:class:: KiwoomOpenApiPlusServerApplicationSubprocess(args, parent=None) + + .. py:method:: start(self) + + + .. py:method:: waitForStarted(self, msecs: int = 30000) -> bool + + + .. py:method:: close(self) + + + .. py:method:: waitForFinished(self, msecs: int = 30000) -> bool + + + +.. py:class:: KiwoomOpenApiPlusManagerApplication(args=()) + + Bases: :py:obj:`koapy.utils.logging.pyside2.QObjectLogging.QObjectLogging` + + .. py:class:: ConnectionStatus + + Bases: :py:obj:`enum.Enum` + + Generic enumeration. + + Derive from this class to define new enumerations. + + .. py:attribute:: DISCONNECTED + :annotation: = 1 + + + + .. py:attribute:: CONNECTED + :annotation: = 2 + + + + + .. py:class:: ServerType + + Bases: :py:obj:`enum.Enum` + + Generic enumeration. + + Derive from this class to define new enumerations. + + .. py:attribute:: SIMULATION + :annotation: = 1 + + + + .. py:attribute:: REAL + :annotation: = 2 + + + + .. py:attribute:: UNKNOWN + :annotation: = 3 + + + + + .. py:class:: RestartType + + Bases: :py:obj:`enum.Enum` + + Generic enumeration. + + Derive from this class to define new enumerations. + + .. py:attribute:: NO_RESTART + :annotation: = 1 + + + + .. py:attribute:: RESTART_ONLY + :annotation: = 2 + + + + .. py:attribute:: RESTART_AND_RESTORE + :annotation: = 3 + + + + .. py:attribute:: RESTART_AND_CONNECT + :annotation: = 4 + + + + .. py:attribute:: RESTART_WITH_UPDATE + :annotation: = 5 + + + + .. py:attribute:: RESTART_WITH_UPDATE_AND_RESTORE + :annotation: = 6 + + + + .. py:attribute:: RESTART_WITH_UPDATE_AND_CONNECT + :annotation: = 7 + + + + + .. py:attribute:: shouldRestart + + + + + .. py:method:: close(self) + + + .. py:method:: exec_(self) + + + .. py:method:: exit(self, return_code=0) + + + .. py:method:: restart(self, restart_type: Optional[RestartType] = None) + + + .. py:method:: execAndExit(self) + + + .. py:method:: main(cls, args=None) + :classmethod: + + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/pyside2/KiwoomOpenApiPlusServerApplication/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/pyside2/KiwoomOpenApiPlusServerApplication/index.rst new file mode 100644 index 00000000..6bde00a1 --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/pyside2/KiwoomOpenApiPlusServerApplication/index.rst @@ -0,0 +1,92 @@ +:py:mod:`koapy.backend.kiwoom_open_api_plus.pyside2.KiwoomOpenApiPlusServerApplication` +======================================================================================= + +.. py:module:: koapy.backend.kiwoom_open_api_plus.pyside2.KiwoomOpenApiPlusServerApplication + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backend.kiwoom_open_api_plus.pyside2.KiwoomOpenApiPlusServerApplication.KiwoomOpenApiPlusServerApplicationArgumentParser + koapy.backend.kiwoom_open_api_plus.pyside2.KiwoomOpenApiPlusServerApplication.KiwoomOpenApiPlusServerApplication + + + + +.. py:class:: KiwoomOpenApiPlusServerApplicationArgumentParser + + Bases: :py:obj:`koapy.cli.extensions.parser.ArgumentParser` + + .. py:method:: parse_args(self, args: Optional[Sequence[str]] = None, namespace: Optional[argparse.Namespace] = None) -> argparse.Namespace + + + .. py:method:: parse_known_args(self, args: Optional[Sequence[str]] = None, namespace: Optional[argparse.Namespace] = None) -> Tuple[argparse.Namespace, List[str]] + + + +.. py:class:: KiwoomOpenApiPlusServerApplication(args=()) + + Bases: :py:obj:`koapy.utils.logging.pyside2.QObjectLogging.QObjectLogging` + + .. py:class:: ConnectionStatus + + Bases: :py:obj:`enum.Enum` + + Generic enumeration. + + Derive from this class to define new enumerations. + + .. py:attribute:: DISCONNECTED + :annotation: = 1 + + + + .. py:attribute:: CONNECTED + :annotation: = 2 + + + + + .. py:class:: ServerType + + Bases: :py:obj:`enum.Enum` + + Generic enumeration. + + Derive from this class to define new enumerations. + + .. py:attribute:: SIMULATION + :annotation: = 1 + + + + .. py:attribute:: REAL + :annotation: = 2 + + + + .. py:attribute:: UNKNOWN + :annotation: = 3 + + + + + .. py:method:: exec_(self) + + + .. py:method:: exit(self, return_code=0) + + + .. py:method:: execAndExit(self) + + + .. py:method:: main(cls, args=None) + :classmethod: + + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/pyside2/KiwoomOpenApiPlusSignalHandler/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/pyside2/KiwoomOpenApiPlusSignalHandler/index.rst new file mode 100644 index 00000000..9827fad6 --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/pyside2/KiwoomOpenApiPlusSignalHandler/index.rst @@ -0,0 +1,24 @@ +:py:mod:`koapy.backend.kiwoom_open_api_plus.pyside2.KiwoomOpenApiPlusSignalHandler` +=================================================================================== + +.. py:module:: koapy.backend.kiwoom_open_api_plus.pyside2.KiwoomOpenApiPlusSignalHandler + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backend.kiwoom_open_api_plus.pyside2.KiwoomOpenApiPlusSignalHandler.KiwoomOpenApiPlusSignalHandler + + + + +.. py:class:: KiwoomOpenApiPlusSignalHandler(app, parent=None) + + Bases: :py:obj:`koapy.backend.kiwoom_open_api_plus.utils.pyside2.QSignalHandler.QSignalHandler` + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/pyside2/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/pyside2/index.rst new file mode 100644 index 00000000..02927967 --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/pyside2/index.rst @@ -0,0 +1,18 @@ +:py:mod:`koapy.backend.kiwoom_open_api_plus.pyside2` +==================================================== + +.. py:module:: koapy.backend.kiwoom_open_api_plus.pyside2 + + +Submodules +---------- +.. toctree:: + :titlesonly: + :maxdepth: 1 + + KiwoomOpenApiPlusDialogHandler/index.rst + KiwoomOpenApiPlusManagerApplication/index.rst + KiwoomOpenApiPlusServerApplication/index.rst + KiwoomOpenApiPlusSignalHandler/index.rst + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/utils/grpc/PipeableMultiThreadedRendezvous/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/utils/grpc/PipeableMultiThreadedRendezvous/index.rst new file mode 100644 index 00000000..e83e2ba2 --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/utils/grpc/PipeableMultiThreadedRendezvous/index.rst @@ -0,0 +1,27 @@ +:py:mod:`koapy.backend.kiwoom_open_api_plus.utils.grpc.PipeableMultiThreadedRendezvous` +======================================================================================= + +.. py:module:: koapy.backend.kiwoom_open_api_plus.utils.grpc.PipeableMultiThreadedRendezvous + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backend.kiwoom_open_api_plus.utils.grpc.PipeableMultiThreadedRendezvous.PipeableMultiThreadedRendezvous + + + + +.. py:class:: PipeableMultiThreadedRendezvous(rendezvous, iterator=None) + + Bases: :py:obj:`collections.abc.Iterator` + + .. py:method:: pipe(self, func) + + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/utils/grpc/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/utils/grpc/index.rst new file mode 100644 index 00000000..0153e721 --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/utils/grpc/index.rst @@ -0,0 +1,15 @@ +:py:mod:`koapy.backend.kiwoom_open_api_plus.utils.grpc` +======================================================= + +.. py:module:: koapy.backend.kiwoom_open_api_plus.utils.grpc + + +Submodules +---------- +.. toctree:: + :titlesonly: + :maxdepth: 1 + + PipeableMultiThreadedRendezvous/index.rst + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/utils/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/utils/index.rst new file mode 100644 index 00000000..86092694 --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/utils/index.rst @@ -0,0 +1,27 @@ +:py:mod:`koapy.backend.kiwoom_open_api_plus.utils` +================================================== + +.. py:module:: koapy.backend.kiwoom_open_api_plus.utils + + +Subpackages +----------- +.. toctree:: + :titlesonly: + :maxdepth: 3 + + grpc/index.rst + pyside2/index.rst + queue/index.rst + + +Submodules +---------- +.. toctree:: + :titlesonly: + :maxdepth: 1 + + list_conversion/index.rst + module_path/index.rst + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/utils/list_conversion/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/utils/list_conversion/index.rst new file mode 100644 index 00000000..1a2c0cdf --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/utils/list_conversion/index.rst @@ -0,0 +1,30 @@ +:py:mod:`koapy.backend.kiwoom_open_api_plus.utils.list_conversion` +================================================================== + +.. py:module:: koapy.backend.kiwoom_open_api_plus.utils.list_conversion + + +Module Contents +--------------- + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + koapy.backend.kiwoom_open_api_plus.utils.list_conversion.string_to_list + koapy.backend.kiwoom_open_api_plus.utils.list_conversion.list_to_string + koapy.backend.kiwoom_open_api_plus.utils.list_conversion.convert_list_arguments + + + +.. py:function:: string_to_list(s, sep=';') + + +.. py:function:: list_to_string(l, sep=';') + + +.. py:function:: convert_list_arguments(*indices) + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/utils/module_path/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/utils/module_path/index.rst new file mode 100644 index 00000000..1eb2b56a --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/utils/module_path/index.rst @@ -0,0 +1,22 @@ +:py:mod:`koapy.backend.kiwoom_open_api_plus.utils.module_path` +============================================================== + +.. py:module:: koapy.backend.kiwoom_open_api_plus.utils.module_path + + +Module Contents +--------------- + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + koapy.backend.kiwoom_open_api_plus.utils.module_path.GetAPIModulePath + + + +.. py:function:: GetAPIModulePath() -> pathlib.Path + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/utils/pyside2/QDialogHandler/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/utils/pyside2/QDialogHandler/index.rst new file mode 100644 index 00000000..e95ea5f8 --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/utils/pyside2/QDialogHandler/index.rst @@ -0,0 +1,50 @@ +:py:mod:`koapy.backend.kiwoom_open_api_plus.utils.pyside2.QDialogHandler` +========================================================================= + +.. py:module:: koapy.backend.kiwoom_open_api_plus.utils.pyside2.QDialogHandler + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backend.kiwoom_open_api_plus.utils.pyside2.QDialogHandler.QDialogHandler + + + + +.. py:class:: QDialogHandler(specifications: Optional[Sequence[koapy.compat.pywinauto.WindowSpecification]] = None, parent: Optional[koapy.compat.pyside2.QtCore.QObject] = None) + + Bases: :py:obj:`koapy.utils.logging.pyside2.QThreadLogging.QThreadLogging` + + .. py:attribute:: readyDialog + + + + + .. py:attribute:: notReadyDialog + + + + + .. py:method:: from_titles(cls, titles: Sequence[str], allow_magic_lookup: bool = False) + :classmethod: + + + .. py:method:: get_text_of_dialog(self, dialog: koapy.compat.pywinauto.WindowSpecification, default: Optional[str] = None) + + + .. py:method:: run(self) + + + .. py:method:: stop(self) + + + .. py:method:: wait_for_termination(self, timeout=None) + + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/utils/pyside2/QSignalHandler/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/utils/pyside2/QSignalHandler/index.rst new file mode 100644 index 00000000..b4000916 --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/utils/pyside2/QSignalHandler/index.rst @@ -0,0 +1,56 @@ +:py:mod:`koapy.backend.kiwoom_open_api_plus.utils.pyside2.QSignalHandler` +========================================================================= + +.. py:module:: koapy.backend.kiwoom_open_api_plus.utils.pyside2.QSignalHandler + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backend.kiwoom_open_api_plus.utils.pyside2.QSignalHandler.QSignalHandler + + + + +.. py:class:: QSignalHandler(signals: Iterable[signal.Signals], parent: Optional[koapy.compat.pyside2.QtCore.QObject]) QSignalHandler(parent: Optional[koapy.compat.pyside2.QtCore.QObject]) + + Bases: :py:obj:`koapy.utils.logging.pyside2.QAbstractSocketLogging.QAbstractSocketLogging` + + .. py:attribute:: signaled + + + + + .. py:method:: onReadyRead(self) + + + .. py:method:: emitSignal(self, signal, frame) + + + .. py:method:: setWakeUpFileDescriptor(self, descriptor, warn_on_full_buffer=True) + + + .. py:method:: restoreWakeUpFileDescrptor(self) + + + .. py:method:: setHandler(self, signal, handler) + + + .. py:method:: restoreHandler(self, signal, default=None) + + + .. py:method:: restoreAllHandlers(self) + + + .. py:method:: setAll(self) + + + .. py:method:: restoreAll(self) + + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/utils/pyside2/QThreadPoolExecutor/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/utils/pyside2/QThreadPoolExecutor/index.rst new file mode 100644 index 00000000..9b2ab330 --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/utils/pyside2/QThreadPoolExecutor/index.rst @@ -0,0 +1,57 @@ +:py:mod:`koapy.backend.kiwoom_open_api_plus.utils.pyside2.QThreadPoolExecutor` +============================================================================== + +.. py:module:: koapy.backend.kiwoom_open_api_plus.utils.pyside2.QThreadPoolExecutor + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backend.kiwoom_open_api_plus.utils.pyside2.QThreadPoolExecutor.QThreadPoolExecutorRunnable + koapy.backend.kiwoom_open_api_plus.utils.pyside2.QThreadPoolExecutor.QThreadPoolExecutor + + + + +.. py:class:: QThreadPoolExecutorRunnable(future: concurrent.futures.Future, fn: Callable[Ellipsis, Any], args: Union[Tuple[Any], List[Any]], kwargs: Dict[str, Any]) + + Bases: :py:obj:`koapy.compat.pyside2.QtCore.QRunnable` + + .. py:method:: run(self) + + + +.. py:class:: QThreadPoolExecutor(thread_pool: koapy.compat.pyside2.QtCore.QThreadPool, parent: Optional[koapy.compat.pyside2.QtCore.QObject]) QThreadPoolExecutor(parent: Optional[koapy.compat.pyside2.QtCore.QObject]) + + Bases: :py:obj:`koapy.compat.pyside2.QtCore.QObject`, :py:obj:`concurrent.futures.Executor` + + This is an abstract base class for concrete asynchronous executors. + + .. py:method:: submit(self, fn, *args, **kwargs) + + Submits a callable to be executed with the given arguments. + + Schedules the callable to be executed as fn(*args, **kwargs) and returns + a Future instance representing the execution of the callable. + + :returns: A Future representing the given call. + + + .. py:method:: shutdown(self, wait=True, cancel_futures=False) + + Clean-up the resources associated with the Executor. + + It is safe to call this method several times. Otherwise, no other + methods can be called after this one. + + :param wait: If True then shutdown will not return until all running + futures have finished executing and the resources used by the + executor have been reclaimed. + + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/utils/pyside2/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/utils/pyside2/index.rst new file mode 100644 index 00000000..ba131b1e --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/utils/pyside2/index.rst @@ -0,0 +1,17 @@ +:py:mod:`koapy.backend.kiwoom_open_api_plus.utils.pyside2` +========================================================== + +.. py:module:: koapy.backend.kiwoom_open_api_plus.utils.pyside2 + + +Submodules +---------- +.. toctree:: + :titlesonly: + :maxdepth: 1 + + QDialogHandler/index.rst + QSignalHandler/index.rst + QThreadPoolExecutor/index.rst + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/utils/queue/QueueBasedBufferedIterator/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/utils/queue/QueueBasedBufferedIterator/index.rst new file mode 100644 index 00000000..a747a292 --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/utils/queue/QueueBasedBufferedIterator/index.rst @@ -0,0 +1,27 @@ +:py:mod:`koapy.backend.kiwoom_open_api_plus.utils.queue.QueueBasedBufferedIterator` +=================================================================================== + +.. py:module:: koapy.backend.kiwoom_open_api_plus.utils.queue.QueueBasedBufferedIterator + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backend.kiwoom_open_api_plus.utils.queue.QueueBasedBufferedIterator.QueueBasedBufferedIterator + + + + +.. py:class:: QueueBasedBufferedIterator(iterator, queue=None, maxsize=None) + + Bases: :py:obj:`koapy.backend.kiwoom_open_api_plus.utils.queue.QueueIterator.BufferedQueueIterator`, :py:obj:`koapy.utils.logging.Logging.Logging` + + .. py:method:: next(self, block=True, timeout=None) + + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/utils/queue/QueueBasedIterableObserver/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/utils/queue/QueueBasedIterableObserver/index.rst new file mode 100644 index 00000000..3dedec38 --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/utils/queue/QueueBasedIterableObserver/index.rst @@ -0,0 +1,67 @@ +:py:mod:`koapy.backend.kiwoom_open_api_plus.utils.queue.QueueBasedIterableObserver` +=================================================================================== + +.. py:module:: koapy.backend.kiwoom_open_api_plus.utils.queue.QueueBasedIterableObserver + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backend.kiwoom_open_api_plus.utils.queue.QueueBasedIterableObserver.QueueBasedIterableObserverIterator + koapy.backend.kiwoom_open_api_plus.utils.queue.QueueBasedIterableObserver.QueueBasedIterableObserver + + + + +.. py:class:: QueueBasedIterableObserverIterator(queue, sentinel) + + Bases: :py:obj:`koapy.backend.kiwoom_open_api_plus.utils.queue.QueueIterator.BufferedQueueIterator` + + .. py:method:: next(self, block=True, timeout=None) + + + .. py:method:: head(self) + + + +.. py:class:: QueueBasedIterableObserver(queue=None, maxsize=None) + + Bases: :py:obj:`rx.core.typing.Observer` + + Observer abstract base class + + An Observer is the entity that receives all emissions of a subscribed + Observable. + + .. py:method:: queue(self) + :property: + + + .. py:method:: on_next(self, value) + + Notifies the observer of a new element in the sequence. + + :param value: The received element. + + + .. py:method:: on_error(self, error) + + Notifies the observer that an exception has occurred. + + :param error: The error that has occurred. + + + .. py:method:: on_completed(self) + + Notifies the observer of the end of the sequence. + + + .. py:method:: stop(self) + + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/utils/queue/QueueIterator/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/utils/queue/QueueIterator/index.rst new file mode 100644 index 00000000..755e20cc --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/utils/queue/QueueIterator/index.rst @@ -0,0 +1,56 @@ +:py:mod:`koapy.backend.kiwoom_open_api_plus.utils.queue.QueueIterator` +====================================================================== + +.. py:module:: koapy.backend.kiwoom_open_api_plus.utils.queue.QueueIterator + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backend.kiwoom_open_api_plus.utils.queue.QueueIterator.QueueIterator + koapy.backend.kiwoom_open_api_plus.utils.queue.QueueIterator.BufferedQueueIterator + + + + +.. py:class:: QueueIterator(queue) + + .. py:method:: queue(self) + :property: + + + .. py:method:: next(self, block=True, timeout=None) + + + .. py:method:: next_nowait(self) + + + .. py:method:: has_next(self) + + + .. py:method:: stop(self) + + + .. py:method:: enable(self) + + + +.. py:class:: BufferedQueueIterator(queue) + + Bases: :py:obj:`QueueIterator` + + .. py:method:: next(self, block=True, timeout=None) + + + .. py:method:: has_next(self) + + + .. py:method:: head(self) + + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/utils/queue/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/utils/queue/index.rst new file mode 100644 index 00000000..352a869b --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_plus/utils/queue/index.rst @@ -0,0 +1,17 @@ +:py:mod:`koapy.backend.kiwoom_open_api_plus.utils.queue` +======================================================== + +.. py:module:: koapy.backend.kiwoom_open_api_plus.utils.queue + + +Submodules +---------- +.. toctree:: + :titlesonly: + :maxdepth: 1 + + QueueBasedBufferedIterator/index.rst + QueueBasedIterableObserver/index.rst + QueueIterator/index.rst + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_w/core/KiwoomOpenApiWDynamicCallable/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_w/core/KiwoomOpenApiWDynamicCallable/index.rst new file mode 100644 index 00000000..15d22daa --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_w/core/KiwoomOpenApiWDynamicCallable/index.rst @@ -0,0 +1,25 @@ +:py:mod:`koapy.backend.kiwoom_open_api_w.core.KiwoomOpenApiWDynamicCallable` +============================================================================ + +.. py:module:: koapy.backend.kiwoom_open_api_w.core.KiwoomOpenApiWDynamicCallable + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backend.kiwoom_open_api_w.core.KiwoomOpenApiWDynamicCallable.KiwoomOpenApiWDynamicCallable + + + + +.. py:class:: KiwoomOpenApiWDynamicCallable(control, name) + + .. py:method:: is_valid_return_type(self, result) + + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_w/core/KiwoomOpenApiWEntrypoint/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_w/core/KiwoomOpenApiWEntrypoint/index.rst new file mode 100644 index 00000000..510291ab --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_w/core/KiwoomOpenApiWEntrypoint/index.rst @@ -0,0 +1,6 @@ +:py:mod:`koapy.backend.kiwoom_open_api_w.core.KiwoomOpenApiWEntrypoint` +======================================================================= + +.. py:module:: koapy.backend.kiwoom_open_api_w.core.KiwoomOpenApiWEntrypoint + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_w/core/KiwoomOpenApiWError/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_w/core/KiwoomOpenApiWError/index.rst new file mode 100644 index 00000000..bf572ceb --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_w/core/KiwoomOpenApiWError/index.rst @@ -0,0 +1,243 @@ +:py:mod:`koapy.backend.kiwoom_open_api_w.core.KiwoomOpenApiWError` +================================================================== + +.. py:module:: koapy.backend.kiwoom_open_api_w.core.KiwoomOpenApiWError + + +Module Contents +--------------- + +.. py:exception:: KiwoomOpenApiWError(message=None) + + Bases: :py:obj:`Exception` + + Common base class for all non-exit exceptions. + + .. py:method:: message(self) + :property: + + + .. py:method:: try_or_raise(cls, arg, message=None) + :classmethod: + + + .. py:method:: try_or_raise_boolean(cls, arg, message) + :classmethod: + + + +.. py:exception:: KiwoomOpenApiWNegativeReturnCodeError(code, message=None) + + Bases: :py:obj:`KiwoomOpenApiWError` + + Common base class for all non-exit exceptions. + + .. py:attribute:: OP_ERR_NONE + :annotation: = 0 + + + + .. py:attribute:: OP_ERR_NO_LOGIN + + + + + .. py:attribute:: OP_ERR_LOGIN + + + + + .. py:attribute:: OP_ERR_CONNECT + + + + + .. py:attribute:: OP_ERR_VERSION + + + + + .. py:attribute:: OP_ERR_TRCODE + + + + + .. py:attribute:: OP_ERR_NO_REGOPENAPI + + + + + .. py:attribute:: OP_ERR_SISE_OVERFLOW + + + + + .. py:attribute:: OP_ERR_ORDER_OVERFLOW + + + + + .. py:attribute:: OP_ERR_RQ_WRONG_INPUT + + + + + .. py:attribute:: OP_ERR_ORD_WRONG_INPUT + + + + + .. py:attribute:: OP_ERR_ORD_WRONG_ACCPWD + + + + + .. py:attribute:: OP_ERR_ORD_WRONG_ACCNO + + + + + .. py:attribute:: OP_ERR_ORD_WRONG_QTY200 + + + + + .. py:attribute:: OP_ERR_ORD_WRONG_QTY400 + + + + + .. py:attribute:: MSG_ERR_NONE + :annotation: = 정상처리 + + + + .. py:attribute:: MSG_ERR_NO_LOGIN + :annotation: = 미접속상태 + + + + .. py:attribute:: MSG_ERR_LOGIN + :annotation: = 로그인시 접속 실패 (아이피 오류 또는 접속정보 오류) + + + + .. py:attribute:: MSG_ERR_CONNECT + :annotation: = 서버 접속 실패 + + + + .. py:attribute:: MSG_ERR_VERSION + :annotation: = 버전처리가 실패하였습니다. + + + + .. py:attribute:: MSG_ERR_TRCODE + :annotation: = TrCode 가 존재하지 않습니다. + + + + .. py:attribute:: MSG_ERR_NO_REGOPENAPI + :annotation: = 해외OpenAPI 미신청 + + + + .. py:attribute:: MSG_ERR_SISE_OVERFLOW + :annotation: = 조회과부화 + + + + .. py:attribute:: MSG_ERR_ORDER_OVERFLOW + :annotation: = 주문과부화 + + + + .. py:attribute:: MSG_ERR_RQ_WRONG_INPUT + :annotation: = 조회입력값(명칭/누락) 오류 + + + + .. py:attribute:: MSG_ERR_ORD_WRONG_INPUT + :annotation: = 주문입력갑 오류 + + + + .. py:attribute:: MSG_ERR_ORD_WRONG_ACCPWD + :annotation: = 계좌비밀번호를 입력하십시오. + + + + .. py:attribute:: MSG_ERR_ORD_WRONG_ACCNO + :annotation: = 타인 계좌를 사용할 수 없습니다. + + + + .. py:attribute:: MSG_ERR_ORD_WRONG_QTY200 + :annotation: = 경고-주문수량 200개 초과 + + + + .. py:attribute:: MSG_ERR_ORD_WRONG_QTY400 + :annotation: = 제한-주문수량 400개 초과 + + + + .. py:attribute:: ERROR_MESSAGE_BY_CODE + + + + + .. py:method:: get_error_message_by_code(cls, code, default=None) + :classmethod: + + + .. py:method:: check_code_or_raise(cls, code) + :classmethod: + + + .. py:method:: wrap_to_check_code_or_raise(cls, func) + :classmethod: + + + .. py:method:: try_or_raise(cls, arg, message=None) + :classmethod: + + + .. py:method:: code(self) + :property: + + + +.. py:exception:: KiwoomOpenApiWBooleanReturnCodeError(code, message=None) + + Bases: :py:obj:`KiwoomOpenApiWError` + + Common base class for all non-exit exceptions. + + .. py:attribute:: OP_ERR_SUCCESS + :annotation: = 1 + + + + .. py:attribute:: OP_ERR_FAILURE + :annotation: = 0 + + + + .. py:method:: check_code_or_raise(cls, code, message=None) + :classmethod: + + + .. py:method:: wrap_to_check_code_or_raise(cls, func, message=None) + :classmethod: + + + .. py:method:: try_or_raise(cls, arg, message=None) + :classmethod: + + + .. py:method:: code(self) + :property: + + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_w/core/KiwoomOpenApiWEventHandler/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_w/core/KiwoomOpenApiWEventHandler/index.rst new file mode 100644 index 00000000..9b8ce590 --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_w/core/KiwoomOpenApiWEventHandler/index.rst @@ -0,0 +1,66 @@ +:py:mod:`koapy.backend.kiwoom_open_api_w.core.KiwoomOpenApiWEventHandler` +========================================================================= + +.. py:module:: koapy.backend.kiwoom_open_api_w.core.KiwoomOpenApiWEventHandler + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backend.kiwoom_open_api_w.core.KiwoomOpenApiWEventHandler.KiwoomOpenApiWEventHandler + + + + +.. py:class:: KiwoomOpenApiWEventHandler(control) + + Bases: :py:obj:`koapy.backend.kiwoom_open_api_w.core.KiwoomOpenApiWEventHandlerFunctions.KiwoomOpenApiWEventHandlerFunctions` + + .. py:method:: control(self) + :property: + + + .. py:method:: observer(self) + :property: + + + .. py:method:: names(cls) + :classmethod: + + + .. py:method:: slots(self) + + + .. py:method:: connect(self) + + + .. py:method:: disconnect(self) + + + .. py:method:: on_enter(self) + + + .. py:method:: on_exit(self, exc_type=None, exc_value=None, traceback=None) + + + .. py:method:: add_callback(self, callback, *args, **kwargs) + + + .. py:method:: enter(self) + + + .. py:method:: exit(self, exc_type=None, exc_value=None, traceback=None) + + + .. py:method:: stop(self) + + + .. py:method:: close(self) + + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_w/core/KiwoomOpenApiWEventHandlerFunctions/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_w/core/KiwoomOpenApiWEventHandlerFunctions/index.rst new file mode 100644 index 00000000..dedc1009 --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_w/core/KiwoomOpenApiWEventHandlerFunctions/index.rst @@ -0,0 +1,42 @@ +:py:mod:`koapy.backend.kiwoom_open_api_w.core.KiwoomOpenApiWEventHandlerFunctions` +================================================================================== + +.. py:module:: koapy.backend.kiwoom_open_api_w.core.KiwoomOpenApiWEventHandlerFunctions + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backend.kiwoom_open_api_w.core.KiwoomOpenApiWEventHandlerFunctions.KiwoomOpenApiWEventHandlerFunctions + + + + +.. py:class:: KiwoomOpenApiWEventHandlerFunctions + + .. py:method:: OnEventConnect(self, errcode) + :abstractmethod: + + + .. py:method:: OnReceiveMsg(self, scrnno, rqname, trcode, msg) + :abstractmethod: + + + .. py:method:: OnReceiveTrData(self, scrnno, rqname, trcode, recordname, prevnext) + :abstractmethod: + + + .. py:method:: OnReceiveRealData(self, code, realtype, realdata) + :abstractmethod: + + + .. py:method:: OnReceiveChejanData(self, gubun, itemcnt, fidlist) + :abstractmethod: + + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_w/core/KiwoomOpenApiWLoggingEventHandler/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_w/core/KiwoomOpenApiWLoggingEventHandler/index.rst new file mode 100644 index 00000000..8683c1da --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_w/core/KiwoomOpenApiWLoggingEventHandler/index.rst @@ -0,0 +1,39 @@ +:py:mod:`koapy.backend.kiwoom_open_api_w.core.KiwoomOpenApiWLoggingEventHandler` +================================================================================ + +.. py:module:: koapy.backend.kiwoom_open_api_w.core.KiwoomOpenApiWLoggingEventHandler + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backend.kiwoom_open_api_w.core.KiwoomOpenApiWLoggingEventHandler.KiwoomOpenApiWLoggingEventHandler + + + + +.. py:class:: KiwoomOpenApiWLoggingEventHandler(control) + + Bases: :py:obj:`koapy.backend.kiwoom_open_api_w.core.KiwoomOpenApiWEventHandler.KiwoomOpenApiWEventHandler`, :py:obj:`koapy.utils.logging.Logging.Logging` + + .. py:method:: OnReceiveTrData(self, scrnno, rqname, trcode, recordname, prevnext) + + + .. py:method:: OnReceiveRealData(self, code, realtype, realdata) + + + .. py:method:: OnReceiveMsg(self, scrnno, rqname, trcode, msg) + + + .. py:method:: OnReceiveChejanData(self, gubun, itemcnt, fidlist) + + + .. py:method:: OnEventConnect(self, errcode) + + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_w/core/KiwoomOpenApiWQAxWidget/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_w/core/KiwoomOpenApiWQAxWidget/index.rst new file mode 100644 index 00000000..e227e1b0 --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_w/core/KiwoomOpenApiWQAxWidget/index.rst @@ -0,0 +1,45 @@ +:py:mod:`koapy.backend.kiwoom_open_api_w.core.KiwoomOpenApiWQAxWidget` +====================================================================== + +.. py:module:: koapy.backend.kiwoom_open_api_w.core.KiwoomOpenApiWQAxWidget + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backend.kiwoom_open_api_w.core.KiwoomOpenApiWQAxWidget.KiwoomOpenApiWQAxWidget + + + + +.. py:class:: KiwoomOpenApiWQAxWidget(*args, **kwargs) + + Bases: :py:obj:`koapy.utils.logging.pyside2.QWidgetLogging.QWidgetLogging`, :py:obj:`koapy.backend.kiwoom_open_api_w.core.KiwoomOpenApiWQAxWidgetMixin.KiwoomOpenApiWQAxWidgetMixin` + + .. py:attribute:: CLSID + :annotation: = {D1ACAB7D-A3AF-49E4-9004-C9E98344E17A} + + + + .. py:attribute:: METHOD_NAMES + + + + + .. py:attribute:: EVENT_NAMES + + + + + .. py:method:: changeEvent(self, event) + + + .. py:method:: closeEvent(self, event) + + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_w/core/KiwoomOpenApiWQAxWidgetMixin/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_w/core/KiwoomOpenApiWQAxWidgetMixin/index.rst new file mode 100644 index 00000000..3b09e488 --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_w/core/KiwoomOpenApiWQAxWidgetMixin/index.rst @@ -0,0 +1,22 @@ +:py:mod:`koapy.backend.kiwoom_open_api_w.core.KiwoomOpenApiWQAxWidgetMixin` +=========================================================================== + +.. py:module:: koapy.backend.kiwoom_open_api_w.core.KiwoomOpenApiWQAxWidgetMixin + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backend.kiwoom_open_api_w.core.KiwoomOpenApiWQAxWidgetMixin.KiwoomOpenApiWQAxWidgetMixin + + + + +.. py:class:: KiwoomOpenApiWQAxWidgetMixin + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_w/core/KiwoomOpenApiWSignalConnector/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_w/core/KiwoomOpenApiWSignalConnector/index.rst new file mode 100644 index 00000000..5a8bb699 --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_w/core/KiwoomOpenApiWSignalConnector/index.rst @@ -0,0 +1,39 @@ +:py:mod:`koapy.backend.kiwoom_open_api_w.core.KiwoomOpenApiWSignalConnector` +============================================================================ + +.. py:module:: koapy.backend.kiwoom_open_api_w.core.KiwoomOpenApiWSignalConnector + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backend.kiwoom_open_api_w.core.KiwoomOpenApiWSignalConnector.KiwoomOpenApiWSignalConnector + + + + +.. py:class:: KiwoomOpenApiWSignalConnector(name=None) + + Bases: :py:obj:`koapy.utils.logging.Logging.Logging` + + .. py:method:: is_valid_slot(self, slot) + + + .. py:method:: connect_to(self, control) + + + .. py:method:: connect(self, slot) + + + .. py:method:: disconnect(self, slot=None) + + + .. py:method:: call(self, *args, **kwargs) + + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_w/core/KiwoomOpenApiWSignature/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_w/core/KiwoomOpenApiWSignature/index.rst new file mode 100644 index 00000000..dabd1a2f --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_w/core/KiwoomOpenApiWSignature/index.rst @@ -0,0 +1,203 @@ +:py:mod:`koapy.backend.kiwoom_open_api_w.core.KiwoomOpenApiWSignature` +====================================================================== + +.. py:module:: koapy.backend.kiwoom_open_api_w.core.KiwoomOpenApiWSignature + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backend.kiwoom_open_api_w.core.KiwoomOpenApiWSignature.KiwoomOpenApiWSignature + koapy.backend.kiwoom_open_api_w.core.KiwoomOpenApiWSignature.KiwoomOpenApiWDispatchSignature + koapy.backend.kiwoom_open_api_w.core.KiwoomOpenApiWSignature.KiwoomOpenApiWEventHandlerSignature + + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + koapy.backend.kiwoom_open_api_w.core.KiwoomOpenApiWSignature.BuildOleItems + koapy.backend.kiwoom_open_api_w.core.KiwoomOpenApiWSignature.LoadDispatchSignatures + koapy.backend.kiwoom_open_api_w.core.KiwoomOpenApiWSignature.LoadEventHandlerSignatures + + + +Attributes +~~~~~~~~~~ + +.. autoapisummary:: + + koapy.backend.kiwoom_open_api_w.core.KiwoomOpenApiWSignature.DISPATCH_SIGNATURES_BY_NAME + koapy.backend.kiwoom_open_api_w.core.KiwoomOpenApiWSignature.EVENT_HANDLER_SIGNATURES_BY_NAME + + +.. py:function:: BuildOleItems(clsid) + + +.. py:class:: KiwoomOpenApiWSignature(name, parameters=None, return_annotation=Signature.empty, entry=None) + + Bases: :py:obj:`inspect.Signature` + + A Signature object represents the overall signature of a function. + It stores a Parameter object for each parameter accepted by the + function, as well as information specific to the function itself. + + A Signature object has the following public attributes and methods: + + * parameters : OrderedDict + An ordered mapping of parameters' names to the corresponding + Parameter objects (keyword-only arguments are in the same order + as listed in `code.co_varnames`). + * return_annotation : object + The annotation for the return type of the function if specified. + If the function has no annotation for its return type, this + attribute is set to `Signature.empty`. + * bind(*args, **kwargs) -> BoundArguments + Creates a mapping from positional and keyword arguments to + parameters. + * bind_partial(*args, **kwargs) -> BoundArguments + Creates a partial mapping from positional and keyword arguments + to parameters (simulating 'functools.partial' behavior.) + + .. py:attribute:: MODULE_CLSID + :annotation: = {1F8A15ED-A979-488F-9694-1EDA98188FFC} + + + + .. py:attribute:: OLE_ITEMS + + + + + .. py:attribute:: DISPATCH_CLSID + :annotation: = {85B07632-4F84-4CEF-991D-C79DE781363D} + + + + .. py:attribute:: EVENT_CLSID + :annotation: = {952B31F8-06FD-4D5A-A021-5FF57F5030AE} + + + + .. py:attribute:: PYTHONTYPE_TO_QTTYPE + + + + + .. py:attribute:: COMTYPE_TO_PYTHONTYPE + + + + + .. py:method:: name(self) + :property: + + + .. py:method:: to_pyside2_function_prototype(self) + + + .. py:method:: to_pyside2_event_signal(self) + + + +.. py:class:: KiwoomOpenApiWDispatchSignature(name, parameters=None, return_annotation=Signature.empty, entry=None) + + Bases: :py:obj:`KiwoomOpenApiWSignature` + + A Signature object represents the overall signature of a function. + It stores a Parameter object for each parameter accepted by the + function, as well as information specific to the function itself. + + A Signature object has the following public attributes and methods: + + * parameters : OrderedDict + An ordered mapping of parameters' names to the corresponding + Parameter objects (keyword-only arguments are in the same order + as listed in `code.co_varnames`). + * return_annotation : object + The annotation for the return type of the function if specified. + If the function has no annotation for its return type, this + attribute is set to `Signature.empty`. + * bind(*args, **kwargs) -> BoundArguments + Creates a mapping from positional and keyword arguments to + parameters. + * bind_partial(*args, **kwargs) -> BoundArguments + Creates a partial mapping from positional and keyword arguments + to parameters (simulating 'functools.partial' behavior.) + + .. py:attribute:: DISPATCH_SIGNATURES_BY_NAME + + + + + .. py:method:: from_name(cls, name) + :classmethod: + + + .. py:method:: names(cls) + :classmethod: + + + +.. py:function:: LoadDispatchSignatures(oleItems, clsId) + + +.. py:data:: DISPATCH_SIGNATURES_BY_NAME + + + + +.. py:class:: KiwoomOpenApiWEventHandlerSignature(name, parameters=None, return_annotation=Signature.empty, entry=None) + + Bases: :py:obj:`KiwoomOpenApiWSignature` + + A Signature object represents the overall signature of a function. + It stores a Parameter object for each parameter accepted by the + function, as well as information specific to the function itself. + + A Signature object has the following public attributes and methods: + + * parameters : OrderedDict + An ordered mapping of parameters' names to the corresponding + Parameter objects (keyword-only arguments are in the same order + as listed in `code.co_varnames`). + * return_annotation : object + The annotation for the return type of the function if specified. + If the function has no annotation for its return type, this + attribute is set to `Signature.empty`. + * bind(*args, **kwargs) -> BoundArguments + Creates a mapping from positional and keyword arguments to + parameters. + * bind_partial(*args, **kwargs) -> BoundArguments + Creates a partial mapping from positional and keyword arguments + to parameters (simulating 'functools.partial' behavior.) + + .. py:attribute:: EVENT_HANDLER_SIGNATURES_BY_NAME + + + + + .. py:method:: from_name(cls, name) + :classmethod: + + + .. py:method:: names(cls) + :classmethod: + + + +.. py:function:: LoadEventHandlerSignatures(oleItems, clsId) + + +.. py:data:: EVENT_HANDLER_SIGNATURES_BY_NAME + + + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_w/core/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_w/core/index.rst new file mode 100644 index 00000000..6b2ef6b7 --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_w/core/index.rst @@ -0,0 +1,24 @@ +:py:mod:`koapy.backend.kiwoom_open_api_w.core` +============================================== + +.. py:module:: koapy.backend.kiwoom_open_api_w.core + + +Submodules +---------- +.. toctree:: + :titlesonly: + :maxdepth: 1 + + KiwoomOpenApiWDynamicCallable/index.rst + KiwoomOpenApiWEntrypoint/index.rst + KiwoomOpenApiWError/index.rst + KiwoomOpenApiWEventHandler/index.rst + KiwoomOpenApiWEventHandlerFunctions/index.rst + KiwoomOpenApiWLoggingEventHandler/index.rst + KiwoomOpenApiWQAxWidget/index.rst + KiwoomOpenApiWQAxWidgetMixin/index.rst + KiwoomOpenApiWSignalConnector/index.rst + KiwoomOpenApiWSignature/index.rst + + diff --git a/_sources/autoapi/koapy/backend/kiwoom_open_api_w/index.rst b/_sources/autoapi/koapy/backend/kiwoom_open_api_w/index.rst new file mode 100644 index 00000000..952f0a63 --- /dev/null +++ b/_sources/autoapi/koapy/backend/kiwoom_open_api_w/index.rst @@ -0,0 +1,15 @@ +:py:mod:`koapy.backend.kiwoom_open_api_w` +========================================= + +.. py:module:: koapy.backend.kiwoom_open_api_w + + +Subpackages +----------- +.. toctree:: + :titlesonly: + :maxdepth: 3 + + core/index.rst + + diff --git a/_sources/autoapi/koapy/backtrader/KiwoomOpenApiPlusBroker/index.rst b/_sources/autoapi/koapy/backtrader/KiwoomOpenApiPlusBroker/index.rst new file mode 100644 index 00000000..7d2dd970 --- /dev/null +++ b/_sources/autoapi/koapy/backtrader/KiwoomOpenApiPlusBroker/index.rst @@ -0,0 +1,94 @@ +:py:mod:`koapy.backtrader.KiwoomOpenApiPlusBroker` +================================================== + +.. py:module:: koapy.backtrader.KiwoomOpenApiPlusBroker + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backtrader.KiwoomOpenApiPlusBroker.KiwoomOpenApiPlusCommInfo + koapy.backtrader.KiwoomOpenApiPlusBroker.MetaKiwoomOpenApiPlusBroker + koapy.backtrader.KiwoomOpenApiPlusBroker.KiwoomOpenApiPlusBroker + + + + +.. py:class:: KiwoomOpenApiPlusCommInfo(*args, **kwargs) + + Bases: :py:obj:`backtrader.comminfo.CommInfoBase` + + .. py:attribute:: params + :annotation: = [['stocklike', True], None, ['percabs', False], ['commission', 0.015], ['tax', 0.25], ['mult', 1.0]] + + + + +.. py:class:: MetaKiwoomOpenApiPlusBroker(cls, name, bases, dct) + + Bases: :py:obj:`backtrader.BrokerBase.__class__` + + +.. py:class:: KiwoomOpenApiPlusBroker(*args, **kwargs) + + Bases: :py:obj:`with_metaclass`\ (\ :py:obj:`MetaKiwoomOpenApiPlusBroker`\ , :py:obj:`BrokerBase`\ ) + + .. py:attribute:: params + :annotation: = [['use_positions', True], None] + + + + .. py:method:: start(self) + + + .. py:method:: data_started(self, data) + + + .. py:method:: stop(self) + + + .. py:method:: getcash(self) + + + .. py:method:: getvalue(self, datas=None) + + + .. py:method:: getposition(self, data, clone=True) + + + .. py:method:: orderstatus(self, order) + + + .. py:method:: buy(self, owner, data, size, price=None, plimit=None, exectype=None, valid=None, tradeid=0, oco=None, trailamount=None, trailpercent=None, parent=None, transmit=True, **kwargs) + + + .. py:method:: sell(self, owner, data, size, price=None, plimit=None, exectype=None, valid=None, tradeid=0, oco=None, trailamount=None, trailpercent=None, parent=None, transmit=True, **kwargs) + + + .. py:method:: cancel(self, order) + + + .. py:method:: notify(self, order) + + + .. py:method:: get_notification(self) + + + .. py:method:: next(self) + + + .. py:method:: submit(self, order) + + + .. py:method:: add_order_history(self, orders, notify=False) + + + .. py:method:: set_fund_history(self, fund) + + + diff --git a/_sources/autoapi/koapy/backtrader/KiwoomOpenApiPlusData/index.rst b/_sources/autoapi/koapy/backtrader/KiwoomOpenApiPlusData/index.rst new file mode 100644 index 00000000..b572be25 --- /dev/null +++ b/_sources/autoapi/koapy/backtrader/KiwoomOpenApiPlusData/index.rst @@ -0,0 +1,65 @@ +:py:mod:`koapy.backtrader.KiwoomOpenApiPlusData` +================================================ + +.. py:module:: koapy.backtrader.KiwoomOpenApiPlusData + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backtrader.KiwoomOpenApiPlusData.MetaKiwoomOpenApiPlusData + koapy.backtrader.KiwoomOpenApiPlusData.KiwoomOpenApiPlusData + + + + +.. py:class:: MetaKiwoomOpenApiPlusData(cls, clsname, bases, dct) + + Bases: :py:obj:`type`\ (\ :py:obj:`Logging`\ ), :py:obj:`type`\ (\ :py:obj:`DataBase`\ ) + + +.. py:class:: KiwoomOpenApiPlusData(*args, **kwargs) + + Bases: :py:obj:`backtrader.feed.DataBase`, :py:obj:`koapy.utils.logging.Logging.Logging` + + .. py:attribute:: params + :annotation: = [['qcheck', 0.5], ['historical', False], ['backfill_start', True], ['backfill', True],... + + + + .. py:method:: isnaive(self, dt) + + + .. py:method:: asutc(self, dt, tz=None, naive=True) + + + .. py:method:: date2num(self, dt, tz=None) + + + .. py:method:: num2date(self, dt=None, tz=None, naive=False) + + + .. py:method:: fromtimestamp(self, timestamp, tz=None) + + + .. py:method:: islive(self) + + + .. py:method:: setenvironment(self, env) + + + .. py:method:: start(self) + + + .. py:method:: stop(self) + + + .. py:method:: haslivedata(self) + + + diff --git a/_sources/autoapi/koapy/backtrader/KiwoomOpenApiPlusEventStreamer/index.rst b/_sources/autoapi/koapy/backtrader/KiwoomOpenApiPlusEventStreamer/index.rst new file mode 100644 index 00000000..41aa0621 --- /dev/null +++ b/_sources/autoapi/koapy/backtrader/KiwoomOpenApiPlusEventStreamer/index.rst @@ -0,0 +1,133 @@ +:py:mod:`koapy.backtrader.KiwoomOpenApiPlusEventStreamer` +========================================================= + +.. py:module:: koapy.backtrader.KiwoomOpenApiPlusEventStreamer + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backtrader.KiwoomOpenApiPlusEventStreamer.KiwoomOpenApiPlusPriceEventChannel + koapy.backtrader.KiwoomOpenApiPlusEventStreamer.KiwoomOpenApiPlusOrderEventChannel + koapy.backtrader.KiwoomOpenApiPlusEventStreamer.MetaKiwoomOpenApiPlusEventStreamer + koapy.backtrader.KiwoomOpenApiPlusEventStreamer.KiwoomOpenApiPlusEventStreamer + + + + +.. py:class:: KiwoomOpenApiPlusPriceEventChannel(stub) + + Bases: :py:obj:`koapy.utils.logging.Logging.Logging` + + .. py:method:: close(self) + + + .. py:method:: initialize(self) + + + .. py:method:: register_code(self, code) + + + .. py:method:: is_for_code(self, response, code) + + + .. py:method:: filter_for_code(self, code) + + + .. py:method:: is_valid_price_event(self, response) + + + .. py:method:: filter_price_event(self) + + + .. py:method:: time_to_timestamp(self, fid20) + + + .. py:method:: event_to_dict(self, response) + + + .. py:method:: convert_to_dict(self) + + + .. py:method:: get_observable_for_code(self, code) + + + +.. py:class:: KiwoomOpenApiPlusOrderEventChannel(stub) + + .. py:method:: close(self) + + + .. py:method:: is_chejan_response(self, response) + + + .. py:method:: filter_chejan_response(self) + + + .. py:method:: event_to_dict(self, response) + + + .. py:method:: convert_to_dict(self) + + + .. py:method:: get_observable(self) + + + +.. py:class:: MetaKiwoomOpenApiPlusEventStreamer(cls, clsname, bases, dct) + + Bases: :py:obj:`type`\ (\ :py:obj:`Logging`\ ), :py:obj:`type`\ (\ :py:obj:`Observer`\ ) + + Metaclass for defining Abstract Base Classes (ABCs). + + Use this metaclass to create an ABC. An ABC can be subclassed + directly, and then acts as a mix-in class. You can also register + unrelated concrete classes (even built-in classes) and unrelated + ABCs as 'virtual subclasses' -- these and their descendants will + be considered subclasses of the registering ABC by the built-in + issubclass() function, but the registering ABC won't show up in + their MRO (Method Resolution Order) nor will method + implementations defined by the registering ABC be callable (not + even via super()). + + +.. py:class:: KiwoomOpenApiPlusEventStreamer(stub, queue) + + Bases: :py:obj:`rx.core.typing.Observer`, :py:obj:`koapy.utils.logging.Logging.Logging` + + Observer abstract base class + + An Observer is the entity that receives all emissions of a subscribed + Observable. + + .. py:method:: on_next(self, value) + + Notifies the observer of a new element in the sequence. + + :param value: The received element. + + + .. py:method:: on_error(self, error) + + Notifies the observer that an exception has occurred. + + :param error: The error that has occurred. + + + .. py:method:: on_completed(self) + + Notifies the observer of the end of the sequence. + + + .. py:method:: rates(self, code) + + + .. py:method:: events(self) + + + diff --git a/_sources/autoapi/koapy/backtrader/KiwoomOpenApiPlusStore/index.rst b/_sources/autoapi/koapy/backtrader/KiwoomOpenApiPlusStore/index.rst new file mode 100644 index 00000000..024010b5 --- /dev/null +++ b/_sources/autoapi/koapy/backtrader/KiwoomOpenApiPlusStore/index.rst @@ -0,0 +1,180 @@ +:py:mod:`koapy.backtrader.KiwoomOpenApiPlusStore` +================================================= + +.. py:module:: koapy.backtrader.KiwoomOpenApiPlusStore + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backtrader.KiwoomOpenApiPlusStore.HistoricalPriceRecord + koapy.backtrader.KiwoomOpenApiPlusStore.API + koapy.backtrader.KiwoomOpenApiPlusStore.MetaSingleton + koapy.backtrader.KiwoomOpenApiPlusStore.MetaKiwoomOpenApiPlusStore + koapy.backtrader.KiwoomOpenApiPlusStore.KiwoomOpenApiPlusStore + + + + +.. py:exception:: KiwoomOpenApiPlusJsonError(code, message=None) + + Bases: :py:obj:`koapy.backend.kiwoom_open_api_plus.core.KiwoomOpenApiPlusError.KiwoomOpenApiPlusNegativeReturnCodeError` + + Common base class for all non-exit exceptions. + + .. py:method:: error_response(self, description=None) + + + +.. py:exception:: KiwoomOpenApiPlusTimeFrameError + + Bases: :py:obj:`KiwoomOpenApiPlusJsonError` + + Common base class for all non-exit exceptions. + + +.. py:class:: HistoricalPriceRecord + + Bases: :py:obj:`collections.namedtuple`\ (\ :py:obj:`'HistoricalPriceRecord'`\ , [\ :py:obj:`'time'`\ , :py:obj:`'open'`\ , :py:obj:`'high'`\ , :py:obj:`'low'`\ , :py:obj:`'close'`\ , :py:obj:`'volume'`\ ]\ ) + + Built-in immutable sequence. + + If no argument is given, the constructor returns an empty tuple. + If iterable is specified the tuple is initialized from iterable's items. + + If the argument is a tuple, the return value is the same object. + + .. py:method:: from_tuple(cls, tup) + :classmethod: + + + .. py:method:: records_from_dataframe(cls, df) + :classmethod: + + + .. py:method:: dict_records_from_dataframe(cls, df) + :classmethod: + + + +.. py:class:: API(context) + + .. py:method:: get_instruments_original(self, account, instruments) + + + .. py:method:: get_instruments(self, account, instruments) + + + .. py:method:: get_history(self, trcode, inputs, dtbegin=None, dtend=None) + + + .. py:method:: get_positions(self, account) + + + .. py:method:: get_account(self, account) + + + .. py:method:: create_order(self, account, **kwargs) + + + .. py:method:: close_order(self, account, oid, size, dataname) + + + .. py:method:: get_today_quotes_by_code(self, codes=None) + + + +.. py:class:: MetaSingleton(cls, clsname, bases, dct) + + Bases: :py:obj:`backtrader.metabase.MetaParams` + + +.. py:class:: MetaKiwoomOpenApiPlusStore(cls, clsname, bases, dct) + + Bases: :py:obj:`type`\ (\ :py:obj:`Logging`\ ), :py:obj:`MetaSingleton` + + +.. py:class:: KiwoomOpenApiPlusStore(context=None) + + Bases: :py:obj:`koapy.utils.logging.Logging.Logging` + + .. py:attribute:: BrokerCls + + + + + .. py:attribute:: DataCls + + + + + .. py:attribute:: params + :annotation: = [['account', ''], ['account_tmout', 60.0]] + + + + .. py:method:: getdata(cls, *args, **kwargs) + :classmethod: + + + .. py:method:: getbroker(cls, *args, **kwargs) + :classmethod: + + + .. py:method:: start(self, data=None, broker=None) + + + .. py:method:: initial_today_historical_msg(self, data=None) + + + .. py:method:: stop(self) + + + .. py:method:: put_notification(self, msg, *args, **kwargs) + + + .. py:method:: get_notifications(self) + + + .. py:method:: timeoffset(self) + + + .. py:method:: get_granularity(self, timeframe, compression, default=None) + + + .. py:method:: get_instrument(self, dataname) + + + .. py:method:: streaming_events(self, tmout=None) + + + .. py:method:: candles(self, dataname, dtbegin, dtend, timeframe, compression) + + + .. py:method:: streaming_prices(self, dataname, tmout=None) + + + .. py:method:: get_cash(self) + + + .. py:method:: get_value(self) + + + .. py:method:: get_positions(self) + + + .. py:method:: broker_threads(self) + + + .. py:method:: order_create(self, order, stopside=None, takeside=None, **kwargs) + + + .. py:method:: order_cancel(self, order) + + + diff --git a/_sources/autoapi/koapy/backtrader/KrxHistoricalDailyPriceData/index.rst b/_sources/autoapi/koapy/backtrader/KrxHistoricalDailyPriceData/index.rst new file mode 100644 index 00000000..df3352cd --- /dev/null +++ b/_sources/autoapi/koapy/backtrader/KrxHistoricalDailyPriceData/index.rst @@ -0,0 +1,44 @@ +:py:mod:`koapy.backtrader.KrxHistoricalDailyPriceData` +====================================================== + +.. py:module:: koapy.backtrader.KrxHistoricalDailyPriceData + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backtrader.KrxHistoricalDailyPriceData.KrxHistoricalDailyPriceData + + + + +.. py:class:: KrxHistoricalDailyPriceData + + Bases: :py:obj:`backtrader.feed.DataBase` + + .. py:attribute:: params + :annotation: = [['loader', None], ['symbol', None], ['name', None], ['fromdate', None], ['todate', None],... + + + + .. py:attribute:: lines + :annotation: = ['amount', 'marketcap', 'shares'] + + + + .. py:method:: start(self) + + + .. py:method:: stop(self) + + + .. py:method:: adddata_fromfile(cls, cerebro, filename, symbols=None, fromdate=None, todate=None, progress_bar=True) + :classmethod: + + + diff --git a/_sources/autoapi/koapy/backtrader/KrxHistoricalDailyPriceDataFromSQLite/index.rst b/_sources/autoapi/koapy/backtrader/KrxHistoricalDailyPriceDataFromSQLite/index.rst new file mode 100644 index 00000000..7deeb8e7 --- /dev/null +++ b/_sources/autoapi/koapy/backtrader/KrxHistoricalDailyPriceDataFromSQLite/index.rst @@ -0,0 +1,42 @@ +:py:mod:`koapy.backtrader.KrxHistoricalDailyPriceDataFromSQLite` +================================================================ + +.. py:module:: koapy.backtrader.KrxHistoricalDailyPriceDataFromSQLite + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backtrader.KrxHistoricalDailyPriceDataFromSQLite.KrxHistoricalDailyPriceDataFromSQLite + + + + +.. py:class:: KrxHistoricalDailyPriceDataFromSQLite + + Bases: :py:obj:`koapy.backtrader.SQLiteData.SQLiteData` + + .. py:attribute:: params + :annotation: = [['engine', None], ['symbol', None], ['name', None], ['fromdate', None], ['todate', None],... + + + + .. py:attribute:: lines + :annotation: = ['amount', 'marketcap', 'shares'] + + + + .. py:method:: dump_from_store(cls, source_filename, dest_filename, symbols=None, fromdate=None, todate=None, progress_bar=True) + :classmethod: + + + .. py:method:: adddata_fromfile(cls, cerebro, filename, symbols=None, fromdate=None, todate=None, progress_bar=True) + :classmethod: + + + diff --git a/_sources/autoapi/koapy/backtrader/KrxTradingCalendar/index.rst b/_sources/autoapi/koapy/backtrader/KrxTradingCalendar/index.rst new file mode 100644 index 00000000..fce10840 --- /dev/null +++ b/_sources/autoapi/koapy/backtrader/KrxTradingCalendar/index.rst @@ -0,0 +1,47 @@ +:py:mod:`koapy.backtrader.KrxTradingCalendar` +============================================= + +.. py:module:: koapy.backtrader.KrxTradingCalendar + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backtrader.KrxTradingCalendar.ExchangeCalendarsTradingCalendar + koapy.backtrader.KrxTradingCalendar.KrxTradingCalendar + + + + +.. py:class:: ExchangeCalendarsTradingCalendar + + Bases: :py:obj:`backtrader.tradingcal.TradingCalendarBase` + + .. py:attribute:: params + :annotation: = [['calendar', None], ['cachesize', 365]] + + + + .. py:method:: schedule(self, day, tz=None) + + day: expecting naive datetime.datetime day in utc timezone + tz: treat/localize internal naive datetimes to this timezone + returns: (opening, closing) naive datetime.datetime pair in utc timezone + + + +.. py:class:: KrxTradingCalendar + + Bases: :py:obj:`ExchangeCalendarsTradingCalendar` + + .. py:attribute:: params + :annotation: = [['calendar', 'XKRX'], ['cachesize', 365]] + + + + diff --git a/_sources/autoapi/koapy/backtrader/SQLAlchemyData/index.rst b/_sources/autoapi/koapy/backtrader/SQLAlchemyData/index.rst new file mode 100644 index 00000000..cef5df22 --- /dev/null +++ b/_sources/autoapi/koapy/backtrader/SQLAlchemyData/index.rst @@ -0,0 +1,35 @@ +:py:mod:`koapy.backtrader.SQLAlchemyData` +========================================= + +.. py:module:: koapy.backtrader.SQLAlchemyData + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backtrader.SQLAlchemyData.SQLAlchemyData + + + + +.. py:class:: SQLAlchemyData + + Bases: :py:obj:`backtrader.feed.DataBase` + + .. py:attribute:: params + :annotation: = [['url', None], ['engine', None], ['connection', None], ['tablename', None], ['timestampcolumn',... + + + + .. py:method:: start(self) + + + .. py:method:: stop(self) + + + diff --git a/_sources/autoapi/koapy/backtrader/SQLAlchemySQLiteData/index.rst b/_sources/autoapi/koapy/backtrader/SQLAlchemySQLiteData/index.rst new file mode 100644 index 00000000..22f0cc11 --- /dev/null +++ b/_sources/autoapi/koapy/backtrader/SQLAlchemySQLiteData/index.rst @@ -0,0 +1,29 @@ +:py:mod:`koapy.backtrader.SQLAlchemySQLiteData` +=============================================== + +.. py:module:: koapy.backtrader.SQLAlchemySQLiteData + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backtrader.SQLAlchemySQLiteData.SQLAlchemySQLiteData + + + + +.. py:class:: SQLAlchemySQLiteData + + Bases: :py:obj:`koapy.backtrader.SQLAlchemyData.SQLAlchemyData` + + .. py:attribute:: params + :annotation: = [['filename', None]] + + + + diff --git a/_sources/autoapi/koapy/backtrader/SQLiteData/index.rst b/_sources/autoapi/koapy/backtrader/SQLiteData/index.rst new file mode 100644 index 00000000..00eca093 --- /dev/null +++ b/_sources/autoapi/koapy/backtrader/SQLiteData/index.rst @@ -0,0 +1,35 @@ +:py:mod:`koapy.backtrader.SQLiteData` +===================================== + +.. py:module:: koapy.backtrader.SQLiteData + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.backtrader.SQLiteData.SQLiteData + + + + +.. py:class:: SQLiteData + + Bases: :py:obj:`backtrader.feed.DataBase` + + .. py:attribute:: params + :annotation: = [['filename', None], ['connection', None], ['engine', None], ['tablename', None],... + + + + .. py:method:: start(self) + + + .. py:method:: stop(self) + + + diff --git a/_sources/autoapi/koapy/backtrader/index.rst b/_sources/autoapi/koapy/backtrader/index.rst new file mode 100644 index 00000000..78b1b3af --- /dev/null +++ b/_sources/autoapi/koapy/backtrader/index.rst @@ -0,0 +1,24 @@ +:py:mod:`koapy.backtrader` +========================== + +.. py:module:: koapy.backtrader + + +Submodules +---------- +.. toctree:: + :titlesonly: + :maxdepth: 1 + + KiwoomOpenApiPlusBroker/index.rst + KiwoomOpenApiPlusData/index.rst + KiwoomOpenApiPlusEventStreamer/index.rst + KiwoomOpenApiPlusStore/index.rst + KrxHistoricalDailyPriceData/index.rst + KrxHistoricalDailyPriceDataFromSQLite/index.rst + KrxTradingCalendar/index.rst + SQLAlchemyData/index.rst + SQLAlchemySQLiteData/index.rst + SQLiteData/index.rst + + diff --git a/_sources/autoapi/koapy/cli/__main__/index.rst b/_sources/autoapi/koapy/cli/__main__/index.rst new file mode 100644 index 00000000..9f1a8909 --- /dev/null +++ b/_sources/autoapi/koapy/cli/__main__/index.rst @@ -0,0 +1,8 @@ +:orphan: + +:py:mod:`koapy.cli.__main__` +============================ + +.. py:module:: koapy.cli.__main__ + + diff --git a/_sources/autoapi/koapy/cli/commands/disable/auto_login/index.rst b/_sources/autoapi/koapy/cli/commands/disable/auto_login/index.rst new file mode 100644 index 00000000..9e3864a1 --- /dev/null +++ b/_sources/autoapi/koapy/cli/commands/disable/auto_login/index.rst @@ -0,0 +1,30 @@ +:py:mod:`koapy.cli.commands.disable.auto_login` +=============================================== + +.. py:module:: koapy.cli.commands.disable.auto_login + + +Module Contents +--------------- + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + koapy.cli.commands.disable.auto_login.disable_auto_login_after_login + koapy.cli.commands.disable.auto_login.disable_auto_login_without_login + koapy.cli.commands.disable.auto_login.auto_login + + + +.. py:function:: disable_auto_login_after_login(port) + + +.. py:function:: disable_auto_login_without_login() + + +.. py:function:: auto_login(port) + + diff --git a/_sources/autoapi/koapy/cli/commands/disable/index.rst b/_sources/autoapi/koapy/cli/commands/disable/index.rst new file mode 100644 index 00000000..d0482b91 --- /dev/null +++ b/_sources/autoapi/koapy/cli/commands/disable/index.rst @@ -0,0 +1,35 @@ +:py:mod:`koapy.cli.commands.disable` +==================================== + +.. py:module:: koapy.cli.commands.disable + + +Submodules +---------- +.. toctree:: + :titlesonly: + :maxdepth: 1 + + auto_login/index.rst + + +Package Contents +---------------- + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + koapy.cli.commands.disable.auto_login + koapy.cli.commands.disable.disable + + + +.. py:function:: auto_login(port) + + +.. py:function:: disable() + + diff --git a/_sources/autoapi/koapy/cli/commands/enable/auto_login/index.rst b/_sources/autoapi/koapy/cli/commands/enable/auto_login/index.rst new file mode 100644 index 00000000..eb198141 --- /dev/null +++ b/_sources/autoapi/koapy/cli/commands/enable/auto_login/index.rst @@ -0,0 +1,22 @@ +:py:mod:`koapy.cli.commands.enable.auto_login` +============================================== + +.. py:module:: koapy.cli.commands.enable.auto_login + + +Module Contents +--------------- + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + koapy.cli.commands.enable.auto_login.auto_login + + + +.. py:function:: auto_login(port) + + diff --git a/_sources/autoapi/koapy/cli/commands/enable/index.rst b/_sources/autoapi/koapy/cli/commands/enable/index.rst new file mode 100644 index 00000000..72b685fa --- /dev/null +++ b/_sources/autoapi/koapy/cli/commands/enable/index.rst @@ -0,0 +1,35 @@ +:py:mod:`koapy.cli.commands.enable` +=================================== + +.. py:module:: koapy.cli.commands.enable + + +Submodules +---------- +.. toctree:: + :titlesonly: + :maxdepth: 1 + + auto_login/index.rst + + +Package Contents +---------------- + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + koapy.cli.commands.enable.auto_login + koapy.cli.commands.enable.enable + + + +.. py:function:: auto_login(port) + + +.. py:function:: enable() + + diff --git a/_sources/autoapi/koapy/cli/commands/generate/grpc/index.rst b/_sources/autoapi/koapy/cli/commands/generate/grpc/index.rst new file mode 100644 index 00000000..d854fbe4 --- /dev/null +++ b/_sources/autoapi/koapy/cli/commands/generate/grpc/index.rst @@ -0,0 +1,35 @@ +:py:mod:`koapy.cli.commands.generate.grpc` +========================================== + +.. py:module:: koapy.cli.commands.generate.grpc + + +Submodules +---------- +.. toctree:: + :titlesonly: + :maxdepth: 1 + + ssl_credentials/index.rst + + +Package Contents +---------------- + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + koapy.cli.commands.generate.grpc.ssl_credentials + koapy.cli.commands.generate.grpc.grpc + + + +.. py:function:: ssl_credentials() + + +.. py:function:: grpc() + + diff --git a/_sources/autoapi/koapy/cli/commands/generate/grpc/ssl_credentials/index.rst b/_sources/autoapi/koapy/cli/commands/generate/grpc/ssl_credentials/index.rst new file mode 100644 index 00000000..00e578a3 --- /dev/null +++ b/_sources/autoapi/koapy/cli/commands/generate/grpc/ssl_credentials/index.rst @@ -0,0 +1,30 @@ +:py:mod:`koapy.cli.commands.generate.grpc.ssl_credentials` +========================================================== + +.. py:module:: koapy.cli.commands.generate.grpc.ssl_credentials + + +Module Contents +--------------- + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + koapy.cli.commands.generate.grpc.ssl_credentials.generate_self_signed_key_cert + koapy.cli.commands.generate.grpc.ssl_credentials.generate_key_cert_signed_by_authority + koapy.cli.commands.generate.grpc.ssl_credentials.ssl_credentials + + + +.. py:function:: generate_self_signed_key_cert(organization_name, common_name, key_filename=None, cert_filename=None, key_password=None, country_name=None, state_or_province_name=None, locality_name=None, valid_days=None) + + +.. py:function:: generate_key_cert_signed_by_authority(organization_name, common_name, alternative_dns_names=None, key_filename=None, csr_filename=None, cert_filename=None, key_password=None, country_name=None, state_or_province_name=None, locality_name=None, valid_days=None, authority_key_filename=None, authority_cert_filename=None, authority_key_password=None) + + +.. py:function:: ssl_credentials() + + diff --git a/_sources/autoapi/koapy/cli/commands/generate/index.rst b/_sources/autoapi/koapy/cli/commands/generate/index.rst new file mode 100644 index 00000000..9a4b9539 --- /dev/null +++ b/_sources/autoapi/koapy/cli/commands/generate/index.rst @@ -0,0 +1,40 @@ +:py:mod:`koapy.cli.commands.generate` +===================================== + +.. py:module:: koapy.cli.commands.generate + + +Subpackages +----------- +.. toctree:: + :titlesonly: + :maxdepth: 3 + + grpc/index.rst + openapi/index.rst + + +Package Contents +---------------- + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + koapy.cli.commands.generate.grpc + koapy.cli.commands.generate.openapi + koapy.cli.commands.generate.generate + + + +.. py:function:: grpc() + + +.. py:function:: openapi() + + +.. py:function:: generate() + + diff --git a/_sources/autoapi/koapy/cli/commands/generate/openapi/index.rst b/_sources/autoapi/koapy/cli/commands/generate/openapi/index.rst new file mode 100644 index 00000000..bdb19d4e --- /dev/null +++ b/_sources/autoapi/koapy/cli/commands/generate/openapi/index.rst @@ -0,0 +1,35 @@ +:py:mod:`koapy.cli.commands.generate.openapi` +============================================= + +.. py:module:: koapy.cli.commands.generate.openapi + + +Submodules +---------- +.. toctree:: + :titlesonly: + :maxdepth: 1 + + python_stubs/index.rst + + +Package Contents +---------------- + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + koapy.cli.commands.generate.openapi.python_stubs + koapy.cli.commands.generate.openapi.openapi + + + +.. py:function:: python_stubs(dispatch_class_name, dispatch_file_path, event_class_name, event_file_path, encoding, force_overwrite) + + +.. py:function:: openapi() + + diff --git a/_sources/autoapi/koapy/cli/commands/generate/openapi/python_stubs/index.rst b/_sources/autoapi/koapy/cli/commands/generate/openapi/python_stubs/index.rst new file mode 100644 index 00000000..96a85a45 --- /dev/null +++ b/_sources/autoapi/koapy/cli/commands/generate/openapi/python_stubs/index.rst @@ -0,0 +1,53 @@ +:py:mod:`koapy.cli.commands.generate.openapi.python_stubs` +========================================================== + +.. py:module:: koapy.cli.commands.generate.openapi.python_stubs + + +Module Contents +--------------- + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + koapy.cli.commands.generate.openapi.python_stubs.python_stubs + + + +Attributes +~~~~~~~~~~ + +.. autoapisummary:: + + koapy.cli.commands.generate.openapi.python_stubs.default_dispatch_class_name + koapy.cli.commands.generate.openapi.python_stubs.default_dispatch_file_path + koapy.cli.commands.generate.openapi.python_stubs.default_event_class_name + koapy.cli.commands.generate.openapi.python_stubs.default_event_file_path + + +.. py:data:: default_dispatch_class_name + :annotation: = KiwoomOpenApiPlusDispatchFunctionsGenerated + + + +.. py:data:: default_dispatch_file_path + + + + +.. py:data:: default_event_class_name + :annotation: = KiwoomOpenApiPlusEventFunctionsGenerated + + + +.. py:data:: default_event_file_path + + + + +.. py:function:: python_stubs(dispatch_class_name, dispatch_file_path, event_class_name, event_file_path, encoding, force_overwrite) + + diff --git a/_sources/autoapi/koapy/cli/commands/get/account_data/deposit/index.rst b/_sources/autoapi/koapy/cli/commands/get/account_data/deposit/index.rst new file mode 100644 index 00000000..f66c7640 --- /dev/null +++ b/_sources/autoapi/koapy/cli/commands/get/account_data/deposit/index.rst @@ -0,0 +1,35 @@ +:py:mod:`koapy.cli.commands.get.account_data.deposit` +===================================================== + +.. py:module:: koapy.cli.commands.get.account_data.deposit + + +Module Contents +--------------- + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + koapy.cli.commands.get.account_data.deposit.deposit + + + +Attributes +~~~~~~~~~~ + +.. autoapisummary:: + + koapy.cli.commands.get.account_data.deposit.logger + + +.. py:data:: logger + + + + +.. py:function:: deposit(account, port) + + diff --git a/_sources/autoapi/koapy/cli/commands/get/account_data/evaluation/index.rst b/_sources/autoapi/koapy/cli/commands/get/account_data/evaluation/index.rst new file mode 100644 index 00000000..3cc66029 --- /dev/null +++ b/_sources/autoapi/koapy/cli/commands/get/account_data/evaluation/index.rst @@ -0,0 +1,35 @@ +:py:mod:`koapy.cli.commands.get.account_data.evaluation` +======================================================== + +.. py:module:: koapy.cli.commands.get.account_data.evaluation + + +Module Contents +--------------- + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + koapy.cli.commands.get.account_data.evaluation.evaluation + + + +Attributes +~~~~~~~~~~ + +.. autoapisummary:: + + koapy.cli.commands.get.account_data.evaluation.logger + + +.. py:data:: logger + + + + +.. py:function:: evaluation(account, include_delisted, exclude_delisted, for_each, as_summary, port) + + diff --git a/_sources/autoapi/koapy/cli/commands/get/account_data/index.rst b/_sources/autoapi/koapy/cli/commands/get/account_data/index.rst new file mode 100644 index 00000000..0ac724f7 --- /dev/null +++ b/_sources/autoapi/koapy/cli/commands/get/account_data/index.rst @@ -0,0 +1,18 @@ +:py:mod:`koapy.cli.commands.get.account_data` +============================================= + +.. py:module:: koapy.cli.commands.get.account_data + + +Submodules +---------- +.. toctree:: + :titlesonly: + :maxdepth: 1 + + deposit/index.rst + evaluation/index.rst + orders/index.rst + userinfo/index.rst + + diff --git a/_sources/autoapi/koapy/cli/commands/get/account_data/orders/index.rst b/_sources/autoapi/koapy/cli/commands/get/account_data/orders/index.rst new file mode 100644 index 00000000..a034a9d7 --- /dev/null +++ b/_sources/autoapi/koapy/cli/commands/get/account_data/orders/index.rst @@ -0,0 +1,35 @@ +:py:mod:`koapy.cli.commands.get.account_data.orders` +==================================================== + +.. py:module:: koapy.cli.commands.get.account_data.orders + + +Module Contents +--------------- + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + koapy.cli.commands.get.account_data.orders.orders + + + +Attributes +~~~~~~~~~~ + +.. autoapisummary:: + + koapy.cli.commands.get.account_data.orders.logger + + +.. py:data:: logger + + + + +.. py:function:: orders(account, date, reverse, executed_only, not_executed_only, stock_only, bond_only, sell_only, buy_only, code, starting_order_no, port) + + diff --git a/_sources/autoapi/koapy/cli/commands/get/account_data/userinfo/index.rst b/_sources/autoapi/koapy/cli/commands/get/account_data/userinfo/index.rst new file mode 100644 index 00000000..e0aa64ab --- /dev/null +++ b/_sources/autoapi/koapy/cli/commands/get/account_data/userinfo/index.rst @@ -0,0 +1,22 @@ +:py:mod:`koapy.cli.commands.get.account_data.userinfo` +====================================================== + +.. py:module:: koapy.cli.commands.get.account_data.userinfo + + +Module Contents +--------------- + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + koapy.cli.commands.get.account_data.userinfo.userinfo + + + +.. py:function:: userinfo(port) + + diff --git a/_sources/autoapi/koapy/cli/commands/get/chart_data/daily/index.rst b/_sources/autoapi/koapy/cli/commands/get/chart_data/daily/index.rst new file mode 100644 index 00000000..64104b79 --- /dev/null +++ b/_sources/autoapi/koapy/cli/commands/get/chart_data/daily/index.rst @@ -0,0 +1,35 @@ +:py:mod:`koapy.cli.commands.get.chart_data.daily` +================================================= + +.. py:module:: koapy.cli.commands.get.chart_data.daily + + +Module Contents +--------------- + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + koapy.cli.commands.get.chart_data.daily.daily + + + +Attributes +~~~~~~~~~~ + +.. autoapisummary:: + + koapy.cli.commands.get.chart_data.daily.logger + + +.. py:data:: logger + + + + +.. py:function:: daily(code, output, format, start_date, end_date, port) + + diff --git a/_sources/autoapi/koapy/cli/commands/get/chart_data/index.rst b/_sources/autoapi/koapy/cli/commands/get/chart_data/index.rst new file mode 100644 index 00000000..df189e8d --- /dev/null +++ b/_sources/autoapi/koapy/cli/commands/get/chart_data/index.rst @@ -0,0 +1,16 @@ +:py:mod:`koapy.cli.commands.get.chart_data` +=========================================== + +.. py:module:: koapy.cli.commands.get.chart_data + + +Submodules +---------- +.. toctree:: + :titlesonly: + :maxdepth: 1 + + daily/index.rst + minute/index.rst + + diff --git a/_sources/autoapi/koapy/cli/commands/get/chart_data/minute/index.rst b/_sources/autoapi/koapy/cli/commands/get/chart_data/minute/index.rst new file mode 100644 index 00000000..fa032595 --- /dev/null +++ b/_sources/autoapi/koapy/cli/commands/get/chart_data/minute/index.rst @@ -0,0 +1,41 @@ +:py:mod:`koapy.cli.commands.get.chart_data.minute` +================================================== + +.. py:module:: koapy.cli.commands.get.chart_data.minute + + +Module Contents +--------------- + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + koapy.cli.commands.get.chart_data.minute.minute + + + +Attributes +~~~~~~~~~~ + +.. autoapisummary:: + + koapy.cli.commands.get.chart_data.minute.logger + koapy.cli.commands.get.chart_data.minute.minute_intervals + + +.. py:data:: logger + + + + +.. py:data:: minute_intervals + :annotation: = ['1', '3', '5', '10', '15', '30', '45', '60'] + + + +.. py:function:: minute(code, interval, output, format, start_date, end_date, port) + + diff --git a/_sources/autoapi/koapy/cli/commands/get/index.rst b/_sources/autoapi/koapy/cli/commands/get/index.rst new file mode 100644 index 00000000..ffdbb7bc --- /dev/null +++ b/_sources/autoapi/koapy/cli/commands/get/index.rst @@ -0,0 +1,116 @@ +:py:mod:`koapy.cli.commands.get` +================================ + +.. py:module:: koapy.cli.commands.get + + +Subpackages +----------- +.. toctree:: + :titlesonly: + :maxdepth: 3 + + account_data/index.rst + chart_data/index.rst + openapi_meta/index.rst + stock_meta/index.rst + + +Package Contents +---------------- + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + koapy.cli.commands.get.deposit + koapy.cli.commands.get.evaluation + koapy.cli.commands.get.orders + koapy.cli.commands.get.userinfo + koapy.cli.commands.get.daily + koapy.cli.commands.get.minute + koapy.cli.commands.get.errmsg + koapy.cli.commands.get.modulepath + koapy.cli.commands.get.realinfo + koapy.cli.commands.get.trinfo + koapy.cli.commands.get.codelist + koapy.cli.commands.get.stockcode + koapy.cli.commands.get.stockinfo + koapy.cli.commands.get.stockname + koapy.cli.commands.get.get + + + +.. py:function:: deposit(account, port) + + +.. py:function:: evaluation(account, include_delisted, exclude_delisted, for_each, as_summary, port) + + +.. py:function:: orders(account, date, reverse, executed_only, not_executed_only, stock_only, bond_only, sell_only, buy_only, code, starting_order_no, port) + + +.. py:function:: userinfo(port) + + +.. py:function:: daily(code, output, format, start_date, end_date, port) + + +.. py:function:: minute(code, interval, output, format, start_date, end_date, port) + + +.. py:function:: errmsg(err_code) + + +.. py:function:: modulepath() + + +.. py:function:: realinfo(realtypes) + + +.. py:function:: trinfo(trcodes) + + +.. py:function:: codelist(markets, port) + + + Possible market codes are: + 0 : 장내 + 10 : 코스닥 + 3 : ELW + 8 : ETF + 50 : KONEX + 4 : 뮤추얼펀드 + 5 : 신주인수권 + 6 : 리츠 + 9 : 하이얼펀드 + 30 : K-OTC + + +.. py:function:: stockcode(names, markets, port) + + + Possible market codes are: + 0 : 장내 + 10 : 코스닥 + 3 : ELW + 8 : ETF + 50 : KONEX + 4 : 뮤추얼펀드 + 5 : 신주인수권 + 6 : 리츠 + 9 : 하이얼펀드 + 30 : K-OTC + + +.. py:function:: stockinfo(code, output, format, port) + + +.. py:function:: stockname(codes, port) + + +.. py:function:: get() + + diff --git a/_sources/autoapi/koapy/cli/commands/get/openapi_meta/errmsg/index.rst b/_sources/autoapi/koapy/cli/commands/get/openapi_meta/errmsg/index.rst new file mode 100644 index 00000000..0d223bee --- /dev/null +++ b/_sources/autoapi/koapy/cli/commands/get/openapi_meta/errmsg/index.rst @@ -0,0 +1,22 @@ +:py:mod:`koapy.cli.commands.get.openapi_meta.errmsg` +==================================================== + +.. py:module:: koapy.cli.commands.get.openapi_meta.errmsg + + +Module Contents +--------------- + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + koapy.cli.commands.get.openapi_meta.errmsg.errmsg + + + +.. py:function:: errmsg(err_code) + + diff --git a/_sources/autoapi/koapy/cli/commands/get/openapi_meta/index.rst b/_sources/autoapi/koapy/cli/commands/get/openapi_meta/index.rst new file mode 100644 index 00000000..935a5aa5 --- /dev/null +++ b/_sources/autoapi/koapy/cli/commands/get/openapi_meta/index.rst @@ -0,0 +1,18 @@ +:py:mod:`koapy.cli.commands.get.openapi_meta` +============================================= + +.. py:module:: koapy.cli.commands.get.openapi_meta + + +Submodules +---------- +.. toctree:: + :titlesonly: + :maxdepth: 1 + + errmsg/index.rst + modulepath/index.rst + realinfo/index.rst + trinfo/index.rst + + diff --git a/_sources/autoapi/koapy/cli/commands/get/openapi_meta/modulepath/index.rst b/_sources/autoapi/koapy/cli/commands/get/openapi_meta/modulepath/index.rst new file mode 100644 index 00000000..a73932ce --- /dev/null +++ b/_sources/autoapi/koapy/cli/commands/get/openapi_meta/modulepath/index.rst @@ -0,0 +1,22 @@ +:py:mod:`koapy.cli.commands.get.openapi_meta.modulepath` +======================================================== + +.. py:module:: koapy.cli.commands.get.openapi_meta.modulepath + + +Module Contents +--------------- + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + koapy.cli.commands.get.openapi_meta.modulepath.modulepath + + + +.. py:function:: modulepath() + + diff --git a/_sources/autoapi/koapy/cli/commands/get/openapi_meta/realinfo/index.rst b/_sources/autoapi/koapy/cli/commands/get/openapi_meta/realinfo/index.rst new file mode 100644 index 00000000..1fb8ef5f --- /dev/null +++ b/_sources/autoapi/koapy/cli/commands/get/openapi_meta/realinfo/index.rst @@ -0,0 +1,22 @@ +:py:mod:`koapy.cli.commands.get.openapi_meta.realinfo` +====================================================== + +.. py:module:: koapy.cli.commands.get.openapi_meta.realinfo + + +Module Contents +--------------- + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + koapy.cli.commands.get.openapi_meta.realinfo.realinfo + + + +.. py:function:: realinfo(realtypes) + + diff --git a/_sources/autoapi/koapy/cli/commands/get/openapi_meta/trinfo/index.rst b/_sources/autoapi/koapy/cli/commands/get/openapi_meta/trinfo/index.rst new file mode 100644 index 00000000..2a8b2a0b --- /dev/null +++ b/_sources/autoapi/koapy/cli/commands/get/openapi_meta/trinfo/index.rst @@ -0,0 +1,22 @@ +:py:mod:`koapy.cli.commands.get.openapi_meta.trinfo` +==================================================== + +.. py:module:: koapy.cli.commands.get.openapi_meta.trinfo + + +Module Contents +--------------- + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + koapy.cli.commands.get.openapi_meta.trinfo.trinfo + + + +.. py:function:: trinfo(trcodes) + + diff --git a/_sources/autoapi/koapy/cli/commands/get/stock_meta/codelist/index.rst b/_sources/autoapi/koapy/cli/commands/get/stock_meta/codelist/index.rst new file mode 100644 index 00000000..56b8f88d --- /dev/null +++ b/_sources/autoapi/koapy/cli/commands/get/stock_meta/codelist/index.rst @@ -0,0 +1,52 @@ +:py:mod:`koapy.cli.commands.get.stock_meta.codelist` +==================================================== + +.. py:module:: koapy.cli.commands.get.stock_meta.codelist + + +Module Contents +--------------- + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + koapy.cli.commands.get.stock_meta.codelist.codelist + koapy.cli.commands.get.stock_meta.codelist.main + + + +Attributes +~~~~~~~~~~ + +.. autoapisummary:: + + koapy.cli.commands.get.stock_meta.codelist.market_codes + + +.. py:data:: market_codes + :annotation: = ['0', '10', '3', '8', '50', '4', '5', '6', '9', '30', 'all'] + + + +.. py:function:: codelist(markets, port) + + + Possible market codes are: + 0 : 장내 + 10 : 코스닥 + 3 : ELW + 8 : ETF + 50 : KONEX + 4 : 뮤추얼펀드 + 5 : 신주인수권 + 6 : 리츠 + 9 : 하이얼펀드 + 30 : K-OTC + + +.. py:function:: main() + + diff --git a/_sources/autoapi/koapy/cli/commands/get/stock_meta/codelist_interactive/index.rst b/_sources/autoapi/koapy/cli/commands/get/stock_meta/codelist_interactive/index.rst new file mode 100644 index 00000000..6435f103 --- /dev/null +++ b/_sources/autoapi/koapy/cli/commands/get/stock_meta/codelist_interactive/index.rst @@ -0,0 +1,108 @@ +:py:mod:`koapy.cli.commands.get.stock_meta.codelist_interactive` +================================================================ + +.. py:module:: koapy.cli.commands.get.stock_meta.codelist_interactive + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.cli.commands.get.stock_meta.codelist_interactive.MarketEntry + koapy.cli.commands.get.stock_meta.codelist_interactive.StockEntry + koapy.cli.commands.get.stock_meta.codelist_interactive.StatusBarHandler + koapy.cli.commands.get.stock_meta.codelist_interactive.Screen + + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + koapy.cli.commands.get.stock_meta.codelist_interactive.screen_len + koapy.cli.commands.get.stock_meta.codelist_interactive.wrapper + koapy.cli.commands.get.stock_meta.codelist_interactive.codelist_interactive + koapy.cli.commands.get.stock_meta.codelist_interactive.main + + + +Attributes +~~~~~~~~~~ + +.. autoapisummary:: + + koapy.cli.commands.get.stock_meta.codelist_interactive.markets + + +.. py:class:: MarketEntry(code, name) + + .. py:method:: to_string(self) + + + +.. py:class:: StockEntry(code, name) + + .. py:method:: to_string(self) + + + +.. py:data:: markets + + + + +.. py:class:: StatusBarHandler(screen, level=logging.NOTSET) + + Bases: :py:obj:`logging.Handler` + + Handler instances dispatch logging events to specific destinations. + + The base handler class. Acts as a placeholder which defines the Handler + interface. Handlers can optionally use Formatter instances to format + records as desired. By default, no formatter is specified; in this case, + the 'raw' message as determined by record.message is logged. + + .. py:method:: emit(self, record) + + Do whatever it takes to actually log the specified logging record. + + This version is intended to be implemented by subclasses and so + raises a NotImplementedError. + + + +.. py:function:: screen_len(str) + + +.. py:class:: Screen(screen) + + .. py:method:: refresh_header_bar(self) + + + .. py:method:: set_header_bar(self, text) + + + .. py:method:: refresh_footer_bar(self) + + + .. py:method:: set_footer_bar(self, text) + + + .. py:method:: show_entries(self, entries) + + + +.. py:function:: wrapper(stdscr) + + +.. py:function:: codelist_interactive() + + +.. py:function:: main() + + diff --git a/_sources/autoapi/koapy/cli/commands/get/stock_meta/index.rst b/_sources/autoapi/koapy/cli/commands/get/stock_meta/index.rst new file mode 100644 index 00000000..af73770a --- /dev/null +++ b/_sources/autoapi/koapy/cli/commands/get/stock_meta/index.rst @@ -0,0 +1,19 @@ +:py:mod:`koapy.cli.commands.get.stock_meta` +=========================================== + +.. py:module:: koapy.cli.commands.get.stock_meta + + +Submodules +---------- +.. toctree:: + :titlesonly: + :maxdepth: 1 + + codelist/index.rst + codelist_interactive/index.rst + stockcode/index.rst + stockinfo/index.rst + stockname/index.rst + + diff --git a/_sources/autoapi/koapy/cli/commands/get/stock_meta/stockcode/index.rst b/_sources/autoapi/koapy/cli/commands/get/stock_meta/stockcode/index.rst new file mode 100644 index 00000000..181686d2 --- /dev/null +++ b/_sources/autoapi/koapy/cli/commands/get/stock_meta/stockcode/index.rst @@ -0,0 +1,48 @@ +:py:mod:`koapy.cli.commands.get.stock_meta.stockcode` +===================================================== + +.. py:module:: koapy.cli.commands.get.stock_meta.stockcode + + +Module Contents +--------------- + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + koapy.cli.commands.get.stock_meta.stockcode.stockcode + + + +Attributes +~~~~~~~~~~ + +.. autoapisummary:: + + koapy.cli.commands.get.stock_meta.stockcode.market_codes + + +.. py:data:: market_codes + :annotation: = ['0', '10', '3', '8', '50', '4', '5', '6', '9', '30', 'all'] + + + +.. py:function:: stockcode(names, markets, port) + + + Possible market codes are: + 0 : 장내 + 10 : 코스닥 + 3 : ELW + 8 : ETF + 50 : KONEX + 4 : 뮤추얼펀드 + 5 : 신주인수권 + 6 : 리츠 + 9 : 하이얼펀드 + 30 : K-OTC + + diff --git a/_sources/autoapi/koapy/cli/commands/get/stock_meta/stockinfo/index.rst b/_sources/autoapi/koapy/cli/commands/get/stock_meta/stockinfo/index.rst new file mode 100644 index 00000000..c41f9e7b --- /dev/null +++ b/_sources/autoapi/koapy/cli/commands/get/stock_meta/stockinfo/index.rst @@ -0,0 +1,22 @@ +:py:mod:`koapy.cli.commands.get.stock_meta.stockinfo` +===================================================== + +.. py:module:: koapy.cli.commands.get.stock_meta.stockinfo + + +Module Contents +--------------- + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + koapy.cli.commands.get.stock_meta.stockinfo.stockinfo + + + +.. py:function:: stockinfo(code, output, format, port) + + diff --git a/_sources/autoapi/koapy/cli/commands/get/stock_meta/stockname/index.rst b/_sources/autoapi/koapy/cli/commands/get/stock_meta/stockname/index.rst new file mode 100644 index 00000000..9e8a8e81 --- /dev/null +++ b/_sources/autoapi/koapy/cli/commands/get/stock_meta/stockname/index.rst @@ -0,0 +1,22 @@ +:py:mod:`koapy.cli.commands.get.stock_meta.stockname` +===================================================== + +.. py:module:: koapy.cli.commands.get.stock_meta.stockname + + +Module Contents +--------------- + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + koapy.cli.commands.get.stock_meta.stockname.stockname + + + +.. py:function:: stockname(codes, port) + + diff --git a/_sources/autoapi/koapy/cli/commands/index.rst b/_sources/autoapi/koapy/cli/commands/index.rst new file mode 100644 index 00000000..88dc1e16 --- /dev/null +++ b/_sources/autoapi/koapy/cli/commands/index.rst @@ -0,0 +1,23 @@ +:py:mod:`koapy.cli.commands` +============================ + +.. py:module:: koapy.cli.commands + + +Subpackages +----------- +.. toctree:: + :titlesonly: + :maxdepth: 3 + + disable/index.rst + enable/index.rst + generate/index.rst + get/index.rst + install/index.rst + serve/index.rst + show/index.rst + uninstall/index.rst + update/index.rst + + diff --git a/_sources/autoapi/koapy/cli/commands/install/index.rst b/_sources/autoapi/koapy/cli/commands/install/index.rst new file mode 100644 index 00000000..b349bdc0 --- /dev/null +++ b/_sources/autoapi/koapy/cli/commands/install/index.rst @@ -0,0 +1,40 @@ +:py:mod:`koapy.cli.commands.install` +==================================== + +.. py:module:: koapy.cli.commands.install + + +Submodules +---------- +.. toctree:: + :titlesonly: + :maxdepth: 1 + + openapi/index.rst + pywin32/index.rst + + +Package Contents +---------------- + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + koapy.cli.commands.install.openapi + koapy.cli.commands.install.pywin32 + koapy.cli.commands.install.install + + + +.. py:function:: openapi(target, cleanup) + + +.. py:function:: pywin32(version) + + +.. py:function:: install() + + diff --git a/_sources/autoapi/koapy/cli/commands/install/openapi/index.rst b/_sources/autoapi/koapy/cli/commands/install/openapi/index.rst new file mode 100644 index 00000000..4003eddc --- /dev/null +++ b/_sources/autoapi/koapy/cli/commands/install/openapi/index.rst @@ -0,0 +1,35 @@ +:py:mod:`koapy.cli.commands.install.openapi` +============================================ + +.. py:module:: koapy.cli.commands.install.openapi + + +Module Contents +--------------- + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + koapy.cli.commands.install.openapi.openapi + + + +Attributes +~~~~~~~~~~ + +.. autoapisummary:: + + koapy.cli.commands.install.openapi.logger + + +.. py:data:: logger + + + + +.. py:function:: openapi(target, cleanup) + + diff --git a/_sources/autoapi/koapy/cli/commands/install/pywin32/index.rst b/_sources/autoapi/koapy/cli/commands/install/pywin32/index.rst new file mode 100644 index 00000000..ac69a232 --- /dev/null +++ b/_sources/autoapi/koapy/cli/commands/install/pywin32/index.rst @@ -0,0 +1,22 @@ +:py:mod:`koapy.cli.commands.install.pywin32` +============================================ + +.. py:module:: koapy.cli.commands.install.pywin32 + + +Module Contents +--------------- + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + koapy.cli.commands.install.pywin32.pywin32 + + + +.. py:function:: pywin32(version) + + diff --git a/_sources/autoapi/koapy/cli/commands/serve/index.rst b/_sources/autoapi/koapy/cli/commands/serve/index.rst new file mode 100644 index 00000000..2fe47ba9 --- /dev/null +++ b/_sources/autoapi/koapy/cli/commands/serve/index.rst @@ -0,0 +1,30 @@ +:py:mod:`koapy.cli.commands.serve` +================================== + +.. py:module:: koapy.cli.commands.serve + + +Package Contents +---------------- + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + koapy.cli.commands.serve.grpc_server_and_client_options + koapy.cli.commands.serve.full_verbose_option + koapy.cli.commands.serve.serve + + + +.. py:function:: grpc_server_and_client_options() + + +.. py:function:: full_verbose_option(*args, **kwargs) + + +.. py:function:: serve(ctx, verbose, **kwargs) + + diff --git a/_sources/autoapi/koapy/cli/commands/show/account_window/index.rst b/_sources/autoapi/koapy/cli/commands/show/account_window/index.rst new file mode 100644 index 00000000..161cba89 --- /dev/null +++ b/_sources/autoapi/koapy/cli/commands/show/account_window/index.rst @@ -0,0 +1,22 @@ +:py:mod:`koapy.cli.commands.show.account_window` +================================================ + +.. py:module:: koapy.cli.commands.show.account_window + + +Module Contents +--------------- + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + koapy.cli.commands.show.account_window.account_window + + + +.. py:function:: account_window(port) + + diff --git a/_sources/autoapi/koapy/cli/commands/show/index.rst b/_sources/autoapi/koapy/cli/commands/show/index.rst new file mode 100644 index 00000000..b541e8a9 --- /dev/null +++ b/_sources/autoapi/koapy/cli/commands/show/index.rst @@ -0,0 +1,35 @@ +:py:mod:`koapy.cli.commands.show` +================================= + +.. py:module:: koapy.cli.commands.show + + +Submodules +---------- +.. toctree:: + :titlesonly: + :maxdepth: 1 + + account_window/index.rst + + +Package Contents +---------------- + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + koapy.cli.commands.show.account_window + koapy.cli.commands.show.show + + + +.. py:function:: account_window(port) + + +.. py:function:: show() + + diff --git a/_sources/autoapi/koapy/cli/commands/uninstall/index.rst b/_sources/autoapi/koapy/cli/commands/uninstall/index.rst new file mode 100644 index 00000000..360de8a0 --- /dev/null +++ b/_sources/autoapi/koapy/cli/commands/uninstall/index.rst @@ -0,0 +1,40 @@ +:py:mod:`koapy.cli.commands.uninstall` +====================================== + +.. py:module:: koapy.cli.commands.uninstall + + +Submodules +---------- +.. toctree:: + :titlesonly: + :maxdepth: 1 + + openapi/index.rst + pywin32/index.rst + + +Package Contents +---------------- + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + koapy.cli.commands.uninstall.openapi + koapy.cli.commands.uninstall.pywin32 + koapy.cli.commands.uninstall.uninstall + + + +.. py:function:: openapi(reboot, cleanup) + + +.. py:function:: pywin32() + + +.. py:function:: uninstall() + + diff --git a/_sources/autoapi/koapy/cli/commands/uninstall/openapi/index.rst b/_sources/autoapi/koapy/cli/commands/uninstall/openapi/index.rst new file mode 100644 index 00000000..0d3cb4d7 --- /dev/null +++ b/_sources/autoapi/koapy/cli/commands/uninstall/openapi/index.rst @@ -0,0 +1,35 @@ +:py:mod:`koapy.cli.commands.uninstall.openapi` +============================================== + +.. py:module:: koapy.cli.commands.uninstall.openapi + + +Module Contents +--------------- + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + koapy.cli.commands.uninstall.openapi.openapi + + + +Attributes +~~~~~~~~~~ + +.. autoapisummary:: + + koapy.cli.commands.uninstall.openapi.logger + + +.. py:data:: logger + + + + +.. py:function:: openapi(reboot, cleanup) + + diff --git a/_sources/autoapi/koapy/cli/commands/uninstall/pywin32/index.rst b/_sources/autoapi/koapy/cli/commands/uninstall/pywin32/index.rst new file mode 100644 index 00000000..b283e34b --- /dev/null +++ b/_sources/autoapi/koapy/cli/commands/uninstall/pywin32/index.rst @@ -0,0 +1,22 @@ +:py:mod:`koapy.cli.commands.uninstall.pywin32` +============================================== + +.. py:module:: koapy.cli.commands.uninstall.pywin32 + + +Module Contents +--------------- + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + koapy.cli.commands.uninstall.pywin32.pywin32 + + + +.. py:function:: pywin32() + + diff --git a/_sources/autoapi/koapy/cli/commands/update/index.rst b/_sources/autoapi/koapy/cli/commands/update/index.rst new file mode 100644 index 00000000..0f0efa22 --- /dev/null +++ b/_sources/autoapi/koapy/cli/commands/update/index.rst @@ -0,0 +1,46 @@ +:py:mod:`koapy.cli.commands.update` +=================================== + +.. py:module:: koapy.cli.commands.update + + +Package Contents +---------------- + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + koapy.cli.commands.update.get_credentials + koapy.cli.commands.update.verbose_option + koapy.cli.commands.update.update + koapy.cli.commands.update.trinfo + koapy.cli.commands.update.realtype + koapy.cli.commands.update.openapi + koapy.cli.commands.update.proto + + + +.. py:function:: get_credentials(interactive=False) + + +.. py:function:: verbose_option(*args, **kwargs) + + +.. py:function:: update() + + +.. py:function:: trinfo() + + +.. py:function:: realtype() + + +.. py:function:: openapi(interactive) + + +.. py:function:: proto() + + diff --git a/_sources/autoapi/koapy/cli/extensions/functools/index.rst b/_sources/autoapi/koapy/cli/extensions/functools/index.rst new file mode 100644 index 00000000..19e80217 --- /dev/null +++ b/_sources/autoapi/koapy/cli/extensions/functools/index.rst @@ -0,0 +1,22 @@ +:py:mod:`koapy.cli.extensions.functools` +======================================== + +.. py:module:: koapy.cli.extensions.functools + + +Module Contents +--------------- + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + koapy.cli.extensions.functools.update_wrapper_with_click_params + + + +.. py:function:: update_wrapper_with_click_params(wrapper, wrapped, *args, **kwargs) + + diff --git a/_sources/autoapi/koapy/cli/extensions/index.rst b/_sources/autoapi/koapy/cli/extensions/index.rst new file mode 100644 index 00000000..702e5340 --- /dev/null +++ b/_sources/autoapi/koapy/cli/extensions/index.rst @@ -0,0 +1,17 @@ +:py:mod:`koapy.cli.extensions` +============================== + +.. py:module:: koapy.cli.extensions + + +Submodules +---------- +.. toctree:: + :titlesonly: + :maxdepth: 1 + + functools/index.rst + parser/index.rst + verbose_option/index.rst + + diff --git a/_sources/autoapi/koapy/cli/extensions/parser/index.rst b/_sources/autoapi/koapy/cli/extensions/parser/index.rst new file mode 100644 index 00000000..a134d46d --- /dev/null +++ b/_sources/autoapi/koapy/cli/extensions/parser/index.rst @@ -0,0 +1,73 @@ +:py:mod:`koapy.cli.extensions.parser` +===================================== + +.. py:module:: koapy.cli.extensions.parser + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.cli.extensions.parser.ArgumentParser + koapy.cli.extensions.parser.ClickArgumentParser + + + + +Attributes +~~~~~~~~~~ + +.. autoapisummary:: + + koapy.cli.extensions.parser.Function + koapy.cli.extensions.parser.FunctionOrCommand + koapy.cli.extensions.parser.ArgumentDecorator + koapy.cli.extensions.parser.CommandDecorator + + +.. py:data:: Function + + + + +.. py:data:: FunctionOrCommand + + + + +.. py:data:: ArgumentDecorator + + + + +.. py:data:: CommandDecorator + + + + +.. py:class:: ArgumentParser + + .. py:method:: parse_args(self, args: Optional[Sequence[str]] = None, namespace: Optional[argparse.Namespace] = None) -> argparse.Namespace + :abstractmethod: + + + .. py:method:: parse_known_args(self, args: Optional[Sequence[str]] = None, namespace: Optional[argparse.Namespace] = None) -> Tuple[argparse.Namespace, List[str]] + :abstractmethod: + + + +.. py:class:: ClickArgumentParser(params: Sequence[ArgumentDecorator], command: Optional[CommandDecorator] = None, help_option_names: Optional[Sequence[str]] = None) + + Bases: :py:obj:`ArgumentParser` + + .. py:method:: parse_args(self, args: Optional[Sequence[str]] = None, namespace: Optional[argparse.Namespace] = None) -> argparse.Namespace + + + .. py:method:: parse_known_args(self, args: Optional[Sequence[str]] = None, namespace: Optional[argparse.Namespace] = None) -> Tuple[argparse.Namespace, List[str]] + + + diff --git a/_sources/autoapi/koapy/cli/extensions/verbose_option/index.rst b/_sources/autoapi/koapy/cli/extensions/verbose_option/index.rst new file mode 100644 index 00000000..dc2ff67f --- /dev/null +++ b/_sources/autoapi/koapy/cli/extensions/verbose_option/index.rst @@ -0,0 +1,104 @@ +:py:mod:`koapy.cli.extensions.verbose_option` +============================================= + +.. py:module:: koapy.cli.extensions.verbose_option + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.cli.extensions.verbose_option.VerboseOption + + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + koapy.cli.extensions.verbose_option.verbose_flag_option + koapy.cli.extensions.verbose_option.no_verbose_flag_option + koapy.cli.extensions.verbose_option.verbose_option + + + +.. py:class:: VerboseOption(*decls, **attrs) + + Bases: :py:obj:`click.Option` + + Options are usually optional values on the command line and + have some extra features that arguments don't have. + + All other parameters are passed onwards to the parameter constructor. + + :param show_default: Show the default value for this option in its + help text. Values are not shown by default, unless + :attr:`Context.show_default` is ``True``. If this value is a + string, it shows that string in parentheses instead of the + actual value. This is particularly useful for dynamic options. + For single option boolean flags, the default remains hidden if + its value is ``False``. + :param show_envvar: Controls if an environment variable should be + shown on the help page. Normally, environment variables are not + shown. + :param prompt: If set to ``True`` or a non empty string then the + user will be prompted for input. If set to ``True`` the prompt + will be the option name capitalized. + :param confirmation_prompt: Prompt a second time to confirm the + value if it was prompted for. Can be set to a string instead of + ``True`` to customize the message. + :param prompt_required: If set to ``False``, the user will be + prompted for input only when the option was specified as a flag + without a value. + :param hide_input: If this is ``True`` then the input on the prompt + will be hidden from the user. This is useful for password input. + :param is_flag: forces this option to act as a flag. The default is + auto detection. + :param flag_value: which value should be used for this flag if it's + enabled. This is set to a boolean automatically if + the option string contains a slash to mark two options. + :param multiple: if this is set to `True` then the argument is accepted + multiple times and recorded. This is similar to ``nargs`` + in how it works but supports arbitrary number of + arguments. + :param count: this flag makes an option increment an integer. + :param allow_from_autoenv: if this is enabled then the value of this + parameter will be pulled from an environment + variable in case a prefix is defined on the + context. + :param help: the help string. + :param hidden: hide this option from help outputs. + + .. versionchanged:: 8.1.0 + Help text indentation is cleaned here instead of only in the + ``@option`` decorator. + + .. versionchanged:: 8.1.0 + The ``show_default`` parameter overrides + ``Context.show_default``. + + .. versionchanged:: 8.1.0 + The default of a single option boolean flag is not shown if the + default value is ``False``. + + .. versionchanged:: 8.0.1 + ``type`` is detected from ``flag_value`` if given. + + .. py:method:: add_to_parser(self, parser, ctx) + + + +.. py:function:: verbose_flag_option(default=0, flag_value=1, show_default=False, metavar='[0...5]', help='Set verbosity level.') + + +.. py:function:: no_verbose_flag_option(help='Force zero verbosity.') + + +.. py:function:: verbose_option(dest='verbose', default=0, flag_value=1, callback=None, expose_value=False, show_default=False) + + diff --git a/_sources/autoapi/koapy/cli/index.rst b/_sources/autoapi/koapy/cli/index.rst new file mode 100644 index 00000000..b50aef94 --- /dev/null +++ b/_sources/autoapi/koapy/cli/index.rst @@ -0,0 +1,176 @@ +:py:mod:`koapy.cli` +=================== + +.. py:module:: koapy.cli + +.. autoapi-nested-parse:: + + Console script for koapy. + + + +Subpackages +----------- +.. toctree:: + :titlesonly: + :maxdepth: 3 + + commands/index.rst + extensions/index.rst + utils/index.rst + + +Package Contents +---------------- + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + koapy.cli.disable + koapy.cli.enable + koapy.cli.generate + koapy.cli.get + koapy.cli.install + koapy.cli.serve + koapy.cli.show + koapy.cli.uninstall + koapy.cli.update + koapy.cli.get_credentials + koapy.cli.fail_with_usage + koapy.cli.verbose_option + koapy.cli.get_logger + koapy.cli.cli + koapy.cli.login + koapy.cli.watch + koapy.cli.order + koapy.cli.main + + + +Attributes +~~~~~~~~~~ + +.. autoapisummary:: + + koapy.cli.default_encoding + koapy.cli.logger + koapy.cli.help_option_names + koapy.cli.context_settings + koapy.cli.order_types + koapy.cli.quote_types + + +.. py:function:: disable() + + +.. py:function:: enable() + + +.. py:function:: generate() + + +.. py:function:: get() + + +.. py:function:: install() + + +.. py:function:: serve(ctx, verbose, **kwargs) + + +.. py:function:: show() + + +.. py:function:: uninstall() + + +.. py:function:: update() + + +.. py:function:: get_credentials(interactive=False) + + +.. py:function:: fail_with_usage(message=None, ctx=None) + + +.. py:function:: verbose_option(*args, **kwargs) + + +.. py:data:: default_encoding + :annotation: = utf-8 + + + +.. py:function:: get_logger(name=None) + + +.. py:data:: logger + + + + +.. py:data:: help_option_names + :annotation: = ['-h', '--help'] + + + +.. py:data:: context_settings + + + + +.. py:function:: cli() + + +.. py:function:: login(interactive, disable_auto_login, port) + + +.. py:function:: watch(codes, input, fids, realtype, output, format, port) + + +.. py:data:: order_types + :annotation: = ['1', '2', '3', '4', '5', '6'] + + + +.. py:data:: quote_types + :annotation: = ['00', '03', '05', '06', '07', '10', '13', '16', '20', '23', '26', '61', '62', '81'] + + + +.. py:function:: order(request_name, screen_no, account_no, order_type, code, quantity, price, quote_type, original_order_no, format, port) + + + [주문유형] + 1 : 신규매수 + 2 : 신규매도 + 3 : 매수취소 + 4 : 매도취소 + 5 : 매수정정 + 6 : 매도정정 + + + [거래구분] + 모의투자에서는 지정가 주문과 시장가 주문만 가능합니다. + 00 : 지정가 + 03 : 시장가 + 05 : 조건부지정가 + 06 : 최유리지정가 + 07 : 최우선지정가 + 10 : 지정가IOC + 13 : 시장가IOC + 16 : 최유리IOC + 20 : 지정가FOK + 23 : 시장가FOK + 26 : 최유리FOK + 61 : 장전시간외종가 + 62 : 시간외단일가매매 + 81 : 장후시간외종가 + + +.. py:function:: main() + + diff --git a/_sources/autoapi/koapy/cli/utils/credentials/index.rst b/_sources/autoapi/koapy/cli/utils/credentials/index.rst new file mode 100644 index 00000000..41f7db93 --- /dev/null +++ b/_sources/autoapi/koapy/cli/utils/credentials/index.rst @@ -0,0 +1,26 @@ +:py:mod:`koapy.cli.utils.credentials` +===================================== + +.. py:module:: koapy.cli.utils.credentials + + +Module Contents +--------------- + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + koapy.cli.utils.credentials.prompt_credentials + koapy.cli.utils.credentials.get_credentials + + + +.. py:function:: prompt_credentials() + + +.. py:function:: get_credentials(interactive=False) + + diff --git a/_sources/autoapi/koapy/cli/utils/fail_with_usage/index.rst b/_sources/autoapi/koapy/cli/utils/fail_with_usage/index.rst new file mode 100644 index 00000000..a4d799a9 --- /dev/null +++ b/_sources/autoapi/koapy/cli/utils/fail_with_usage/index.rst @@ -0,0 +1,30 @@ +:py:mod:`koapy.cli.utils.fail_with_usage` +========================================= + +.. py:module:: koapy.cli.utils.fail_with_usage + + +Module Contents +--------------- + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + koapy.cli.utils.fail_with_usage.get_help + koapy.cli.utils.fail_with_usage.get_help_without_usage + koapy.cli.utils.fail_with_usage.fail_with_usage + + + +.. py:function:: get_help(ctx) + + +.. py:function:: get_help_without_usage(ctx) + + +.. py:function:: fail_with_usage(message=None, ctx=None) + + diff --git a/_sources/autoapi/koapy/cli/utils/grpc_options/index.rst b/_sources/autoapi/koapy/cli/utils/grpc_options/index.rst new file mode 100644 index 00000000..5c4eb1a8 --- /dev/null +++ b/_sources/autoapi/koapy/cli/utils/grpc_options/index.rst @@ -0,0 +1,271 @@ +:py:mod:`koapy.cli.utils.grpc_options` +====================================== + +.. py:module:: koapy.cli.utils.grpc_options + + +Module Contents +--------------- + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + koapy.cli.utils.grpc_options.grpc_server_options + koapy.cli.utils.grpc_options.grpc_client_options + koapy.cli.utils.grpc_options.grpc_server_and_client_options + + + +Attributes +~~~~~~~~~~ + +.. autoapisummary:: + + koapy.cli.utils.grpc_options.grpc_config + koapy.cli.utils.grpc_options.default_server_bind_address + koapy.cli.utils.grpc_options.default_server_host + koapy.cli.utils.grpc_options.default_server_port + koapy.cli.utils.grpc_options.default_client_host + koapy.cli.utils.grpc_options.default_client_port + koapy.cli.utils.grpc_options.default_common_host + koapy.cli.utils.grpc_options.default_common_port + koapy.cli.utils.grpc_options.server_bind_address_option + koapy.cli.utils.grpc_options.server_port_option + koapy.cli.utils.grpc_options.server_key_file_option + koapy.cli.utils.grpc_options.server_cert_file_option + koapy.cli.utils.grpc_options.server_root_certs_file_option + koapy.cli.utils.grpc_options.server_require_client_auth_option + koapy.cli.utils.grpc_options.server_no_require_client_auth_option + koapy.cli.utils.grpc_options.server_options + koapy.cli.utils.grpc_options.client_host_option + koapy.cli.utils.grpc_options.client_port_option + koapy.cli.utils.grpc_options.client_enable_ssl_option + koapy.cli.utils.grpc_options.client_root_certs_file_option + koapy.cli.utils.grpc_options.client_key_file_option + koapy.cli.utils.grpc_options.client_cert_file_option + koapy.cli.utils.grpc_options.client_options + koapy.cli.utils.grpc_options.server_and_client_bind_address_option + koapy.cli.utils.grpc_options.server_and_client_host_option + koapy.cli.utils.grpc_options.server_and_client_port_option + koapy.cli.utils.grpc_options.server_and_client_enable_ssl_option + koapy.cli.utils.grpc_options.server_and_client_server_key_file_option + koapy.cli.utils.grpc_options.server_and_client_server_cert_file_option + koapy.cli.utils.grpc_options.server_and_client_server_root_certs_file_option + koapy.cli.utils.grpc_options.server_and_client_require_client_auth_option + koapy.cli.utils.grpc_options.server_and_client_no_require_client_auth_option + koapy.cli.utils.grpc_options.server_and_client_client_root_certs_file_option + koapy.cli.utils.grpc_options.server_and_client_client_key_file_option + koapy.cli.utils.grpc_options.server_and_client_client_cert_file_option + koapy.cli.utils.grpc_options.server_and_client_options + koapy.cli.utils.grpc_options.server_argument_parser + koapy.cli.utils.grpc_options.client_argument_parser + koapy.cli.utils.grpc_options.server_and_client_argument_parser + + +.. py:data:: grpc_config + + + + +.. py:data:: default_server_bind_address + + + + +.. py:data:: default_server_host + + + + +.. py:data:: default_server_port + + + + +.. py:data:: default_client_host + + + + +.. py:data:: default_client_port + + + + +.. py:data:: default_common_host + + + + +.. py:data:: default_common_port + + + + +.. py:data:: server_bind_address_option + + + + +.. py:data:: server_port_option + + + + +.. py:data:: server_key_file_option + + + + +.. py:data:: server_cert_file_option + + + + +.. py:data:: server_root_certs_file_option + + + + +.. py:data:: server_require_client_auth_option + + + + +.. py:data:: server_no_require_client_auth_option + + + + +.. py:data:: server_options + + + + +.. py:data:: client_host_option + + + + +.. py:data:: client_port_option + + + + +.. py:data:: client_enable_ssl_option + + + + +.. py:data:: client_root_certs_file_option + + + + +.. py:data:: client_key_file_option + + + + +.. py:data:: client_cert_file_option + + + + +.. py:data:: client_options + + + + +.. py:data:: server_and_client_bind_address_option + + + + +.. py:data:: server_and_client_host_option + + + + +.. py:data:: server_and_client_port_option + + + + +.. py:data:: server_and_client_enable_ssl_option + + + + +.. py:data:: server_and_client_server_key_file_option + + + + +.. py:data:: server_and_client_server_cert_file_option + + + + +.. py:data:: server_and_client_server_root_certs_file_option + + + + +.. py:data:: server_and_client_require_client_auth_option + + + + +.. py:data:: server_and_client_no_require_client_auth_option + + + + +.. py:data:: server_and_client_client_root_certs_file_option + + + + +.. py:data:: server_and_client_client_key_file_option + + + + +.. py:data:: server_and_client_client_cert_file_option + + + + +.. py:data:: server_and_client_options + + + + +.. py:function:: grpc_server_options() + + +.. py:function:: grpc_client_options() + + +.. py:function:: grpc_server_and_client_options() + + +.. py:data:: server_argument_parser + + + + +.. py:data:: client_argument_parser + + + + +.. py:data:: server_and_client_argument_parser + + + + diff --git a/_sources/autoapi/koapy/cli/utils/index.rst b/_sources/autoapi/koapy/cli/utils/index.rst new file mode 100644 index 00000000..0a84114d --- /dev/null +++ b/_sources/autoapi/koapy/cli/utils/index.rst @@ -0,0 +1,20 @@ +:py:mod:`koapy.cli.utils` +========================= + +.. py:module:: koapy.cli.utils + + +Submodules +---------- +.. toctree:: + :titlesonly: + :maxdepth: 1 + + credentials/index.rst + fail_with_usage/index.rst + grpc_options/index.rst + openapi/index.rst + pywin32/index.rst + verbose_option/index.rst + + diff --git a/_sources/autoapi/koapy/cli/utils/openapi/index.rst b/_sources/autoapi/koapy/cli/utils/openapi/index.rst new file mode 100644 index 00000000..671ddd01 --- /dev/null +++ b/_sources/autoapi/koapy/cli/utils/openapi/index.rst @@ -0,0 +1,53 @@ +:py:mod:`koapy.cli.utils.openapi` +================================= + +.. py:module:: koapy.cli.utils.openapi + + +Module Contents +--------------- + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + koapy.cli.utils.openapi.download_openapi_installer + koapy.cli.utils.openapi.prepare_issfile_for_install + koapy.cli.utils.openapi.prepare_issfile_for_uninstall + koapy.cli.utils.openapi.run_installer_with_issfile + + + +Attributes +~~~~~~~~~~ + +.. autoapisummary:: + + koapy.cli.utils.openapi.logger + koapy.cli.utils.openapi.iss_file_encoding + + +.. py:data:: logger + + + + +.. py:data:: iss_file_encoding + :annotation: = euc-kr + + + +.. py:function:: download_openapi_installer(filepath) + + +.. py:function:: prepare_issfile_for_install(filepath, target=None) + + +.. py:function:: prepare_issfile_for_uninstall(filepath, reboot=False) + + +.. py:function:: run_installer_with_issfile(installer, issfile, logfile=None, cwd=None) + + diff --git a/_sources/autoapi/koapy/cli/utils/pywin32/index.rst b/_sources/autoapi/koapy/cli/utils/pywin32/index.rst new file mode 100644 index 00000000..3617fb56 --- /dev/null +++ b/_sources/autoapi/koapy/cli/utils/pywin32/index.rst @@ -0,0 +1,43 @@ +:py:mod:`koapy.cli.utils.pywin32` +================================= + +.. py:module:: koapy.cli.utils.pywin32 + + +Module Contents +--------------- + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + koapy.cli.utils.pywin32.get_pywin32_postinstall_script + koapy.cli.utils.pywin32.install_pywin32 + koapy.cli.utils.pywin32.uninstall_pywin32 + + + +Attributes +~~~~~~~~~~ + +.. autoapisummary:: + + koapy.cli.utils.pywin32.logger + + +.. py:data:: logger + + + + +.. py:function:: get_pywin32_postinstall_script(filepath) + + +.. py:function:: install_pywin32(version=None) + + +.. py:function:: uninstall_pywin32() + + diff --git a/_sources/autoapi/koapy/cli/utils/verbose_option/index.rst b/_sources/autoapi/koapy/cli/utils/verbose_option/index.rst new file mode 100644 index 00000000..bd2f0763 --- /dev/null +++ b/_sources/autoapi/koapy/cli/utils/verbose_option/index.rst @@ -0,0 +1,43 @@ +:py:mod:`koapy.cli.utils.verbose_option` +======================================== + +.. py:module:: koapy.cli.utils.verbose_option + + +Module Contents +--------------- + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + koapy.cli.utils.verbose_option.verbose_option_callback + koapy.cli.utils.verbose_option.verbose_option + koapy.cli.utils.verbose_option.full_verbose_option + + + +Attributes +~~~~~~~~~~ + +.. autoapisummary:: + + koapy.cli.utils.verbose_option.full_verbosity + + +.. py:data:: full_verbosity + :annotation: = 5 + + + +.. py:function:: verbose_option_callback(ctx, param, value) + + +.. py:function:: verbose_option(*args, **kwargs) + + +.. py:function:: full_verbose_option(*args, **kwargs) + + diff --git a/_sources/autoapi/koapy/compat/index.rst b/_sources/autoapi/koapy/compat/index.rst new file mode 100644 index 00000000..4039994a --- /dev/null +++ b/_sources/autoapi/koapy/compat/index.rst @@ -0,0 +1,16 @@ +:py:mod:`koapy.compat` +====================== + +.. py:module:: koapy.compat + + +Subpackages +----------- +.. toctree:: + :titlesonly: + :maxdepth: 3 + + pyside2/index.rst + pywinauto/index.rst + + diff --git a/_sources/autoapi/koapy/compat/pyside2/QtAxContainer/index.rst b/_sources/autoapi/koapy/compat/pyside2/QtAxContainer/index.rst new file mode 100644 index 00000000..fa706a84 --- /dev/null +++ b/_sources/autoapi/koapy/compat/pyside2/QtAxContainer/index.rst @@ -0,0 +1,6 @@ +:py:mod:`koapy.compat.pyside2.QtAxContainer` +============================================ + +.. py:module:: koapy.compat.pyside2.QtAxContainer + + diff --git a/_sources/autoapi/koapy/compat/pyside2/QtCore/index.rst b/_sources/autoapi/koapy/compat/pyside2/QtCore/index.rst new file mode 100644 index 00000000..1103370c --- /dev/null +++ b/_sources/autoapi/koapy/compat/pyside2/QtCore/index.rst @@ -0,0 +1,6 @@ +:py:mod:`koapy.compat.pyside2.QtCore` +===================================== + +.. py:module:: koapy.compat.pyside2.QtCore + + diff --git a/_sources/autoapi/koapy/compat/pyside2/QtGui/index.rst b/_sources/autoapi/koapy/compat/pyside2/QtGui/index.rst new file mode 100644 index 00000000..d5421cec --- /dev/null +++ b/_sources/autoapi/koapy/compat/pyside2/QtGui/index.rst @@ -0,0 +1,6 @@ +:py:mod:`koapy.compat.pyside2.QtGui` +==================================== + +.. py:module:: koapy.compat.pyside2.QtGui + + diff --git a/_sources/autoapi/koapy/compat/pyside2/QtNetwork/index.rst b/_sources/autoapi/koapy/compat/pyside2/QtNetwork/index.rst new file mode 100644 index 00000000..eee25144 --- /dev/null +++ b/_sources/autoapi/koapy/compat/pyside2/QtNetwork/index.rst @@ -0,0 +1,6 @@ +:py:mod:`koapy.compat.pyside2.QtNetwork` +======================================== + +.. py:module:: koapy.compat.pyside2.QtNetwork + + diff --git a/_sources/autoapi/koapy/compat/pyside2/QtWidgets/index.rst b/_sources/autoapi/koapy/compat/pyside2/QtWidgets/index.rst new file mode 100644 index 00000000..0a855fa3 --- /dev/null +++ b/_sources/autoapi/koapy/compat/pyside2/QtWidgets/index.rst @@ -0,0 +1,6 @@ +:py:mod:`koapy.compat.pyside2.QtWidgets` +======================================== + +.. py:module:: koapy.compat.pyside2.QtWidgets + + diff --git a/_sources/autoapi/koapy/compat/pyside2/index.rst b/_sources/autoapi/koapy/compat/pyside2/index.rst new file mode 100644 index 00000000..87723d57 --- /dev/null +++ b/_sources/autoapi/koapy/compat/pyside2/index.rst @@ -0,0 +1,66 @@ +:py:mod:`koapy.compat.pyside2` +============================== + +.. py:module:: koapy.compat.pyside2 + + +Submodules +---------- +.. toctree:: + :titlesonly: + :maxdepth: 1 + + QtAxContainer/index.rst + QtCore/index.rst + QtGui/index.rst + QtNetwork/index.rst + QtWidgets/index.rst + + +Package Contents +---------------- + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + koapy.compat.pyside2.get_logger + + + +Attributes +~~~~~~~~~~ + +.. autoapisummary:: + + koapy.compat.pyside2.config + koapy.compat.pyside2.debug + koapy.compat.pyside2.logger + koapy.compat.pyside2.QT_QPA_PLATFORM_PLUGIN_PATH + + +.. py:data:: config + + + + +.. py:data:: debug + :annotation: = False + + + +.. py:function:: get_logger(name=None) + + +.. py:data:: logger + + + + +.. py:data:: QT_QPA_PLATFORM_PLUGIN_PATH + + + + diff --git a/_sources/autoapi/koapy/compat/pywinauto/findwindows/index.rst b/_sources/autoapi/koapy/compat/pywinauto/findwindows/index.rst new file mode 100644 index 00000000..22f7597f --- /dev/null +++ b/_sources/autoapi/koapy/compat/pywinauto/findwindows/index.rst @@ -0,0 +1,6 @@ +:py:mod:`koapy.compat.pywinauto.findwindows` +============================================ + +.. py:module:: koapy.compat.pywinauto.findwindows + + diff --git a/_sources/autoapi/koapy/compat/pywinauto/importlib/index.rst b/_sources/autoapi/koapy/compat/pywinauto/importlib/index.rst new file mode 100644 index 00000000..caab5904 --- /dev/null +++ b/_sources/autoapi/koapy/compat/pywinauto/importlib/index.rst @@ -0,0 +1,63 @@ +:py:mod:`koapy.compat.pywinauto.importlib` +========================================== + +.. py:module:: koapy.compat.pywinauto.importlib + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.compat.pywinauto.importlib.PyWinAutoFinder + koapy.compat.pywinauto.importlib.PyWinAutoLoader + + + + +.. py:class:: PyWinAutoFinder + + Bases: :py:obj:`importlib.abc.MetaPathFinder` + + Abstract base class for import finders on sys.meta_path. + + .. py:method:: find_spec(self, fullname, path, target=None) + + + .. py:method:: register(cls) + :classmethod: + + + .. py:method:: unregister(cls) + :classmethod: + + + +.. py:class:: PyWinAutoLoader + + Bases: :py:obj:`importlib.abc.Loader` + + Abstract base class for import loaders. + + .. py:method:: set_sys_coinit_flags(self) + + + .. py:method:: reset_sys_coinit_flags(self) + + + .. py:method:: create_module(self, spec) + + Return a module to initialize and into which to load. + + This method should raise ImportError if anything prevents it + from creating a new module. It may return None to indicate + that the spec should create the new module. + + + .. py:method:: exec_module(self, module) + + + diff --git a/_sources/autoapi/koapy/compat/pywinauto/index.rst b/_sources/autoapi/koapy/compat/pywinauto/index.rst new file mode 100644 index 00000000..4e4bdf66 --- /dev/null +++ b/_sources/autoapi/koapy/compat/pywinauto/index.rst @@ -0,0 +1,48 @@ +:py:mod:`koapy.compat.pywinauto` +================================ + +.. py:module:: koapy.compat.pywinauto + + +Submodules +---------- +.. toctree:: + :titlesonly: + :maxdepth: 1 + + findwindows/index.rst + importlib/index.rst + timings/index.rst + + +Package Contents +---------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.compat.pywinauto.PyWinAutoFinder + + + + +.. py:class:: PyWinAutoFinder + + Bases: :py:obj:`importlib.abc.MetaPathFinder` + + Abstract base class for import finders on sys.meta_path. + + .. py:method:: find_spec(self, fullname, path, target=None) + + + .. py:method:: register(cls) + :classmethod: + + + .. py:method:: unregister(cls) + :classmethod: + + + diff --git a/_sources/autoapi/koapy/compat/pywinauto/timings/index.rst b/_sources/autoapi/koapy/compat/pywinauto/timings/index.rst new file mode 100644 index 00000000..6aa9aa25 --- /dev/null +++ b/_sources/autoapi/koapy/compat/pywinauto/timings/index.rst @@ -0,0 +1,6 @@ +:py:mod:`koapy.compat.pywinauto.timings` +======================================== + +.. py:module:: koapy.compat.pywinauto.timings + + diff --git a/_sources/autoapi/koapy/config/index.rst b/_sources/autoapi/koapy/config/index.rst new file mode 100644 index 00000000..4862a303 --- /dev/null +++ b/_sources/autoapi/koapy/config/index.rst @@ -0,0 +1,183 @@ +:py:mod:`koapy.config` +====================== + +.. py:module:: koapy.config + + +Module Contents +--------------- + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + koapy.config.read_config + koapy.config.config_from_dict + koapy.config.find_user_config_file_in + koapy.config.find_user_config_file_from + koapy.config.set_user_config + koapy.config.initialize_config_from_given_path + koapy.config.initialize_config_from_expected_paths + koapy.config.get_config + koapy.config.get_user_config + koapy.config.dump_config + koapy.config.save_config + koapy.config.save_user_config + koapy.config.get_executable_from_conda_envname + koapy.config.get_executable_from_conda_envpath + koapy.config.get_executable_from_executable_config + koapy.config.get_32bit_executable + koapy.config.get_64bit_executable + + + +Attributes +~~~~~~~~~~ + +.. autoapisummary:: + + koapy.config.Config + koapy.config.default_config_filename + koapy.config.default_config_file_directory + koapy.config.default_config_filepath + koapy.config.current_working_directory + koapy.config.home_directory + koapy.config.default_user_config_filename + koapy.config.user_config_filename_cadidates + koapy.config.default_user_config_filepath + koapy.config.default_encoding + koapy.config.default_config + koapy.config.empty_config + koapy.config.user_config + koapy.config.config + koapy.config.debug + + +.. py:data:: Config + + + + +.. py:data:: default_config_filename + :annotation: = config.conf + + + +.. py:data:: default_config_file_directory + + + + +.. py:data:: default_config_filepath + + + + +.. py:data:: current_working_directory + + + + +.. py:data:: home_directory + + + + +.. py:data:: default_user_config_filename + :annotation: = koapy.conf + + + +.. py:data:: user_config_filename_cadidates + + + + +.. py:data:: default_user_config_filepath + + + + +.. py:data:: default_encoding + :annotation: = utf-8 + + + +.. py:function:: read_config(filename: Optional[Union[os.PathLike, str]] = None, encoding: Optional[str] = None) -> Config + + +.. py:function:: config_from_dict(dictionary: Mapping[str, Any]) -> Config + + +.. py:data:: default_config + + + + +.. py:function:: find_user_config_file_in(searching_directory: Optional[Union[os.PathLike, str]] = None) -> Optional[pathlib.Path] + + +.. py:function:: find_user_config_file_from(starting_directory: Optional[Union[os.PathLike, str]] = None) -> Optional[pathlib.Path] + + +.. py:data:: empty_config + + + + +.. py:data:: user_config + + + + +.. py:data:: config + + + + +.. py:function:: set_user_config(c: Config) -> Config + + +.. py:function:: initialize_config_from_given_path(filename: Optional[Union[os.PathLike, str]] = None) -> bool + + +.. py:function:: initialize_config_from_expected_paths() -> bool + + +.. py:function:: get_config() -> Config + + +.. py:function:: get_user_config() -> Config + + +.. py:data:: debug + :annotation: = False + + + +.. py:function:: dump_config(config: Config, compact: bool = False, indent: int = 4) -> str + + +.. py:function:: save_config(filename: Union[os.PathLike, str], config: Optional[Config] = None, compact: bool = False, indent: int = 4, encoding: Optional[str] = None) + + +.. py:function:: save_user_config(filename: Optional[Union[os.PathLike, str]] = None, user_config: Optional[Config] = None, compact: bool = False, indent: int = 4, encoding: Optional[str] = None) + + +.. py:function:: get_executable_from_conda_envname(envname: str) -> str + + +.. py:function:: get_executable_from_conda_envpath(envpath: str) -> str + + +.. py:function:: get_executable_from_executable_config(executable_config: Config) -> Optional[str] + + +.. py:function:: get_32bit_executable() -> Optional[str] + + +.. py:function:: get_64bit_executable() -> Optional[str] + + diff --git a/_sources/autoapi/koapy/index.rst b/_sources/autoapi/koapy/index.rst new file mode 100644 index 00000000..582830c3 --- /dev/null +++ b/_sources/autoapi/koapy/index.rst @@ -0,0 +1,33 @@ +:py:mod:`koapy` +=============== + +.. py:module:: koapy + +.. autoapi-nested-parse:: + + Top-level package for KOAPY. + + + +Subpackages +----------- +.. toctree:: + :titlesonly: + :maxdepth: 3 + + backend/index.rst + backtrader/index.rst + cli/index.rst + compat/index.rst + utils/index.rst + + +Submodules +---------- +.. toctree:: + :titlesonly: + :maxdepth: 1 + + config/index.rst + + diff --git a/_sources/autoapi/koapy/utils/builtin/index.rst b/_sources/autoapi/koapy/utils/builtin/index.rst new file mode 100644 index 00000000..1a5d43aa --- /dev/null +++ b/_sources/autoapi/koapy/utils/builtin/index.rst @@ -0,0 +1,22 @@ +:py:mod:`koapy.utils.builtin` +============================= + +.. py:module:: koapy.utils.builtin + + +Module Contents +--------------- + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + koapy.utils.builtin.dir_public + + + +.. py:function:: dir_public(*args) + + diff --git a/_sources/autoapi/koapy/utils/ctypes/index.rst b/_sources/autoapi/koapy/utils/ctypes/index.rst new file mode 100644 index 00000000..e2d1b062 --- /dev/null +++ b/_sources/autoapi/koapy/utils/ctypes/index.rst @@ -0,0 +1,22 @@ +:py:mod:`koapy.utils.ctypes` +============================ + +.. py:module:: koapy.utils.ctypes + + +Module Contents +--------------- + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + koapy.utils.ctypes.is_admin + + + +.. py:function:: is_admin() + + diff --git a/_sources/autoapi/koapy/utils/data/KrxHistoricalDailyPriceDataDownloader/index.rst b/_sources/autoapi/koapy/utils/data/KrxHistoricalDailyPriceDataDownloader/index.rst new file mode 100644 index 00000000..aa90a107 --- /dev/null +++ b/_sources/autoapi/koapy/utils/data/KrxHistoricalDailyPriceDataDownloader/index.rst @@ -0,0 +1,45 @@ +:py:mod:`koapy.utils.data.KrxHistoricalDailyPriceDataDownloader` +================================================================ + +.. py:module:: koapy.utils.data.KrxHistoricalDailyPriceDataDownloader + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.utils.data.KrxHistoricalDailyPriceDataDownloader.KrxHistoricalDailyPriceDataDownloader + + + + +.. py:class:: KrxHistoricalDailyPriceDataDownloader + + .. py:method:: get_stocks(self) + + + .. py:method:: get_stocks_delisted(self) + + + .. py:method:: stocks(self) + :property: + + + .. py:method:: stocks_delisted(self) + :property: + + + .. py:method:: get_full_code(self, symbol) + + + .. py:method:: get_name(self, symbol) + + + .. py:method:: download(self, symbol, start_date=None, end_date=None) + + + diff --git a/_sources/autoapi/koapy/utils/data/KrxHistoricalDailyPriceDataForBacktestLoader/index.rst b/_sources/autoapi/koapy/utils/data/KrxHistoricalDailyPriceDataForBacktestLoader/index.rst new file mode 100644 index 00000000..d4745270 --- /dev/null +++ b/_sources/autoapi/koapy/utils/data/KrxHistoricalDailyPriceDataForBacktestLoader/index.rst @@ -0,0 +1,42 @@ +:py:mod:`koapy.utils.data.KrxHistoricalDailyPriceDataForBacktestLoader` +======================================================================= + +.. py:module:: koapy.utils.data.KrxHistoricalDailyPriceDataForBacktestLoader + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.utils.data.KrxHistoricalDailyPriceDataForBacktestLoader.KrxHistoricalDailyPriceDataForBacktestLoader + + + + +.. py:class:: KrxHistoricalDailyPriceDataForBacktestLoader(filename, library=None) + + .. py:method:: get_adjust_ratios(cls, data, sort=True) + :classmethod: + + + .. py:method:: adjust_data(cls, data, sort=True) + :classmethod: + + + .. py:method:: get_symbols(self) + + + .. py:method:: update(self, download=False, progress_bar=False) + + + .. py:method:: load(self, symbol, start_time=None, end_time=None) + + + .. py:method:: load_as_cursor(self, symbol, start_time=None, end_time=None) + + + diff --git a/_sources/autoapi/koapy/utils/data/KrxHistoricalDailyPriceDataLoader/index.rst b/_sources/autoapi/koapy/utils/data/KrxHistoricalDailyPriceDataLoader/index.rst new file mode 100644 index 00000000..7fa6359f --- /dev/null +++ b/_sources/autoapi/koapy/utils/data/KrxHistoricalDailyPriceDataLoader/index.rst @@ -0,0 +1,42 @@ +:py:mod:`koapy.utils.data.KrxHistoricalDailyPriceDataLoader` +============================================================ + +.. py:module:: koapy.utils.data.KrxHistoricalDailyPriceDataLoader + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.utils.data.KrxHistoricalDailyPriceDataLoader.KrxHistoricalDailyPriceDataLoader + + + + +.. py:class:: KrxHistoricalDailyPriceDataLoader(filename, library=None, library_delisted=None) + + .. py:method:: symbols(self) + :property: + + + .. py:method:: symbols_delisted(self) + :property: + + + .. py:method:: load_from_database(self, symbol, is_delisted=None) + + + .. py:method:: load_or_download(self, symbol, is_delisted=None, start_date=None, end_date=None) + + + .. py:method:: load(self, symbol, is_delisted=None, start_date=None, end_date=None, download=True) + + + .. py:method:: update(self, progress_bar=False) + + + diff --git a/_sources/autoapi/koapy/utils/data/YahooFinanceKrxHistoricalDailyPriceDataDownloader/index.rst b/_sources/autoapi/koapy/utils/data/YahooFinanceKrxHistoricalDailyPriceDataDownloader/index.rst new file mode 100644 index 00000000..da20ed63 --- /dev/null +++ b/_sources/autoapi/koapy/utils/data/YahooFinanceKrxHistoricalDailyPriceDataDownloader/index.rst @@ -0,0 +1,25 @@ +:py:mod:`koapy.utils.data.YahooFinanceKrxHistoricalDailyPriceDataDownloader` +============================================================================ + +.. py:module:: koapy.utils.data.YahooFinanceKrxHistoricalDailyPriceDataDownloader + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.utils.data.YahooFinanceKrxHistoricalDailyPriceDataDownloader.YahooFinanceKrxHistoricalDailyPriceDataDownloader + + + + +.. py:class:: YahooFinanceKrxHistoricalDailyPriceDataDownloader + + .. py:method:: download(self, symbol, start_date=None, end_date=None) + + + diff --git a/_sources/autoapi/koapy/utils/data/index.rst b/_sources/autoapi/koapy/utils/data/index.rst new file mode 100644 index 00000000..7c73da04 --- /dev/null +++ b/_sources/autoapi/koapy/utils/data/index.rst @@ -0,0 +1,105 @@ +:py:mod:`koapy.utils.data` +========================== + +.. py:module:: koapy.utils.data + + +Submodules +---------- +.. toctree:: + :titlesonly: + :maxdepth: 1 + + KrxHistoricalDailyPriceDataDownloader/index.rst + KrxHistoricalDailyPriceDataForBacktestLoader/index.rst + KrxHistoricalDailyPriceDataLoader/index.rst + YahooFinanceKrxHistoricalDailyPriceDataDownloader/index.rst + + +Package Contents +---------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.utils.data.KrxHistoricalDailyPriceDataDownloader + koapy.utils.data.KrxHistoricalDailyPriceDataForBacktestLoader + koapy.utils.data.KrxHistoricalDailyPriceDataLoader + + + + +.. py:class:: KrxHistoricalDailyPriceDataDownloader + + .. py:method:: get_stocks(self) + + + .. py:method:: get_stocks_delisted(self) + + + .. py:method:: stocks(self) + :property: + + + .. py:method:: stocks_delisted(self) + :property: + + + .. py:method:: get_full_code(self, symbol) + + + .. py:method:: get_name(self, symbol) + + + .. py:method:: download(self, symbol, start_date=None, end_date=None) + + + +.. py:class:: KrxHistoricalDailyPriceDataForBacktestLoader(filename, library=None) + + .. py:method:: get_adjust_ratios(cls, data, sort=True) + :classmethod: + + + .. py:method:: adjust_data(cls, data, sort=True) + :classmethod: + + + .. py:method:: get_symbols(self) + + + .. py:method:: update(self, download=False, progress_bar=False) + + + .. py:method:: load(self, symbol, start_time=None, end_time=None) + + + .. py:method:: load_as_cursor(self, symbol, start_time=None, end_time=None) + + + +.. py:class:: KrxHistoricalDailyPriceDataLoader(filename, library=None, library_delisted=None) + + .. py:method:: symbols(self) + :property: + + + .. py:method:: symbols_delisted(self) + :property: + + + .. py:method:: load_from_database(self, symbol, is_delisted=None) + + + .. py:method:: load_or_download(self, symbol, is_delisted=None, start_date=None, end_date=None) + + + .. py:method:: load(self, symbol, is_delisted=None, start_date=None, end_date=None, download=True) + + + .. py:method:: update(self, progress_bar=False) + + + diff --git a/_sources/autoapi/koapy/utils/datetime/index.rst b/_sources/autoapi/koapy/utils/datetime/index.rst new file mode 100644 index 00000000..7c428b5c --- /dev/null +++ b/_sources/autoapi/koapy/utils/datetime/index.rst @@ -0,0 +1,26 @@ +:py:mod:`koapy.utils.datetime` +============================== + +.. py:module:: koapy.utils.datetime + + +Module Contents +--------------- + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + koapy.utils.datetime.is_naive + koapy.utils.datetime.localize + + + +.. py:function:: is_naive(dt) + + +.. py:function:: localize(dt, tz) + + diff --git a/_sources/autoapi/koapy/utils/exchange_calendars/index.rst b/_sources/autoapi/koapy/utils/exchange_calendars/index.rst new file mode 100644 index 00000000..4d30fe5d --- /dev/null +++ b/_sources/autoapi/koapy/utils/exchange_calendars/index.rst @@ -0,0 +1,51 @@ +:py:mod:`koapy.utils.exchange_calendars` +======================================== + +.. py:module:: koapy.utils.exchange_calendars + + +Module Contents +--------------- + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + koapy.utils.exchange_calendars.is_currently_in_session + koapy.utils.exchange_calendars.get_last_session_date + + + +Attributes +~~~~~~~~~~ + +.. autoapisummary:: + + koapy.utils.exchange_calendars.name + koapy.utils.exchange_calendars.calendar + koapy.utils.exchange_calendars.day + + +.. py:data:: name + :annotation: = XKRX + + + +.. py:data:: calendar + + + + +.. py:data:: day + + + + +.. py:function:: is_currently_in_session() -> bool + + +.. py:function:: get_last_session_date() -> pandas.Timestamp + + diff --git a/_sources/autoapi/koapy/utils/grpc/index.rst b/_sources/autoapi/koapy/utils/grpc/index.rst new file mode 100644 index 00000000..d9fb94d6 --- /dev/null +++ b/_sources/autoapi/koapy/utils/grpc/index.rst @@ -0,0 +1,34 @@ +:py:mod:`koapy.utils.grpc` +========================== + +.. py:module:: koapy.utils.grpc + + +Module Contents +--------------- + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + koapy.utils.grpc.warn_on_rpc_error_context + koapy.utils.grpc.warn_on_rpc_error + koapy.utils.grpc.cancel_after + koapy.utils.grpc.pprint_message + + + +.. py:function:: warn_on_rpc_error_context() + + +.. py:function:: warn_on_rpc_error(stream) + + +.. py:function:: cancel_after(stream, after) + + +.. py:function:: pprint_message(message) + + diff --git a/_sources/autoapi/koapy/utils/index.rst b/_sources/autoapi/koapy/utils/index.rst new file mode 100644 index 00000000..ad099837 --- /dev/null +++ b/_sources/autoapi/koapy/utils/index.rst @@ -0,0 +1,41 @@ +:py:mod:`koapy.utils` +===================== + +.. py:module:: koapy.utils + + +Subpackages +----------- +.. toctree:: + :titlesonly: + :maxdepth: 3 + + data/index.rst + logging/index.rst + messaging/index.rst + rate_limiting/index.rst + store/index.rst + + +Submodules +---------- +.. toctree:: + :titlesonly: + :maxdepth: 1 + + builtin/index.rst + ctypes/index.rst + datetime/index.rst + exchange_calendars/index.rst + grpc/index.rst + itertools/index.rst + networking/index.rst + notimplemented/index.rst + platform/index.rst + pywin32/index.rst + recursion/index.rst + serialization/index.rst + subprocess/index.rst + threading/index.rst + + diff --git a/_sources/autoapi/koapy/utils/itertools/index.rst b/_sources/autoapi/koapy/utils/itertools/index.rst new file mode 100644 index 00000000..313b19c2 --- /dev/null +++ b/_sources/autoapi/koapy/utils/itertools/index.rst @@ -0,0 +1,22 @@ +:py:mod:`koapy.utils.itertools` +=============================== + +.. py:module:: koapy.utils.itertools + + +Module Contents +--------------- + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + koapy.utils.itertools.chunk + + + +.. py:function:: chunk(iterable, n) + + diff --git a/_sources/autoapi/koapy/utils/logging/Logging/index.rst b/_sources/autoapi/koapy/utils/logging/Logging/index.rst new file mode 100644 index 00000000..e631e5e9 --- /dev/null +++ b/_sources/autoapi/koapy/utils/logging/Logging/index.rst @@ -0,0 +1,66 @@ +:py:mod:`koapy.utils.logging.Logging` +===================================== + +.. py:module:: koapy.utils.logging.Logging + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.utils.logging.Logging.LoggingMeta + koapy.utils.logging.Logging.Logging + + + + +.. py:class:: LoggingMeta(cls, clsname, bases, dct) + + Bases: :py:obj:`type` + + .. py:method:: get_logger(cls, name=None) + + + .. py:method:: get_class_logger(cls) + + + .. py:method:: get_module_logger(cls) + + + .. py:method:: get_package_logger(cls) + + + .. py:method:: logger(cls) + :property: + + + .. py:method:: verbosity_to_loglevel(cls, verbosity) + + + .. py:method:: loglevel_to_verbosity(cls, loglevel) + + + .. py:method:: set_loglevel(cls, loglevel=logging.WARNING) + + + .. py:method:: set_verbosity(cls, verbosity=0) + + + .. py:method:: get_loglevel(cls) + + + .. py:method:: get_verbosity(cls) + + + +.. py:class:: Logging + + .. py:method:: logger(self) + :property: + + + diff --git a/_sources/autoapi/koapy/utils/logging/index.rst b/_sources/autoapi/koapy/utils/logging/index.rst new file mode 100644 index 00000000..ac33ad94 --- /dev/null +++ b/_sources/autoapi/koapy/utils/logging/index.rst @@ -0,0 +1,84 @@ +:py:mod:`koapy.utils.logging` +============================= + +.. py:module:: koapy.utils.logging + + +Subpackages +----------- +.. toctree:: + :titlesonly: + :maxdepth: 3 + + pyside2/index.rst + tqdm/index.rst + + +Submodules +---------- +.. toctree:: + :titlesonly: + :maxdepth: 1 + + Logging/index.rst + + +Package Contents +---------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.utils.logging.Logging + + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + koapy.utils.logging.get_logger + koapy.utils.logging.verbosity_to_loglevel + koapy.utils.logging.loglevel_to_verbosity + koapy.utils.logging.get_package_logger + koapy.utils.logging.set_loglevel + koapy.utils.logging.set_verbosity + koapy.utils.logging.get_loglevel + koapy.utils.logging.get_verbosity + + + +.. py:class:: Logging + + .. py:method:: logger(self) + :property: + + + +.. py:function:: get_logger(name=None) + + +.. py:function:: verbosity_to_loglevel(verbosity) + + +.. py:function:: loglevel_to_verbosity(loglevel) + + +.. py:function:: get_package_logger() + + +.. py:function:: set_loglevel(loglevel) + + +.. py:function:: set_verbosity(verbosity) + + +.. py:function:: get_loglevel() + + +.. py:function:: get_verbosity() + + diff --git a/_sources/autoapi/koapy/utils/logging/pyside2/QAbstractSocketLogging/index.rst b/_sources/autoapi/koapy/utils/logging/pyside2/QAbstractSocketLogging/index.rst new file mode 100644 index 00000000..d9565c59 --- /dev/null +++ b/_sources/autoapi/koapy/utils/logging/pyside2/QAbstractSocketLogging/index.rst @@ -0,0 +1,30 @@ +:py:mod:`koapy.utils.logging.pyside2.QAbstractSocketLogging` +============================================================ + +.. py:module:: koapy.utils.logging.pyside2.QAbstractSocketLogging + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.utils.logging.pyside2.QAbstractSocketLogging.QAbstractSocketLoggingMeta + koapy.utils.logging.pyside2.QAbstractSocketLogging.QAbstractSocketLogging + + + + +.. py:class:: QAbstractSocketLoggingMeta(cls, clsname, bases, dct) + + Bases: :py:obj:`type`\ (\ :py:obj:`Logging`\ ), :py:obj:`type`\ (\ :py:obj:`QAbstractSocket`\ ) + + +.. py:class:: QAbstractSocketLogging(*args, **kwargs) + + Bases: :py:obj:`koapy.compat.pyside2.QtNetwork.QAbstractSocket`, :py:obj:`koapy.utils.logging.Logging.Logging` + + diff --git a/_sources/autoapi/koapy/utils/logging/pyside2/QObjectLogging/index.rst b/_sources/autoapi/koapy/utils/logging/pyside2/QObjectLogging/index.rst new file mode 100644 index 00000000..c38fb5d5 --- /dev/null +++ b/_sources/autoapi/koapy/utils/logging/pyside2/QObjectLogging/index.rst @@ -0,0 +1,30 @@ +:py:mod:`koapy.utils.logging.pyside2.QObjectLogging` +==================================================== + +.. py:module:: koapy.utils.logging.pyside2.QObjectLogging + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.utils.logging.pyside2.QObjectLogging.QObjectLoggingMeta + koapy.utils.logging.pyside2.QObjectLogging.QObjectLogging + + + + +.. py:class:: QObjectLoggingMeta(cls, clsname, bases, dct) + + Bases: :py:obj:`type`\ (\ :py:obj:`Logging`\ ), :py:obj:`type`\ (\ :py:obj:`QObject`\ ) + + +.. py:class:: QObjectLogging(*args, **kwargs) + + Bases: :py:obj:`koapy.compat.pyside2.QtCore.QObject`, :py:obj:`koapy.utils.logging.Logging.Logging` + + diff --git a/_sources/autoapi/koapy/utils/logging/pyside2/QThreadLogging/index.rst b/_sources/autoapi/koapy/utils/logging/pyside2/QThreadLogging/index.rst new file mode 100644 index 00000000..0d59e7c2 --- /dev/null +++ b/_sources/autoapi/koapy/utils/logging/pyside2/QThreadLogging/index.rst @@ -0,0 +1,30 @@ +:py:mod:`koapy.utils.logging.pyside2.QThreadLogging` +==================================================== + +.. py:module:: koapy.utils.logging.pyside2.QThreadLogging + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.utils.logging.pyside2.QThreadLogging.QThreadLoggingMeta + koapy.utils.logging.pyside2.QThreadLogging.QThreadLogging + + + + +.. py:class:: QThreadLoggingMeta(cls, clsname, bases, dct) + + Bases: :py:obj:`type`\ (\ :py:obj:`Logging`\ ), :py:obj:`type`\ (\ :py:obj:`QThread`\ ) + + +.. py:class:: QThreadLogging(*args, **kwargs) + + Bases: :py:obj:`koapy.compat.pyside2.QtCore.QThread`, :py:obj:`koapy.utils.logging.Logging.Logging` + + diff --git a/_sources/autoapi/koapy/utils/logging/pyside2/QWidgetLogging/index.rst b/_sources/autoapi/koapy/utils/logging/pyside2/QWidgetLogging/index.rst new file mode 100644 index 00000000..43c142a7 --- /dev/null +++ b/_sources/autoapi/koapy/utils/logging/pyside2/QWidgetLogging/index.rst @@ -0,0 +1,30 @@ +:py:mod:`koapy.utils.logging.pyside2.QWidgetLogging` +==================================================== + +.. py:module:: koapy.utils.logging.pyside2.QWidgetLogging + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.utils.logging.pyside2.QWidgetLogging.QWidgetLoggingMeta + koapy.utils.logging.pyside2.QWidgetLogging.QWidgetLogging + + + + +.. py:class:: QWidgetLoggingMeta(cls, clsname, bases, dct) + + Bases: :py:obj:`type`\ (\ :py:obj:`Logging`\ ), :py:obj:`type`\ (\ :py:obj:`QWidget`\ ) + + +.. py:class:: QWidgetLogging(*args, **kwargs) + + Bases: :py:obj:`koapy.compat.pyside2.QtWidgets.QWidget`, :py:obj:`koapy.utils.logging.Logging.Logging` + + diff --git a/_sources/autoapi/koapy/utils/logging/pyside2/index.rst b/_sources/autoapi/koapy/utils/logging/pyside2/index.rst new file mode 100644 index 00000000..5164ec43 --- /dev/null +++ b/_sources/autoapi/koapy/utils/logging/pyside2/index.rst @@ -0,0 +1,18 @@ +:py:mod:`koapy.utils.logging.pyside2` +===================================== + +.. py:module:: koapy.utils.logging.pyside2 + + +Submodules +---------- +.. toctree:: + :titlesonly: + :maxdepth: 1 + + QAbstractSocketLogging/index.rst + QObjectLogging/index.rst + QThreadLogging/index.rst + QWidgetLogging/index.rst + + diff --git a/_sources/autoapi/koapy/utils/logging/tqdm/TqdmStreamHandler/index.rst b/_sources/autoapi/koapy/utils/logging/tqdm/TqdmStreamHandler/index.rst new file mode 100644 index 00000000..60fc1e3e --- /dev/null +++ b/_sources/autoapi/koapy/utils/logging/tqdm/TqdmStreamHandler/index.rst @@ -0,0 +1,28 @@ +:py:mod:`koapy.utils.logging.tqdm.TqdmStreamHandler` +==================================================== + +.. py:module:: koapy.utils.logging.tqdm.TqdmStreamHandler + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.utils.logging.tqdm.TqdmStreamHandler.TqdmStreamHandler + + + + +.. py:class:: TqdmStreamHandler(stream=None) + + Bases: :py:obj:`logging.StreamHandler` + + A handler class which writes logging records, appropriately formatted, + to a stream. Note that this class does not close the stream, as + sys.stdout or sys.stderr may be used. + + diff --git a/_sources/autoapi/koapy/utils/logging/tqdm/index.rst b/_sources/autoapi/koapy/utils/logging/tqdm/index.rst new file mode 100644 index 00000000..74ef5c8b --- /dev/null +++ b/_sources/autoapi/koapy/utils/logging/tqdm/index.rst @@ -0,0 +1,15 @@ +:py:mod:`koapy.utils.logging.tqdm` +================================== + +.. py:module:: koapy.utils.logging.tqdm + + +Submodules +---------- +.. toctree:: + :titlesonly: + :maxdepth: 1 + + TqdmStreamHandler/index.rst + + diff --git a/_sources/autoapi/koapy/utils/messaging/DiscordMessenger/index.rst b/_sources/autoapi/koapy/utils/messaging/DiscordMessenger/index.rst new file mode 100644 index 00000000..0e03b529 --- /dev/null +++ b/_sources/autoapi/koapy/utils/messaging/DiscordMessenger/index.rst @@ -0,0 +1,36 @@ +:py:mod:`koapy.utils.messaging.DiscordMessenger` +================================================ + +.. py:module:: koapy.utils.messaging.DiscordMessenger + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.utils.messaging.DiscordMessenger.DiscordWebhookMessenger + koapy.utils.messaging.DiscordMessenger.DoItYourselfDiscordWebhookMessenger + + + + +.. py:class:: DiscordWebhookMessenger(url=None) + + Bases: :py:obj:`koapy.utils.messaging.Messenger.Messenger` + + .. py:method:: send_message(self, content) + + + +.. py:class:: DoItYourselfDiscordWebhookMessenger(url=None) + + Bases: :py:obj:`koapy.utils.messaging.Messenger.Messenger` + + .. py:method:: send_message(self, content) + + + diff --git a/_sources/autoapi/koapy/utils/messaging/Messenger/index.rst b/_sources/autoapi/koapy/utils/messaging/Messenger/index.rst new file mode 100644 index 00000000..2ceed099 --- /dev/null +++ b/_sources/autoapi/koapy/utils/messaging/Messenger/index.rst @@ -0,0 +1,28 @@ +:py:mod:`koapy.utils.messaging.Messenger` +========================================= + +.. py:module:: koapy.utils.messaging.Messenger + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.utils.messaging.Messenger.Messenger + + + + +.. py:class:: Messenger + + Bases: :py:obj:`abc.ABC` + + .. py:method:: send_message(self, content) + :abstractmethod: + + + diff --git a/_sources/autoapi/koapy/utils/messaging/index.rst b/_sources/autoapi/koapy/utils/messaging/index.rst new file mode 100644 index 00000000..e66d26ed --- /dev/null +++ b/_sources/autoapi/koapy/utils/messaging/index.rst @@ -0,0 +1,16 @@ +:py:mod:`koapy.utils.messaging` +=============================== + +.. py:module:: koapy.utils.messaging + + +Submodules +---------- +.. toctree:: + :titlesonly: + :maxdepth: 1 + + DiscordMessenger/index.rst + Messenger/index.rst + + diff --git a/_sources/autoapi/koapy/utils/networking/index.rst b/_sources/autoapi/koapy/utils/networking/index.rst new file mode 100644 index 00000000..7291aca3 --- /dev/null +++ b/_sources/autoapi/koapy/utils/networking/index.rst @@ -0,0 +1,30 @@ +:py:mod:`koapy.utils.networking` +================================ + +.. py:module:: koapy.utils.networking + + +Module Contents +--------------- + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + koapy.utils.networking.find_free_port_for_host + koapy.utils.networking.get_free_localhost_port + koapy.utils.networking.is_in_private_network + + + +.. py:function:: find_free_port_for_host(host) + + +.. py:function:: get_free_localhost_port() + + +.. py:function:: is_in_private_network(host) + + diff --git a/_sources/autoapi/koapy/utils/notimplemented/index.rst b/_sources/autoapi/koapy/utils/notimplemented/index.rst new file mode 100644 index 00000000..a5c8cfe0 --- /dev/null +++ b/_sources/autoapi/koapy/utils/notimplemented/index.rst @@ -0,0 +1,30 @@ +:py:mod:`koapy.utils.notimplemented` +==================================== + +.. py:module:: koapy.utils.notimplemented + + +Module Contents +--------------- + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + koapy.utils.notimplemented.notimplemented + koapy.utils.notimplemented.isnotimplemented + koapy.utils.notimplemented.isimplemented + + + +.. py:function:: notimplemented(func) + + +.. py:function:: isnotimplemented(func) + + +.. py:function:: isimplemented(func) + + diff --git a/_sources/autoapi/koapy/utils/platform/index.rst b/_sources/autoapi/koapy/utils/platform/index.rst new file mode 100644 index 00000000..e856902a --- /dev/null +++ b/_sources/autoapi/koapy/utils/platform/index.rst @@ -0,0 +1,30 @@ +:py:mod:`koapy.utils.platform` +============================== + +.. py:module:: koapy.utils.platform + + +Module Contents +--------------- + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + koapy.utils.platform.is_windows + koapy.utils.platform.is_32bit + koapy.utils.platform.is_64bit + + + +.. py:function:: is_windows() + + +.. py:function:: is_32bit() + + +.. py:function:: is_64bit() + + diff --git a/_sources/autoapi/koapy/utils/pywin32/index.rst b/_sources/autoapi/koapy/utils/pywin32/index.rst new file mode 100644 index 00000000..79303e1e --- /dev/null +++ b/_sources/autoapi/koapy/utils/pywin32/index.rst @@ -0,0 +1,71 @@ +:py:mod:`koapy.utils.pywin32` +============================= + +.. py:module:: koapy.utils.pywin32 + + +Module Contents +--------------- + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + koapy.utils.pywin32.IsPyIID + koapy.utils.pywin32.IsPyITypeLib + koapy.utils.pywin32.IsPyIIDLike + koapy.utils.pywin32.GetTypelibSpecs + koapy.utils.pywin32.GetLatestTypelibSpec + koapy.utils.pywin32.LoadTypeLib + koapy.utils.pywin32.BuildOleItems + + + +Attributes +~~~~~~~~~~ + +.. autoapisummary:: + + koapy.utils.pywin32.PyIID + koapy.utils.pywin32.PyITypeLib + koapy.utils.pywin32.PyIIDLike + + +.. py:data:: PyIID + + + + +.. py:data:: PyITypeLib + :annotation: = PyITypeLib + + + +.. py:data:: PyIIDLike + + + + +.. py:function:: IsPyIID(value) -> TypeGuard[PyIID] + + +.. py:function:: IsPyITypeLib(value) -> TypeGuard[PyITypeLib] + + +.. py:function:: IsPyIIDLike(value) -> TypeGuard[PyIIDLike] + + +.. py:function:: GetTypelibSpecs(iid: PyIIDLike) -> List[win32com.client.selecttlb.TypelibSpec] + + +.. py:function:: GetLatestTypelibSpec(specs: Union[Sequence[win32com.client.selecttlb.TypelibSpec], PyIIDLike]) -> Optional[win32com.client.selecttlb.TypelibSpec] + + +.. py:function:: LoadTypeLib(spec: Union[win32com.client.selecttlb.TypelibSpec, PyIIDLike]) -> Optional[PyITypeLib] + + +.. py:function:: BuildOleItems(spec: Union[win32com.client.selecttlb.TypelibSpec, PyIIDLike], tlb: Optional[PyITypeLib] = None) -> Tuple[Dict[PyIID, win32com.client.genpy.DispatchItem], Dict[PyIID, win32com.client.genpy.EnumerationItem], Dict[PyIID, win32com.client.genpy.RecordItem], Dict[PyIID, win32com.client.genpy.VTableItem]] + + diff --git a/_sources/autoapi/koapy/utils/rate_limiting/RateLimiter/index.rst b/_sources/autoapi/koapy/utils/rate_limiting/RateLimiter/index.rst new file mode 100644 index 00000000..70fe4f7e --- /dev/null +++ b/_sources/autoapi/koapy/utils/rate_limiting/RateLimiter/index.rst @@ -0,0 +1,64 @@ +:py:mod:`koapy.utils.rate_limiting.RateLimiter` +=============================================== + +.. py:module:: koapy.utils.rate_limiting.RateLimiter + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.utils.rate_limiting.RateLimiter.RateLimiter + koapy.utils.rate_limiting.RateLimiter.TimeWindowRateLimiter + koapy.utils.rate_limiting.RateLimiter.CompositeTimeWindowRateLimiter + + + + +.. py:class:: RateLimiter + + .. py:method:: check_sleep_seconds(self, *args, **kwargs) + + + .. py:method:: add_call_history(self, *args, **kwargs) + + + .. py:method:: sleep_if_necessary(self, *args, **kwargs) + + + .. py:method:: wrap(self, func) + + + +.. py:class:: TimeWindowRateLimiter(period, calls) + + Bases: :py:obj:`RateLimiter`, :py:obj:`koapy.utils.logging.Logging.Logging` + + .. py:method:: check_sleep_seconds(self, *args, **kwargs) + + + .. py:method:: add_call_history(self, *args, **kwargs) + + + .. py:method:: sleep_if_necessary(self, *args, **kwargs) + + + +.. py:class:: CompositeTimeWindowRateLimiter(limiters: List[RateLimiter]) + + Bases: :py:obj:`RateLimiter` + + .. py:method:: check_sleep_seconds(self, *args, **kwargs) + + + .. py:method:: add_call_history(self, *args, **kwargs) + + + .. py:method:: sleep_if_necessary(self, *args, **kwargs) + + + diff --git a/_sources/autoapi/koapy/utils/rate_limiting/index.rst b/_sources/autoapi/koapy/utils/rate_limiting/index.rst new file mode 100644 index 00000000..b8a863b2 --- /dev/null +++ b/_sources/autoapi/koapy/utils/rate_limiting/index.rst @@ -0,0 +1,24 @@ +:py:mod:`koapy.utils.rate_limiting` +=================================== + +.. py:module:: koapy.utils.rate_limiting + + +Subpackages +----------- +.. toctree:: + :titlesonly: + :maxdepth: 3 + + pyside2/index.rst + + +Submodules +---------- +.. toctree:: + :titlesonly: + :maxdepth: 1 + + RateLimiter/index.rst + + diff --git a/_sources/autoapi/koapy/utils/rate_limiting/pyside2/QRateLimitedExecutor/index.rst b/_sources/autoapi/koapy/utils/rate_limiting/pyside2/QRateLimitedExecutor/index.rst new file mode 100644 index 00000000..0e1a8a40 --- /dev/null +++ b/_sources/autoapi/koapy/utils/rate_limiting/pyside2/QRateLimitedExecutor/index.rst @@ -0,0 +1,94 @@ +:py:mod:`koapy.utils.rate_limiting.pyside2.QRateLimitedExecutor` +================================================================ + +.. py:module:: koapy.utils.rate_limiting.pyside2.QRateLimitedExecutor + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.utils.rate_limiting.pyside2.QRateLimitedExecutor.QRateLimitedExecutorRunnable + koapy.utils.rate_limiting.pyside2.QRateLimitedExecutor.QRateLimitedExecutorDecoratedFunction + koapy.utils.rate_limiting.pyside2.QRateLimitedExecutor.QRateLimitedExecutor + + + + +.. py:class:: QRateLimitedExecutorRunnable(limiter: koapy.utils.rate_limiting.RateLimiter.RateLimiter, future: concurrent.futures.Future, fn: Callable[Ellipsis, Any], args: Union[Tuple[Any], List[Any]], kwargs: Dict[str, Any]) + + .. py:method:: check_sleep_seconds(self) + + + .. py:method:: add_call_history(self) + + + .. py:method:: sleep_if_necessary(self) + + + .. py:method:: run(self) + + + .. py:method:: cancel(self) + + + .. py:method:: result(self) + + + +.. py:class:: QRateLimitedExecutorDecoratedFunction(func, limiter: koapy.utils.rate_limiting.RateLimiter.RateLimiter, executor: concurrent.futures.Executor) + + .. py:method:: call(self, *args, **kwargs) + + + .. py:method:: async_call(self, *args, **kwargs) + + + +.. py:class:: QRateLimitedExecutor(limiter: koapy.utils.rate_limiting.RateLimiter.RateLimiter, parent: Optional[koapy.compat.pyside2.QtCore.QObject] = None) + + Bases: :py:obj:`koapy.utils.logging.pyside2.QThreadLogging.QThreadLogging`, :py:obj:`concurrent.futures.Executor` + + This is an abstract base class for concrete asynchronous executors. + + .. py:attribute:: readyRunnable + + + + + .. py:method:: run(self) + + + .. py:method:: onReadyRunnable(self, runnable: QRateLimitedExecutorRunnable) + + + .. py:method:: submit(self, fn: Callable[Ellipsis, Any], *args, **kwargs) + + Submits a callable to be executed with the given arguments. + + Schedules the callable to be executed as fn(*args, **kwargs) and returns + a Future instance representing the execution of the callable. + + :returns: A Future representing the given call. + + + .. py:method:: shutdown(self, wait: bool = True, cancel_futures: bool = False) + + Clean-up the resources associated with the Executor. + + It is safe to call this method several times. Otherwise, no other + methods can be called after this one. + + :param wait: If True then shutdown will not return until all running + futures have finished executing and the resources used by the + executor have been reclaimed. + + + .. py:method:: wrap(self, func: Callable[Ellipsis, Any]) + + + diff --git a/_sources/autoapi/koapy/utils/rate_limiting/pyside2/index.rst b/_sources/autoapi/koapy/utils/rate_limiting/pyside2/index.rst new file mode 100644 index 00000000..89886b88 --- /dev/null +++ b/_sources/autoapi/koapy/utils/rate_limiting/pyside2/index.rst @@ -0,0 +1,15 @@ +:py:mod:`koapy.utils.rate_limiting.pyside2` +=========================================== + +.. py:module:: koapy.utils.rate_limiting.pyside2 + + +Submodules +---------- +.. toctree:: + :titlesonly: + :maxdepth: 1 + + QRateLimitedExecutor/index.rst + + diff --git a/_sources/autoapi/koapy/utils/recursion/index.rst b/_sources/autoapi/koapy/utils/recursion/index.rst new file mode 100644 index 00000000..8f3a2793 --- /dev/null +++ b/_sources/autoapi/koapy/utils/recursion/index.rst @@ -0,0 +1,24 @@ +:py:mod:`koapy.utils.recursion` +=============================== + +.. py:module:: koapy.utils.recursion + + +Module Contents +--------------- + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + koapy.utils.recursion.depth + + + +.. py:function:: depth() + + return recursion depth. 0 if no recursion + + diff --git a/_sources/autoapi/koapy/utils/serialization/index.rst b/_sources/autoapi/koapy/utils/serialization/index.rst new file mode 100644 index 00000000..47cedca6 --- /dev/null +++ b/_sources/autoapi/koapy/utils/serialization/index.rst @@ -0,0 +1,36 @@ +:py:mod:`koapy.utils.serialization` +=================================== + +.. py:module:: koapy.utils.serialization + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.utils.serialization.JsonSerializable + + + + +.. py:class:: JsonSerializable + + .. py:method:: to_dict(self) + + + .. py:method:: from_dict(cls, dic) + :classmethod: + + + .. py:method:: to_json(self, f=None, encoding=None) + + + .. py:method:: from_json(cls, jsn, encoding=None) + :classmethod: + + + diff --git a/_sources/autoapi/koapy/utils/store/SQLiteFileLibrary/index.rst b/_sources/autoapi/koapy/utils/store/SQLiteFileLibrary/index.rst new file mode 100644 index 00000000..8cab8a30 --- /dev/null +++ b/_sources/autoapi/koapy/utils/store/SQLiteFileLibrary/index.rst @@ -0,0 +1,43 @@ +:py:mod:`koapy.utils.store.SQLiteFileLibrary` +============================================= + +.. py:module:: koapy.utils.store.SQLiteFileLibrary + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.utils.store.SQLiteFileLibrary.SQLiteFileLibrary + + + + +.. py:class:: SQLiteFileLibrary(filename) + + .. py:method:: list_symbols(self) + + + .. py:method:: has_symbol(self, symbol) + + + .. py:method:: write(self, symbol, data) + + + .. py:method:: read_as_dataframe(self, symbol, time_column=None, start_time=None, end_time=None) + + + .. py:method:: read_as_cursor(self, symbol, time_column=None, start_time=None, end_time=None) + + + .. py:method:: read(self, *args, **kwargs) + + + .. py:method:: delete(self, symbol) + + + diff --git a/_sources/autoapi/koapy/utils/store/SQLiteStore/index.rst b/_sources/autoapi/koapy/utils/store/SQLiteStore/index.rst new file mode 100644 index 00000000..16f67439 --- /dev/null +++ b/_sources/autoapi/koapy/utils/store/SQLiteStore/index.rst @@ -0,0 +1,40 @@ +:py:mod:`koapy.utils.store.SQLiteStore` +======================================= + +.. py:module:: koapy.utils.store.SQLiteStore + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.utils.store.SQLiteStore.SQLiteStore + + + + +.. py:class:: SQLiteStore(filename) + + .. py:method:: list_libraries(self) + + + .. py:method:: library_exists(self, library) + + + .. py:method:: initialize_library(self, library) + + + .. py:method:: get_library(self, library) + + + .. py:method:: get_or_create_library(self, library) + + + .. py:method:: delete_library(self, library) + + + diff --git a/_sources/autoapi/koapy/utils/store/SQLiteStoreLibrary/index.rst b/_sources/autoapi/koapy/utils/store/SQLiteStoreLibrary/index.rst new file mode 100644 index 00000000..ef013066 --- /dev/null +++ b/_sources/autoapi/koapy/utils/store/SQLiteStoreLibrary/index.rst @@ -0,0 +1,55 @@ +:py:mod:`koapy.utils.store.SQLiteStoreLibrary` +============================================== + +.. py:module:: koapy.utils.store.SQLiteStoreLibrary + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.utils.store.SQLiteStoreLibrary.SQLiteStoreLibrary + + + + +.. py:class:: SQLiteStoreLibrary(store, library) + + .. py:method:: list_symbols(self, all_symbols=False, snapshot=None) + + + .. py:method:: has_symbol(self, symbol) + + + .. py:method:: list_versions(self, symbol=None, snapshot=None, latest_only=False) + + + .. py:method:: write(self, symbol, data, metadata=None, prune_previous_version=True, **kwargs) + + + .. py:method:: read_as_dataframe(self, symbol, as_of=None, time_column=None, start_time=None, end_time=None) + + + .. py:method:: read_as_cursor(self, symbol, as_of=None, time_column=None, start_time=None, end_time=None) + + + .. py:method:: read(self, *args, **kwargs) + + + .. py:method:: delete(self, symbol) + + + .. py:method:: list_snapshots(self) + + + .. py:method:: snapshot(self, snapshot) + + + .. py:method:: delete_snapshot(self, snapshot) + + + diff --git a/_sources/autoapi/koapy/utils/store/index.rst b/_sources/autoapi/koapy/utils/store/index.rst new file mode 100644 index 00000000..8522dc2a --- /dev/null +++ b/_sources/autoapi/koapy/utils/store/index.rst @@ -0,0 +1,61 @@ +:py:mod:`koapy.utils.store` +=========================== + +.. py:module:: koapy.utils.store + + +Subpackages +----------- +.. toctree:: + :titlesonly: + :maxdepth: 3 + + misc/index.rst + sqlalchemy/index.rst + + +Submodules +---------- +.. toctree:: + :titlesonly: + :maxdepth: 1 + + SQLiteFileLibrary/index.rst + SQLiteStore/index.rst + SQLiteStoreLibrary/index.rst + + +Package Contents +---------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.utils.store.SQLiteStore + + + + +.. py:class:: SQLiteStore(filename) + + .. py:method:: list_libraries(self) + + + .. py:method:: library_exists(self, library) + + + .. py:method:: initialize_library(self, library) + + + .. py:method:: get_library(self, library) + + + .. py:method:: get_or_create_library(self, library) + + + .. py:method:: delete_library(self, library) + + + diff --git a/_sources/autoapi/koapy/utils/store/misc/VersionedItem/index.rst b/_sources/autoapi/koapy/utils/store/misc/VersionedItem/index.rst new file mode 100644 index 00000000..b6be6b91 --- /dev/null +++ b/_sources/autoapi/koapy/utils/store/misc/VersionedItem/index.rst @@ -0,0 +1,22 @@ +:py:mod:`koapy.utils.store.misc.VersionedItem` +============================================== + +.. py:module:: koapy.utils.store.misc.VersionedItem + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.utils.store.misc.VersionedItem.VersionedItem + + + + +.. py:class:: VersionedItem(library, symbol, version, timestamp, data, metadata) + + diff --git a/_sources/autoapi/koapy/utils/store/misc/index.rst b/_sources/autoapi/koapy/utils/store/misc/index.rst new file mode 100644 index 00000000..db0f9425 --- /dev/null +++ b/_sources/autoapi/koapy/utils/store/misc/index.rst @@ -0,0 +1,15 @@ +:py:mod:`koapy.utils.store.misc` +================================ + +.. py:module:: koapy.utils.store.misc + + +Submodules +---------- +.. toctree:: + :titlesonly: + :maxdepth: 1 + + VersionedItem/index.rst + + diff --git a/_sources/autoapi/koapy/utils/store/sqlalchemy/Base/index.rst b/_sources/autoapi/koapy/utils/store/sqlalchemy/Base/index.rst new file mode 100644 index 00000000..a8ee4e84 --- /dev/null +++ b/_sources/autoapi/koapy/utils/store/sqlalchemy/Base/index.rst @@ -0,0 +1,14 @@ +:py:mod:`koapy.utils.store.sqlalchemy.Base` +=========================================== + +.. py:module:: koapy.utils.store.sqlalchemy.Base + + +Module Contents +--------------- + +.. py:data:: Base + + + + diff --git a/_sources/autoapi/koapy/utils/store/sqlalchemy/Library/index.rst b/_sources/autoapi/koapy/utils/store/sqlalchemy/Library/index.rst new file mode 100644 index 00000000..38175ad9 --- /dev/null +++ b/_sources/autoapi/koapy/utils/store/sqlalchemy/Library/index.rst @@ -0,0 +1,68 @@ +:py:mod:`koapy.utils.store.sqlalchemy.Library` +============================================== + +.. py:module:: koapy.utils.store.sqlalchemy.Library + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.utils.store.sqlalchemy.Library.Library + + + + +.. py:class:: Library + + Bases: :py:obj:`koapy.utils.store.sqlalchemy.Base.Base` + + .. py:attribute:: id + + + + + .. py:attribute:: name + + + + + .. py:attribute:: symbols + + + + + .. py:attribute:: snapshots + + + + + .. py:method:: get_symbol(self, symbol, deleted=False) + + + .. py:method:: get_or_create_symbol(self, symbol) + + + .. py:method:: get_symbols(self, deleted=False) + + + .. py:method:: get_versions(self, deleted=False) + + + .. py:method:: get_latest_versions(self, deleted=False) + + + .. py:method:: get_snapshot(self, snapshot) + + + .. py:method:: create_snapshot(self, snapshot) + + + .. py:method:: delete(self) + + + diff --git a/_sources/autoapi/koapy/utils/store/sqlalchemy/Session/index.rst b/_sources/autoapi/koapy/utils/store/sqlalchemy/Session/index.rst new file mode 100644 index 00000000..1f84a044 --- /dev/null +++ b/_sources/autoapi/koapy/utils/store/sqlalchemy/Session/index.rst @@ -0,0 +1,14 @@ +:py:mod:`koapy.utils.store.sqlalchemy.Session` +============================================== + +.. py:module:: koapy.utils.store.sqlalchemy.Session + + +Module Contents +--------------- + +.. py:data:: Session + + + + diff --git a/_sources/autoapi/koapy/utils/store/sqlalchemy/Snapshot/index.rst b/_sources/autoapi/koapy/utils/store/sqlalchemy/Snapshot/index.rst new file mode 100644 index 00000000..1caefe78 --- /dev/null +++ b/_sources/autoapi/koapy/utils/store/sqlalchemy/Snapshot/index.rst @@ -0,0 +1,66 @@ +:py:mod:`koapy.utils.store.sqlalchemy.Snapshot` +=============================================== + +.. py:module:: koapy.utils.store.sqlalchemy.Snapshot + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.utils.store.sqlalchemy.Snapshot.Snapshot + + + + +.. py:class:: Snapshot + + Bases: :py:obj:`koapy.utils.store.sqlalchemy.Base.Base` + + .. py:attribute:: id + + + + + .. py:attribute:: name + + + + + .. py:attribute:: timestamp + + + + + .. py:attribute:: library_id + + + + + .. py:attribute:: library + + + + + .. py:attribute:: versions + + + + + .. py:method:: get_symbols(self) + + + .. py:method:: get_versions(self) + + + .. py:method:: get_version_of_symbol(self, symbol) + + + .. py:method:: delete(self) + + + diff --git a/_sources/autoapi/koapy/utils/store/sqlalchemy/SnapshotAssociation/index.rst b/_sources/autoapi/koapy/utils/store/sqlalchemy/SnapshotAssociation/index.rst new file mode 100644 index 00000000..bec8f489 --- /dev/null +++ b/_sources/autoapi/koapy/utils/store/sqlalchemy/SnapshotAssociation/index.rst @@ -0,0 +1,44 @@ +:py:mod:`koapy.utils.store.sqlalchemy.SnapshotAssociation` +========================================================== + +.. py:module:: koapy.utils.store.sqlalchemy.SnapshotAssociation + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.utils.store.sqlalchemy.SnapshotAssociation.SnapshotAssociation + + + + +.. py:class:: SnapshotAssociation + + Bases: :py:obj:`koapy.utils.store.sqlalchemy.Base.Base` + + .. py:attribute:: snapshot_id + + + + + .. py:attribute:: version_id + + + + + .. py:attribute:: snapshot + + + + + .. py:attribute:: version + + + + + diff --git a/_sources/autoapi/koapy/utils/store/sqlalchemy/Symbol/index.rst b/_sources/autoapi/koapy/utils/store/sqlalchemy/Symbol/index.rst new file mode 100644 index 00000000..3db303ea --- /dev/null +++ b/_sources/autoapi/koapy/utils/store/sqlalchemy/Symbol/index.rst @@ -0,0 +1,75 @@ +:py:mod:`koapy.utils.store.sqlalchemy.Symbol` +============================================= + +.. py:module:: koapy.utils.store.sqlalchemy.Symbol + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.utils.store.sqlalchemy.Symbol.Symbol + + + + +.. py:class:: Symbol + + Bases: :py:obj:`koapy.utils.store.sqlalchemy.Base.Base` + + .. py:attribute:: id + + + + + .. py:attribute:: name + + + + + .. py:attribute:: library_id + + + + + .. py:attribute:: library + + + + + .. py:attribute:: versions + + + + + .. py:method:: get_versions(self, deleted=False) + + versions = self.versions + if not deleted: + versions = [version for version in versions if not version.deleted] + + + .. py:method:: get_latest_version(self, deleted=False) + + versions = self.versions + if len(versions) == 0: + raise NoResultFound + latest_version = self.versions[-1] + if not deleted and latest_version.deleted: + raise NoResultFound + + + .. py:method:: create_new_version(self, table_name=None, user_metadata=None, pandas_metadata=None, deleted=None) + + + .. py:method:: get_version_by_number(self, version_number, deleted=False) + + + .. py:method:: get_prunable_versions(self, keep_mins=120) + + + diff --git a/_sources/autoapi/koapy/utils/store/sqlalchemy/Timestamp/index.rst b/_sources/autoapi/koapy/utils/store/sqlalchemy/Timestamp/index.rst new file mode 100644 index 00000000..567c136f --- /dev/null +++ b/_sources/autoapi/koapy/utils/store/sqlalchemy/Timestamp/index.rst @@ -0,0 +1,219 @@ +:py:mod:`koapy.utils.store.sqlalchemy.Timestamp` +================================================ + +.. py:module:: koapy.utils.store.sqlalchemy.Timestamp + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.utils.store.sqlalchemy.Timestamp.Timestamp + + + + +.. py:class:: Timestamp(*args, **kwargs) + + Bases: :py:obj:`sqlalchemy.types.TypeDecorator` + + Allows the creation of types which add additional functionality + to an existing type. + + This method is preferred to direct subclassing of SQLAlchemy's + built-in types as it ensures that all required functionality of + the underlying type is kept in place. + + Typical usage:: + + import sqlalchemy.types as types + + class MyType(types.TypeDecorator): + '''Prefixes Unicode values with "PREFIX:" on the way in and + strips it off on the way out. + ''' + + impl = types.Unicode + + cache_ok = True + + def process_bind_param(self, value, dialect): + return "PREFIX:" + value + + def process_result_value(self, value, dialect): + return value[7:] + + def copy(self, **kw): + return MyType(self.impl.length) + + The class-level ``impl`` attribute is required, and can reference any + :class:`.TypeEngine` class. Alternatively, the :meth:`load_dialect_impl` + method can be used to provide different type classes based on the dialect + given; in this case, the ``impl`` variable can reference + ``TypeEngine`` as a placeholder. + + The :attr:`.TypeDecorator.cache_ok` class-level flag indicates if this + custom :class:`.TypeDecorator` is safe to be used as part of a cache key. + This flag defaults to ``None`` which will initially generate a warning + when the SQL compiler attempts to generate a cache key for a statement + that uses this type. If the :class:`.TypeDecorator` is not guaranteed + to produce the same bind/result behavior and SQL generation + every time, this flag should be set to ``False``; otherwise if the + class produces the same behavior each time, it may be set to ``True``. + See :attr:`.TypeDecorator.cache_ok` for further notes on how this works. + + Types that receive a Python type that isn't similar to the ultimate type + used may want to define the :meth:`TypeDecorator.coerce_compared_value` + method. This is used to give the expression system a hint when coercing + Python objects into bind parameters within expressions. Consider this + expression:: + + mytable.c.somecol + datetime.date(2009, 5, 15) + + Above, if "somecol" is an ``Integer`` variant, it makes sense that + we're doing date arithmetic, where above is usually interpreted + by databases as adding a number of days to the given date. + The expression system does the right thing by not attempting to + coerce the "date()" value into an integer-oriented bind parameter. + + However, in the case of ``TypeDecorator``, we are usually changing an + incoming Python type to something new - ``TypeDecorator`` by default will + "coerce" the non-typed side to be the same type as itself. Such as below, + we define an "epoch" type that stores a date value as an integer:: + + class MyEpochType(types.TypeDecorator): + impl = types.Integer + + epoch = datetime.date(1970, 1, 1) + + def process_bind_param(self, value, dialect): + return (value - self.epoch).days + + def process_result_value(self, value, dialect): + return self.epoch + timedelta(days=value) + + Our expression of ``somecol + date`` with the above type will coerce the + "date" on the right side to also be treated as ``MyEpochType``. + + This behavior can be overridden via the + :meth:`~TypeDecorator.coerce_compared_value` method, which returns a type + that should be used for the value of the expression. Below we set it such + that an integer value will be treated as an ``Integer``, and any other + value is assumed to be a date and will be treated as a ``MyEpochType``:: + + def coerce_compared_value(self, op, value): + if isinstance(value, int): + return Integer() + else: + return self + + .. warning:: + + Note that the **behavior of coerce_compared_value is not inherited + by default from that of the base type**. + If the :class:`.TypeDecorator` is augmenting a + type that requires special logic for certain types of operators, + this method **must** be overridden. A key example is when decorating + the :class:`_postgresql.JSON` and :class:`_postgresql.JSONB` types; + the default rules of :meth:`.TypeEngine.coerce_compared_value` should + be used in order to deal with operators like index operations:: + + class MyJsonType(TypeDecorator): + impl = postgresql.JSON + + cache_ok = True + + def coerce_compared_value(self, op, value): + return self.impl.coerce_compared_value(op, value) + + Without the above step, index operations such as ``mycol['foo']`` + will cause the index value ``'foo'`` to be JSON encoded. + + + .. py:attribute:: impl + + + + + .. py:attribute:: cache_ok + :annotation: = True + + + + .. py:attribute:: signature + + + + + .. py:attribute:: utc + + + + + .. py:attribute:: local_timezone + + + + + .. py:method:: is_naive(cls, value) + :classmethod: + + + .. py:method:: process_bind_param(self, value, dialect) + + Receive a bound parameter value to be converted. + + Custom subclasses of :class:`_types.TypeDecorator` should override + this method to provide custom behaviors for incoming data values. + This method is called at **statement execution time** and is passed + the literal Python data value which is to be associated with a bound + parameter in the statement. + + The operation could be anything desired to perform custom + behavior, such as transforming or serializing data. + This could also be used as a hook for validating logic. + + :param value: Data to operate upon, of any type expected by + this method in the subclass. Can be ``None``. + :param dialect: the :class:`.Dialect` in use. + + .. seealso:: + + :ref:`types_typedecorator` + + :meth:`_types.TypeDecorator.process_result_value` + + + + .. py:method:: process_result_value(self, value, dialect) + + Receive a result-row column value to be converted. + + Custom subclasses of :class:`_types.TypeDecorator` should override + this method to provide custom behaviors for data values + being received in result rows coming from the database. + This method is called at **result fetching time** and is passed + the literal Python data value that's extracted from a database result + row. + + The operation could be anything desired to perform custom + behavior, such as transforming or deserializing data. + + :param value: Data to operate upon, of any type expected by + this method in the subclass. Can be ``None``. + :param dialect: the :class:`.Dialect` in use. + + .. seealso:: + + :ref:`types_typedecorator` + + :meth:`_types.TypeDecorator.process_bind_param` + + + + + diff --git a/_sources/autoapi/koapy/utils/store/sqlalchemy/Version/index.rst b/_sources/autoapi/koapy/utils/store/sqlalchemy/Version/index.rst new file mode 100644 index 00000000..1015bcc5 --- /dev/null +++ b/_sources/autoapi/koapy/utils/store/sqlalchemy/Version/index.rst @@ -0,0 +1,80 @@ +:py:mod:`koapy.utils.store.sqlalchemy.Version` +============================================== + +.. py:module:: koapy.utils.store.sqlalchemy.Version + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.utils.store.sqlalchemy.Version.Version + + + + +.. py:class:: Version + + Bases: :py:obj:`koapy.utils.store.sqlalchemy.Base.Base` + + .. py:attribute:: id + + + + + .. py:attribute:: version + + + + + .. py:attribute:: table_name + + + + + .. py:attribute:: user_metadata + + + + + .. py:attribute:: pandas_metadata + + + + + .. py:attribute:: deleted + + + + + .. py:attribute:: timestamp + + + + + .. py:attribute:: symbol_id + + + + + .. py:attribute:: symbol + + + + + .. py:attribute:: snapshots + + + + + .. py:method:: get_snapshots(self) + + + .. py:method:: delete(self) + + + diff --git a/_sources/autoapi/koapy/utils/store/sqlalchemy/index.rst b/_sources/autoapi/koapy/utils/store/sqlalchemy/index.rst new file mode 100644 index 00000000..5c06dea8 --- /dev/null +++ b/_sources/autoapi/koapy/utils/store/sqlalchemy/index.rst @@ -0,0 +1,22 @@ +:py:mod:`koapy.utils.store.sqlalchemy` +====================================== + +.. py:module:: koapy.utils.store.sqlalchemy + + +Submodules +---------- +.. toctree:: + :titlesonly: + :maxdepth: 1 + + Base/index.rst + Library/index.rst + Session/index.rst + Snapshot/index.rst + SnapshotAssociation/index.rst + Symbol/index.rst + Timestamp/index.rst + Version/index.rst + + diff --git a/_sources/autoapi/koapy/utils/subprocess/index.rst b/_sources/autoapi/koapy/utils/subprocess/index.rst new file mode 100644 index 00000000..c39f0f8d --- /dev/null +++ b/_sources/autoapi/koapy/utils/subprocess/index.rst @@ -0,0 +1,86 @@ +:py:mod:`koapy.utils.subprocess` +================================ + +.. py:module:: koapy.utils.subprocess + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.utils.subprocess.Popen + + + +Functions +~~~~~~~~~ + +.. autoapisummary:: + + koapy.utils.subprocess.function_to_script + koapy.utils.subprocess.function_to_subprocess_args + koapy.utils.subprocess.run_file + koapy.utils.subprocess.run_script + koapy.utils.subprocess.run_function + koapy.utils.subprocess.quote + koapy.utils.subprocess.run_as_admin + koapy.utils.subprocess.create_job_object_for_cleanup + koapy.utils.subprocess.make_process_die_when_parent_dies + + + +Attributes +~~~~~~~~~~ + +.. autoapisummary:: + + koapy.utils.subprocess.logger + koapy.utils.subprocess.job_handle + + +.. py:data:: logger + + + + +.. py:function:: function_to_script(func) + + +.. py:function:: function_to_subprocess_args(func, executable=None) + + +.. py:function:: run_file(filename, *args, executable=None, **kwargs) + + +.. py:function:: run_script(script, *args, executable=None, **kwargs) + + +.. py:function:: run_function(function, *args, executable=None, **kwargs) + + +.. py:function:: quote(s) + + +.. py:function:: run_as_admin(cmd, cwd=None, check=True, wait=True) + + +.. py:function:: create_job_object_for_cleanup() + + +.. py:data:: job_handle + + + + +.. py:function:: make_process_die_when_parent_dies(pid) + + +.. py:class:: Popen(*args, **kwargs) + + Bases: :py:obj:`subprocess.Popen` + + diff --git a/_sources/autoapi/koapy/utils/threading/index.rst b/_sources/autoapi/koapy/utils/threading/index.rst new file mode 100644 index 00000000..1a98256b --- /dev/null +++ b/_sources/autoapi/koapy/utils/threading/index.rst @@ -0,0 +1,26 @@ +:py:mod:`koapy.utils.threading` +=============================== + +.. py:module:: koapy.utils.threading + + +Module Contents +--------------- + +Classes +~~~~~~~ + +.. autoapisummary:: + + koapy.utils.threading.Singleton + + + + +.. py:class:: Singleton + + .. py:method:: get_instance(cls, *args, **kwargs) + :classmethod: + + + diff --git a/docs/source/contributing.rst b/_sources/contributing.rst similarity index 100% rename from docs/source/contributing.rst rename to _sources/contributing.rst diff --git a/docs/source/history.rst b/_sources/history.rst similarity index 100% rename from docs/source/history.rst rename to _sources/history.rst diff --git a/docs/source/index.rst b/_sources/index.rst similarity index 100% rename from docs/source/index.rst rename to _sources/index.rst diff --git a/docs/source/installation.rst b/_sources/installation.rst similarity index 100% rename from docs/source/installation.rst rename to _sources/installation.rst diff --git a/docs/source/notebooks/getting-historical-stock-price-data.rst b/_sources/notebooks/getting-historical-stock-price-data.rst similarity index 100% rename from docs/source/notebooks/getting-historical-stock-price-data.rst rename to _sources/notebooks/getting-historical-stock-price-data.rst diff --git a/docs/source/notebooks/index.rst b/_sources/notebooks/index.rst similarity index 100% rename from docs/source/notebooks/index.rst rename to _sources/notebooks/index.rst diff --git a/docs/source/notebooks/koapy-tutorial.rst b/_sources/notebooks/koapy-tutorial.rst similarity index 100% rename from docs/source/notebooks/koapy-tutorial.rst rename to _sources/notebooks/koapy-tutorial.rst diff --git a/docs/source/readme.rst b/_sources/readme.rst similarity index 100% rename from docs/source/readme.rst rename to _sources/readme.rst diff --git a/docs/source/usage.rst b/_sources/usage.rst similarity index 100% rename from docs/source/usage.rst rename to _sources/usage.rst diff --git a/_static/alabaster.css b/_static/alabaster.css new file mode 100644 index 00000000..dc404f5c --- /dev/null +++ b/_static/alabaster.css @@ -0,0 +1,707 @@ +@import url("basic.css"); + +/* -- page layout ----------------------------------------------------------- */ + +body { + font-family: 'Noto Serif KR', Georgia, 'Times New Roman', Times, serif; + font-size: 17px; + background-color: #fff; + color: #000; + margin: 0; + padding: 0; +} + + +div.document { + width: 940px; + margin: 30px auto 0 auto; +} + +div.documentwrapper { + float: left; + width: 100%; +} + +div.bodywrapper { + margin: 0 0 0 220px; +} + +div.sphinxsidebar { + width: 220px; + font-size: 14px; + line-height: 1.5; +} + +hr { + border: 1px solid #B1B4B6; +} + +div.body { + background-color: #fff; + color: #3E4349; + padding: 0 30px 0 30px; +} + +div.body > .section { + text-align: left; +} + +div.footer { + width: 940px; + margin: 20px auto 30px auto; + font-size: 14px; + color: #888; + text-align: right; +} + +div.footer a { + color: #888; +} + +p.caption { + font-family: inherit; + font-size: inherit; +} + + +div.relations { + display: none; +} + + +div.sphinxsidebar a { + color: #444; + text-decoration: none; + border-bottom: 1px dotted #999; +} + +div.sphinxsidebar a:hover { + border-bottom: 1px solid #999; +} + +div.sphinxsidebarwrapper { + padding: 18px 10px; +} + +div.sphinxsidebarwrapper p.logo { + padding: 0; + margin: -10px 0 0 0px; + text-align: center; +} + +div.sphinxsidebarwrapper h1.logo { + margin-top: -10px; + text-align: center; + margin-bottom: 5px; + text-align: left; +} + +div.sphinxsidebarwrapper h1.logo-name { + margin-top: 0px; +} + +div.sphinxsidebarwrapper p.blurb { + margin-top: 0; + font-style: normal; +} + +div.sphinxsidebar h3, +div.sphinxsidebar h4 { + font-family: 'Noto Serif KR', Georgia, 'Times New Roman', Times, serif; + color: #444; + font-size: 24px; + font-weight: normal; + margin: 0 0 5px 0; + padding: 0; +} + +div.sphinxsidebar h4 { + font-size: 20px; +} + +div.sphinxsidebar h3 a { + color: #444; +} + +div.sphinxsidebar p.logo a, +div.sphinxsidebar h3 a, +div.sphinxsidebar p.logo a:hover, +div.sphinxsidebar h3 a:hover { + border: none; +} + +div.sphinxsidebar p { + color: #555; + margin: 10px 0; +} + +div.sphinxsidebar ul { + margin: 10px 0; + padding: 0; + color: #000; +} + +div.sphinxsidebar ul li.toctree-l1 > a { + font-size: 120%; +} + +div.sphinxsidebar ul li.toctree-l2 > a { + font-size: 110%; +} + +div.sphinxsidebar input { + border: 1px solid #CCC; + font-family: 'Noto Serif KR', Georgia, 'Times New Roman', Times, serif; + font-size: 1em; +} + +div.sphinxsidebar hr { + border: none; + height: 1px; + color: #AAA; + background: #AAA; + + text-align: left; + margin-left: 0; + width: 50%; +} + +div.sphinxsidebar .badge { + border-bottom: none; +} + +div.sphinxsidebar .badge:hover { + border-bottom: none; +} + +/* To address an issue with donation coming after search */ +div.sphinxsidebar h3.donation { + margin-top: 10px; +} + +/* -- body styles ----------------------------------------------------------- */ + +a { + color: #004B6B; + text-decoration: underline; +} + +a:hover { + color: #6D4100; + text-decoration: underline; +} + +div.body h1, +div.body h2, +div.body h3, +div.body h4, +div.body h5, +div.body h6 { + font-family: 'Noto Serif KR', Georgia, 'Times New Roman', Times, serif; + font-weight: normal; + margin: 30px 0px 10px 0px; + padding: 0; +} + +div.body h1 { margin-top: 0; padding-top: 0; font-size: 240%; } +div.body h2 { font-size: 180%; } +div.body h3 { font-size: 150%; } +div.body h4 { font-size: 130%; } +div.body h5 { font-size: 100%; } +div.body h6 { font-size: 100%; } + +a.headerlink { + color: #DDD; + padding: 0 4px; + text-decoration: none; +} + +a.headerlink:hover { + color: #444; + background: #EAEAEA; +} + +div.body p, div.body dd, div.body li { + line-height: 1.4em; +} + +div.admonition { + margin: 20px 0px; + padding: 10px 30px; + background-color: #EEE; + border: 1px solid #CCC; +} + +div.admonition tt.xref, div.admonition code.xref, div.admonition a tt { + background-color: #FBFBFB; + border-bottom: 1px solid #fafafa; +} + +div.admonition p.admonition-title { + font-family: 'Noto Serif KR', Georgia, 'Times New Roman', Times, serif; + font-weight: normal; + font-size: 24px; + margin: 0 0 10px 0; + padding: 0; + line-height: 1; +} + +div.admonition p.last { + margin-bottom: 0; +} + +div.highlight { + background-color: #fff; +} + +dt:target, .highlight { + background: #FAF3E8; +} + +div.warning { + background-color: #FCC; + border: 1px solid #FAA; +} + +div.danger { + background-color: #FCC; + border: 1px solid #FAA; + -moz-box-shadow: 2px 2px 4px #D52C2C; + -webkit-box-shadow: 2px 2px 4px #D52C2C; + box-shadow: 2px 2px 4px #D52C2C; +} + +div.error { + background-color: #FCC; + border: 1px solid #FAA; + -moz-box-shadow: 2px 2px 4px #D52C2C; + -webkit-box-shadow: 2px 2px 4px #D52C2C; + box-shadow: 2px 2px 4px #D52C2C; +} + +div.caution { + background-color: #FCC; + border: 1px solid #FAA; +} + +div.attention { + background-color: #FCC; + border: 1px solid #FAA; +} + +div.important { + background-color: #EEE; + border: 1px solid #CCC; +} + +div.note { + background-color: #EEE; + border: 1px solid #CCC; +} + +div.tip { + background-color: #EEE; + border: 1px solid #CCC; +} + +div.hint { + background-color: #EEE; + border: 1px solid #CCC; +} + +div.seealso { + background-color: #EEE; + border: 1px solid #CCC; +} + +div.topic { + background-color: #EEE; +} + +p.admonition-title { + display: inline; +} + +p.admonition-title:after { + content: ":"; +} + +pre, tt, code { + font-family: 'D2Coding', 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace; + font-size: 0.9em; +} + +.hll { + background-color: #FFC; + margin: 0 -12px; + padding: 0 12px; + display: block; +} + +img.screenshot { +} + +tt.descname, tt.descclassname, code.descname, code.descclassname { + font-size: 0.95em; +} + +tt.descname, code.descname { + padding-right: 0.08em; +} + +img.screenshot { + -moz-box-shadow: 2px 2px 4px #EEE; + -webkit-box-shadow: 2px 2px 4px #EEE; + box-shadow: 2px 2px 4px #EEE; +} + +table.docutils { + border: 1px solid #888; + -moz-box-shadow: 2px 2px 4px #EEE; + -webkit-box-shadow: 2px 2px 4px #EEE; + box-shadow: 2px 2px 4px #EEE; +} + +table.docutils td, table.docutils th { + border: 1px solid #888; + padding: 0.25em 0.7em; +} + +table.field-list, table.footnote { + border: none; + -moz-box-shadow: none; + -webkit-box-shadow: none; + box-shadow: none; +} + +table.footnote { + margin: 15px 0; + width: 100%; + border: 1px solid #EEE; + background: #FDFDFD; + font-size: 0.9em; +} + +table.footnote + table.footnote { + margin-top: -15px; + border-top: none; +} + +table.field-list th { + padding: 0 0.8em 0 0; +} + +table.field-list td { + padding: 0; +} + +table.field-list p { + margin-bottom: 0.8em; +} + +/* Cloned from + * https://github.com/sphinx-doc/sphinx/commit/ef60dbfce09286b20b7385333d63a60321784e68 + */ +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +table.footnote td.label { + width: .1px; + padding: 0.3em 0 0.3em 0.5em; +} + +table.footnote td { + padding: 0.3em 0.5em; +} + +dl { + margin: 0; + padding: 0; +} + +dl dd { + margin-left: 30px; +} + +blockquote { + margin: 0 0 0 30px; + padding: 0; +} + +ul, ol { + /* Matches the 30px from the narrow-screen "li > ul" selector below */ + margin: 10px 0 10px 30px; + padding: 0; +} + +pre { + background: #EEE; + padding: 7px 30px; + margin: 15px 0px; + line-height: 1.3em; +} + +div.viewcode-block:target { + background: #ffd; +} + +dl pre, blockquote pre, li pre { + margin-left: 0; + padding-left: 30px; +} + +tt, code { + background-color: #ecf0f3; + color: #222; + /* padding: 1px 2px; */ +} + +tt.xref, code.xref, a tt { + background-color: #FBFBFB; + border-bottom: 1px solid #fff; +} + +a.reference { + text-decoration: none; + border-bottom: 1px dotted #004B6B; +} + +/* Don't put an underline on images */ +a.image-reference, a.image-reference:hover { + border-bottom: none; +} + +a.reference:hover { + border-bottom: 1px solid #6D4100; +} + +a.footnote-reference { + text-decoration: none; + font-size: 0.7em; + vertical-align: top; + border-bottom: 1px dotted #004B6B; +} + +a.footnote-reference:hover { + border-bottom: 1px solid #6D4100; +} + +a:hover tt, a:hover code { + background: #EEE; +} + + +@media screen and (max-width: 870px) { + + div.sphinxsidebar { + display: none; + } + + div.document { + width: 100%; + + } + + div.documentwrapper { + margin-left: 0; + margin-top: 0; + margin-right: 0; + margin-bottom: 0; + } + + div.bodywrapper { + margin-top: 0; + margin-right: 0; + margin-bottom: 0; + margin-left: 0; + } + + ul { + margin-left: 0; + } + + li > ul { + /* Matches the 30px from the "ul, ol" selector above */ + margin-left: 30px; + } + + .document { + width: auto; + } + + .footer { + width: auto; + } + + .bodywrapper { + margin: 0; + } + + .footer { + width: auto; + } + + .github { + display: none; + } + + + +} + + + +@media screen and (max-width: 875px) { + + body { + margin: 0; + padding: 20px 30px; + } + + div.documentwrapper { + float: none; + background: #fff; + } + + div.sphinxsidebar { + display: block; + float: none; + width: 102.5%; + margin: -20px -30px 20px -30px; + padding: 10px 20px; + background: #333; + color: #FFF; + } + + div.sphinxsidebar h3, div.sphinxsidebar h4, div.sphinxsidebar p, + div.sphinxsidebar h3 a { + color: #fff; + } + + div.sphinxsidebar a { + color: #AAA; + } + + div.sphinxsidebar p.logo { + display: none; + } + + div.document { + width: 100%; + margin: 0; + } + + div.footer { + display: none; + } + + div.bodywrapper { + margin: 0; + } + + div.body { + min-height: 0; + padding: 0; + } + + .rtd_doc_footer { + display: none; + } + + .document { + width: auto; + } + + .footer { + width: auto; + } + + .footer { + width: auto; + } + + .github { + display: none; + } +} +@media screen and (min-width: 876px) { + div.sphinxsidebar { + position: fixed; + margin-left: 0; + } +} + + +/* misc. */ + +.revsys-inline { + display: none!important; +} + +/* Make nested-list/multi-paragraph items look better in Releases changelog + * pages. Without this, docutils' magical list fuckery causes inconsistent + * formatting between different release sub-lists. + */ +div#changelog > div.section > ul > li > p:only-child { + margin-bottom: 0; +} + +/* Hide fugly table cell borders in ..bibliography:: directive output */ +table.docutils.citation, table.docutils.citation td, table.docutils.citation th { + border: none; + /* Below needed in some edge cases; if not applied, bottom shadows appear */ + -moz-box-shadow: none; + -webkit-box-shadow: none; + box-shadow: none; +} + + +/* relbar */ + +.related { + line-height: 30px; + width: 100%; + font-size: 0.9rem; +} + +.related.top { + border-bottom: 1px solid #EEE; + margin-bottom: 20px; +} + +.related.bottom { + border-top: 1px solid #EEE; +} + +.related ul { + padding: 0; + margin: 0; + list-style: none; +} + +.related li { + display: inline; +} + +nav#rellinks { + float: right; +} + +nav#rellinks li+li:before { + content: "|"; +} + +nav#breadcrumbs li+li:before { + content: "\00BB"; +} + +/* Hide certain items when printing */ +@media print { + div.related { + display: none; + } +} \ No newline at end of file diff --git a/_static/basic.css b/_static/basic.css new file mode 100644 index 00000000..bf18350b --- /dev/null +++ b/_static/basic.css @@ -0,0 +1,906 @@ +/* + * basic.css + * ~~~~~~~~~ + * + * Sphinx stylesheet -- basic theme. + * + * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/* -- main layout ----------------------------------------------------------- */ + +div.clearer { + clear: both; +} + +div.section::after { + display: block; + content: ''; + clear: left; +} + +/* -- relbar ---------------------------------------------------------------- */ + +div.related { + width: 100%; + font-size: 90%; +} + +div.related h3 { + display: none; +} + +div.related ul { + margin: 0; + padding: 0 0 0 10px; + list-style: none; +} + +div.related li { + display: inline; +} + +div.related li.right { + float: right; + margin-right: 5px; +} + +/* -- sidebar --------------------------------------------------------------- */ + +div.sphinxsidebarwrapper { + padding: 10px 5px 0 10px; +} + +div.sphinxsidebar { + float: left; + width: 230px; + margin-left: -100%; + font-size: 90%; + word-wrap: break-word; + overflow-wrap : break-word; +} + +div.sphinxsidebar ul { + list-style: none; +} + +div.sphinxsidebar ul ul, +div.sphinxsidebar ul.want-points { + margin-left: 20px; + list-style: square; +} + +div.sphinxsidebar ul ul { + margin-top: 0; + margin-bottom: 0; +} + +div.sphinxsidebar form { + margin-top: 10px; +} + +div.sphinxsidebar input { + border: 1px solid #98dbcc; + font-family: sans-serif; + font-size: 1em; +} + +div.sphinxsidebar #searchbox form.search { + overflow: hidden; +} + +div.sphinxsidebar #searchbox input[type="text"] { + float: left; + width: 80%; + padding: 0.25em; + box-sizing: border-box; +} + +div.sphinxsidebar #searchbox input[type="submit"] { + float: left; + width: 20%; + border-left: none; + padding: 0.25em; + box-sizing: border-box; +} + + +img { + border: 0; + max-width: 100%; +} + +/* -- search page ----------------------------------------------------------- */ + +ul.search { + margin: 10px 0 0 20px; + padding: 0; +} + +ul.search li { + padding: 5px 0 5px 20px; + background-image: url(file.png); + background-repeat: no-repeat; + background-position: 0 7px; +} + +ul.search li a { + font-weight: bold; +} + +ul.search li p.context { + color: #888; + margin: 2px 0 0 30px; + text-align: left; +} + +ul.keywordmatches li.goodmatch a { + font-weight: bold; +} + +/* -- index page ------------------------------------------------------------ */ + +table.contentstable { + width: 90%; + margin-left: auto; + margin-right: auto; +} + +table.contentstable p.biglink { + line-height: 150%; +} + +a.biglink { + font-size: 1.3em; +} + +span.linkdescr { + font-style: italic; + padding-top: 5px; + font-size: 90%; +} + +/* -- general index --------------------------------------------------------- */ + +table.indextable { + width: 100%; +} + +table.indextable td { + text-align: left; + vertical-align: top; +} + +table.indextable ul { + margin-top: 0; + margin-bottom: 0; + list-style-type: none; +} + +table.indextable > tbody > tr > td > ul { + padding-left: 0em; +} + +table.indextable tr.pcap { + height: 10px; +} + +table.indextable tr.cap { + margin-top: 10px; + background-color: #f2f2f2; +} + +img.toggler { + margin-right: 3px; + margin-top: 3px; + cursor: pointer; +} + +div.modindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +div.genindex-jumpbox { + border-top: 1px solid #ddd; + border-bottom: 1px solid #ddd; + margin: 1em 0 1em 0; + padding: 0.4em; +} + +/* -- domain module index --------------------------------------------------- */ + +table.modindextable td { + padding: 2px; + border-collapse: collapse; +} + +/* -- general body styles --------------------------------------------------- */ + +div.body { + min-width: 450px; + max-width: 800px; +} + +div.body p, div.body dd, div.body li, div.body blockquote { + -moz-hyphens: auto; + -ms-hyphens: auto; + -webkit-hyphens: auto; + hyphens: auto; +} + +a.headerlink { + visibility: hidden; +} + +a.brackets:before, +span.brackets > a:before{ + content: "["; +} + +a.brackets:after, +span.brackets > a:after { + content: "]"; +} + +h1:hover > a.headerlink, +h2:hover > a.headerlink, +h3:hover > a.headerlink, +h4:hover > a.headerlink, +h5:hover > a.headerlink, +h6:hover > a.headerlink, +dt:hover > a.headerlink, +caption:hover > a.headerlink, +p.caption:hover > a.headerlink, +div.code-block-caption:hover > a.headerlink { + visibility: visible; +} + +div.body p.caption { + text-align: inherit; +} + +div.body td { + text-align: left; +} + +.first { + margin-top: 0 !important; +} + +p.rubric { + margin-top: 30px; + font-weight: bold; +} + +img.align-left, figure.align-left, .figure.align-left, object.align-left { + clear: left; + float: left; + margin-right: 1em; +} + +img.align-right, figure.align-right, .figure.align-right, object.align-right { + clear: right; + float: right; + margin-left: 1em; +} + +img.align-center, figure.align-center, .figure.align-center, object.align-center { + display: block; + margin-left: auto; + margin-right: auto; +} + +img.align-default, figure.align-default, .figure.align-default { + display: block; + margin-left: auto; + margin-right: auto; +} + +.align-left { + text-align: left; +} + +.align-center { + text-align: center; +} + +.align-default { + text-align: center; +} + +.align-right { + text-align: right; +} + +/* -- sidebars -------------------------------------------------------------- */ + +div.sidebar, +aside.sidebar { + margin: 0 0 0.5em 1em; + border: 1px solid #ddb; + padding: 7px; + background-color: #ffe; + width: 40%; + float: right; + clear: right; + overflow-x: auto; +} + +p.sidebar-title { + font-weight: bold; +} + +div.admonition, div.topic, blockquote { + clear: left; +} + +/* -- topics ---------------------------------------------------------------- */ + +div.topic { + border: 1px solid #ccc; + padding: 7px; + margin: 10px 0 10px 0; +} + +p.topic-title { + font-size: 1.1em; + font-weight: bold; + margin-top: 10px; +} + +/* -- admonitions ----------------------------------------------------------- */ + +div.admonition { + margin-top: 10px; + margin-bottom: 10px; + padding: 7px; +} + +div.admonition dt { + font-weight: bold; +} + +p.admonition-title { + margin: 0px 10px 5px 0px; + font-weight: bold; +} + +div.body p.centered { + text-align: center; + margin-top: 25px; +} + +/* -- content of sidebars/topics/admonitions -------------------------------- */ + +div.sidebar > :last-child, +aside.sidebar > :last-child, +div.topic > :last-child, +div.admonition > :last-child { + margin-bottom: 0; +} + +div.sidebar::after, +aside.sidebar::after, +div.topic::after, +div.admonition::after, +blockquote::after { + display: block; + content: ''; + clear: both; +} + +/* -- tables ---------------------------------------------------------------- */ + +table.docutils { + margin-top: 10px; + margin-bottom: 10px; + border: 0; + border-collapse: collapse; +} + +table.align-center { + margin-left: auto; + margin-right: auto; +} + +table.align-default { + margin-left: auto; + margin-right: auto; +} + +table caption span.caption-number { + font-style: italic; +} + +table caption span.caption-text { +} + +table.docutils td, table.docutils th { + padding: 1px 8px 1px 5px; + border-top: 0; + border-left: 0; + border-right: 0; + border-bottom: 1px solid #aaa; +} + +table.footnote td, table.footnote th { + border: 0 !important; +} + +th { + text-align: left; + padding-right: 5px; +} + +table.citation { + border-left: solid 1px gray; + margin-left: 1px; +} + +table.citation td { + border-bottom: none; +} + +th > :first-child, +td > :first-child { + margin-top: 0px; +} + +th > :last-child, +td > :last-child { + margin-bottom: 0px; +} + +/* -- figures --------------------------------------------------------------- */ + +div.figure, figure { + margin: 0.5em; + padding: 0.5em; +} + +div.figure p.caption, figcaption { + padding: 0.3em; +} + +div.figure p.caption span.caption-number, +figcaption span.caption-number { + font-style: italic; +} + +div.figure p.caption span.caption-text, +figcaption span.caption-text { +} + +/* -- field list styles ----------------------------------------------------- */ + +table.field-list td, table.field-list th { + border: 0 !important; +} + +.field-list ul { + margin: 0; + padding-left: 1em; +} + +.field-list p { + margin: 0; +} + +.field-name { + -moz-hyphens: manual; + -ms-hyphens: manual; + -webkit-hyphens: manual; + hyphens: manual; +} + +/* -- hlist styles ---------------------------------------------------------- */ + +table.hlist { + margin: 1em 0; +} + +table.hlist td { + vertical-align: top; +} + +/* -- object description styles --------------------------------------------- */ + +.sig { + font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace; +} + +.sig-name, code.descname { + background-color: transparent; + font-weight: bold; +} + +.sig-name { + font-size: 1.1em; +} + +code.descname { + font-size: 1.2em; +} + +.sig-prename, code.descclassname { + background-color: transparent; +} + +.optional { + font-size: 1.3em; +} + +.sig-paren { + font-size: larger; +} + +.sig-param.n { + font-style: italic; +} + +/* C++ specific styling */ + +.sig-inline.c-texpr, +.sig-inline.cpp-texpr { + font-family: unset; +} + +.sig.c .k, .sig.c .kt, +.sig.cpp .k, .sig.cpp .kt { + color: #0033B3; +} + +.sig.c .m, +.sig.cpp .m { + color: #1750EB; +} + +.sig.c .s, .sig.c .sc, +.sig.cpp .s, .sig.cpp .sc { + color: #067D17; +} + + +/* -- other body styles ----------------------------------------------------- */ + +ol.arabic { + list-style: decimal; +} + +ol.loweralpha { + list-style: lower-alpha; +} + +ol.upperalpha { + list-style: upper-alpha; +} + +ol.lowerroman { + list-style: lower-roman; +} + +ol.upperroman { + list-style: upper-roman; +} + +:not(li) > ol > li:first-child > :first-child, +:not(li) > ul > li:first-child > :first-child { + margin-top: 0px; +} + +:not(li) > ol > li:last-child > :last-child, +:not(li) > ul > li:last-child > :last-child { + margin-bottom: 0px; +} + +ol.simple ol p, +ol.simple ul p, +ul.simple ol p, +ul.simple ul p { + margin-top: 0; +} + +ol.simple > li:not(:first-child) > p, +ul.simple > li:not(:first-child) > p { + margin-top: 0; +} + +ol.simple p, +ul.simple p { + margin-bottom: 0; +} + +dl.footnote > dt, +dl.citation > dt { + float: left; + margin-right: 0.5em; +} + +dl.footnote > dd, +dl.citation > dd { + margin-bottom: 0em; +} + +dl.footnote > dd:after, +dl.citation > dd:after { + content: ""; + clear: both; +} + +dl.field-list { + display: grid; + grid-template-columns: fit-content(30%) auto; +} + +dl.field-list > dt { + font-weight: bold; + word-break: break-word; + padding-left: 0.5em; + padding-right: 5px; +} + +dl.field-list > dt:after { + content: ":"; +} + +dl.field-list > dd { + padding-left: 0.5em; + margin-top: 0em; + margin-left: 0em; + margin-bottom: 0em; +} + +dl { + margin-bottom: 15px; +} + +dd > :first-child { + margin-top: 0px; +} + +dd ul, dd table { + margin-bottom: 10px; +} + +dd { + margin-top: 3px; + margin-bottom: 10px; + margin-left: 30px; +} + +dl > dd:last-child, +dl > dd:last-child > :last-child { + margin-bottom: 0; +} + +dt:target, span.highlighted { + background-color: #fbe54e; +} + +rect.highlighted { + fill: #fbe54e; +} + +dl.glossary dt { + font-weight: bold; + font-size: 1.1em; +} + +.versionmodified { + font-style: italic; +} + +.system-message { + background-color: #fda; + padding: 5px; + border: 3px solid red; +} + +.footnote:target { + background-color: #ffa; +} + +.line-block { + display: block; + margin-top: 1em; + margin-bottom: 1em; +} + +.line-block .line-block { + margin-top: 0; + margin-bottom: 0; + margin-left: 1.5em; +} + +.guilabel, .menuselection { + font-family: sans-serif; +} + +.accelerator { + text-decoration: underline; +} + +.classifier { + font-style: oblique; +} + +.classifier:before { + font-style: normal; + margin: 0 0.5em; + content: ":"; + display: inline-block; +} + +abbr, acronym { + border-bottom: dotted 1px; + cursor: help; +} + +/* -- code displays --------------------------------------------------------- */ + +pre { + overflow: auto; + overflow-y: hidden; /* fixes display issues on Chrome browsers */ +} + +pre, div[class*="highlight-"] { + clear: both; +} + +span.pre { + -moz-hyphens: none; + -ms-hyphens: none; + -webkit-hyphens: none; + hyphens: none; + white-space: nowrap; +} + +div[class*="highlight-"] { + margin: 1em 0; +} + +td.linenos pre { + border: 0; + background-color: transparent; + color: #aaa; +} + +table.highlighttable { + display: block; +} + +table.highlighttable tbody { + display: block; +} + +table.highlighttable tr { + display: flex; +} + +table.highlighttable td { + margin: 0; + padding: 0; +} + +table.highlighttable td.linenos { + padding-right: 0.5em; +} + +table.highlighttable td.code { + flex: 1; + overflow: hidden; +} + +.highlight .hll { + display: block; +} + +div.highlight pre, +table.highlighttable pre { + margin: 0; +} + +div.code-block-caption + div { + margin-top: 0; +} + +div.code-block-caption { + margin-top: 1em; + padding: 2px 5px; + font-size: small; +} + +div.code-block-caption code { + background-color: transparent; +} + +table.highlighttable td.linenos, +span.linenos, +div.highlight span.gp { /* gp: Generic.Prompt */ + user-select: none; + -webkit-user-select: text; /* Safari fallback only */ + -webkit-user-select: none; /* Chrome/Safari */ + -moz-user-select: none; /* Firefox */ + -ms-user-select: none; /* IE10+ */ +} + +div.code-block-caption span.caption-number { + padding: 0.1em 0.3em; + font-style: italic; +} + +div.code-block-caption span.caption-text { +} + +div.literal-block-wrapper { + margin: 1em 0; +} + +code.xref, a code { + background-color: transparent; + font-weight: bold; +} + +h1 code, h2 code, h3 code, h4 code, h5 code, h6 code { + background-color: transparent; +} + +.viewcode-link { + float: right; +} + +.viewcode-back { + float: right; + font-family: sans-serif; +} + +div.viewcode-block:target { + margin: -1px -10px; + padding: 0 10px; +} + +/* -- math display ---------------------------------------------------------- */ + +img.math { + vertical-align: middle; +} + +div.body div.math p { + text-align: center; +} + +span.eqno { + float: right; +} + +span.eqno a.headerlink { + position: absolute; + z-index: 1; +} + +div.math:hover a.headerlink { + visibility: visible; +} + +/* -- printout stylesheet --------------------------------------------------- */ + +@media print { + div.document, + div.documentwrapper, + div.bodywrapper { + margin: 0 !important; + width: 100%; + } + + div.sphinxsidebar, + div.related, + div.footer, + #top-link { + display: none; + } +} \ No newline at end of file diff --git a/docs/source/_static/css/style.css b/_static/css/style.css similarity index 100% rename from docs/source/_static/css/style.css rename to _static/css/style.css diff --git a/_static/custom.css b/_static/custom.css new file mode 100644 index 00000000..2a924f1d --- /dev/null +++ b/_static/custom.css @@ -0,0 +1 @@ +/* This file intentionally left blank. */ diff --git a/_static/doctools.js b/_static/doctools.js new file mode 100644 index 00000000..e1bfd708 --- /dev/null +++ b/_static/doctools.js @@ -0,0 +1,358 @@ +/* + * doctools.js + * ~~~~~~~~~~~ + * + * Sphinx JavaScript utilities for all documentation. + * + * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +/** + * select a different prefix for underscore + */ +$u = _.noConflict(); + +/** + * make the code below compatible with browsers without + * an installed firebug like debugger +if (!window.console || !console.firebug) { + var names = ["log", "debug", "info", "warn", "error", "assert", "dir", + "dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace", + "profile", "profileEnd"]; + window.console = {}; + for (var i = 0; i < names.length; ++i) + window.console[names[i]] = function() {}; +} + */ + +/** + * small helper function to urldecode strings + * + * See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL + */ +jQuery.urldecode = function(x) { + if (!x) { + return x + } + return decodeURIComponent(x.replace(/\+/g, ' ')); +}; + +/** + * small helper function to urlencode strings + */ +jQuery.urlencode = encodeURIComponent; + +/** + * This function returns the parsed url parameters of the + * current request. Multiple values per key are supported, + * it will always return arrays of strings for the value parts. + */ +jQuery.getQueryParameters = function(s) { + if (typeof s === 'undefined') + s = document.location.search; + var parts = s.substr(s.indexOf('?') + 1).split('&'); + var result = {}; + for (var i = 0; i < parts.length; i++) { + var tmp = parts[i].split('=', 2); + var key = jQuery.urldecode(tmp[0]); + var value = jQuery.urldecode(tmp[1]); + if (key in result) + result[key].push(value); + else + result[key] = [value]; + } + return result; +}; + +/** + * highlight a given string on a jquery object by wrapping it in + * span elements with the given class name. + */ +jQuery.fn.highlightText = function(text, className) { + function highlight(node, addItems) { + if (node.nodeType === 3) { + var val = node.nodeValue; + var pos = val.toLowerCase().indexOf(text); + if (pos >= 0 && + !jQuery(node.parentNode).hasClass(className) && + !jQuery(node.parentNode).hasClass("nohighlight")) { + var span; + var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg"); + if (isInSVG) { + span = document.createElementNS("http://www.w3.org/2000/svg", "tspan"); + } else { + span = document.createElement("span"); + span.className = className; + } + span.appendChild(document.createTextNode(val.substr(pos, text.length))); + node.parentNode.insertBefore(span, node.parentNode.insertBefore( + document.createTextNode(val.substr(pos + text.length)), + node.nextSibling)); + node.nodeValue = val.substr(0, pos); + if (isInSVG) { + var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect"); + var bbox = node.parentElement.getBBox(); + rect.x.baseVal.value = bbox.x; + rect.y.baseVal.value = bbox.y; + rect.width.baseVal.value = bbox.width; + rect.height.baseVal.value = bbox.height; + rect.setAttribute('class', className); + addItems.push({ + "parent": node.parentNode, + "target": rect}); + } + } + } + else if (!jQuery(node).is("button, select, textarea")) { + jQuery.each(node.childNodes, function() { + highlight(this, addItems); + }); + } + } + var addItems = []; + var result = this.each(function() { + highlight(this, addItems); + }); + for (var i = 0; i < addItems.length; ++i) { + jQuery(addItems[i].parent).before(addItems[i].target); + } + return result; +}; + +/* + * backward compatibility for jQuery.browser + * This will be supported until firefox bug is fixed. + */ +if (!jQuery.browser) { + jQuery.uaMatch = function(ua) { + ua = ua.toLowerCase(); + + var match = /(chrome)[ \/]([\w.]+)/.exec(ua) || + /(webkit)[ \/]([\w.]+)/.exec(ua) || + /(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) || + /(msie) ([\w.]+)/.exec(ua) || + ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) || + []; + + return { + browser: match[ 1 ] || "", + version: match[ 2 ] || "0" + }; + }; + jQuery.browser = {}; + jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true; +} + +/** + * Small JavaScript module for the documentation. + */ +var Documentation = { + + init : function() { + this.fixFirefoxAnchorBug(); + this.highlightSearchWords(); + this.initIndexTable(); + this.initOnKeyListeners(); + }, + + /** + * i18n support + */ + TRANSLATIONS : {}, + PLURAL_EXPR : function(n) { return n === 1 ? 0 : 1; }, + LOCALE : 'unknown', + + // gettext and ngettext don't access this so that the functions + // can safely bound to a different name (_ = Documentation.gettext) + gettext : function(string) { + var translated = Documentation.TRANSLATIONS[string]; + if (typeof translated === 'undefined') + return string; + return (typeof translated === 'string') ? translated : translated[0]; + }, + + ngettext : function(singular, plural, n) { + var translated = Documentation.TRANSLATIONS[singular]; + if (typeof translated === 'undefined') + return (n == 1) ? singular : plural; + return translated[Documentation.PLURALEXPR(n)]; + }, + + addTranslations : function(catalog) { + for (var key in catalog.messages) + this.TRANSLATIONS[key] = catalog.messages[key]; + this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')'); + this.LOCALE = catalog.locale; + }, + + /** + * add context elements like header anchor links + */ + addContextElements : function() { + $('div[id] > :header:first').each(function() { + $('\u00B6'). + attr('href', '#' + this.id). + attr('title', _('Permalink to this headline')). + appendTo(this); + }); + $('dt[id]').each(function() { + $('\u00B6'). + attr('href', '#' + this.id). + attr('title', _('Permalink to this definition')). + appendTo(this); + }); + }, + + /** + * workaround a firefox stupidity + * see: https://bugzilla.mozilla.org/show_bug.cgi?id=645075 + */ + fixFirefoxAnchorBug : function() { + if (document.location.hash && $.browser.mozilla) + window.setTimeout(function() { + document.location.href += ''; + }, 10); + }, + + /** + * highlight the search words provided in the url in the text + */ + highlightSearchWords : function() { + var params = $.getQueryParameters(); + var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : []; + if (terms.length) { + var body = $('div.body'); + if (!body.length) { + body = $('body'); + } + window.setTimeout(function() { + $.each(terms, function() { + body.highlightText(this.toLowerCase(), 'highlighted'); + }); + }, 10); + $('

' + _('Hide Search Matches') + '

') + .appendTo($('#searchbox')); + } + }, + + /** + * init the domain index toggle buttons + */ + initIndexTable : function() { + var togglers = $('img.toggler').click(function() { + var src = $(this).attr('src'); + var idnum = $(this).attr('id').substr(7); + $('tr.cg-' + idnum).toggle(); + if (src.substr(-9) === 'minus.png') + $(this).attr('src', src.substr(0, src.length-9) + 'plus.png'); + else + $(this).attr('src', src.substr(0, src.length-8) + 'minus.png'); + }).css('display', ''); + if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) { + togglers.click(); + } + }, + + /** + * helper function to hide the search marks again + */ + hideSearchWords : function() { + $('#searchbox .highlight-link').fadeOut(300); + $('span.highlighted').removeClass('highlighted'); + var url = new URL(window.location); + url.searchParams.delete('highlight'); + window.history.replaceState({}, '', url); + }, + + /** + * helper function to focus on search bar + */ + focusSearchBar : function() { + $('input[name=q]').first().focus(); + }, + + /** + * make the url absolute + */ + makeURL : function(relativeURL) { + return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL; + }, + + /** + * get the current relative url + */ + getCurrentURL : function() { + var path = document.location.pathname; + var parts = path.split(/\//); + $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() { + if (this === '..') + parts.pop(); + }); + var url = parts.join('/'); + return path.substring(url.lastIndexOf('/') + 1, path.length - 1); + }, + + initOnKeyListeners: function() { + // only install a listener if it is really needed + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS && + !DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) + return; + + $(document).keydown(function(event) { + var activeElementType = document.activeElement.tagName; + // don't navigate when in search box, textarea, dropdown or button + if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT' + && activeElementType !== 'BUTTON') { + if (event.altKey || event.ctrlKey || event.metaKey) + return; + + if (!event.shiftKey) { + switch (event.key) { + case 'ArrowLeft': + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) + break; + var prevHref = $('link[rel="prev"]').prop('href'); + if (prevHref) { + window.location.href = prevHref; + return false; + } + break; + case 'ArrowRight': + if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) + break; + var nextHref = $('link[rel="next"]').prop('href'); + if (nextHref) { + window.location.href = nextHref; + return false; + } + break; + case 'Escape': + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) + break; + Documentation.hideSearchWords(); + return false; + } + } + + // some keyboard layouts may need Shift to get / + switch (event.key) { + case '/': + if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) + break; + Documentation.focusSearchBar(); + return false; + } + } + }); + } +}; + +// quick alias for translations +_ = Documentation.gettext; + +$(document).ready(function() { + Documentation.init(); +}); diff --git a/_static/documentation_options.js b/_static/documentation_options.js new file mode 100644 index 00000000..608119d1 --- /dev/null +++ b/_static/documentation_options.js @@ -0,0 +1,14 @@ +var DOCUMENTATION_OPTIONS = { + URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), + VERSION: '0.8.3', + LANGUAGE: 'None', + COLLAPSE_INDEX: false, + BUILDER: 'html', + FILE_SUFFIX: '.html', + LINK_SUFFIX: '.html', + HAS_SOURCE: true, + SOURCELINK_SUFFIX: '', + NAVIGATION_WITH_KEYS: false, + SHOW_SEARCH_SUMMARY: true, + ENABLE_SEARCH_SHORTCUTS: true, +}; \ No newline at end of file diff --git a/_static/file.png b/_static/file.png new file mode 100644 index 00000000..a858a410 Binary files /dev/null and b/_static/file.png differ diff --git a/_static/graphviz.css b/_static/graphviz.css new file mode 100644 index 00000000..19e7afd3 --- /dev/null +++ b/_static/graphviz.css @@ -0,0 +1,19 @@ +/* + * graphviz.css + * ~~~~~~~~~~~~ + * + * Sphinx stylesheet -- graphviz extension. + * + * :copyright: Copyright 2007-2022 by the Sphinx team, see AUTHORS. + * :license: BSD, see LICENSE for details. + * + */ + +img.graphviz { + border: 0; + max-width: 100%; +} + +object.graphviz { + max-width: 100%; +} diff --git a/docs/source/_static/html/notebooks/getting-historical-stock-price-data.html b/_static/html/notebooks/getting-historical-stock-price-data.html similarity index 100% rename from docs/source/_static/html/notebooks/getting-historical-stock-price-data.html rename to _static/html/notebooks/getting-historical-stock-price-data.html diff --git a/docs/source/_static/html/notebooks/koapy-tutorial.html b/_static/html/notebooks/koapy-tutorial.html similarity index 100% rename from docs/source/_static/html/notebooks/koapy-tutorial.html rename to _static/html/notebooks/koapy-tutorial.html diff --git a/_static/jquery-3.5.1.js b/_static/jquery-3.5.1.js new file mode 100644 index 00000000..50937333 --- /dev/null +++ b/_static/jquery-3.5.1.js @@ -0,0 +1,10872 @@ +/*! + * jQuery JavaScript Library v3.5.1 + * https://jquery.com/ + * + * Includes Sizzle.js + * https://sizzlejs.com/ + * + * Copyright JS Foundation and other contributors + * Released under the MIT license + * https://jquery.org/license + * + * Date: 2020-05-04T22:49Z + */ +( function( global, factory ) { + + "use strict"; + + if ( typeof module === "object" && typeof module.exports === "object" ) { + + // For CommonJS and CommonJS-like environments where a proper `window` + // is present, execute the factory and get jQuery. + // For environments that do not have a `window` with a `document` + // (such as Node.js), expose a factory as module.exports. + // This accentuates the need for the creation of a real `window`. + // e.g. var jQuery = require("jquery")(window); + // See ticket #14549 for more info. + module.exports = global.document ? + factory( global, true ) : + function( w ) { + if ( !w.document ) { + throw new Error( "jQuery requires a window with a document" ); + } + return factory( w ); + }; + } else { + factory( global ); + } + +// Pass this if window is not defined yet +} )( typeof window !== "undefined" ? window : this, function( window, noGlobal ) { + +// Edge <= 12 - 13+, Firefox <=18 - 45+, IE 10 - 11, Safari 5.1 - 9+, iOS 6 - 9.1 +// throw exceptions when non-strict code (e.g., ASP.NET 4.5) accesses strict mode +// arguments.callee.caller (trac-13335). But as of jQuery 3.0 (2016), strict mode should be common +// enough that all such attempts are guarded in a try block. +"use strict"; + +var arr = []; + +var getProto = Object.getPrototypeOf; + +var slice = arr.slice; + +var flat = arr.flat ? function( array ) { + return arr.flat.call( array ); +} : function( array ) { + return arr.concat.apply( [], array ); +}; + + +var push = arr.push; + +var indexOf = arr.indexOf; + +var class2type = {}; + +var toString = class2type.toString; + +var hasOwn = class2type.hasOwnProperty; + +var fnToString = hasOwn.toString; + +var ObjectFunctionString = fnToString.call( Object ); + +var support = {}; + +var isFunction = function isFunction( obj ) { + + // Support: Chrome <=57, Firefox <=52 + // In some browsers, typeof returns "function" for HTML

`CybosPlusDispatch`
`CybosPlusIncompleteProgID`
`CybosPlusEntrypoint`	http://cybosplus.github.io/

`CybosPlusDispatchProxyMethod`
`CybosPlusDispatchProxy`
`CybosPlusIncompleteProgIDProxy`
`CybosPlusEntrypointProxy`

`CybosPlusEvent`
`CybosPlusEventIterator`
`CybosPlusEventHandler`
`CybosPlusProxyServiceServicer`	Missing associated documentation comment in .proto file.

`KiwoomOpenApiPlusCommRqDataRateLimiter`	[조회횟수 제한 관련 가이드]
`KiwoomOpenApiPlusSendOrderRateLimiter`
`KiwoomOpenApiPlusSendConditionRateLimiter`	[조건검색 제한]

`KiwoomOpenApiPlusLazyAllEventHandler`
`KiwoomOpenApiPlusEagerAllEventHandler`
`KiwoomOpenApiPlusAllEventHandler`
`KiwoomOpenApiPlusLazySomeEventHandler`
`KiwoomOpenApiPlusEagerSomeEventHandler`
`KiwoomOpenApiPlusSomeEventHandler`
`KiwoomOpenApiPlusSomeBidirectionalEventHandler`

`CybosPlusLookupRequestRateLimiter`	시세 오브젝트 조회 제한: 15초에 최대 60건으로제한
`CybosPlusTradeRequestRateLimiter`	주문관련 오브젝트 조회 제한: 15초에 최대 20건으로제한

`AssignPrimitive`(message, value)
`ExtractPrimitive`(message)
`Protoc`()

`CybosPlusProxyServiceStub`	Missing associated documentation comment in .proto file.
`CybosPlusProxyServiceServicer`	Missing associated documentation comment in .proto file.
`CybosPlusProxyService`	Missing associated documentation comment in .proto file.

`KiwoomOpenApiPlusConditionEntry`
`KiwoomOpenApiPlusConditionFile`

`KiwoomOpenApiPlusDynamicCallableRunnable`
`KiwoomOpenApiPlusDynamicCallable`	Abstract base class for generic types.

`KiwoomOpenApiPlusQAxWidgetUniversalMixin`	일차적으로 KiwoomOpenApiPlusQAxWidget 객체에 대해 사용될 수 있는 Mixin 이지만,
`KiwoomOpenApiPlusQAxWidgetServerSideMixin`	KiwoomOpenApiPlusQAxWidget 객체에 대해 Server-Side 에서만 사용되는 Mixin 입니다.
`KiwoomOpenApiPlusQAxWidgetMixin`	KiwoomOpenApiPlusQAxWidgetUniversalMixin, KiwoomOpenApiPlusQAxWidgetServerSideMixin 구현이 포함된

`KiwoomOpenApiPlusServiceClientStubCoreWrapper`	KiwoomOpenApiPlusServiceServicer 에서 구현되어 이후 Stub 을 통해 제공되는
`KiwoomOpenApiPlusServiceClientStubExtendedWrapper`	제공되는 RPC 들을 활용한 여러 사용 케이스들을 구현합니다.
`KiwoomOpenApiPlusServiceClientStubWrapper`	KiwoomOpenApiPlusServiceClientStubCoreWrapper, KiwoomOpenApiPlusServiceClientStubExtendedWrapper 의 구현 및

`convert_arguments_from_protobuf_to_python`(arguments)
`convert_arguments_from_python_to_protobuf`(arguments, arguments_message)

`KiwoomOpenApiPlusServiceStub`	Missing associated documentation comment in .proto file.
`KiwoomOpenApiPlusServiceServicer`	Missing associated documentation comment in .proto file.
`KiwoomOpenApiPlusService`	Missing associated documentation comment in .proto file.

`KiwoomOpenApiPlusBaseOrderEventHandler`
`KiwoomOpenApiPlusAllOrderEventHandler`
`KiwoomOpenApiPlusOrderEventHandler`

`main`()
`infer_fids_by_tr_outputs`(output_filename=None)

`KiwoomOpenApiPlusRealEventHandler`
`KiwoomOpenApiPlusBidirectionalRealEventHandler`

`DialogToHandle`
`KiwoomOpenApiPlusDialogToHandle`
`KiwoomOpenApiPlusDialogHandler`

`KiwoomOpenApiPlusManagerApplicationArgumentParser`
`KiwoomOpenApiPlusServerApplicationProcess`
`KiwoomOpenApiPlusServerApplicationSubprocess`
`KiwoomOpenApiPlusManagerApplication`

`KiwoomOpenApiPlusServerApplicationArgumentParser`
`KiwoomOpenApiPlusServerApplication`

`string_to_list`(s, sep=';')
`list_to_string`(l, sep=';')
`convert_list_arguments`(*indices)

`QThreadPoolExecutorRunnable`
`QThreadPoolExecutor`	This is an abstract base class for concrete asynchronous executors.

`QueueBasedIterableObserverIterator`
`QueueBasedIterableObserver`	Observer abstract base class

`KiwoomOpenApiWSignature`	A Signature object represents the overall signature of a function.
`KiwoomOpenApiWDispatchSignature`	A Signature object represents the overall signature of a function.
`KiwoomOpenApiWEventHandlerSignature`	A Signature object represents the overall signature of a function.

`BuildOleItems`(clsid)
`LoadDispatchSignatures`(oleItems, clsId)
`LoadEventHandlerSignatures`(oleItems, clsId)

`DISPATCH_SIGNATURES_BY_NAME`
`EVENT_HANDLER_SIGNATURES_BY_NAME`

`KiwoomOpenApiPlusCommInfo`
`MetaKiwoomOpenApiPlusBroker`
`KiwoomOpenApiPlusBroker`

`KiwoomOpenApiPlusPriceEventChannel`
`KiwoomOpenApiPlusOrderEventChannel`
`MetaKiwoomOpenApiPlusEventStreamer`	Metaclass for defining Abstract Base Classes (ABCs).
`KiwoomOpenApiPlusEventStreamer`	Observer abstract base class

`HistoricalPriceRecord`	Built-in immutable sequence.
`API`
`MetaSingleton`
`MetaKiwoomOpenApiPlusStore`
`KiwoomOpenApiPlusStore`

`disable_auto_login_after_login`(port)
`disable_auto_login_without_login`()
`auto_login`(port)

`generate_self_signed_key_cert`(organization_name, common_name, key_filename=None, cert_filename=None, key_password=None, country_name=None, state_or_province_name=None, locality_name=None, valid_days=None)
`generate_key_cert_signed_by_authority`(organization_name, common_name, alternative_dns_names=None, key_filename=None, csr_filename=None, cert_filename=None, key_password=None, country_name=None, state_or_province_name=None, locality_name=None, valid_days=None, authority_key_filename=None, authority_cert_filename=None, authority_key_password=None)
`ssl_credentials`()

`default_dispatch_class_name`
`default_dispatch_file_path`
`default_event_class_name`
`default_event_file_path`

`deposit`(account, port)
`evaluation`(account, include_delisted, exclude_delisted, for_each, as_summary, port)
`orders`(account, date, reverse, executed_only, not_executed_only, stock_only, bond_only, sell_only, buy_only, code, starting_order_no, port)
`userinfo`(port)
`daily`(code, output, format, start_date, end_date, port)
`minute`(code, interval, output, format, start_date, end_date, port)
`errmsg`(err_code)
`modulepath`()
`realinfo`(realtypes)
`trinfo`(trcodes)
`codelist`(markets, port)
`stockcode`(names, markets, port)
`stockinfo`(code, output, format, port)
`stockname`(codes, port)
`get`()

`MarketEntry`
`StockEntry`
`StatusBarHandler`	Handler instances dispatch logging events to specific destinations.
`Screen`

`screen_len`(str)
`wrapper`(stdscr)
`codelist_interactive`()
`main`()

`grpc_server_and_client_options`()
`full_verbose_option`(args, *kwargs)
`serve`(ctx, verbose, **kwargs)