Skip to content

Commit

Permalink
Merge pull request #17512 from anandolee/28.x
Browse files Browse the repository at this point in the history
Cherrypick python deprecated warnings for reflection.py and service.py to 28.x
  • Loading branch information
zhangskz authored Jul 17, 2024
2 parents fa8dbae + 902a68a commit 7699dd0
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 4 deletions.
3 changes: 1 addition & 2 deletions python/google/protobuf/internal/builder.py
Original file line number Diff line number Diff line change
Expand Up @@ -105,12 +105,11 @@ def BuildServices(file_des, module_name, module):
module: Generated _pb2 module
"""
# pylint: disable=g-import-not-at-top
from google.protobuf import service as _service
from google.protobuf import service_reflection
# pylint: enable=g-import-not-at-top
for (name, service) in file_des.services_by_name.items():
module[name] = service_reflection.GeneratedServiceType(
name, (_service.Service,),
name, (),
dict(DESCRIPTOR=service, __module__=module_name))
stub_name = name + '_Stub'
module[stub_name] = service_reflection.GeneratedServiceStubType(
Expand Down
17 changes: 15 additions & 2 deletions python/google/protobuf/reflection.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@

__author__ = '[email protected] (Will Robinson)'

import warnings

from google.protobuf import message_factory
from google.protobuf import symbol_database
Expand All @@ -40,7 +41,7 @@ def ParseMessage(descriptor, byte_str):
"""Generate a new Message instance from this Descriptor and a byte string.
DEPRECATED: ParseMessage is deprecated because it is using MakeClass().
Please use MessageFactory.GetPrototype() instead.
Please use MessageFactory.GetMessageClass() instead.
Args:
descriptor: Protobuf Descriptor object
Expand All @@ -49,6 +50,12 @@ def ParseMessage(descriptor, byte_str):
Returns:
Newly created protobuf Message object.
"""
warnings.warn(
'reflection.ParseMessage() is deprecated. Please use '
'MessageFactory.GetMessageClass() and message.ParseFromString() instead. '
'reflection.ParseMessage() will be removed in Jan 2025.',
stacklevel=2,
)
result_class = MakeClass(descriptor)
new_msg = result_class()
new_msg.ParseFromString(byte_str)
Expand All @@ -59,13 +66,19 @@ def ParseMessage(descriptor, byte_str):
def MakeClass(descriptor):
"""Construct a class object for a protobuf described by descriptor.
DEPRECATED: use MessageFactory.GetPrototype() instead.
DEPRECATED: use MessageFactory.GetMessageClass() instead.
Args:
descriptor: A descriptor.Descriptor object describing the protobuf.
Returns:
The Message class object described by the descriptor.
"""
warnings.warn(
'reflection.MakeClass() is deprecated. Please use '
'MessageFactory.GetMessageClass() instead. '
'reflection.MakeClass() will be removed in Jan 2025.',
stacklevel=2,
)
# Original implementation leads to duplicate message classes, which won't play
# well with extensions. Message factory info is also missing.
# Redirect to message_factory.
Expand Down
8 changes: 8 additions & 0 deletions python/google/protobuf/service.py
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,14 @@

__author__ = '[email protected] (Petar Petrov)'

import warnings

warnings.warn(
'google.protobuf.service module is deprecated. RPC implementations '
'should provide code generator plugins which generate code specific to '
'the RPC implementation. service.py will be removed in Jan 2025',
stacklevel=2,
)

class RpcException(Exception):
"""Exception raised on failed blocking RPC method call."""
Expand Down

0 comments on commit 7699dd0

Please sign in to comment.