analyser_hj3415 3.3.0__py3-none-any.whl → 3.3.1__py3-none-any.whl

analyser_hj3415/analyser/compile.py

@@ -11,9 +11,20 @@ from analyser_hj3415.analyser import tsa, eval, MIs
 mylogger = setup_logger(__name__,'WARNING')
 expire_time = tools.to_int(os.getenv('DEFAULT_EXPIRE_TIME_H', 48)) * 3600
 
-
 @dataclass
 class MICompileData:
+    """
+    MI(Market Index) 데이터를 컴파일하여 저장하는 데이터 클래스.
+
+    속성:
+        mi_type (str): 시장 지수 유형.
+        prophet_data (tsa.ProphetData): Prophet 예측 데이터.
+        lstm_grade (tsa.LSTMGrade): LSTM 등급 데이터.
+        is_lstm_up (bool): LSTM 상승 여부.
+        is_prophet_up (bool): Prophet 상승 여부.
+        lstm_html (str): LSTM 시각화 HTML.
+        prophet_html (str): Prophet 시각화 HTML.
+    """
     mi_type: str
 
     prophet_data: tsa.ProphetData
@@ -27,20 +38,57 @@ class MICompileData:
 
 
 class MICompile:
+    """
+    MI(Market Index) 데이터를 컴파일하는 클래스.
+
+    메서드:
+        get(refresh=False) -> MICompileData:
+            MI 데이터를 컴파일하거나 캐시에서 가져옵니다.
+
+        analyser_lstm_all_mi(refresh: bool):
+            모든 MI에 대해 LSTM 예측 및 초기화 수행.
+    """
     def __init__(self, mi_type: str):
+        """
+        MICompile 객체를 초기화합니다.
+
+        매개변수:
+            mi_type (str): 시장 지수 유형.
+        """
         assert mi_type in MIs._fields, f"Invalid MI type ({MIs._fields})"
         self._mi_type = mi_type
 
     @property
     def mi_type(self) -> str:
+        """
+        MI 유형을 반환합니다.
+
+        반환값:
+            str: MI 유형.
+        """
         return self._mi_type
 
     @mi_type.setter
     def mi_type(self, mi_type: str):
+        """
+        MI 유형을 변경합니다.
+
+        매개변수:
+            mi_type (str): 새로 설정할 MI 유형.
+        """
         assert mi_type in MIs._fields, f"Invalid MI type ({MIs._fields})"
         self._mi_type = mi_type
 
     def get(self, refresh=False) -> MICompileData:
+        """
+        MI 데이터를 컴파일하거나 캐시에서 가져옵니다.
+
+        매개변수:
+            refresh (bool): 데이터를 새로 가져올지 여부.
+
+        반환값:
+            MICompileData: 컴파일된 MI 데이터.
+        """
         print(f"{self.mi_type}의 compiling을 시작합니다.")
         redis_name = self.mi_type + '_mi_compile'
         print(
@@ -66,6 +114,12 @@ class MICompile:
 
     @staticmethod
     def analyser_lstm_all_mi(refresh: bool):
+        """
+        모든 MI(Market Index)에 대해 LSTM 예측과 초기화를 수행합니다.
+
+        매개변수:
+            refresh (bool): 데이터를 새로 가져올지 여부.
+        """
         mi_lstm = tsa.MILSTM('WTI')
         print(f"*** LSTM prediction redis cashing Market Index items ***")
         for mi_type in MIs._fields:
@@ -74,9 +128,23 @@ class MICompile:
             mi_lstm.initializing()
             mi_lstm.get_final_predictions(refresh=refresh, num=5)
 
-
 @dataclass
 class CorpCompileData:
+    """
+    기업 데이터를 컴파일하여 저장하는 데이터 클래스.
+
+    속성:
+        code (str): 기업 코드.
+        name (str): 기업 이름.
+        red_data (eval.RedData): RED 분석 데이터.
+        mil_data (eval.MilData): MIL 분석 데이터.
+        prophet_data (tsa.ProphetData): Prophet 예측 데이터.
+        lstm_grade (tsa.LSTMGrade): LSTM 등급 데이터.
+        is_lstm_up (bool): LSTM 상승 여부.
+        is_prophet_up (bool): Prophet 상승 여부.
+        lstm_html (str): LSTM 시각화 HTML.
+        prophet_html (str): Prophet 시각화 HTML.
+    """
     code: str
     name: str
 
@@ -94,22 +162,66 @@ class CorpCompileData:
 
 
 class CorpCompile:
+    """
+    기업 데이터를 컴파일하는 클래스.
+
+    메서드:
+        get(refresh=False) -> CorpCompileData:
+            기업 데이터를 컴파일하거나 캐시에서 가져옵니다.
+
+        red_ranking(expect_earn: float = 0.06, refresh=False) -> OrderedDict:
+            RED 데이터를 기반으로 기업 순위를 계산합니다.
+
+        prophet_ranking(refresh=False, top: Union[int, str]='all') -> OrderedDict:
+            Prophet 데이터를 기반으로 기업 순위를 계산합니다.
+
+        analyse_lstm_topn(refresh: bool, top=40):
+            상위 N개의 기업에 대해 LSTM 예측 수행.
+    """
     def __init__(self, code: str, expect_earn=0.06):
+        """
+        CorpCompile 객체를 초기화합니다.
+
+        매개변수:
+            code (str): 기업 코드.
+            expect_earn (float, optional): 예상 수익률. 기본값은 0.06.
+        """
         assert tools.is_6digit(code), f'Invalid value : {code}'
         self._code = code
         self.expect_earn = expect_earn
 
     @property
     def code(self) -> str:
+        """
+        기업 코드를 반환합니다.
+
+        반환값:
+            str: 기업 코드.
+        """
         return self._code
 
     @code.setter
     def code(self, code: str):
+        """
+        기업 코드를 변경합니다.
+
+        매개변수:
+            code (str): 새로 설정할 기업 코드.
+        """
         assert tools.is_6digit(code), f'Invalid value : {code}'
         mylogger.info(f'change code : {self.code} -> {code}')
         self._code = code
 
-    def get(self, refresh=False) -> dict:
+    def get(self, refresh=False) -> CorpCompileData:
+        """
+        기업 데이터를 컴파일하거나 캐시에서 가져옵니다.
+
+        매개변수:
+            refresh (bool): 데이터를 새로 가져올지 여부.
+
+        반환값:
+            CorpCompileData: 컴파일된 기업 데이터.
+        """
         print(f"{self.code}의 compiling을 시작합니다.")
         redis_name = self.code + '_corp_compile'
         print(
@@ -139,11 +251,19 @@ class CorpCompile:
 
     @staticmethod
     def red_ranking(expect_earn: float = 0.06, refresh=False) -> OrderedDict:
-        # 이전 expect earn 과 비교하여 다르거나 없으면 강제 refresh 설정
+        """
+        RED 데이터를 기반으로 기업 순위를 계산합니다.
+
+        매개변수:
+            expect_earn (float, optional): 예상 수익률. 기본값은 0.06.
+            refresh (bool): 데이터를 새로 가져올지 여부.
+
+        반환값:
+            OrderedDict: RED 점수를 기준으로 정렬된 기업 순위.
+        """
         redis_name = 'red_ranking_prev_expect_earn'
         pee = tools.to_float(myredis.Base.get_value(redis_name))
         if pee != expect_earn:
-            # expect earn의 이전 계산값이 없거나 이전 값과 다르면 새로 계산
             mylogger.warning(
                 f"expect earn : {expect_earn} / prev expect earn : {pee} 두 값이 달라 refresh = True"
             )
@@ -172,7 +292,16 @@ class CorpCompile:
 
     @staticmethod
     def prophet_ranking(refresh=False, top: Union[int, str]='all') -> OrderedDict:
+        """
+        Prophet 데이터를 기반으로 기업 순위를 계산합니다.
 
+        매개변수:
+            refresh (bool): 데이터를 새로 가져올지 여부.
+            top (Union[int, str], optional): 상위 기업 개수. 'all'이면 전체 반환. 기본값은 'all'.
+
+        반환값:
+            OrderedDict: Prophet 점수를 기준으로 정렬된 기업 순위.
+        """
         print("**** Start Compiling scores and sorting... ****")
         redis_name = 'prophet_ranking'
 
@@ -195,7 +324,6 @@ class CorpCompile:
 
         data_dict = myredis.Base.fetch_and_cache_data(redis_name, refresh, fetch_prophet_ranking, timer=expire_time)
 
-        # prophet_score를 기준으로 정렬
         ranking = OrderedDict(sorted(data_dict.items(), key=lambda x: x[1], reverse=True))
 
         if top == 'all':
@@ -208,6 +336,13 @@ class CorpCompile:
 
     @staticmethod
     def analyse_lstm_topn(refresh: bool, top=40):
+        """
+        상위 N개의 기업에 대해 LSTM 예측을 수행합니다.
+
+        매개변수:
+            refresh (bool): 데이터를 새로 가져올지 여부.
+            top (int, optional): 상위 기업 개수. 기본값은 40.
+        """
         ranking_topn = CorpCompile.prophet_ranking(refresh=False, top=top)
         mylogger.info(ranking_topn)
         corp_lstm = tsa.CorpLSTM('005930')

{analyser_hj3415-3.3.0.dist-info → analyser_hj3415-3.3.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: analyser_hj3415
-Version: 3.3.0
+Version: 3.3.1
 Summary: Stock analyser and database processing programs
 Requires-Python: >=3.6
 Description-Content-Type: text/markdown

{analyser_hj3415-3.3.0.dist-info → analyser_hj3415-3.3.1.dist-info}/RECORD

@@ -1,7 +1,7 @@
 analyser_hj3415/__init__.py,sha256=jqHEUoBeihYOMaS0bPOe3nRVXBufZ0clxc6M6jxPY0o,320
 analyser_hj3415/cli.py,sha256=rn9feZcUpgIXM8JX0OsNCKy9oZauMnEcNKR38sSQfds,12017
 analyser_hj3415/analyser/__init__.py,sha256=N0XyBfWJNpDS_6JYziKETWePO_jtFB1m7E8Qbwt1w0Q,1096
-analyser_hj3415/analyser/compile.py,sha256=_zOxWfBSLGv2QuKqL2LR-OS97JzXvkZfSSrpuRLU48c,8037
+analyser_hj3415/analyser/compile.py,sha256=xumUdFxcBWPqiT0fLzl7ZP6Sx0Vj3uThPTMOJcjfeUE,12513
 analyser_hj3415/analyser/eval/__init__.py,sha256=IP1d0Q3nOCAD3zK1qxrC685MkJQfUh-qaXc7xptTxk8,80
 analyser_hj3415/analyser/eval/blue.py,sha256=p9_ddqLMJGq5HSn6NApuLhrX29qD--AASig9F71eb8I,10952
 analyser_hj3415/analyser/eval/common.py,sha256=sNXapoofShA43ww_SLjXmIjkrAr1AhAcezdaN_X_3Us,11443
@@ -17,7 +17,7 @@ analyser_hj3415/workroom/mysklearn.py,sha256=wJXKz5MqqTzADdG2mqRMMzc_G9RzwYjj5_j
 analyser_hj3415/workroom/mysklearn2.py,sha256=1lIy6EWEQHkOzDS-av8U0zQH6DuCLKWMI73dnJx5KRs,1495
 analyser_hj3415/workroom/score.py,sha256=P6nHBJYmyhigGtT4qna4BmNtvt4B93b7SKyzdstJK24,17376
 analyser_hj3415/workroom/trash.py,sha256=zF-W0piqkGr66UP6-iybo9EXh2gO0RP6R1FnIpsGkl8,12262
-analyser_hj3415-3.3.0.dist-info/entry_points.txt,sha256=ZfjPnJuH8SzvhE9vftIPMBIofsc65IAWYOhqOC_L5ck,65
-analyser_hj3415-3.3.0.dist-info/WHEEL,sha256=CpUCUxeHQbRN5UGRQHYRJorO5Af-Qy_fHMctcQ8DSGI,82
-analyser_hj3415-3.3.0.dist-info/METADATA,sha256=oQXcQ45N87lL1UNCjceZWvAsgbzOKoL2m06iIM3cOvE,6777
-analyser_hj3415-3.3.0.dist-info/RECORD,,
+analyser_hj3415-3.3.1.dist-info/entry_points.txt,sha256=ZfjPnJuH8SzvhE9vftIPMBIofsc65IAWYOhqOC_L5ck,65
+analyser_hj3415-3.3.1.dist-info/WHEEL,sha256=CpUCUxeHQbRN5UGRQHYRJorO5Af-Qy_fHMctcQ8DSGI,82
+analyser_hj3415-3.3.1.dist-info/METADATA,sha256=fkHlNPU6RQq-I-oxqzDi1vb7C0nFH6UNg0AbQ6SyWfw,6777
+analyser_hj3415-3.3.1.dist-info/RECORD,,