Add generated doc strings and remove exception from pydocstyle

Author: VegetarianOrc

pyproject.toml

@@ -122,7 +122,7 @@ exclude = [
 [tool.pydocstyle]
 convention = "google"
 # https://github.com/PyCQA/pydocstyle/issues/363#issuecomment-625563088
-match_dir = "^(?!(docs|scripts|tests|api|proto|generated|\\.)).*"
+match_dir = "^(?!(docs|scripts|tests|api|proto|\\.)).*"
 add_ignore = [
   # We like to wrap at a certain number of chars, even long summary sentences.
   # https://github.com/PyCQA/pydocstyle/issues/184

scripts/gen_bridge_client.py

@@ -17,11 +17,12 @@
 
 def generate_python_services(
     file_descriptors: list[FileDescriptor],
-    output_file: str = "temporalio/bridge/generated/services_generated.py",
+    output_file: str = "temporalio/bridge/services_generated.py",
 ):
     print("generating python services")
 
-    services_template = Template("""# Generated file. DO NOT EDIT
+    services_template = Template('''# Generated file. DO NOT EDIT
+"""Generated RPC calls for Temporal services."""
 
 from __future__ import annotations
 
@@ -36,7 +37,7 @@ def generate_python_services(
     from temporalio.service import ServiceClient
 
 $service_defns
-""")
+''')
 
     def service_name(s):
         return f"import {sanitize_proto_name(s.full_name)[:-len(s.name)-1]}"
@@ -63,13 +64,15 @@ def service_name(s):
 
 
 def generate_python_service(service_descriptor: ServiceDescriptor) -> str:
-    service_template = Template("""
+    service_template = Template('''
 class $service_name:
+    """RPC calls for the $service_name."""
     def __init__(self, client: ServiceClient):
-        self.client = client
-        self.service = "$rpc_service_name"
+        """Initialize service with the provided ServiceClient."""
+        self._client = client
+        self._service = "$rpc_service_name"
 $method_calls
-""")
+''')
 
     sanitized_service_name: str = service_descriptor.name
     # The health service doesn't end in "Service" in the proto definition
@@ -88,7 +91,7 @@ def __init__(self, client: ServiceClient):
     ]
 
     method_calls = [
-        generate_python_method_call(method)
+        generate_python_method_call(sanitized_service_name, method)
         for method in sorted(methods, key=lambda m: m.name)
     ]
 
@@ -99,27 +102,31 @@ def __init__(self, client: ServiceClient):
     )
 
 
-def generate_python_method_call(method_descriptor: MethodDescriptor) -> str:
-    method_template = Template("""
+def generate_python_method_call(
+    service_name: str, method_descriptor: MethodDescriptor
+) -> str:
+    method_template = Template('''
     async def $method_name(
         self,
         req: $request_type,
         retry: bool = False,
         metadata: Mapping[str, Union[str, bytes]] = {},
         timeout: Optional[timedelta] = None,
     ) -> $response_type:
-        return await self.client._rpc_call(
+        """Invokes the $service_name.$method_name rpc method."""
+        return await self._client._rpc_call(
             rpc="$method_name",
             req=req,
-            service=self.service,
+            service=self._service,
             resp_type=$response_type,
             retry=retry,
             metadata=metadata,
             timeout=timeout,
         )
-""")
+''')
 
     return method_template.substitute(
+        service_name=service_name,
         method_name=pascal_to_snake(method_descriptor.name),
         request_type=sanitize_proto_name(method_descriptor.input_type.full_name),
         response_type=sanitize_proto_name(method_descriptor.output_type.full_name),