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

xfintech/data/source/baostock/session/tests/test_class_session_all.py

@@ -0,0 +1,505 @@
+"""
+Test suite for Session class
+Tests cover initialization, connection modes, state management, and session lifecycle
+"""
+
+from datetime import datetime
+from unittest.mock import Mock, patch
+
+import pandas as pd
+import pytest
+
+from xfintech.data.source.baostock.session.session import Session
+
+# ============================================================================
+# Session Initialization Tests - Direct Mode
+# ============================================================================
+
+
+@patch("xfintech.data.source.baostock.session.session.bs")
+def test_session_init_direct_mode_basic(mock_bs):
+    """Test Session initialization in direct mode"""
+    mock_bs.login.return_value = Mock()
+
+    session = Session(mode="direct")
+
+    assert session.mode == "direct"
+    assert session._credential is None
+    assert session.relay_url is None
+    assert session.relay_secret is None
+    assert len(session.id) == 8
+    assert session.connected is True
+
+
+@patch("xfintech.data.source.baostock.session.session.bs")
+def test_session_init_direct_mode_default(mock_bs):
+    """Test Session defaults to direct mode"""
+    mock_bs.login.return_value = Mock()
+
+    session = Session()
+
+    assert session.mode == "direct"
+
+
+@patch("xfintech.data.source.baostock.session.session.bs")
+def test_session_init_direct_mode_uppercase(mock_bs):
+    """Test Session handles uppercase mode"""
+    mock_bs.login.return_value = Mock()
+
+    session = Session(mode="DIRECT")
+
+    assert session.mode == "direct"
+
+
+@patch("xfintech.data.source.baostock.session.session.bs")
+def test_session_init_direct_calls_login(mock_bs):
+    """Test Session calls bs.login in direct mode"""
+    mock_bs.login.return_value = Mock()
+
+    Session(mode="direct")
+
+    mock_bs.login.assert_called_once()
+
+
+@patch("xfintech.data.source.baostock.session.session.bs")
+def test_session_init_direct_creates_connection(mock_bs):
+    """Test Session creates baostock connection"""
+    mock_bs.login.return_value = Mock()
+
+    session = Session(mode="direct")
+
+    assert session.connection is mock_bs
+
+
+# ============================================================================
+# Session Resolve Methods Tests
+# ============================================================================
+
+
+def test_session_resolve_mode_invalid():
+    """Test _resolve_mode raises error with invalid mode"""
+    with pytest.raises(ValueError, match="Unsupported mode"):
+        Session(mode="invalid")
+
+
+@patch("xfintech.data.source.baostock.session.session.bs")
+def test_session_resolve_mode_empty_returns_direct(mock_bs):
+    """Test _resolve_mode returns 'direct' for empty string"""
+    mock_bs.login.return_value = Mock()
+
+    session = Session(mode="")
+
+    assert session.mode == "direct"
+
+
+# ============================================================================
+# Session ID Tests
+# ============================================================================
+
+
+@patch("xfintech.data.source.baostock.session.session.bs")
+def test_session_id_length(mock_bs):
+    """Test Session ID is 8 characters"""
+    mock_bs.login.return_value = Mock()
+
+    session = Session()
+
+    assert len(session.id) == 8
+
+
+@patch("xfintech.data.source.baostock.session.session.bs")
+def test_session_id_unique(mock_bs):
+    """Test different Sessions have different IDs"""
+    mock_bs.login.return_value = Mock()
+
+    session1 = Session()
+    session2 = Session()
+
+    assert session1.id != session2.id
+
+
+# ============================================================================
+# Session Properties Tests
+# ============================================================================
+
+
+@patch("xfintech.data.source.baostock.session.session.bs")
+def test_session_connected_property_true(mock_bs):
+    """Test connected property returns True when connection exists"""
+    mock_bs.login.return_value = Mock()
+
+    session = Session()
+
+    assert session.connected is True
+
+
+@patch("xfintech.data.source.baostock.session.session.bs")
+def test_session_connected_property_false(mock_bs):
+    """Test connected property returns False when no connection"""
+    mock_bs.login.return_value = Mock()
+
+    session = Session()
+    session.connection = None
+
+    assert session.connected is False
+
+
+@patch("xfintech.data.source.baostock.session.session.bs")
+@patch("xfintech.data.source.baostock.session.session.pd.Timestamp")
+def test_session_duration_property_no_start(mock_timestamp, mock_bs):
+    """Test duration returns 0.0 when not started"""
+    mock_bs.login.return_value = Mock()
+
+    session = Session()
+    session.start_at = None
+
+    assert session.duration == 0.0
+
+
+@patch("xfintech.data.source.baostock.session.session.bs")
+def test_session_duration_property_ongoing(mock_bs):
+    """Test duration calculates correctly for ongoing session"""
+    mock_bs.login.return_value = Mock()
+
+    # Create session
+    session = Session()
+
+    # Set times directly
+    session.start_at = pd.Timestamp("2024-01-15 10:00:00")
+    session.finish_at = None
+
+    # Mock datetime.now to return a specific time
+    with patch(
+        "xfintech.data.source.baostock.session.session.datetime",
+    ) as mock_datetime:
+        mock_now = datetime(2024, 1, 15, 10, 0, 10)
+        mock_datetime.now.return_value = mock_now
+
+        duration = session.duration
+
+        assert duration == 10.0
+
+
+@patch("xfintech.data.source.baostock.session.session.bs")
+def test_session_duration_property_finished(mock_bs):
+    """Test duration calculates correctly for finished session"""
+    mock_bs.login.return_value = Mock()
+
+    session = Session()
+    session.start_at = pd.Timestamp("2024-01-15 10:00:00")
+    session.finish_at = pd.Timestamp("2024-01-15 10:00:30")
+
+    assert session.duration == 30.0
+
+
+# ============================================================================
+# Session String Representation Tests
+# ============================================================================
+
+
+@patch("xfintech.data.source.baostock.session.session.bs")
+def test_session_str(mock_bs):
+    """Test __str__ returns session ID"""
+    mock_bs.login.return_value = Mock()
+
+    session = Session()
+
+    assert str(session) == session.id
+
+
+@patch("xfintech.data.source.baostock.session.session.bs")
+def test_session_repr(mock_bs):
+    """Test __repr__ includes class name, connected status, and mode"""
+    mock_bs.login.return_value = Mock()
+
+    session = Session(mode="direct")
+
+    result = repr(session)
+    assert "Session" in result
+    assert "connected=True" in result
+    assert "mode=direct" in result
+
+
+@patch("xfintech.data.source.baostock.session.session.BaostockRelayClient")
+def test_session_repr_relay_mode(mock_relay_client_class):
+    """Test __repr__ shows relay mode"""
+    mock_client = Mock()
+    mock_client.check_health.return_value = True
+    mock_relay_client_class.return_value = mock_client
+
+    session = Session(
+        mode="relay",
+        relay_url="https://relay.example.com",
+        relay_secret="relay-secret",
+    )
+
+    result = repr(session)
+    assert "mode=relay" in result
+
+
+# ============================================================================
+# Session Start/End Methods Tests
+# ============================================================================
+
+
+@patch("xfintech.data.source.baostock.session.session.bs")
+@patch("xfintech.data.source.baostock.session.session.pd.Timestamp")
+def test_session_start_method(mock_timestamp, mock_bs):
+    """Test start method sets start_at"""
+    mock_bs.login.return_value = Mock()
+    mock_now = pd.Timestamp("2024-01-15 10:00:00")
+    mock_timestamp.now.return_value = mock_now
+
+    session = Session()
+    session.start_at = None
+    session.start()
+
+    assert session.start_at == mock_now
+
+
+@patch("xfintech.data.source.baostock.session.session.bs")
+@patch("xfintech.data.source.baostock.session.session.pd.Timestamp")
+def test_session_end_method(mock_timestamp, mock_bs):
+    """Test end method sets finish_at"""
+    mock_bs.login.return_value = Mock()
+    mock_now = pd.Timestamp("2024-01-15 10:00:30")
+    mock_timestamp.now.return_value = mock_now
+
+    session = Session()
+    session.end()
+
+    assert session.finish_at == mock_now
+
+
+@patch("xfintech.data.source.baostock.session.session.bs")
+def test_session_get_start_iso_none(mock_bs):
+    """Test get_start_iso returns None when start_at is None"""
+    mock_bs.login.return_value = Mock()
+
+    session = Session()
+    session.start_at = None
+
+    assert session.get_start_iso() is None
+
+
+@patch("xfintech.data.source.baostock.session.session.bs")
+def test_session_get_start_iso_with_value(mock_bs):
+    """Test get_start_iso returns ISO format"""
+    mock_bs.login.return_value = Mock()
+
+    session = Session()
+    session.start_at = pd.Timestamp("2024-01-15 10:00:00")
+
+    result = session.get_start_iso()
+    assert "2024-01-15" in result
+
+
+@patch("xfintech.data.source.baostock.session.session.bs")
+def test_session_get_finish_iso_none(mock_bs):
+    """Test get_finish_iso returns None when finish_at is None"""
+    mock_bs.login.return_value = Mock()
+
+    session = Session()
+    session.finish_at = None
+
+    assert session.get_finish_iso() is None
+
+
+@patch("xfintech.data.source.baostock.session.session.bs")
+def test_session_get_finish_iso_with_value(mock_bs):
+    """Test get_finish_iso returns ISO format"""
+    mock_bs.login.return_value = Mock()
+
+    session = Session()
+    session.finish_at = pd.Timestamp("2024-01-15 10:00:30")
+    session = Session()
+    session.connection = None
+
+    result = session.connect()
+
+    assert result is not None
+
+
+@patch("xfintech.data.source.baostock.session.session.bs")
+def test_session_connect_already_connected(mock_bs):
+    """Test connect returns existing connection if already connected"""
+    mock_bs.login.return_value = Mock()
+
+    session = Session()
+    first_connection = session.connection
+
+    # Reset call count
+    mock_bs.login.reset_mock()
+
+    # Try to connect again
+    result = session.connect()
+
+    assert result is first_connection
+    # Should not call login again
+    mock_bs.login.assert_not_called()
+
+
+@patch("xfintech.data.source.baostock.session.session.bs")
+@patch("xfintech.data.source.baostock.session.session.pd.Timestamp")
+def test_session_disconnect_clears_connection(mock_timestamp, mock_bs):
+    """Test disconnect clears connection"""
+    mock_bs.login.return_value = Mock()
+    mock_bs.logout.return_value = Mock()
+
+    session = Session()
+    assert session.connected is True
+
+    session.disconnect()
+
+    assert session.connection is None
+    assert session.connected is False
+    mock_bs.logout.assert_called_once()
+
+
+@patch("xfintech.data.source.baostock.session.session.bs")
+@patch("xfintech.data.source.baostock.session.session.pd.Timestamp")
+def test_session_disconnect_sets_finish_time(mock_timestamp, mock_bs):
+    """Test disconnect sets finish_at"""
+    mock_bs.login.return_value = Mock()
+    mock_bs.logout.return_value = Mock()
+    mock_now = pd.Timestamp("2024-01-15 10:00:30")
+    mock_timestamp.now.return_value = mock_now
+
+    session = Session()
+    session.disconnect()
+
+    assert session.finish_at == mock_now
+
+
+# ============================================================================
+# Session Describe Method Tests
+# ============================================================================
+
+
+@patch("xfintech.data.source.baostock.session.session.bs")
+def test_session_describe_basic(mock_bs):
+    """Test describe returns basic session info"""
+    mock_bs.login.return_value = Mock()
+
+    session = Session(mode="direct")
+    result = session.describe()
+
+    assert "id" in result
+    assert result["id"] == session.id
+    assert "mode" in result
+    assert result["mode"] == "direct"
+    assert "connected" in result
+    assert result["connected"] is True
+
+
+@patch("xfintech.data.source.baostock.session.session.BaostockRelayClient")
+def test_session_describe_relay_mode(mock_relay_client_class):
+    """Test describe includes relay info in relay mode"""
+    mock_client = Mock()
+    mock_client.check_health.return_value = True
+
+
+@patch("xfintech.data.source.baostock.session.session.bs")
+def test_session_describe_with_timestamps(mock_bs):
+    """Test describe includes timestamps when available"""
+    mock_bs.login.return_value = Mock()
+
+    session = Session()
+    session.start_at = pd.Timestamp("2024-01-15 10:00:00")
+    session.finish_at = pd.Timestamp("2024-01-15 10:00:30")
+
+    result = session.describe()
+
+    assert "start_at" in result
+    assert "finish_at" in result
+
+
+@patch("xfintech.data.source.baostock.session.session.bs")
+def test_session_describe_without_finish(mock_bs):
+    """Test describe handles ongoing session"""
+    mock_bs.login.return_value = Mock()
+
+    session = Session()
+    session.finish_at = None
+
+    result = session.describe()
+
+    assert "start_at" in result
+    assert "finish_at" not in result
+
+
+# ============================================================================
+# Session To Dict Method Tests
+# ============================================================================
+
+
+@patch("xfintech.data.source.baostock.session.session.bs")
+def test_session_to_dict_structure(mock_bs):
+    """Test to_dict returns expected structure"""
+    mock_bs.login.return_value = Mock()
+
+    session = Session(mode="direct")
+    result = session.to_dict()
+
+    assert "id" in result
+    assert "connected" in result
+    assert "mode" in result
+    assert "relay" in result
+    assert "start_at" in result
+    assert "finish_at" in result
+    assert "duration" in result
+
+
+@patch("xfintech.data.source.baostock.session.session.bs")
+def test_session_to_dict_includes_duration(mock_bs):
+    """Test to_dict includes duration"""
+    mock_bs.login.return_value = Mock()
+
+    session = Session()
+    session.start_at = pd.Timestamp("2024-01-15 10:00:00")
+    session.finish_at = pd.Timestamp("2024-01-15 10:00:30")
+
+    result = session.to_dict()
+
+    assert result["duration"] == 30.0
+
+
+# ============================================================================
+# Integration Tests
+# ============================================================================
+
+
+@patch("xfintech.data.source.baostock.session.session.bs")
+def test_session_full_lifecycle_direct(mock_bs):
+    """Test complete session lifecycle in direct mode"""
+    mock_bs.login.return_value = Mock()
+    mock_bs.logout.return_value = Mock()
+
+    # Create session
+    session = Session(mode="direct")
+    assert session.connected is True
+
+    # Use connection
+    assert session.connection is mock_bs
+
+    # Disconnect
+    session.disconnect()
+    assert session.connected is False
+    assert session.finish_at is not None
+    mock_bs.logout.assert_called_once()
+
+
+@patch("xfintech.data.source.baostock.session.session.bs")
+def test_session_reconnect(mock_bs):
+    """Test reconnecting after disconnect"""
+    mock_bs.login.return_value = Mock()
+    mock_bs.logout.return_value = Mock()
+
+    session = Session()
+    session.disconnect()
+
+    # Reconnect
+    session.connect()
+
+    assert session.connected is True
+    assert session.connection is not None

