chore(sdk-py): Update types (#5939)

This commit is contained in:
William FH
2025-08-18 18:29:07 +00:00
committed by GitHub
parent 875f20ba9f
commit 3488eb2a2c
5 changed files with 302 additions and 169 deletions
-1
View File
@@ -17,7 +17,6 @@ lint lint_diff:
uv run ruff check .
[ "$(PYTHON_FILES)" = "" ] || uv run ruff format $(PYTHON_FILES) --diff
[ "$(PYTHON_FILES)" = "" ] || uv run ruff check --select I $(PYTHON_FILES)
[ "$(PYTHON_FILES)" = "" ] || mkdir -p $(MYPY_CACHE) || uv run mypy $(PYTHON_FILES) --cache-dir $(MYPY_CACHE)
uvx ty check .
format format_diff:
@@ -385,6 +385,8 @@ class _ResourceOn(typing.Generic[VCreate, VRead, VUpdate, VDelete, VSearch]):
_register_handler(self.auth, self.resource, "*", handler),
)
# Accept keyword-only parameters for future filtering behavior; referenced to satisfy linters.
_ = resources, actions
return decorator
File diff suppressed because it is too large Load Diff
+1
View File
@@ -50,5 +50,6 @@ lint.select = [
"UP", # pyupgrade
"B", # flake8-bugbear
"I", # isort
"ARG", # flake8-unused-arguments
]
lint.ignore = ["E501", "B008"]
+120
View File
@@ -0,0 +1,120 @@
from __future__ import annotations
import inspect
import re
import pytest
from langgraph_sdk.client import (
AssistantsClient,
CronClient,
RunsClient,
StoreClient,
SyncAssistantsClient,
SyncCronClient,
SyncRunsClient,
SyncStoreClient,
SyncThreadsClient,
ThreadsClient,
)
def _public_methods(cls) -> dict[str, object]:
methods: dict[str, object] = {}
# Use the raw class dict to avoid runtime wrappers from plugins/decorators
for name, member in cls.__dict__.items():
if name.startswith("_"):
continue
if inspect.isfunction(member):
methods[name] = member
return methods
def _strip_self(sig: inspect.Signature) -> inspect.Signature:
params = list(sig.parameters.values())
if params and params[0].name == "self":
params = params[1:]
return sig.replace(parameters=params)
def _normalize_return_annotation(ann: object) -> str:
s = str(ann)
s = re.sub(r"\s+", "", s)
s = s.replace("typing.", "").replace("collections.abc.", "")
s = re.sub(r"AsyncGenerator\[([^,\]]+)(?:,[^\]]*)?\]", r"Iterator[\1]", s)
s = re.sub(r"Generator\[([^,\]]+)(?:,[^\]]*)?\]", r"Iterator[\1]", s)
s = re.sub(r"AsyncIterator\[(.+)\]", r"Iterator[\1]", s)
s = re.sub(r"AsyncIterable\[(.+)\]", r"Iterable[\1]", s)
return s
@pytest.mark.parametrize(
"async_cls,sync_cls",
[
(AssistantsClient, SyncAssistantsClient),
(ThreadsClient, SyncThreadsClient),
(RunsClient, SyncRunsClient),
(CronClient, SyncCronClient),
(StoreClient, SyncStoreClient),
],
)
def test_sync_api_matches_async(async_cls, sync_cls):
async_methods = _public_methods(async_cls)
sync_methods = _public_methods(sync_cls)
# Method name parity
assert set(sync_methods.keys()) == set(async_methods.keys()), (
f"Method sets differ: async-only={set(async_methods) - set(sync_methods)}, sync-only={set(sync_methods) - set(async_methods)}"
)
for name, async_fn in async_methods.items():
sync_fn = sync_methods[name]
# Use inspect.signature for parameter names (robust across versions)
async_sig = _strip_self(inspect.signature(async_fn))
sync_sig = _strip_self(inspect.signature(sync_fn))
a_names = list(async_sig.parameters.keys())
s_names = list(sync_sig.parameters.keys())
assert set(a_names) == set(s_names), (
f"Parameter names differ for {async_cls.__name__}.{name}: "
f"async={a_names}, sync={s_names}"
)
# Compare default presence and parameter kinds (with some tolerance)
a_params = async_sig.parameters
s_params = sync_sig.parameters
def kinds_compatible(
akind: inspect._ParameterKind, skind: inspect._ParameterKind
) -> bool:
if akind == skind:
return True
return {
inspect.Parameter.KEYWORD_ONLY,
inspect.Parameter.POSITIONAL_OR_KEYWORD,
} == {akind, skind}
for pname in set(a_names) & set(s_names):
apar = a_params[pname]
spar = s_params[pname]
assert kinds_compatible(apar.kind, spar.kind), (
f"Parameter kind mismatch for {async_cls.__name__}.{name}.{pname}: "
f"async={apar.kind}, sync={spar.kind}"
)
assert (apar.default is inspect._empty) == (
spar.default is inspect._empty
), (
f"Default presence mismatch for {async_cls.__name__}.{name}.{pname}: "
f"async_has_default={apar.default is not inspect._empty}, "
f"sync_has_default={spar.default is not inspect._empty}"
)
# Return annotations must match or be iterator-equivalent
a_ret = _normalize_return_annotation(async_sig.return_annotation)
s_ret = _normalize_return_annotation(sync_sig.return_annotation)
assert a_ret == s_ret, (
f"Return annotation mismatch for {async_cls.__name__}.{name}: "
f"async={a_ret}, sync={s_ret}"
)