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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lixinger-python
-Version: 0.3.2
+Version: 0.3.3
 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.3/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.2 → lixinger_python-0.3.3}/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.3}/pyproject.toml

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

{lixinger_python-0.3.2 → lixinger_python-0.3.3}/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.3}/uv.lock

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