lixinger-python 0.3.12__tar.gz → 0.3.14__tar.gz

{lixinger_python-0.3.12 → lixinger_python-0.3.14}/.claude/settings.local.json

@@ -12,7 +12,12 @@
       "Bash(git push *)",
       "Bash(uv sync *)",
       "Bash(curl -s https://pypi.org/pypi/lixinger-python/0.3.11/json)",
-      "Bash(python3 -c \"import sys, json; d = json.load\\(sys.stdin\\); print\\('Name:', d['info']['name']\\); print\\('Version:', d['info']['version']\\); print\\('Files:', len\\(d['urls']\\)\\)\")"
+      "Bash(python3 -c \"import sys, json; d = json.load\\(sys.stdin\\); print\\('Name:', d['info']['name']\\); print\\('Version:', d['info']['version']\\); print\\('Files:', len\\(d['urls']\\)\\)\")",
+      "Bash(curl -s https://pypi.org/pypi/lixinger-python/0.3.12/json)",
+      "Bash(curl -s https://pypi.org/pypi/lixinger-python/0.3.13/json)",
+      "Bash(git diff *)",
+      "Read(//tmp/**)",
+      "Bash(git checkout *)"
     ]
   }
 }

{lixinger_python-0.3.12 → lixinger_python-0.3.14}/CHANGELOG.md

@@ -11,6 +11,41 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Add support for US stock market APIs
 - Add caching mechanism for API responses
 
+## [0.3.14] - 2026-07-05
+
+### Fixed
+- `code=1, message="no data"` 响应不再被误报为错误. 之前会抛
+  `APIError("API returned error code 1: no data")`, 现在正确返回空 payload,
+  下游得到空 `DataFrame`. Lixinger 在非交易日、空日期范围、停牌股票等
+  场景会返回该响应.
+- 服务端未返回 `Retry-After` header 的 429 响应现在退避 15 秒 (可通过
+  `DEFAULT_RATE_LIMIT_RETRY_AFTER` 观察), 而不是之前的 1/2/4 秒指数退避.
+  Lixinger 的速率窗口是 60 秒, 1 秒后重试几乎必然再 429, 白白浪费重试配额.
+
+### Changed
+- `_request` 的成功判断从 `code == 1 AND message == "success"` 放宽为
+  `code == 1`. message 视为人类可读的描述.
+- `_request` 会把 `data` 字段的 `None` / 缺失情况归一到 `[]`, 避免下游
+  20+ 个遍历 `data` 的 API 方法崩在 `for item in None`.
+- `async_retry_on_failure` 新增 `jitter: float = 0.2` 参数, 每次 sleep
+  会在 `[base*(1-jitter), base*(1+jitter)]` 之间均匀采样, 避免多客户端
+  惊群. 传 `jitter=0` 关闭 (方便测试和确定性场景).
+
+## [0.3.13] - 2026-07-05
+
+### Fixed
+- `AuthenticationError` (401) 和 `ValidationError` 不再被重试. 之前会被
+  重试装饰器兜底 catch 3 次, 白白浪费 ~7 秒和 3 次配额.
+- 429 响应现在会尊重服务端返回的 `Retry-After` header, 按 header 指定的
+  时长退避（同时支持 RFC 7231 的 `delta-seconds` 和 `HTTP-date` 两种格式）;
+  header 缺失时保持原有的 1/2/4 秒指数退避.
+
+### Changed
+- `async_retry_on_failure` 新增 `no_retry_on: tuple[type[Exception], ...]`
+  参数, 命中即立即抛出.
+- `RateLimitError` 新增 `retry_after: float | None` 属性; 若异常对象带
+  `retry_after` 属性, 重试装饰器会用它替代默认的指数退避.
+
 ## [0.3.12] - 2026-07-05
 
 ### Added
@@ -186,7 +221,9 @@ asyncio.run(main())
 - Pre-commit hooks
 - MkDocs for documentation
 
-[unreleased]: https://github.com/TedaLIEz/lixinger-python/compare/v0.3.12...HEAD
+[unreleased]: https://github.com/TedaLIEz/lixinger-python/compare/v0.3.14...HEAD
+[0.3.14]: https://github.com/TedaLIEz/lixinger-python/compare/v0.3.13...v0.3.14
+[0.3.13]: https://github.com/TedaLIEz/lixinger-python/compare/v0.3.12...v0.3.13
 [0.3.12]: https://github.com/TedaLIEz/lixinger-python/compare/v0.3.11...v0.3.12
 [0.3.11]: https://github.com/TedaLIEz/lixinger-python/compare/v0.3.10...v0.3.11
 [0.3.10]: https://github.com/TedaLIEz/lixinger-python/compare/v0.3.9...v0.3.10

