lib-x17-fintech 2.1.3__py3-none-any.whl

xfintech/data/source/tushare/stock/stocksuspend/__init__.py

@@ -0,0 +1,21 @@
+from __future__ import annotations
+
+from xfintech.data.source.tushare.stock.stocksuspend.constant import (
+    KEY,
+    NAME,
+    PAGINATE,
+    SOURCE,
+    TARGET,
+)
+from xfintech.data.source.tushare.stock.stocksuspend.stocksuspend import (
+    StockSuspend,
+)
+
+__all__ = [
+    "StockSuspend",
+    "KEY",
+    "NAME",
+    "PAGINATE",
+    "SOURCE",
+    "TARGET",
+]

xfintech/data/source/tushare/stock/stocksuspend/constant.py

@@ -0,0 +1,75 @@
+from __future__ import annotations
+
+from xfintech.data.common.paginate import Paginate
+from xfintech.fabric.column.info import ColumnInfo
+from xfintech.fabric.column.kind import ColumnKind
+from xfintech.fabric.table.info import TableInfo
+
+PROVIDER = "tushare"
+SOURCE_NAME = "suspend_d"
+URL = "https://tushare.pro/document/2?doc_id=214"
+ARGS = {
+    "ts_code": {
+        "type": ColumnKind.STRING,
+        "required": "N",
+        "desc": "TS股票代码",
+    },
+    "start_date": {
+        "type": ColumnKind.STRING,
+        "required": "N",
+        "desc": "开始日期(YYYYMMDD)",
+    },
+    "end_date": {
+        "type": ColumnKind.STRING,
+        "required": "N",
+        "desc": "结束日期(YYYYMMDD)",
+    },
+    "trade_date": {
+        "type": ColumnKind.STRING,
+        "required": "N",
+        "desc": "交易日期(YYYYMMDD)",
+    },
+}
+
+# Exported constants
+NAME = "stocksuspend"
+KEY = "/tushare/stocksuspend"
+PAGINATE = Paginate(
+    pagesize=1000,
+    pagelimit=1000,
+)
+SOURCE = TableInfo(
+    desc="股票停复牌信息（Tushare格式）",
+    meta={
+        "provider": PROVIDER,
+        "source": SOURCE_NAME,
+        "url": URL,
+        "args": ARGS,
+        "type": "partitioned",
+        "scale": "crosssection",
+    },
+    name=SOURCE_NAME,
+    columns=[
+        ColumnInfo(name="ts_code", kind=ColumnKind.STRING, desc="TS股票代码"),
+        ColumnInfo(name="trade_date", kind=ColumnKind.STRING, desc="交易日期"),
+        ColumnInfo(name="suspend_timing", kind=ColumnKind.STRING, desc="日内停牌时间段"),
+        ColumnInfo(name="suspend_type", kind=ColumnKind.STRING, desc="停复牌类型"),
+    ],
+)
+TARGET = TableInfo(
+    desc="股票停复牌信息（标准格式）",
+    meta={
+        "key": KEY,
+        "name": NAME,
+        "type": "partitioned",
+        "scale": "crosssection",
+    },
+    name=NAME,
+    columns=[
+        ColumnInfo(name="code", kind=ColumnKind.STRING, desc="股票代码"),
+        ColumnInfo(name="date", kind=ColumnKind.STRING, desc="交易日期"),
+        ColumnInfo(name="datecode", kind=ColumnKind.STRING, desc="交易日期字符串"),
+        ColumnInfo(name="suspend_timing", kind=ColumnKind.STRING, desc="日内停牌时间段"),
+        ColumnInfo(name="suspend_type", kind=ColumnKind.STRING, desc="停复牌类型"),
+    ],
+)

xfintech/data/source/tushare/stock/stocksuspend/stocksuspend.py

