neurostats-API 0.0.16__py3-none-any.whl → 0.0.18__py3-none-any.whl

neurostats_API/__init__.py

@@ -1,4 +1,4 @@
-__version__='0.0.16'
+__version__='0.0.18'
 
 from .fetchers import (
     BalanceSheetFetcher,

neurostats_API/fetchers/base.py

@@ -53,6 +53,23 @@ class StatsFetcher:
         season = (month - 1) // 3 + 1
 
         return StatsDateTime(date, year, month, day, season)
+    
+    def has_required_columns(self, df:pd.DataFrame, required_cols=None):
+        """
+        Check if the required columns are present in the DataFrame.
+
+        Args:
+            df (pd.DataFrame): The DataFrame to check.
+            required_cols (list, optional): List of required column names. 
+                                            Defaults to ['date', 'open', 'high', 'low', 'close', 'volume'].
+
+        Returns:
+            bool: True if all required columns are present, False otherwise.
+        """
+        if required_cols is None:
+            required_cols = ['date', 'open', 'high', 'low', 'close', 'volume']
+        
+        return all(col in df.columns for col in required_cols)
 
 
 class BaseTEJFetcher(abc.ABC):
@@ -80,7 +97,11 @@ class BaseTEJFetcher(abc.ABC):
         year_shifts = [1, 3, 5, 10]
         return_dict = {}
         for year in range(start_year, end_year + 1):
-            year_data = data_dict[f"{year}Q{season}"]
+            try:
+                year_data = data_dict[f"{year}Q{season}"].copy()
+            except KeyError as e:
+                continue
+
             year_keys = list(year_data.keys())
             for key in year_keys:
                 if (key in 'season'):
@@ -92,7 +113,7 @@ class BaseTEJFetcher(abc.ABC):
                     for shift in year_shifts:
                         this_value = year_data[key]
                         try:
-                            past_year = str(year - shift)
+                            past_year = year - shift
                             last_value = data_dict[f"{past_year}Q{season}"][key]
                             temp_dict[f"YoY_{shift}"] = YoY_Calculator.cal_growth(this_value, last_value, delta=shift)
                         except Exception as e:

neurostats_API/fetchers/tech.py

@@ -47,40 +47,46 @@ class TechFetcher(StatsFetcher):
         )
 
     def _get_ohlcv(self):
-        
-        if self.ticker in ['GSPC', 'IXIC', 'DJI', 'TWII']:
-            
-            full_tick = f'^{self.ticker}'
-            yf_ticker = yf.Ticker(full_tick)
-            origin_df = yf_ticker.history(period="10y")
-            origin_df = origin_df.reset_index()
-            origin_df["Date"] = pd.to_datetime(origin_df["Date"]).dt.date
-            df = origin_df.rename(
-                columns={
-                    "Date": "date",
-                    "Open": "open",
-                    "High": "high",
-                    "Low": "low",
-                    "Close": "close",
-                    "Volume": "volume"
-                }
-            )
-        else:
 
+        required_cols = ['date', 'open', 'high', 'low', 'close', 'volume']
+
+        try:
             query = {'ticker': self.ticker}
-            ticker_full = list(self.collection.find(query))
+            ticker_full = self.collection.find_one(query)
 
             if not ticker_full:
                 raise ValueError(f"No data found for ticker: {self.ticker}")
 
-            if 'daily_data' not in ticker_full[0] or ticker_full[0]['daily_data'] is None:
-                raise KeyError("Missing 'daily_data' in the retrieved data")
+            daily_data = ticker_full.get("daily_data", [])
+            if not isinstance(daily_data, list):
+                raise TypeError("Expected 'daily_data' to be a list.")
+
+            df = pd.DataFrame(daily_data)
 
-            df = pd.DataFrame(ticker_full[0]['daily_data'])
+            if not self.has_required_columns(df, required_cols):
+                raise KeyError(f"Missing required columns")
 
-        selected_cols = ['date','open','high','low','close','volume']
+        except (KeyError, ValueError, TypeError) as e:
+
+            print(f"Conduct yf searching")
+
+            if self.ticker in ['GSPC', 'IXIC', 'DJI', 'TWII']:
+                full_tick = f'^{self.ticker}'
+            else:
+                full_tick = f'{self.ticker}.tw'
+
+            df = self.conduct_yf_search(full_tick)
+
+            if not self.has_required_columns(df, required_cols):
+
+                print(f".tw failed, try .two")
+            
+                full_tick = f'{self.ticker}.two'
+
+                df = self.conduct_yf_search(full_tick)
+                
+        return df[required_cols]
 