{lixinger_python-0.3.12 → lixinger_python-0.3.14}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: lixinger-python
-Version: 0.3.12
+Version: 0.3.14
 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.12 → lixinger_python-0.3.14}/lixinger/api/base.py

@@ -1,9 +1,11 @@
+from datetime import UTC, datetime
+from email.utils import parsedate_to_datetime
 from typing import Any
 
 import httpx
 
 from lixinger.config import Config, settings
-from lixinger.exceptions import APIError, AuthenticationError, RateLimitError
+from lixinger.exceptions import APIError, AuthenticationError, RateLimitError, ValidationError
 from lixinger.utils.rate_limiter import AsyncRateLimiter
 from lixinger.utils.retry import async_retry_on_failure
 
@@ -13,6 +15,12 @@ _global_rate_limiter = AsyncRateLimiter(max_requests=1000)
 # Lazy initialization of global http client to avoid issues with proxy/config changes
 _global_http_client: httpx.AsyncClient | None = None
 
+# Fallback delay in seconds when a 429 response omits Retry-After. The Lixinger
+# rate-limit window is 60s, so short exponential backoff (1/2/4s) almost always
+# fires inside the same window and gets 429ed again. 15s gives the window room
+# to age and burns fewer retry attempts on doomed requests.
+DEFAULT_RATE_LIMIT_RETRY_AFTER = 15.0
+
 
 def get_global_client() -> httpx.AsyncClient:
     """Get or create the global HTTP client."""
@@ -29,6 +37,39 @@ def get_global_client() -> httpx.AsyncClient:
     return _global_http_client
 
 
+def _parse_retry_after(header_value: str | None) -> float | None:
+    """Parse a Retry-After header into seconds.
+
+    Accepts both formats defined by RFC 7231 §7.1.3:
+    - ``delta-seconds`` (e.g. ``"120"``)
+    - ``HTTP-date`` (e.g. ``"Wed, 21 Oct 2015 07:28:00 GMT"``)
+
+    Returns ``None`` when the header is missing or unparseable so the caller
+    can fall back to its default backoff.
+    """
+    if not header_value:
+        return None
+    value = header_value.strip()
+    # Try delta-seconds first — the common case.
+    try:
+        seconds = float(value)
+    except ValueError:
+        pass
+    else:
+        return seconds if seconds >= 0 else None
+    # Fall back to HTTP-date.
+    try:
+        target = parsedate_to_datetime(value)
+    except (TypeError, ValueError):
+        return None
+    if target.tzinfo is None:
+        # RFC 7231 HTTP-date is always GMT, so treat naive dates as UTC.
+        target = target.replace(tzinfo=UTC)
+    now = datetime.now(tz=target.tzinfo)
+    delta = (target - now).total_seconds()
+    return max(delta, 0.0)
+
+
 class BaseAPI:
     """Base class for API endpoint groups."""
 
@@ -42,7 +83,12 @@ class BaseAPI:
         self._config = config or settings
         self._rate_limiter = rate_limiter or _global_rate_limiter
 
-    @async_retry_on_failure(max_retries=3, backoff=1.0)
+    @async_retry_on_failure(
+        max_retries=3,
+        backoff=1.0,
+        # Do NOT retry non-transient errors even though they inherit from Exception.
+        no_retry_on=(AuthenticationError, ValidationError),
+    )
     async def _request(
         self,
         method: str,
@@ -72,7 +118,16 @@ class BaseAPI:
         )
 
         if response.status_code == 429:
-            raise RateLimitError("Rate limit exceeded", status_code=429)
+            retry_after = _parse_retry_after(response.headers.get("Retry-After"))
+            # Server didn't tell us how long to wait — pick a delay long enough
+            # for the 60s rate-limit window to actually age.
+            if retry_after is None:
+                retry_after = DEFAULT_RATE_LIMIT_RETRY_AFTER
+            raise RateLimitError(
+                "Rate limit exceeded",
+                status_code=429,
+                retry_after=retry_after,
+            )
         if response.status_code == 401:
             raise AuthenticationError("Authentication failed", status_code=401)
         if response.status_code != 200:
@@ -88,7 +143,15 @@ class BaseAPI:
         code = data.get("code")
         message = data.get("message")
 
-        if code != 1 or message != "success":
+        # code is the machine-readable success signal; message is human text.
+        # Lixinger returns code=1 for success even when there's no data
+        # (e.g. message="no data" on non-trading days or empty ranges) —
+        # treat any code=1 as success and normalize a missing/null payload
+        # to [] so downstream iteration and get_response_df both work.
+        if code != 1:
             raise APIError(f"API returned error code {code}: {message}")
 