@@ -0,0 +1,151 @@
+from __future__ import annotations
+
+from typing import Any, Dict, Optional
+
+import pandas as pd
+
+from xfintech.data.common.cache import Cache
+from xfintech.data.common.coolant import Coolant
+from xfintech.data.common.params import Params
+from xfintech.data.common.retry import Retry
+from xfintech.data.job import JobHouse
+from xfintech.data.source.tushare.job import TushareJob
+from xfintech.data.source.tushare.session.session import Session
+from xfintech.data.source.tushare.stock.stocksuspend.constant import (
+    KEY,
+    NAME,
+    PAGINATE,
+    SOURCE,
+    TARGET,
+)
+
+
+@JobHouse.register(KEY, alias=KEY)
+class StockSuspend(TushareJob):
+    """
+    描述:
+    - 获取股票每日停复牌信息（按日期或日期范围查询）
+    - API文档: https://tushare.pro/document/2?doc_id=397
+    - SCALE: CrossSection
+    - TYPE: Partitioned
+    - PAGINATE: 1000 rows / 1000 pages
+
+    属性:
+    - name: str, 作业名称 'stocksuspend'。
+    - key: str, 作业键 '/tushare/stocksuspend'。
+    - session: Session, Tushare会话对象。
+    - source: TableInfo, 源表信息（Tushare原始格式）。
+    - target: TableInfo, 目标表信息（转换后格式）。
+    - params: Params, 查询参数。
+        - ts_code: str, 可选, TS股票代码
+        - trade_date: str, 可选, 交易日期（YYYYMMDD）
+        - start_date: str, 可选, 开始日期（YYYYMMDD）
+        - end_date: str, 可选, 结束日期（YYYYMMDD）
+    - coolant: Coolant, 请求冷却控制。
+    - paginate: Paginate, 分页控制（pagesize=1000, pagelimit=1000）。
+    - retry: Retry, 重试策略。
+    - cache: Cache, 缓存管理。
+
+    方法:
+    - run(): 执行作业，返回停复牌信息DataFrame。
+    - _run(): 内部执行逻辑，处理日期参数转换。
+    - transform(data): 转换数据格式，将源格式转为目标格式。
+
+    例子:
+    ```python
+    from xfintech.data.source.tushare.session import Session
+    from xfintech.data.source.tushare.stock.stocksuspend import StockSuspend
+
+    session = Session(credential="your_token")
+    suspend = StockSuspend(
+        session=session,
+        params={"trade_date": "20201231"},
+    )
+    df = suspend.run()
+    ```
+    """
+
+    def __init__(
+        self,
+        session: Session,
+        params: Optional[Params | Dict[str, Any]] = None,
+        coolant: Optional[Coolant | Dict[str, Any]] = None,
+        retry: Optional[Retry | Dict[str, Any]] = None,
+        cache: Optional[Cache | Dict[str, str] | bool] = None,
+    ) -> None:
+        super().__init__(
+            name=NAME,
+            key=KEY,
+            session=session,
+            source=SOURCE,
+            target=TARGET,
+            params=params,
+            coolant=coolant,
+            paginate=PAGINATE,
+            retry=retry,
+            cache=cache,
+        )
+
+    def _run(self) -> pd.DataFrame:
+        cached = self._load_cache()
+        if cached is not None:
+            return cached
+
+        # Prepare payload dict
+        payload = self.params.to_dict()
+        payload = self._parse_date_params(
+            payload,
+            keys=[
+                "trade_date",
+                "start_date",
+                "end_date",
+            ],
+        )
+        payload = self._parse_string_params(
+            payload,
+            keys=["ts_code"],
+        )
+        all_fields = self.source.list_column_names()
+        payload["fields"] = ",".join(all_fields)
+
+        # Fetch and transform data
+        data = self._fetchall(
+            api=self.connection.suspend_d,
+            **payload,
+        )
+        result = self.transform(data)
+        self._save_cache(result)
+        return result
+
+    # Transform logic
+    def transform(
+        self,
+        data: pd.DataFrame,
+    ) -> pd.DataFrame:
+        cols = self.target.list_column_names()
+        if data is None or data.empty:
+            return pd.DataFrame(columns=cols)
+
+        transformed = {}
+        transformed["code"] = data["ts_code"].astype(str)
+        transformed["datecode"] = data["trade_date"].astype(str)
+        transformed["date"] = pd.to_datetime(
+            data["trade_date"],
+            format="%Y%m%d",
+            errors="coerce",
+        ).dt.strftime("%Y-%m-%d")
+        for col in ["suspend_timing", "suspend_type"]:
+            if col in data.columns:
+                transformed[col] = data[col].astype(str)
+
+        for col in cols:
+            if col not in transformed:
+                transformed[col] = pd.NA
+
+        # Select target columns, drop duplicates, and sort
+        out = pd.DataFrame(transformed)
+        out = out[cols].drop_duplicates()
+        out = out.sort_values(by=["code", "date"])
+        out = out.reset_index(drop=True)
+        self.markpoint("transform[OK]")
+        return out