Replace extra decorator with property and lazy initialization so that it is backward compatible.

Author: jameslan

betterproto/__init__.py

@@ -431,9 +431,9 @@ def parse_fields(value: bytes) -> Generator[ParsedField, None, None]:
 
 
 class ProtoClassMetadata:
-    cls: "Message"
+    cls: Type["Message"]
 
-    def __init__(self, cls: "Message"):
+    def __init__(self, cls: Type["Message"]):
         self.cls = cls
         by_field = {}
         by_group = {}
@@ -450,6 +450,9 @@ def __init__(self, cls: "Message"):
         self.oneof_group_by_field = by_field
         self.oneof_field_by_group = by_group
 
+        self.init_default_gen()
+        self.init_cls_by_field()
+
     def init_default_gen(self):
         default_gen = {}
 
@@ -476,34 +479,13 @@ def init_cls_by_field(self):
                     ],
                     bases=(Message,),
                 )
-                make_protoclass(Entry)
                 field_cls[field.name] = Entry
                 field_cls[field.name + ".value"] = vt
             else:
                 field_cls[field.name] = self.cls._cls_for(field)
 
         self.cls_by_field = field_cls
 
-    def __getattr__(self, item):
-        # Lazy init because forward reference classes may not be available at the beginning.
-        if item == 'default_gen':
-            self.init_default_gen()
-            return self.default_gen
-
-        if item == 'cls_by_field':
-            self.init_cls_by_field()
-            return self.cls_by_field
-
-
-def make_protoclass(cls):
-    setattr(cls, "_betterproto", ProtoClassMetadata(cls))
-
-
-def protoclass(*args, **kwargs):
-    cls = dataclasses.dataclass(*args, **kwargs)
-    make_protoclass(cls)
-    return cls
-
 
 class Message(ABC):
     """
@@ -565,6 +547,19 @@ def __setattr__(self, attr: str, value: Any) -> None:
 
         super().__setattr__(attr, value)
 
+    @property
+    def _betterproto(self):
+        """
+        Lazy initialize metadata for each protobuf class.
+        It may be initialized multiple times in a multi-threaded environment,
+        but that won't affect the correctness.
+        """
+        meta = getattr(self.__class__, "_betterproto_meta", None)
+        if not meta:
+            meta = ProtoClassMetadata(self.__class__)
+            self.__class__._betterproto_meta = meta
+        return meta
+
     def __bytes__(self) -> bytes:
         """
         Get the binary encoded Protobuf representation of this instance.
@@ -930,7 +925,7 @@ def which_one_of(message: Message, group_name: str) -> Tuple[str, Any]:
     return (field.name, getattr(message, field.name))
 
 
-@protoclass
+@dataclasses.dataclass
 class _Duration(Message):
     # Signed seconds of the span of time. Must be from -315,576,000,000 to
     # +315,576,000,000 inclusive. Note: these bounds are computed from: 60
@@ -955,7 +950,7 @@ def delta_to_json(delta: timedelta) -> str:
         return ".".join(parts) + "s"
 
 
-@protoclass
+@dataclasses.dataclass
 class _Timestamp(Message):
     # Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must
     # be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.
@@ -1005,47 +1000,47 @@ def from_dict(self: T, value: Any) -> T:
         return self
 
 
-@protoclass
+@dataclasses.dataclass
 class _BoolValue(_WrappedMessage):
     value: bool = bool_field(1)
 
 
-@protoclass
+@dataclasses.dataclass
 class _Int32Value(_WrappedMessage):
     value: int = int32_field(1)
 
 
-@protoclass
+@dataclasses.dataclass
 class _UInt32Value(_WrappedMessage):
     value: int = uint32_field(1)
 
 
-@protoclass
+@dataclasses.dataclass
 class _Int64Value(_WrappedMessage):
     value: int = int64_field(1)
 
 
-@protoclass
+@dataclasses.dataclass
 class _UInt64Value(_WrappedMessage):
     value: int = uint64_field(1)
 
 
-@protoclass
+@dataclasses.dataclass
 class _FloatValue(_WrappedMessage):
     value: float = float_field(1)
 
 