-        return data.get("data")
+        payload = data.get("data")
+        if payload is None:
+            return []
+        return payload

lixinger_python-0.3.14/lixinger/exceptions.py

@@ -0,0 +1,38 @@
+class LixingerError(Exception):
+    """Base exception for Lixinger SDK."""
+
+
+class APIError(LixingerError):
+    """API request failed."""
+
+    def __init__(self, message: str, status_code: int | None = None) -> None:
+        super().__init__(message)
+        self.status_code = status_code
+
+
+class RateLimitError(APIError):
+    """Rate limit exceeded (429).
+
+    Attributes:
+        retry_after: Optional server-provided delay in seconds parsed from the
+            ``Retry-After`` response header. ``None`` when the header was absent
+            or malformed. The retry decorator honors this value in place of the
+            default exponential backoff.
+    """
+
+    def __init__(
+        self,
+        message: str,
+        status_code: int | None = None,
+        retry_after: float | None = None,
+    ) -> None:
+        super().__init__(message, status_code=status_code)
+        self.retry_after = retry_after
+
+
+class AuthenticationError(APIError):
+    """Authentication failed (401)."""
+
+
+class ValidationError(LixingerError):
+    """Request validation failed."""

lixinger_python-0.3.14/lixinger/utils/retry.py

@@ -0,0 +1,63 @@
+import asyncio
+from collections.abc import Awaitable, Callable
+from functools import wraps
+import random
+from typing import Any, TypeVar
+
+T = TypeVar("T")
+
+
+def async_retry_on_failure(
+    max_retries: int = 3,
+    backoff: float = 1.0,
+    retry_on: tuple[type[Exception], ...] = (Exception,),
+    no_retry_on: tuple[type[Exception], ...] = (),
+    jitter: float = 0.2,
+) -> Callable[[Callable[..., Awaitable[T]]], Callable[..., Awaitable[T]]]:
+    """Retry failed async requests with exponential backoff and jitter.
+
+    Args:
+        max_retries: Maximum number of retry attempts (total attempts = max_retries + 1).
+        backoff: Base delay in seconds for exponential backoff (2**attempt * backoff).
+        retry_on: Exception types that trigger a retry.
+        no_retry_on: Exception types that must NOT be retried even if matched by
+            ``retry_on``. Use this to short-circuit on non-transient errors such
+            as authentication failures.
+        jitter: Multiplicative jitter fraction applied to every sleep. The actual
+            sleep is drawn from ``uniform(base * (1 - jitter), base * (1 + jitter))``
+            where ``base`` is either the ``retry_after`` hint or the exponential
+            backoff. Pass ``0`` to disable (mostly useful in tests). Values are
+            clamped so the sleep never goes negative.
+
+    If the caught exception exposes a ``retry_after`` attribute (float seconds,
+    typically parsed from a ``Retry-After`` HTTP header on 429 responses), that
+    value is used for the next sleep instead of the exponential backoff.
+    """
+
+    def decorator(func: Callable[..., Awaitable[T]]) -> Callable[..., Awaitable[T]]:
+        @wraps(func)
+        async def wrapper(*args: Any, **kwargs: Any) -> T:
+            for attempt in range(max_retries + 1):
+                try:
+                    return await func(*args, **kwargs)
+                except retry_on as e:
+                    # Bail out immediately on non-transient errors.
+                    if no_retry_on and isinstance(e, no_retry_on):
+                        raise
+                    if attempt == max_retries:
+                        raise
+                    # Prefer server-provided retry hint when available.
+                    hint = getattr(e, "retry_after", None)
+                    base = float(hint) if isinstance(hint, int | float) and hint > 0 else backoff * (2**attempt)
+                    if jitter > 0:
+                        low = max(0.0, base * (1.0 - jitter))
+                        high = base * (1.0 + jitter)
+                        wait_time = random.uniform(low, high)  # noqa: S311 (non-crypto jitter)
+                    else:
+                        wait_time = base
+                    await asyncio.sleep(wait_time)
+            raise RuntimeError("Unreachable")
+
+        return wrapper
+
+    return decorator

{lixinger_python-0.3.12 → lixinger_python-0.3.14}/pyproject.toml

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

lixinger_python-0.3.14/tests/test_no_data.py