-        return df[selected_cols]
 
     def get_daily(self):
 
@@ -101,6 +107,29 @@ class TechFetcher(StatsFetcher):
     def get_yearly(self):
 
         return self.yearly_index
+    
+    def conduct_yf_search(self, ticker:str):
+
+        yf_ticker = yf.Ticker(ticker)
+        origin_df = yf_ticker.history(period="10y")
+        
+        if origin_df.empty:
+            return origin_df
+            
+        origin_df = origin_df.reset_index()
+        origin_df["Date"] = pd.to_datetime(origin_df["Date"])
+        df = origin_df.rename(
+            columns={
+                "Date": "date",
+                "Open": "open",
+                "High": "high",
+                "Low": "low",
+                "Close": "close",
+                "Volume": "volume"
+            }
+        )
+
+        return df
 
 class TechProcessor:
     

neurostats_API/fetchers/tej_finance_report.py

@@ -5,6 +5,7 @@ import pandas as pd
 from pymongo import MongoClient
 from ..utils import StatsProcessor, YoY_Calculator
 import warnings
+import yaml
 
 
 class FinanceReportFetcher(BaseTEJFetcher):
@@ -20,18 +21,8 @@ class FinanceReportFetcher(BaseTEJFetcher):
         self.db = self.client[db_name]
         self.collection = self.db[collection_name]
 
-        # yapf: disabled
-        self.check_index = {
-            'coid', 'mdate', 'key3', 'no', 'sem', 'merg', 'curr', 'annd', 'fin_ind', 'bp11', 'bp21', 'bp22', 'bp31',
-            'bp41', 'bp51', 'bp53', 'bp61', 'bp62', 'bp63', 'bp64', 'bp65', 'bf11', 'bf12', 'bf21', 'bf22', 'bf41',
-            'bf42', 'bf43', 'bf44', 'bf45', 'bf99', 'bsca', 'bsnca', 'bsta', 'bscl', 'bsncl', 'bstl', 'bsse', 'bslse',
-            'debt', 'quick', 'ppe', 'ar', 'ip12', 'ip22', 'ip31', 'ip51', 'iv41', 'if11', 'isibt', 'isni', 'isnip',
-            'eps', 'ispsd', 'gm', 'opi', 'nri', 'ri', 'nopi', 'ebit', 'cip31', 'cscfo', 'cscfi', 'cscff', 'person',
-            'shares', 'wavg', 'taxrate', 'r104', 'r115', 'r105', 'r106', 'r107', 'r108', 'r201', 'r112', 'r401', 'r402',
-            'r403', 'r404', 'r405', 'r408', 'r409', 'r410', 'r502', 'r501', 'r205', 'r505', 'r517', 'r512', 'r509',
-            'r608', 'r616', 'r610', 'r607', 'r613', 'r612', 'r609', 'r614', 'r611', 'r307', 'r304', 'r305', 'r306',
-            'r316', 'r834'
-        }    # yapf: enabled
+        index_dict = StatsProcessor.load_yaml("tej_db_index.yaml")
+        self.check_index = set(index_dict[collection_name])
 
     def get(
             self,
@@ -59,17 +50,19 @@ class FinanceReportFetcher(BaseTEJFetcher):
             if (difference):
                 warnings.warn(f"{list(difference)} 沒有出現在資料表中，請確認column名稱是否正確", UserWarning)
 
+        if (not start_date):
+            start_date = datetime.strptime("2005-01-01", "%Y-%m-%d")
+        else:
+            start_date = datetime.strptime(start_date, "%Y-%m-%d")
+
         if (fetch_mode in {self.FetchMode.QOQ, self.FetchMode.QOQ_NOCAL}):
-            if (not start_date):
-                warnings.warn("No start_date specified, use default date = \"2005-01-01\"", UserWarning)
-                start_date = datetime.strptime("2005-01-01", "%Y-%m-%d")
+
             if (not end_date):
-                warnings.warn("No end_date specified, use default date = today", UserWarning)
                 end_date = datetime.today()
+            else:
+                end_date = datetime.strptime(end_date, "%Y-%m-%d")
 
             assert (start_date <= end_date)
-            start_date = datetime.strptime(start_date, "%Y-%m-%d")
-            end_date = datetime.strptime(end_date, "%Y-%m-%d")
 
             start_year = start_date.year
             start_season = (start_date.month - 1) // 4 + 1
@@ -94,7 +87,6 @@ class FinanceReportFetcher(BaseTEJFetcher):
             return data_df
 
         elif (fetch_mode in {self.FetchMode.YOY, self.FetchMode.YOY_NOCAL}):
-            start_date = datetime.strptime(start_date, "%Y-%m-%d")
             start_year = start_date.year
             end_date = self.get_latest_data_time(ticker)
             if (not end_date):
@@ -225,7 +217,6 @@ class FinanceReportFetcher(BaseTEJFetcher):
             ]
 
         fetched_data = self.collection.aggregate(pipeline).to_list()
