only generate method as property if deprecated

Signed-off-by: Aidan Jensen <aidandj.github@gmail.com>

Author: aidandj

mypy_protobuf/main.py

@@ -580,10 +580,11 @@ def write_messages(
                     if is_scalar(field) and field.label != d.FieldDescriptorProto.LABEL_REPEATED:
                         # Scalar non repeated fields are r/w, generate getter and setter if deprecated
                         scl_field = scl + [d.DescriptorProto.FIELD_FIELD_NUMBER, idx]
+                        deprecation_scl_field = scl_field + [d.FieldDescriptorProto.OPTIONS_FIELD_NUMBER] + [d.FieldOptions.DEPRECATED_FIELD_NUMBER]
                         if field.options.deprecated:
                             wl("@property")
                             self._write_deprecation_warning(
-                                scl_field + [d.FieldDescriptorProto.OPTIONS_FIELD_NUMBER] + [d.FieldOptions.DEPRECATED_FIELD_NUMBER],
+                                deprecation_scl_field,
                                 "This field has been marked as deprecated using proto field options.",
                             )
                             body = " ..." if not self._has_comments(scl_field) else ""
@@ -594,7 +595,7 @@ def write_messages(
                                 wl("")
                             wl(f"@{field.name}.setter")
                             self._write_deprecation_warning(
-                                scl_field + [d.FieldDescriptorProto.OPTIONS_FIELD_NUMBER] + [d.FieldOptions.DEPRECATED_FIELD_NUMBER],
+                                deprecation_scl_field,
                                 "This field has been marked as deprecated using proto field options.",
                             )
                             body = " ..." if not self._has_comments(scl_field) else ""
@@ -953,7 +954,7 @@ def write_grpc_servicer_context(self) -> None:
             wl("...")
         wl("")
 
-    def write_grpc_stub_methods(self, service: d.ServiceDescriptorProto, scl_prefix: SourceCodeLocation, *, is_async: bool, both: bool = False, ignore_override_errors: bool = False) -> None:
+    def write_grpc_stub_methods(self, service: d.ServiceDescriptorProto, scl_prefix: SourceCodeLocation, *, is_async: bool, both: bool = False, ignore_type_error: bool = False) -> None:
         wl = self._write_line
         methods = [(i, m) for i, m in enumerate(service.method) if m.name not in PYTHON_RESERVED]
         if not methods:
@@ -964,20 +965,30 @@ def type_str(method: d.MethodDescriptorProto, is_async: bool) -> str:
 
         for i, method in methods:
             scl = scl_prefix + [d.ServiceDescriptorProto.METHOD_FIELD_NUMBER, i]
-            wl("@property")
-            if method.options.deprecated:
+            is_deprecated = method.options.deprecated
+            has_comments = self._has_comments(scl)
+
+            # Generate type annotation once
+            if both:
+                type_annotation = f"{self._import('typing', 'Union')}[{type_str(method, is_async=False)}, {type_str(method, is_async=True)}]"
+            else:
+                type_annotation = type_str(method, is_async=is_async)
+
+            if is_deprecated:
+                wl("@property")
                 self._write_deprecation_warning(
-                    scl + [d.MethodDescriptorProto.OPTIONS_FIELD_NUMBER] + [d.MethodOptions.DEPRECATED_FIELD_NUMBER],
+                    scl + [d.MethodDescriptorProto.OPTIONS_FIELD_NUMBER, d.MethodOptions.DEPRECATED_FIELD_NUMBER],
                     "This method has been marked as deprecated using proto method options.",
                 )
-            if both:
-                wl("def {}(self) -> {}[{}, {}]:{}", method.name, self._import("typing", "Union"), type_str(method, is_async=False), type_str(method, is_async=True), " ..." if not self._has_comments(scl) else " ")
+                wl(f"def {method.name}(self) -> {type_annotation}:{' ...' if not has_comments else ''}{'  # type: ignore[override]' if ignore_type_error else ''}")
+
+                if has_comments:
+                    with self._indent():
+                        if not self._write_comments(scl):
+                            wl("...")
             else:
-                wl("def {}(self) -> {}:{}{}", method.name, type_str(method, is_async=is_async), " ..." if not self._has_comments(scl) else "", "" if not ignore_override_errors else "  # type: ignore[override]")
-            if self._has_comments(scl):
-                with self._indent():
-                    if not self._write_comments(scl):
-                        wl("...")
+                wl(f"{method.name}: {type_annotation}{'  # type: ignore[assignment]' if ignore_type_error else ''}")
+                self._write_comments(scl)
 
     def write_grpc_methods(self, service: d.ServiceDescriptorProto, scl_prefix: SourceCodeLocation) -> None:
         wl = self._write_line
@@ -1094,7 +1105,7 @@ def write_grpc_services(
                         if self._write_comments(scl):
                             wl("")
                         wl("def __init__(self, channel: {}) -> None: ...", self._import("grpc.aio", "Channel"))
-                        self.write_grpc_stub_methods(service, scl, is_async=True, ignore_assignment_errors=True)
+                        self.write_grpc_stub_methods(service, scl, is_async=True, ignore_type_error=True)
                 else:
                     # ASYNC only - use Stub name (not AsyncStub) since there's only one type
                     wl("class {}:", class_name)

proto/testproto/grpc/dummy.proto

@@ -41,6 +41,9 @@ service DeprecatedService {
     // Method is deprecated, but request message is not
     option deprecated = true;
   }
+  rpc DeprecatedMethodNoComments(DeprecatedRequest) returns (DummyReply) {
+    option deprecated = true;
+  }
 }
 
 message ManyRequest1 {}

test_negative/negative.py

@@ -313,6 +313,13 @@ def DeprecatedMethodNotDeprecatedRequest(
     ) -> DummyReply:
         return DummyReply()
 
+    def DeprecatedMethodNoComments(
+        self,
+        request: DeprecatedRequest,
+        context: grpc.ServicerContext,
+    ) -> DummyReply:
+        return DummyReply()
+
 
 server = grpc.server(thread_pool=concurrent.futures.ThreadPoolExecutor())
 deprecated_servicer = DeprecatedServicer()

test_negative/output.expected.3.10

@@ -126,24 +126,24 @@ test_negative/negative.py:292: error: Return type "Iterator[DummyReply]" of "Str
 test_negative/negative.py:294: error: Argument 1 of "StreamUnary" is incompatible with supertype "testproto.grpc.dummy_pb2_grpc.DummyServiceServicer"; supertype defines the argument type as "_MaybeAsyncIterator[DummyRequest]"  [override]
 test_negative/negative.py:294: note: This violates the Liskov substitution principle
 test_negative/negative.py:294: note: See https://mypy.readthedocs.io/en/stable/common_issues.html#incompatible-overrides
-test_negative/negative.py:321: error: function testproto.grpc.dummy_pb2_grpc.DeprecatedServiceStub.DeprecatedMethod is deprecated: This method has been marked as deprecated using proto method options.  [deprecated]
-test_negative/negative.py:322: error: function testproto.grpc.dummy_pb2_grpc.DeprecatedServiceStub.DeprecatedMethodNotDeprecatedRequest is deprecated: Method is deprecated, but request message is not  [deprecated]
-test_negative/negative.py:323: error: class testproto.grpc.dummy_pb2_grpc.DeprecatedServiceAsyncStub is deprecated: This service is deprecated  [deprecated]
-test_negative/negative.py:326: error: function testproto.test_pb2._DeprecatedEnumEnumTypeWrapper.DEPRECATED_ONE is deprecated: This enum value has been marked as deprecated using proto enum value options.  [deprecated]
-test_negative/negative.py:327: error: function testproto.test_pb2._DeprecatedEnumEnumTypeWrapper.DEPRECATED_TWO is deprecated: This enum value has been marked as deprecated using proto enum value options.  [deprecated]
-test_negative/negative.py:337: error: Argument "implicit_singular" to "Editions2024Test" has incompatible type "None"; expected "str"  [arg-type]
-test_negative/negative.py:339: error: Argument 1 to "HasField" of "Editions2024Test" has incompatible type "Literal['implicit_singular']"; expected "Literal['default_singular', b'default_singular', 'explicit_singular', b'explicit_singular', 'legacy', b'legacy', 'message_field', b'message_field']"  [arg-type]
-test_negative/negative.py:350: error: Cannot instantiate abstract class "IncompleteServicer" with abstract attributes "StreamStream", "StreamUnary", "UnaryStream" and "UnaryUnary"  [abstract]
-test_negative/negative.py:357: error: Argument 2 to "test_hasfield_alias" has incompatible type "Literal['not_a_field']"; expected "Literal['default_singular', b'default_singular', 'explicit_singular', b'explicit_singular', 'legacy', b'legacy', 'message_field', b'message_field']"  [arg-type]
-test_negative/negative.py:364: error: Argument 2 to "test_clearfield_alias" has incompatible type "Literal['not_a_field']"; expected "Literal['default_singular', b'default_singular', 'explicit_singular', b'explicit_singular', 'implicit_singular', b'implicit_singular', 'legacy', b'legacy', 'message_field', b'message_field']"  [arg-type]
-test_negative/negative.py:365: error: Property "message_field" defined in "Editions2024Test" is read-only  [misc]
-test_negative/negative.py:376: error: Argument 2 to "test_whichoneof_alias" has incompatible type "Literal['not_a_oneof']"; expected "Literal['a_oneof', b'a_oneof']"  [arg-type]
-test_negative/negative.py:379: error: All overload variants of "DummyServiceStub" require at least one argument  [call-overload]
-test_negative/negative.py:379: note: Possible overload variants:
-test_negative/negative.py:379: note:     def __new__(cls, channel: Channel) -> DummyServiceStub
-test_negative/negative.py:379: note:     def __new__(cls, channel: Channel) -> DummyServiceAsyncStub
-test_negative/negative.py:380: error: No overload variant of "DummyServiceStub" matches argument type "str"  [call-overload]
-test_negative/negative.py:380: note: Possible overload variants:
-test_negative/negative.py:380: note:     def __new__(cls, channel: Channel) -> DummyServiceStub
-test_negative/negative.py:380: note:     def __new__(cls, channel: Channel) -> DummyServiceAsyncStub
-Found 111 errors in 4 files (checked 4 source files)
+test_negative/negative.py:328: error: function testproto.grpc.dummy_pb2_grpc.DeprecatedServiceStub.DeprecatedMethod is deprecated: This method has been marked as deprecated using proto method options.  [deprecated]
+test_negative/negative.py:329: error: function testproto.grpc.dummy_pb2_grpc.DeprecatedServiceStub.DeprecatedMethodNotDeprecatedRequest is deprecated: Method is deprecated, but request message is not  [deprecated]
+test_negative/negative.py:330: error: class testproto.grpc.dummy_pb2_grpc.DeprecatedServiceAsyncStub is deprecated: This service is deprecated  [deprecated]
+test_negative/negative.py:333: error: function testproto.test_pb2._DeprecatedEnumEnumTypeWrapper.DEPRECATED_ONE is deprecated: This enum value has been marked as deprecated using proto enum value options.  [deprecated]
+test_negative/negative.py:334: error: function testproto.test_pb2._DeprecatedEnumEnumTypeWrapper.DEPRECATED_TWO is deprecated: This enum value has been marked as deprecated using proto enum value options.  [deprecated]
+test_negative/negative.py:344: error: Argument "implicit_singular" to "Editions2024Test" has incompatible type "None"; expected "str"  [arg-type]
+test_negative/negative.py:346: error: Argument 1 to "HasField" of "Editions2024Test" has incompatible type "Literal['implicit_singular']"; expected "Literal['default_singular', b'default_singular', 'explicit_singular', b'explicit_singular', 'legacy', b'legacy', 'message_field', b'message_field']"  [arg-type]
+test_negative/negative.py:357: error: Cannot instantiate abstract class "IncompleteServicer" with abstract attributes "StreamStream", "StreamUnary", "UnaryStream" and "UnaryUnary"  [abstract]
+test_negative/negative.py:364: error: Argument 2 to "test_hasfield_alias" has incompatible type "Literal['not_a_field']"; expected "Literal['default_singular', b'default_singular', 'explicit_singular', b'explicit_singular', 'legacy', b'legacy', 'message_field', b'message_field']"  [arg-type]
+test_negative/negative.py:371: error: Argument 2 to "test_clearfield_alias" has incompatible type "Literal['not_a_field']"; expected "Literal['default_singular', b'default_singular', 'explicit_singular', b'explicit_singular', 'implicit_singular', b'implicit_singular', 'legacy', b'legacy', 'message_field', b'message_field']"  [arg-type]
+test_negative/negative.py:372: error: Property "message_field" defined in "Editions2024Test" is read-only  [misc]
+test_negative/negative.py:383: error: Argument 2 to "test_whichoneof_alias" has incompatible type "Literal['not_a_oneof']"; expected "Literal['a_oneof', b'a_oneof']"  [arg-type]
+test_negative/negative.py:386: error: All overload variants of "DummyServiceStub" require at least one argument  [call-overload]
+test_negative/negative.py:386: note: Possible overload variants:
+test_negative/negative.py:386: note:     def __new__(cls, channel: Channel) -> DummyServiceStub
+test_negative/negative.py:386: note:     def __new__(cls, channel: Channel) -> DummyServiceAsyncStub
+test_negative/negative.py:387: error: No overload variant of "DummyServiceStub" matches argument type "str"  [call-overload]
+test_negative/negative.py:387: note: Possible overload variants:
+test_negative/negative.py:387: note:     def __new__(cls, channel: Channel) -> DummyServiceStub
+test_negative/negative.py:387: note:     def __new__(cls, channel: Channel) -> DummyServiceAsyncStub
+Found 114 errors in 4 files (checked 4 source files)

test_negative/output.expected.3.10.omit_linenos

@@ -1,10 +1,14 @@
 test/generated/testproto/grpc/dummy_pb2.pyi: error: class testproto.grpc.dummy_pb2.DeprecatedRequest is deprecated: This message has been marked as deprecated using proto message options.  [deprecated]
 test/generated/testproto/grpc/dummy_pb2_grpc.pyi: error: class testproto.grpc.dummy_pb2_grpc.DeprecatedServiceAsyncStub is deprecated: This service is deprecated  [deprecated]
 test/generated/testproto/grpc/dummy_pb2_grpc.pyi: error: class testproto.grpc.dummy_pb2.DeprecatedRequest is deprecated: This message has been marked as deprecated using proto message options.  [deprecated]
+test/generated/testproto/grpc/dummy_pb2_grpc.pyi: error: class testproto.grpc.dummy_pb2.DeprecatedRequest is deprecated: This message has been marked as deprecated using proto message options.  [deprecated]
 test/generated/testproto/grpc/dummy_pb2_grpc.pyi: error: class testproto.grpc.dummy_pb2_grpc.DeprecatedServiceStub is deprecated: This service is deprecated  [deprecated]
 test/generated/testproto/grpc/dummy_pb2_grpc.pyi: error: class testproto.grpc.dummy_pb2.DeprecatedRequest is deprecated: This message has been marked as deprecated using proto message options.  [deprecated]
 test/generated/testproto/grpc/dummy_pb2_grpc.pyi: note: Error code "deprecated" not covered by "type: ignore" comment
 test/generated/testproto/grpc/dummy_pb2_grpc.pyi: error: class testproto.grpc.dummy_pb2.DeprecatedRequest is deprecated: This message has been marked as deprecated using proto message options.  [deprecated]
+test/generated/testproto/grpc/dummy_pb2_grpc.pyi: note: Error code "deprecated" not covered by "type: ignore" comment
+test/generated/testproto/grpc/dummy_pb2_grpc.pyi: error: class testproto.grpc.dummy_pb2.DeprecatedRequest is deprecated: This message has been marked as deprecated using proto message options.  [deprecated]
+test/generated/testproto/grpc/dummy_pb2_grpc.pyi: error: class testproto.grpc.dummy_pb2.DeprecatedRequest is deprecated: This message has been marked as deprecated using proto message options.  [deprecated]
 test/generated/testproto/grpc/dummy_pb2_grpc.pyi: error: class testproto.grpc.dummy_pb2_grpc.DeprecatedServiceServicer is deprecated: This service is deprecated  [deprecated]
 test/generated/testproto/test_pb2.pyi: error: class testproto.test_pb2.DeprecatedEnum is deprecated: This enum is deprecated
 2 lines of comments
@@ -145,4 +149,4 @@ test_negative/negative.py: error: No overload variant of "DummyServiceStub" matc
 test_negative/negative.py: note: Possible overload variants:
 test_negative/negative.py: note:     def __new__(cls, channel: Channel) -> DummyServiceStub
 test_negative/negative.py: note:     def __new__(cls, channel: Channel) -> DummyServiceAsyncStub
-Found 111 errors in 4 files (checked 4 source files)
+Found 114 errors in 4 files (checked 4 source files)