Skip to content

fix(proto-plus): annotate Message.serialize and Message.deserialize #18553

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

Closed
NorthIsUp wants to merge 1 commit into from
Closed

fix(proto-plus): annotate Message.serialize and Message.deserialize #18553

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
10 changes: 7 additions & 3 deletions packages/proto-plus/proto/message.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
import copy
import re
import warnings
from typing import Any, Dict, List, Optional, Type
from typing import Any, Dict, List, Mapping, Optional, Type, TypeVar, Union

import google.protobuf
from google.protobuf import descriptor_pb2, message
Expand All @@ -36,6 +36,8 @@

_upb = has_upb() # Important to cache result here.

_MessageT = TypeVar("_MessageT", bound="Message")


class MessageMeta(type):
"""A metaclass for building and registering Message subclasses."""
Expand Down Expand Up @@ -347,7 +349,9 @@ def wrap(cls, pb):
super(cls, instance).__setattr__("_pb", pb)
return instance

def serialize(cls, instance) -> bytes:
def serialize(
cls, instance: Union["Message", message.Message, Mapping[str, Any]]
) -> bytes:
"""Return the serialized proto.

Args:
Expand All @@ -359,7 +363,7 @@ def serialize(cls, instance) -> bytes:
"""
return cls.pb(instance, coerce=True).SerializeToString()

def deserialize(cls, payload: bytes) -> "Message":
def deserialize(cls: Type[_MessageT], payload: bytes) -> _MessageT:
"""Given a serialized proto, deserialize it into a Message instance.

Args:
Expand Down
Loading