xfintech/data/source/baostock/stock/hs300stock/__init__.py

@@ -0,0 +1,3 @@
+from .hs300stock import HS300Stock
+
+__all__ = ["HS300Stock"]

xfintech/data/source/baostock/stock/hs300stock/constant.py

@@ -0,0 +1,49 @@
+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 = "baostock"
+SOURCE_NAME = "query_hs300_stocks"
+URL = "http://www.baostock.com/mainContent?file=hs300Stock.md"
+ARGS = {}
+
+# Exported constants
+NAME = "hs300stock"
+KEY = "/baostock/hs300stock"
+PAGINATE = Paginate(
+    pagesize=10000,
+    pagelimit=100,
+)
+SOURCE = TableInfo(
+    desc="沪深300成分股（BaoStock格式）",
+    meta={
+        "provider": PROVIDER,
+        "source": SOURCE_NAME,
+        "url": URL,
+        "args": ARGS,
+        "type": "static",
+        "scale": "crosssection",
+    },
+    columns=[
+        ColumnInfo(name="updateDate", kind=ColumnKind.STRING, desc="更新日期"),
+        ColumnInfo(name="code", kind=ColumnKind.STRING, desc="证券代码"),
+        ColumnInfo(name="code_name", kind=ColumnKind.STRING, desc="证券名称"),
+    ],
+)
+TARGET = TableInfo(
+    desc="沪深300成分股（xfintech格式）",
+    meta={
+        "key": KEY,
+        "name": NAME,
+        "type": "static",
+        "scale": "crosssection",
+    },
+    columns=[
+        ColumnInfo(name="update_date", kind=ColumnKind.STRING, desc="更新日期"),
+        ColumnInfo(name="code", kind=ColumnKind.STRING, desc="证券代码"),
+        ColumnInfo(name="name", kind=ColumnKind.STRING, desc="证券名称"),
+    ],
+)

