Skip to content

Commit

Permalink
Raise warnings for deprecated google/protobuf/reflection.py APIs.
Browse files Browse the repository at this point in the history
reflection.py APIs are marked as deprecated since 2018. These APIs will be
removed in Jan 2025

PiperOrigin-RevId: 653263213
  • Loading branch information
anandolee committed Jul 17, 2024
1 parent ca75771 commit 38140ac
Showing 1 changed file with 15 additions and 2 deletions.
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__ = 'robinson@google.com (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

0 comments on commit 38140ac

Please sign in to comment.