Skip to content
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

Jump to bottom

Add support for PEP 746 #700

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add support for PEP 746 #700

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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
93 changes: 83 additions & 10 deletions msgspec/__init__.pyi
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,17 @@
import datetime
import enum
from typing import (
Any,
Callable,
ClassVar,
Dict,
Final,
Generic,
Iterable,
Literal,
Mapping,
Optional,
Protocol,
Tuple,
Type,
TypeVar,
Expand Down Expand Up @@ -111,9 +114,73 @@ class Raw(bytes):
def __new__(cls, msg: Union[bytes, str]) -> "Raw": ...
def copy(self) -> "Raw": ...

class Meta:
def __init__(
self,
class Meta(Generic[T]):
# datetime constraints
@overload
def __new__(
cls,
*,
gt: Union[datetime.datetime, None] = None,
ge: Union[datetime.datetime, None] = None,
lt: Union[datetime.datetime, None] = None,
le: Union[datetime.datetime, None] = None,
tz: Union[bool, None] = None,
title: Union[str, None] = None,
description: Union[str, None] = None,
examples: Union[list[Any], None] = None,
extra_json_schema: Union[dict[str, Any], None] = None,
extra: Union[dict[str, Any], None] = None,
) -> Meta[datetime.datetime]: ...

# numeric constraints
@overload
def __new__(
cls,
*,
gt: Union[int, float, None] = None,
ge: Union[int, float, None] = None,
lt: Union[int, float, None] = None,
le: Union[int, float, None] = None,
multiple_of: Union[int, float, None] = None,
title: Union[str, None] = None,
description: Union[str, None] = None,
examples: Union[list[Any], None] = None,
extra_json_schema: Union[dict[str, Any], None] = None,
extra: Union[dict[str, Any], None] = None,
) -> Meta[Union[int, float]]: ...

# array constraints
@overload
def __new__(
cls,
*,
pattern: Literal[None] = None,
min_length: Union[int, None] = None,
max_length: Union[int, None] = None,
title: Union[str, None] = None,
description: Union[str, None] = None,
examples: Union[list[Any], None] = None,
extra_json_schema: Union[dict[str, Any], None] = None,
extra: Union[dict[str, Any], None] = None,
) -> Meta[_SupportsLen]: ...

# string constraints
@overload
def __new__(
cls,
*,
pattern: Union[str, None] = None,
min_length: Union[int, None] = None,
max_length: Union[int, None] = None,
title: Union[str, None] = None,
description: Union[str, None] = None,
examples: Union[list[Any], None] = None,
extra_json_schema: Union[dict[str, Any], None] = None,
extra: Union[dict[str, Any], None] = None,
) -> Meta[str]: ...

def __new__(
cls,
*,
gt: Union[int, float, None] = None,
ge: Union[int, float, None] = None,
Expand All @@ -126,10 +193,11 @@ class Meta:
tz: Union[bool, None] = None,
title: Union[str, None] = None,
description: Union[str, None] = None,
examples: Union[list, None] = None,
extra_json_schema: Union[dict, None] = None,
extra: Union[dict, None] = None,
): ...
examples: Union[list[Any], None] = None,
extra_json_schema: Union[dict[str, Any], None] = None,
extra: Union[dict[str, Any], None] = None,
) -> None: ...

gt: Final[Union[int, float, None]]
ge: Final[Union[int, float, None]]
lt: Final[Union[int, float, None]]
Expand All @@ -141,11 +209,16 @@ class Meta:
tz: Final[Union[int, None]]
title: Final[Union[str, None]]
description: Final[Union[str, None]]
examples: Final[Union[list, None]]
extra_json_schema: Final[Union[dict, None]]
extra: Final[Union[dict, None]]
examples: Final[Union[list[Any], None]]
extra_json_schema: Final[Union[dict[str, Any], None]]
extra: Final[Union[dict[str, Any], None]]
def __rich_repr__(self) -> Iterable[Tuple[str, Any]]: ...

def __supports_type__(self, obj: T) -> bool: ...

class _SupportsLen(Protocol):
def __len__(self) -> int: ...

def to_builtins(
obj: Any,
*,
Expand Down