xfintech/data/source/baostock/stock/hs300stock/hs300stock.py

@@ -0,0 +1,133 @@
+from __future__ import annotations
+
+from typing import Any, Dict, List, 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.baostock.job import BaostockJob
+from xfintech.data.source.baostock.session.session import Session
+from xfintech.data.source.baostock.stock.hs300stock.constant import (
+    KEY,
+    NAME,
+    PAGINATE,
+    SOURCE,
+    TARGET,
+)
+
+
+@JobHouse.register(KEY, alias=KEY)
+class HS300Stock(BaostockJob):
+    """
+    描述:
+    - 获取沪深300成分股
+    - 返回沪深300指数的300只成份股信息
+    - 每周一更新
+    - API文档: http://www.baostock.com/mainContent?file=hs300Stock.md
+    - SCALE: CrossSection
+    - TYPE: Static
+    - PAGINATE: 10000 rows / 100 pages
+
+    属性:
+    - name: str, 作业名称 'hs300index'。
+    - key: str, 作业键 '/baostock/hs300index'。
+    - session: Session, Baostock会话对象。
+    - source: TableInfo, 源表信息（BaoStock原始格式）。
+    - target: TableInfo, 目标表信息（xfintech格式）。
+    - params: Params, 查询参数（此API无需参数）。
+    - coolant: Coolant, 请求冷却控制。
+    - paginate: Paginate, 分页控制（pagesize=10000, pagelimit=100）。
+    - retry: Retry, 重试策略。
+    - cache: Cache, 缓存管理。
+
+    方法:
+    - run(): 执行作业，返回沪深300成分股DataFrame。
+    - _run(): 内部执行逻辑，处理参数并调用API。
+    - transform(data): 转换数据格式，将源格式转为目标格式。
+    - list_codes(): 返回所有股票代码列表。
+    - list_names(): 返回所有股票名称列表。
+
+    例子:
+    ```python
+        from xfintech.data.source.baostock.session import Session
+        from xfintech.data.source.baostock.stock.hs300index import HS300Stock
+
+        session = Session()
+
+        # 获取沪深300成分股
+        job = HS300Stock(session=session)
+        df = job.run()
+
+        # 获取代码列表
+        codes = job.list_codes()
+    ```
+    """
+
+    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
+
+        payload = self.params.to_dict()
+        payload = self._parse_date_params(payload, keys=["date"])
+        # Fetch data from API
+        data = self._fetchall(
+            api=self.connection.query_hs300_stocks,
+            **payload,
+        )
+        result = self.transform(data)
+        self._save_cache(result)
+        return result
+
+    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)
+
+        out = data.copy()
+        out["update_date"] = out["updateDate"].astype(str)
+        out["code"] = out["code"].astype(str)
+        out["name"] = out["code_name"].astype(str)
+
+        # Finalize output
+        out = out[cols].drop_duplicates()
+        out = out.sort_values(by=["code"])
+        out = out.reset_index(drop=True)
+        self.markpoint("transform[OK]")
+        return out
+
+    def list_codes(self) -> List[str]:
+        df = self.run()
+        return sorted(df["code"].unique().tolist())
+
+    def list_names(self) -> List[str]:
+        df = self.run()
+        return sorted(df["name"].unique().tolist())

xfintech/data/source/baostock/stock/hs300stock/tests/__init__.py

@@ -0,0 +1 @@
+"""Tests for hs300index module."""