Skip to content

Use class docstring as description for struct types in Python SDK. #187

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 21, 2025
Merged

Use class docstring as description for struct types in Python SDK. #187

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions python/cocoindex/typing.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
import collections
import dataclasses
import types
import inspect
from typing import Annotated, NamedTuple, Any, TypeVar, TYPE_CHECKING, overload

class Vector(NamedTuple):
Expand Down Expand Up @@ -147,6 +148,8 @@ def _encode_type(type_info: AnalyzedTypeInfo) -> dict[str, Any]:
if type_info.dataclass_type is None:
raise ValueError("Struct type must have a dataclass type")
encoded_type['fields'] = _encode_fields_schema(type_info.dataclass_type)
if doc := inspect.getdoc(type_info.dataclass_type):
encoded_type['description'] = doc

elif type_info.kind == 'Vector':
if type_info.vector_info is None:
Expand Down