@@ -0,0 +1,126 @@
+"""Unit tests for `code=1` / "no data" handling in BaseAPI._request."""
+
+from __future__ import annotations
+
+from unittest.mock import AsyncMock, Mock, patch
+
+import httpx
+import pandas as pd
+import pytest
+
+from lixinger.api.base import BaseAPI
+from lixinger.exceptions import APIError
+from lixinger.utils.rate_limiter import AsyncRateLimiter
+
+
+def _mock_response(json_body: dict) -> Mock:
+    resp = Mock()
+    resp.status_code = 200
+    resp.text = "mock body"
+    resp.headers = {}
+    resp.json.return_value = json_body
+    return resp
+
+
+def _make_api(monkeypatch: pytest.MonkeyPatch) -> BaseAPI:
+    monkeypatch.setenv("LIXINGER_API_KEY", "test_key")
+    return BaseAPI(rate_limiter=AsyncRateLimiter(max_requests=1000))
+
+
+@pytest.mark.asyncio
+async def test_no_data_message_returns_empty_list(monkeypatch):
+    """Lixinger returns code=1/message="no data" for successful requests that
+    happen to have nothing to return (non-trading days, empty ranges, etc.).
+    _request should treat this as success and return an empty payload rather
+    than raising APIError."""
+    api = _make_api(monkeypatch)
+
+    body = {"code": 1, "message": "no data", "data": None}
+
+    with patch("lixinger.api.base.get_global_client") as mock_client_factory:
+        client = Mock(spec=httpx.AsyncClient)
+        client.request = AsyncMock(return_value=_mock_response(body))
+        mock_client_factory.return_value = client
+
+        result = await api._request("POST", "/whatever", json={"a": 1})
+
+    assert result == []
+
+
+@pytest.mark.asyncio
+async def test_missing_data_key_returns_empty_list(monkeypatch):
+    """Some 'no data' responses omit the data key entirely instead of nulling it."""
+    api = _make_api(monkeypatch)
+
+    body = {"code": 1, "message": "no data"}
+
+    with patch("lixinger.api.base.get_global_client") as mock_client_factory:
+        client = Mock(spec=httpx.AsyncClient)
+        client.request = AsyncMock(return_value=_mock_response(body))
+        mock_client_factory.return_value = client
+
+        result = await api._request("POST", "/whatever", json={"a": 1})
+
+    assert result == []
+
+
+@pytest.mark.asyncio
+async def test_success_with_data_unchanged(monkeypatch):
+    """Regression guard: code=1/message="success" with real data still works."""
+    api = _make_api(monkeypatch)
+
+    body = {"code": 1, "message": "success", "data": [{"x": 1}, {"x": 2}]}
+
+    with patch("lixinger.api.base.get_global_client") as mock_client_factory:
+        client = Mock(spec=httpx.AsyncClient)
+        client.request = AsyncMock(return_value=_mock_response(body))
+        mock_client_factory.return_value = client
+
+        result = await api._request("POST", "/whatever", json={"a": 1})
+
+    assert result == [{"x": 1}, {"x": 2}]
+
+
+@pytest.mark.asyncio
+async def test_non_success_code_still_raises(monkeypatch):
+    """Real errors (code != 1) must still raise regardless of message text."""
+    api = _make_api(monkeypatch)
+
+    body = {"code": 0, "message": "bad token", "data": None}
+
+    with patch("lixinger.api.base.get_global_client") as mock_client_factory:
+        client = Mock(spec=httpx.AsyncClient)
+        client.request = AsyncMock(return_value=_mock_response(body))
+        mock_client_factory.return_value = client
+
+        with pytest.raises(APIError, match="error code 0"):
+            await api._request("POST", "/whatever", json={"a": 1})
+
+
+@pytest.mark.asyncio
+async def test_no_data_downstream_returns_empty_dataframe(monkeypatch):
+    """End-to-end check: an API method that iterates the payload and passes it
+    through get_response_df should return an empty DataFrame (not crash) when
+    the server returns code=1/message='no data'."""
+    # Late import so the AsyncLixingerClient instantiation picks up the env var.
+    from lixinger import AsyncLixingerClient
+
+    monkeypatch.setenv("LIXINGER_API_KEY", "test_key")
+    client = AsyncLixingerClient()
+
+    body = {"code": 1, "message": "no data", "data": None}
+
+    with patch.object(client._http_client, "request") as mock_request:
+        mock_request.return_value = Mock()
+        mock_request.return_value.status_code = 200
+        mock_request.return_value.headers = {}
+        mock_request.return_value.json.return_value = body
+
+        df = await client.cn_industry.margin_trading.sw.get_margin_trading(
+            stock_code="490000",
+            start_date="2025-06-13",
+            end_date="2026-06-13",
+        )
+
+    assert isinstance(df, pd.DataFrame)
+    assert df.empty