-
         data_dict = StatsProcessor.list_of_dict_to_dict(
             fetched_data, keys=["year", "season"], delimeter="Q", data_key=report_type)
 

neurostats_API/tools/tej_db_index.yaml

@@ -0,0 +1,135 @@
+TWN/AINVFQ1:
+- coid
+- mdate
+- key3
+- 'no'
+- sem
+- merg
+- curr
+- annd
+- fin_ind
+- bp11
+- bp21
+- bp22
+- bp31
+- bp41
+- bp51
+- bp53
+- bp61
+- bp62
+- bp63
+- bp64
+- bp65
+- bf11
+- bf12
+- bf21
+- bf22
+- bf41
+- bf42
+- bf43
+- bf44
+- bf45
+- bf99
+- bsca
+- bsnca
+- bsta
+- bscl
+- bsncl
+- bstl
+- bsse
+- bslse
+- debt
+- quick
+- ppe
+- ar
+- ip12
+- ip22
+- ip31
+- ip51
+- iv41
+- if11
+- isibt
+- isni
+- isnip
+- eps
+- ispsd
+- gm
+- opi
+- nri
+- ri
+- nopi
+- ebit
+- cip31
+- cscfo
+- cscfi
+- cscff
+- person
+- shares
+- wavg
+- taxrate
+- r104
+- r115
+- r105
+- r106
+- r107
+- r108
+- r201
+- r112
+- r401
+- r402
+- r403
+- r404
+- r405
+- r408
+- r409
+- r410
+- r502
+- r501
+- r205
+- r505
+- r517
+- r512
+- r509
+- r608
+- r616
+- r610
+- r607
+- r613
+- r612
+- r609
+- r614
+- r611
+- r307
+- r304
+- r305
+- r306
+- r316
+- r834
+TWN/AFESTM1:
+- coid
+- mdate
+- key3
+- 'no'
+- sem
+- merg
+- curr
+- annd
+- fin_ind
+- ip12
+- gm
+- opi
+- isibt
+- isni
+- isnip
+- r306
+- r316
+- eps
+- r105
+- r106
+- r107
+- r108
+- r401
+- r402
+- r403
+- r404
+- r405

{neurostats_API-0.0.16.dist-info → neurostats_API-0.0.18.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: neurostats_API
-Version: 0.0.16
+Version: 0.0.18
 Summary: The service of NeuroStats website
 Home-page: https://github.com/NeurowattStats/NeuroStats_API.git
 Author: JasonWang@Neurowatt
@@ -774,43 +774,48 @@ YoY_10  1.420500e-01  1.586797e-01  1.551364e-01
 }
 ```
 
+### 公司自結資料
+```Python
+from neurostats_API import FinanceReportFetcher
 
-## 版本紀錄
-## 0.0.16
-- 處理ValueFetcher的error #issue76
-
-- tej_fetcher新增 QOQ, YOY功能
-
-## 0.0.15
-- TechFetcher中新增指數條件
-
-- 新增tej_fetcher索取TEJ相關的資料
-
-- package新增depensnecy，可以安裝需要的相關package
+fetcher = FinanceReportFetcher(
+    mongo_uri = mongo_uri,
+    db_name = db_name,
+    collection_name = collection_name
+)
 
