lixinger-python 0.3.2__tar.gz → 0.3.4__tar.gz

{lixinger_python-0.3.2 → lixinger_python-0.3.4}/.claude/settings.local.json

@@ -106,7 +106,10 @@
       "Bash(grep -r \"API Endpoint:\" lixinger/api/cn/company/*.py | head -10)",
       "Bash(uv run mypy lixinger/api/cn/company/dividend.py)",
       "Bash(uv run mypy lixinger/models/cn/company/dividend.py lixinger/api/cn/company/dividend.py)",
-      "Bash(uv run:*)"
+      "Bash(uv run:*)",
+      "Bash(curl *)",
+      "Read(//Users/JianGuo/.claude/plugins/cache/playwright-skill/playwright-skill/4.1.0/skills/playwright-skill/**)",
+      "Bash(node run.js ' *)"
     ]
   }
 }

{lixinger_python-0.3.2 → lixinger_python-0.3.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lixinger-python
-Version: 0.3.2
+Version: 0.3.4
 Summary: Python SDK for Lixinger Financial Data API
 Project-URL: Homepage, https://www.lixinger.com
 Project-URL: Documentation, https://www.lixinger.com/open/api/doc

lixinger_python-0.3.4/examples/dividend_example.py

@@ -0,0 +1,20 @@
+import asyncio
+
+from lixinger import AsyncLixingerClient
+
+
+async def main():
+    # Method 1: Using the async client with environment variables
+    # The API key is ALWAYS loaded from .env file (LIXINGER_API_KEY)
+    print("Method 1: Using async client (loads API key from .env)...")
+    client = AsyncLixingerClient()
+    try:
+        print("Fetching company information using client...")
+        df = await client.company.dividend.get_dividend(stock_code="000001", start_date="2026-03-01")
+        print(df)
+    finally:
+        await client.close()
+
+
+if __name__ == "__main__":
+    asyncio.run(main())

lixinger_python-0.3.4/lixinger/api/cn/company/candlestick.py

@@ -0,0 +1,113 @@
+from typing import Any, Literal
+
+import pandas as pd
+
+from lixinger.api.base import BaseAPI
+from lixinger.models.cn.company import Candlestick
+from lixinger.utils.api import api
+from lixinger.utils.dataframe import get_response_df
+
+
+class CandlestickAPI(BaseAPI):
+    """Candlestick (K-line) data APIs."""
+
+    async def get_candlestick(  # noqa: PLR0913
+        self,
+        stock_code: str,
+        start_date: str,
+        end_date: str,
+        adjust_type: Literal["ex_rights", "lxr_fc_rights", "fc_rights", "bc_rights"] | None = None,
+        adjust_forward_date: str | None = None,
+        adjust_backward_date: str | None = None,
+        limit: int | None = None,
+    ) -> pd.DataFrame:
+        """获取K线数据.
+
+        API Endpoint: /cn/company/candlestick
+        API Method: POST
+
+        Args:
+            stock_code: 股票代码
+            start_date: 开始日期 (YYYY-MM-DD)
+            end_date: 结束日期 (YYYY-MM-DD)
+            adjust_type: 复权类型
+                - ex_rights: 不复权
+                - lxr_fc_rights: 理杏仁前复权
+                - fc_rights: 前复权
+                - bc_rights: 后复权
+            adjust_forward_date: 前复权指定起始时间点 (YYYY-MM-DD)，需要与endDate一起使用且大于或等于endDate
+            adjust_backward_date: 后复权指定起始时间点 (YYYY-MM-DD)，需要与startDate一起使用且小于或等于startDate
+            limit: 返回最近数据的数量
+
+        Returns:
+            DataFrame containing candlestick data
+
+        """
+        payload: dict[str, Any] = {
+            "stockCode": stock_code,
+            "startDate": start_date,
+            "endDate": end_date,
+        }
+        if adjust_type is not None:
+            payload["type"] = adjust_type
+        if adjust_forward_date is not None:
+            payload["adjustForwardDate"] = adjust_forward_date
+        if adjust_backward_date is not None:
+            payload["adjustBackwardDate"] = adjust_backward_date
+        if limit is not None:
+            payload["limit"] = limit
+
+        data = await self._request("POST", "/cn/company/candlestick", json=payload)
+        return get_response_df(data, Candlestick)
+
+
+# Functional API instance
+_api_instance = CandlestickAPI()
+
+
+@api
+async def get_candlestick(  # noqa: PLR0913
+    stock_code: str,
+    start_date: str,
+    end_date: str,
+    adjust_type: Literal["ex_rights", "lxr_fc_rights", "fc_rights", "bc_rights"] | None = None,
+    adjust_forward_date: str | None = None,
+    adjust_backward_date: str | None = None,
+    limit: int | None = None,
+) -> pd.DataFrame:
+    """获取K线数据.
+
+    Args:
+        stock_code: 股票代码
+        start_date: 开始日期 (YYYY-MM-DD)
+        end_date: 结束日期 (YYYY-MM-DD)
+        adjust_type: 复权类型
+            - ex_rights: 不复权
+            - lxr_fc_rights: 理杏仁前复权
+            - fc_rights: 前复权
+            - bc_rights: 后复权
+        adjust_forward_date: 前复权指定起始时间点 (YYYY-MM-DD)
+        adjust_backward_date: 后复权指定起始时间点 (YYYY-MM-DD)
+        limit: 返回最近数据的数量
+
+    Returns:
+        DataFrame containing candlestick data
+
+    Example:
+        >>> df = await get_candlestick(
+        ...     stock_code="300750",
+        ...     start_date="2025-04-01",
+        ...     end_date="2026-04-01",
+        ...     adjust_type="lxr_fc_rights"
+        ... )
+
+    """
+    return await _api_instance.get_candlestick(
+        stock_code=stock_code,
+        start_date=start_date,
+        end_date=end_date,
+        adjust_type=adjust_type,
+        adjust_forward_date=adjust_forward_date,
+        adjust_backward_date=adjust_backward_date,
+        limit=limit,
+    )

{lixinger_python-0.3.2 → lixinger_python-0.3.4}/lixinger/models/cn/company/dividend.py

@@ -22,6 +22,7 @@ class Dividend(pa.DataFrameModel):
         ex_date: 除权除息日
         payment_date: 分红到账日
         fs_end_date: 财报时间
+        status: 状态（board_director_plan/shareholders_meeting_plan/company_plan/delay_implementation/cancelled/implemented/terminated/plan）
         stock_code: 股票代码（由SDK添加）
 
     """
@@ -43,6 +44,7 @@ class Dividend(pa.DataFrameModel):
 
     # 可选字段
     content: pa.typing.Series[str] | None = pa.Field(nullable=True)
+    status: pa.typing.Series[str] | None = pa.Field(nullable=True)
     register_date: pa.typing.Series[pa.typing.DateTime] | None = pa.Field(nullable=True)
     ex_date: pa.typing.Series[pa.typing.DateTime] | None = pa.Field(nullable=True)
     payment_date: pa.typing.Series[pa.typing.DateTime] | None = pa.Field(nullable=True)

{lixinger_python-0.3.2 → lixinger_python-0.3.4}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "lixinger-python"
-version = "0.3.2"
+version = "0.3.4"
 description = "Python SDK for Lixinger Financial Data API"
 readme = "README.md"
 requires-python = ">=3.11"

{lixinger_python-0.3.2 → lixinger_python-0.3.4}/tests/api/cn/company/test_dividend.py

@@ -121,7 +121,7 @@ async def test_get_dividend_with_optional_fields_missing():
                 "bonusSharesFromCapitalReserve": 0,
                 "dividend": 1.5,
                 # Optional fields missing: content, registerDate, exDate, paymentDate,
-                # dividendAmount, annualNetProfit, annualNetProfitDividendRatio
+                # dividendAmount, annualNetProfit, annualNetProfitDividendRatio, status
             }
         ],
     }
@@ -141,3 +141,130 @@ async def test_get_dividend_with_optional_fields_missing():
         assert "content" not in df.columns
         assert "annual_net_profit" not in df.columns
         assert "annual_net_profit_dividend_ratio" not in df.columns
+        assert "status" not in df.columns
+
+
+@pytest.mark.asyncio
+async def test_get_dividend_with_status_field():
+    """Test that status field is properly handled when present."""
+    mock_response = {
+        "code": 1,
+        "message": "success",
+        "data": [
+            {
+                "date": "2023-03-25T00:00:00+08:00",
+                "fsEndDate": "2022-12-31T00:00:00+08:00",
+                "currency": "CNY",
+                "bonusSharesFromProfit": 0,
+                "bonusSharesFromCapitalReserve": 0,
+                "dividend": 1.738,
+                "status": "implemented",
+            }
+        ],
+    }
+
+    with patch("httpx.AsyncClient.request") as mock_request:
+        mock_request.return_value = Mock()
+        mock_request.return_value.status_code = 200
+        mock_request.return_value.json.return_value = mock_response
+
+        df = await get_dividend(stock_code="600036", start_date="2023-01-01")
+
+        assert isinstance(df, pd.DataFrame)
+        assert len(df) == 1
+        assert df.iloc[0]["status"] == "implemented"
+
+
+@pytest.mark.asyncio
+@pytest.mark.parametrize(
+    "status_value",
+    [
+        "board_director_plan",  # 董事会预案
+        "shareholders_meeting_plan",  # 股东大会预案
+        "company_plan",  # 公司预案
+        "delay_implementation",  # 延迟实施
+        "cancelled",  # 取消分红
+        "implemented",  # 已执行
+        "terminated",  # 终止
+        "plan",  # 预案
+    ],
+)
+async def test_get_dividend_with_all_status_values(status_value: str):
+    """Test all possible status values from the API documentation."""
+    mock_response = {
+        "code": 1,
+        "message": "success",
+        "data": [
+            {
+                "date": "2023-03-25T00:00:00+08:00",
+                "fsEndDate": "2022-12-31T00:00:00+08:00",
+                "currency": "CNY",
+                "bonusSharesFromProfit": 0,
+                "bonusSharesFromCapitalReserve": 0,
+                "dividend": 1.5,
+                "status": status_value,
+            }
+        ],
+    }
+
+    with patch("httpx.AsyncClient.request") as mock_request:
+        mock_request.return_value = Mock()
+        mock_request.return_value.status_code = 200
+        mock_request.return_value.json.return_value = mock_response
+
+        df = await get_dividend(stock_code="600036", start_date="2023-01-01")
+
+        assert isinstance(df, pd.DataFrame)
+        assert len(df) == 1
+        assert df.iloc[0]["status"] == status_value
+
+
+@pytest.mark.asyncio
+async def test_get_dividend_with_multiple_status_values():
+    """Test multiple dividend records with different status values."""
+    mock_response = {
+        "code": 1,
+        "message": "success",
+        "data": [
+            {
+                "date": "2023-03-25T00:00:00+08:00",
+                "fsEndDate": "2022-12-31T00:00:00+08:00",
+                "currency": "CNY",
+                "bonusSharesFromProfit": 0,
+                "bonusSharesFromCapitalReserve": 0,
+                "dividend": 1.738,
+                "status": "implemented",
+            },
+            {
+                "date": "2024-03-20T00:00:00+08:00",
+                "fsEndDate": "2023-12-31T00:00:00+08:00",
+                "currency": "CNY",
+                "bonusSharesFromProfit": 0,
+                "bonusSharesFromCapitalReserve": 0,
+                "dividend": 1.8,
+                "status": "board_director_plan",
+            },
+            {
+                "date": "2024-04-15T00:00:00+08:00",
+                "fsEndDate": "2023-12-31T00:00:00+08:00",
+                "currency": "CNY",
+                "bonusSharesFromProfit": 0,
+                "bonusSharesFromCapitalReserve": 0,
+                "dividend": 1.8,
+                "status": "shareholders_meeting_plan",
+            },
+        ],
+    }
+
+    with patch("httpx.AsyncClient.request") as mock_request:
+        mock_request.return_value = Mock()
+        mock_request.return_value.status_code = 200
+        mock_request.return_value.json.return_value = mock_response
+
+        df = await get_dividend(stock_code="600036", start_date="2023-01-01")
+
+        assert isinstance(df, pd.DataFrame)
+        assert len(df) == 3
+        assert df.iloc[0]["status"] == "implemented"
+        assert df.iloc[1]["status"] == "board_director_plan"
+        assert df.iloc[2]["status"] == "shareholders_meeting_plan"

{lixinger_python-0.3.2 → lixinger_python-0.3.4}/tests/test_candlestick.py

@@ -53,7 +53,6 @@ async def test_get_candlestick():
         mock_request.return_value = mock_response
 
         df = await get_candlestick(
-            type="1d",
             stock_code="600036",
             start_date="2024-01-09",
             end_date="2024-01-10",
@@ -72,10 +71,9 @@ async def test_get_candlestick():
         assert args[0] == "POST"
         assert "/cn/company/candlestick" in str(args[1])
         assert kwargs["json"]["stockCode"] == "600036"
-        assert kwargs["json"]["type"] == "1d"
         assert kwargs["json"]["startDate"] == "2024-01-09"
         assert kwargs["json"]["endDate"] == "2024-01-10"
-        assert "adjustType" not in kwargs["json"]
+        assert "type" not in kwargs["json"]
 
 
 @pytest.mark.asyncio
@@ -107,11 +105,10 @@ async def test_get_candlestick_with_adjust_type():
         mock_request.return_value = mock_response
 
         df = await get_candlestick(
-            type="1d",
             stock_code="600036",
             start_date="2024-01-09",
             end_date="2024-01-10",
-            adjust_type="qxw",
+            adjust_type="lxr_fc_rights",
         )
 
         assert isinstance(df, pd.DataFrame)
@@ -120,4 +117,4 @@ async def test_get_candlestick_with_adjust_type():
 
         # Verify request parameters
         args, kwargs = mock_request.call_args
-        assert kwargs["json"]["adjustType"] == "qxw"
+        assert kwargs["json"]["type"] == "lxr_fc_rights"

{lixinger_python-0.3.2 → lixinger_python-0.3.4}/tests/test_integration.py

@@ -211,7 +211,6 @@ class TestRealAPIResponses:
 
         # Make a real API call for candlestick data
         result = await real_client.candlestick.get_candlestick(
-            type="1d",
             stock_code="600036",
             start_date="2024-01-01",
             end_date="2024-01-10",

{lixinger_python-0.3.2 → lixinger_python-0.3.4}/uv.lock

@@ -629,7 +629,7 @@ wheels = [
 
 [[package]]
 name = "lixinger-python"
-version = "0.3.2"
+version = "0.3.4"
 source = { editable = "." }
 dependencies = [
     { name = "httpx", extra = ["socks"] },

lixinger_python-0.3.2/lixinger/api/cn/company/candlestick.py

@@ -1,76 +0,0 @@
-from typing import Any, Literal
-
-import pandas as pd
-
-from lixinger.api.base import BaseAPI
-from lixinger.models.cn.company import Candlestick
-from lixinger.utils.api import api
-from lixinger.utils.dataframe import get_response_df
-
-
-class CandlestickAPI(BaseAPI):
-    """Candlestick (K-line) data APIs."""
-
-    async def get_candlestick(
-        self,
-        type: Literal["1d", "1w", "1m", "5m", "15m", "30m", "60m"],
-        stock_code: str,
-        start_date: str,
-        end_date: str,
-        adjust_type: Literal["none", "qxw", "hxw"] | None = None,
-    ) -> pd.DataFrame:
-        """获取K线数据.
-
-        API Endpoint: /cn/company/candlestick
-        API Method: POST
-
-        Args:
-            type: K线类型 (1d, 1w, 1m, 5m, 15m, 30m, 60m)
-            stock_code: 股票代码
-            start_date: 开始日期 (YYYY-MM-DD)
-            end_date: 结束日期 (YYYY-MM-DD)
-            adjust_type: 复权类型 (none, qxw, hxw)
-
-        """
-        payload: dict[str, Any] = {
-            "type": type,
-            "stockCode": stock_code,
-            "startDate": start_date,
-            "endDate": end_date,
-        }
-        if adjust_type is not None:
-            payload["adjustType"] = adjust_type
-
-        data = await self._request("POST", "/cn/company/candlestick", json=payload)
-        return get_response_df(data, Candlestick)
-
-
-# Functional API instance
-_api_instance = CandlestickAPI()
-
-
-@api
-async def get_candlestick(
-    type: Literal["1d", "1w", "1m", "5m", "15m", "30m", "60m"],
-    stock_code: str,
-    start_date: str,
-    end_date: str,
-    adjust_type: Literal["none", "qxw", "hxw"] | None = None,
-) -> pd.DataFrame:
-    """获取K线数据.
-
-    Args:
-        type: K线类型 (1d, 1w, 1m, 5m, 15m, 30m, 60m)
-        stock_code: 股票代码
-        start_date: 开始日期 (YYYY-MM-DD)
-        end_date: 结束日期 (YYYY-MM-DD)
-        adjust_type: 复权类型 (none, qxw, hxw)
-
-    """
-    return await _api_instance.get_candlestick(
-        type=type,
-        stock_code=stock_code,
-        start_date=start_date,
-        end_date=end_date,
-        adjust_type=adjust_type,
-    )