-@protoclass
+@dataclasses.dataclass
 class _DoubleValue(_WrappedMessage):
     value: float = double_field(1)
 
 
-@protoclass
+@dataclasses.dataclass
 class _StringValue(_WrappedMessage):
     value: str = string_field(1)
 
 
-@protoclass
+@dataclasses.dataclass
 class _BytesValue(_WrappedMessage):
     value: bytes = bytes_field(1)
 

betterproto/templates/template.py

@@ -4,11 +4,11 @@
 
 
 def test_has_field():
-    @betterproto.protoclass
+    @dataclass
     class Bar(betterproto.Message):
         baz: int = betterproto.int32_field(1)
 
-    @betterproto.protoclass
+    @dataclass
     class Foo(betterproto.Message):
         bar: Bar = betterproto.message_field(1)
 
@@ -34,11 +34,11 @@ class Foo(betterproto.Message):
 
 
 def test_class_init():
-    @betterproto.protoclass
+    @dataclass
     class Bar(betterproto.Message):
         name: str = betterproto.string_field(1)
 
-    @betterproto.protoclass
+    @dataclass
     class Foo(betterproto.Message):
         name: str = betterproto.string_field(1)
         child: Bar = betterproto.message_field(2)
@@ -53,7 +53,7 @@ class TestEnum(betterproto.Enum):
         ZERO = 0
         ONE = 1
 
-    @betterproto.protoclass
+    @dataclass
     class Foo(betterproto.Message):
         bar: TestEnum = betterproto.enum_field(1)
 
@@ -67,13 +67,13 @@ class Foo(betterproto.Message):
 
 
 def test_unknown_fields():
-    @betterproto.protoclass
+    @dataclass
     class Newer(betterproto.Message):
         foo: bool = betterproto.bool_field(1)
         bar: int = betterproto.int32_field(2)
         baz: str = betterproto.string_field(3)
 
-    @betterproto.protoclass
+    @dataclass
     class Older(betterproto.Message):
         foo: bool = betterproto.bool_field(1)
 
@@ -89,11 +89,11 @@ class Older(betterproto.Message):
 
 
 def test_oneof_support():
-    @betterproto.protoclass
+    @dataclass
     class Sub(betterproto.Message):
         val: int = betterproto.int32_field(1)
 
-    @betterproto.protoclass
+    @dataclass
     class Foo(betterproto.Message):
         bar: int = betterproto.int32_field(1, group="group1")
         baz: str = betterproto.string_field(2, group="group1")
@@ -134,7 +134,7 @@ class Foo(betterproto.Message):
 
 
 def test_json_casing():
-    @betterproto.protoclass
+    @dataclass
     class CasingTest(betterproto.Message):
         pascal_case: int = betterproto.int32_field(1)
         camel_case: int = betterproto.int32_field(2)
@@ -165,7 +165,7 @@ class CasingTest(betterproto.Message):
 
 
 def test_optional_flag():
-    @betterproto.protoclass
+    @dataclass
     class Request(betterproto.Message):
         flag: Optional[bool] = betterproto.message_field(1, wraps=betterproto.TYPE_BOOL)
 
@@ -180,7 +180,7 @@ class Request(betterproto.Message):
 
 
 def test_to_dict_default_values():
-    @betterproto.protoclass
+    @dataclass
     class TestMessage(betterproto.Message):
         some_int: int = betterproto.int32_field(1)
         some_double: float = betterproto.double_field(2)
@@ -210,7 +210,7 @@ class TestMessage(betterproto.Message):
     }
 
     # Some default and some other values
-    @betterproto.protoclass
+    @dataclass
     class TestMessage2(betterproto.Message):
         some_int: int = betterproto.int32_field(1)
         some_double: float = betterproto.double_field(2)
@@ -246,11 +246,11 @@ class TestMessage2(betterproto.Message):
     }
 
     # Nested messages
-    @betterproto.protoclass
+    @dataclass
     class TestChildMessage(betterproto.Message):
         some_other_int: int = betterproto.int32_field(1)
 
-    @betterproto.protoclass
+    @dataclass
     class TestParentMessage(betterproto.Message):
         some_int: int = betterproto.int32_field(1)
         some_double: float = betterproto.double_field(2)