-## 0.0.14
-- 修改部分財報資料錯誤的乘以1000的問題
+data = fetcher.get(
+    ticker = "2330" # 任意的股票代碼
+    fetch_mode = fetcher.FetchMode.QOQ_NOCAL # 取得模式
+    start_date = "2005-01-01",
+    end_date = "2024-12-31",
+    report_type = "Q",
+    indexes = []
+) # -> pd.DataFrame or Dict[pd.DataFrame] 
+```
+- `ticker`: 股票代碼
 
-- 新增例外處理: 若資料庫對於季資料一部分index缺失的情況下仍會盡可能去將資料蒐集並呈現
+- `fetch_mode` : 取得模式，為`fetcher.YOY_NOCAL` 或 `fetcher.QOQ_NOCAL`
+    - `YOY_NOCAL`: 以end_date為準，取得與end_date同季的歷年資料，時間範圍以start_date為起始
+        > 例如`start_date = "2020-07-01"`, `end_date = "2024-01-01"`，會回傳2020~2024的第一季資料
 
-### 0.0.13
-- value_fetcher 新增獲得一序列評價的功能
+    - `QOQ_NOCAL`: 時間範圍內的每季資料
 
-### 0.0.12
-- 新增資券變化(margin trading)
+    - `QOQ`: 時間範圍內每季的每個index的數值以及QoQ
 
-- 修改法人買賣(institution_trading)的query方式
+    - `YoY`: 以end_date為準，取得與end_date同季的歷年資料以及成長率，時間範圍以start_date為起始
 
-### 0.0.11
-- 修復財務分析的千元計算問題
+- `start_date`: 開始日期，不設定時預設為`2005-01-01`
 
-- 籌碼面新增法人買賣(institution_trading)
+- `end_date`: 結束日期，不設定時預設為資料庫最新資料的日期
 
-- 將財報三表與月營收的資料型態與數值做轉換(%轉字串, 千元乘以1000)
-### 0.0.10
-- 更新指標的資料型態: 單位為千元乘以1000之後回傳整數
+- `report_type`: 選擇哪種報告，預設為`Q`
+    - `A`: 當年累計
+    - `Q`: 當季數值
+    - `TTM`: 移動四季 (包括當季在內，往前累計四個季度)
 
-- 處理銀行公司在finanace_overview會報錯誤的問題(未完全解決，因銀行公司財報有許多名稱不同，目前都會顯示為None)
+- `indexes`: 選擇的column，需要以TEJ提供的欄位名稱為準，不提供時或提供`[]`會回傳全部column
+   - 範例輸入: `['bp41', 'bp51']`
 
-### 0.0.9
-- 更新指標的資料型態: 單位為日, %, 倍轉為字串
+[TEJ資料集連結](https://tquant.tejwin.com/%E8%B3%87%E6%96%99%E9%9B%86/)
+請看 `公司自結數`

{neurostats_API-0.0.16.dist-info → neurostats_API-0.0.18.dist-info}/RECORD

@@ -1,30 +1,31 @@
-neurostats_API/__init__.py,sha256=5ToELVqNOIdVJrMj5G8JvbyRIjvo1FxcP6e-a-iMe1Y,261
+neurostats_API/__init__.py,sha256=S8SovSxsgsbHC7Ddhoka7I5juDmObJGSSX-As0KVcZE,261
 neurostats_API/cli.py,sha256=UJSWLIw03P24p-gkBb6JSEI5dW5U12UvLf1L8HjQD-o,873
 neurostats_API/main.py,sha256=QcsfmWivg2Dnqw3MTJWiI0QvEiRs0VuH-BjwQHFCv00,677
 neurostats_API/fetchers/__init__.py,sha256=B4aBwVzf_X-YieEf3fZteU0qmBPVIB9VjrmkyWhLK18,489
 neurostats_API/fetchers/balance_sheet.py,sha256=sQv4Gk5uoKURLEdh57YknOQWiyVwaXJ2Mw75jxNqUS0,5804
-neurostats_API/fetchers/base.py,sha256=rcrKW2PTJYfBsxsiGpCYiVTK9pQW4aALYLixIjvNMUk,4890
+neurostats_API/fetchers/base.py,sha256=AgSqjxSwmYGxhn8HaFcl-yyAE7r59l4FcFGhWSEitMA,5677
 neurostats_API/fetchers/cash_flow.py,sha256=TY7VAWVXkj5-mzH5Iu0sIE-oV8MvGmmDy0URNotNV1E,7614
 neurostats_API/fetchers/finance_overview.py,sha256=PxUdWY0x030olYMLcCHDBn068JLmCE2RTOce1dxs5vM,27753
 neurostats_API/fetchers/institution.py,sha256=UrcBc6t7u7CnEwUsf6YmLbbJ8VncdWpq8bCz17q2dgs,11168
 neurostats_API/fetchers/margin_trading.py,sha256=lQImtNdvaBoSlKhJvQ3DkH3HjSSgKRJz4ZZpyR5-Z4I,10433
 neurostats_API/fetchers/month_revenue.py,sha256=nixX2llzjCFr2m2YVjxrSfkBusnZPrPb2dRDq1XLGhw,4251
 neurostats_API/fetchers/profit_lose.py,sha256=EN9Y0iamcAaHMZdjHXO6b_2buLnORssf8ZS7A0hi74s,5896
-neurostats_API/fetchers/tech.py,sha256=Hol1bcwJ_ERcnoTXNWlqqaWOuzdl7MeiAjCvzQMZDTg,12269
-neurostats_API/fetchers/tej_finance_report.py,sha256=laXph2ca1LCFocZjjdvtzmm5fcUecHk2Gs5h6-XMSWY,12967
+neurostats_API/fetchers/tech.py,sha256=8U6kn7cvWJsmKIMn_f2l6U9H_NBy_OwOXlS26XhFIv0,12926
+neurostats_API/fetchers/tej_finance_report.py,sha256=O_mqrMY_A1pGR5geq1fS4Zm1AREKHzC2hKBEk4gA8hs,11822
 neurostats_API/fetchers/value_invest.py,sha256=b_x2Dpgs8VBU5HdG8ocKtfIEkqhU-Q0S5n6RxuFuM2g,7467
 neurostats_API/tools/balance_sheet.yaml,sha256=6XygNG_Ybb1Xkk1e39LMLKr7ATvaCP3xxuwFbgNl6dA,673
 neurostats_API/tools/cash_flow_percentage.yaml,sha256=fk2Z4eb1JjGFvP134eJatHacB7BgTkBenhDJr83w8RE,1345
 neurostats_API/tools/finance_overview_dict.yaml,sha256=B9nV75StXkrF3yv2-eezzitlJ38eEK86RD_VY6588gQ,2884
 neurostats_API/tools/profit_lose.yaml,sha256=iyp9asYJ04vAxk_HBUDse_IBy5oVvYHpwsyACg5YEeg,3029
 neurostats_API/tools/seasonal_data_field_dict.txt,sha256=X8yc_el6p8BH_3FikTqBVFGsvWdXT6MHXLfKfi44334,8491
+neurostats_API/tools/tej_db_index.yaml,sha256=lu-cmbB6dhx0eUlBSkyzXWqPKlwRtEvqlMTAh2y0oHs,969
 neurostats_API/utils/__init__.py,sha256=0tJCRmlJq2aDwcNNW-oEaA9H0OxTJMFvjpVYtG4AvZU,186
 neurostats_API/utils/calculate_value.py,sha256=lUKSsWU76XRmDUcmi4eDjoQxjb3vWpAAKInF9w49VNI,782
 neurostats_API/utils/data_process.py,sha256=A--dzOsu42jRxqqCD41gTtjE5rhEBYmhB6y-AnCvo5U,8986
 neurostats_API/utils/datetime.py,sha256=XJya4G8b_-ZOaBbMXgQjWh2MC4wc-o6goQ7EQJQMWrQ,773
 neurostats_API/utils/db_client.py,sha256=OYe6yazcR4Aa6jYmy47JrryUeh2NnKGqY2K_lSZe6i8,455
 neurostats_API/utils/fetcher.py,sha256=VbrUhjA-GG5AyjPX2SHtFIbZM4dm3jo0RgZzuCbb_Io,40927
-neurostats_API-0.0.16.dist-info/METADATA,sha256=9US1mdwWnOCAnwfsOj-ZLRCfo07p3yd0UfwMKS6989g,29848
-neurostats_API-0.0.16.dist-info/WHEEL,sha256=R06PA3UVYHThwHvxuRWMqaGcr-PuniXahwjmQRFMEkY,91
-neurostats_API-0.0.16.dist-info/top_level.txt,sha256=nSlQPMG0VtXivJyedp4Bkf86EOy2TpW10VGxolXrqnU,15
-neurostats_API-0.0.16.dist-info/RECORD,,
+neurostats_API-0.0.18.dist-info/METADATA,sha256=S8Fn1OmtZ0kxsl2BXdqyy0T2KYISxkMJPvqzv2glgPM,30350
+neurostats_API-0.0.18.dist-info/WHEEL,sha256=R06PA3UVYHThwHvxuRWMqaGcr-PuniXahwjmQRFMEkY,91
+neurostats_API-0.0.18.dist-info/top_level.txt,sha256=nSlQPMG0VtXivJyedp4Bkf86EOy2TpW10VGxolXrqnU,15
+neurostats_API-0.0.18.dist-info/RECORD,,