def _get_methods(
self,
methods: Sequence[descriptor_pb2.MethodDescriptorProto],
address: metadata.Address,
path: Tuple[int, ...],
) -> Mapping[str, wrappers.Method]:
"""Return a dictionary of wrapped methods for the given service.
Args:
methods (Sequence[~.descriptor_pb2.MethodDescriptorProto]): A
sequence of protobuf method objects.
address (~.metadata.Address): An address object denoting the
location of these methods.
path (Tuple[int]): The source location path thus far, as understood
by ``SourceCodeInfo.Location``.
Returns:
Mapping[str, ~.wrappers.Method]: A ordered mapping of
:class:`~.wrappers.Method` objects.
"""
# Iterate over the methods and collect them into a dictionary.
answer: Dict[str, wrappers.Method] = collections.OrderedDict()
for meth_pb, i in zip(methods, range(0, sys.maxsize)):
lro = None
# If the output type is google.longrunning.Operation, we use
# a specialized object in its place.
if meth_pb.output_type.endswith('google.longrunning.Operation'):
op = meth_pb.options.Extensions[operations_pb2.operation_info]
if not op.response_type or not op.metadata_type:
raise TypeError(
f'rpc {meth_pb.name} returns a google.longrunning.'
'Operation, but is missing a response type or '
'metadata type.', )
lro = wrappers.OperationInfo(
response_type=self.api_messages[address.resolve(
op.response_type, )],
metadata_type=self.api_messages[address.resolve(
op.metadata_type, )],
)
# Create the method wrapper object.
answer[meth_pb.name] = wrappers.Method(
input=self.api_messages[meth_pb.input_type.lstrip('.')],
lro=lro,
method_pb=meth_pb,
meta=metadata.Metadata(
address=address.child(meth_pb.name, path + (i, )),
documentation=self.docs.get(path + (i, ), self.EMPTY),
),
output=self.api_messages[meth_pb.output_type.lstrip('.')],
)
# Done; return the answer.
return answer
def _maybe_get_lro(
self,
service_address: metadata.Address,
meth_pb: descriptor_pb2.MethodDescriptorProto
) -> Optional[wrappers.OperationInfo]:
"""Determines whether a method is a Long Running Operation (aka LRO)
and, if it is, return an OperationInfo that includes the response
and metadata types.
Args:
service_address (~.metadata.Address): An address object for the
service, denoting the location of these methods.
meth_pb (~.descriptor_pb2.MethodDescriptorProto): A
protobuf method objects.
Returns:
Optional[~.wrappers.OperationInfo]: The info for the long-running
operation, if the passed method is an LRO.
"""
lro = None
# If the output type is google.longrunning.Operation, we use
# a specialized object in its place.
if meth_pb.output_type.endswith('google.longrunning.Operation'):
if not meth_pb.options.HasExtension(operations_pb2.operation_info):
# This is not a long running operation even though it returns
# an Operation.
return None
op = meth_pb.options.Extensions[operations_pb2.operation_info]
if not op.response_type or not op.metadata_type:
raise TypeError(
f'rpc {meth_pb.name} returns a google.longrunning.'
'Operation, but is missing a response type or '
'metadata type.',
)
response_key = service_address.resolve(op.response_type)
metadata_key = service_address.resolve(op.metadata_type)
lro = wrappers.OperationInfo(
response_type=self.api_messages[response_key],
metadata_type=self.api_messages[metadata_key],
)
return lro
def get_method(
name: str,
in_type: str,
out_type: str,
lro_response_type: str = '',
lro_metadata_type: str = '',
*,
in_fields: typing.Tuple[desc.FieldDescriptorProto] = (),
http_rule: http_pb2.HttpRule = None,
method_signature: str = '',
) -> wrappers.Method:
input_ = get_message(in_type, fields=in_fields)
output = get_message(out_type)
lro = None
# Define a method descriptor. Set the field headers if appropriate.
method_pb = desc.MethodDescriptorProto(
name=name,
input_type=input_.ident.proto,
output_type=output.ident.proto,
)
if lro_response_type:
lro = wrappers.OperationInfo(
response_type=get_message(lro_response_type),
metadata_type=get_message(lro_metadata_type),
)
if http_rule:
ext_key = annotations_pb2.http
method_pb.options.Extensions[ext_key].MergeFrom(http_rule)
if method_signature:
ext_key = client_pb2.method_signature
method_pb.options.Extensions[ext_key].append(method_signature)
return wrappers.Method(
method_pb=method_pb,
input=input_,
output=output,
lro=lro,
meta=input_.meta,
)
def _get_methods(
self,
methods: Sequence[descriptor_pb2.MethodDescriptorProto],
service_address: metadata.Address,
path: Tuple[int, ...],
) -> Mapping[str, wrappers.Method]:
"""Return a dictionary of wrapped methods for the given service.
Args:
methods (Sequence[~.descriptor_pb2.MethodDescriptorProto]): A
sequence of protobuf method objects.
service_address (~.metadata.Address): An address object for the
service, denoting the location of these methods.
path (Tuple[int]): The source location path thus far, as understood
by ``SourceCodeInfo.Location``.
Returns:
Mapping[str, ~.wrappers.Method]: A ordered mapping of
:class:`~.wrappers.Method` objects.
"""
# Iterate over the methods and collect them into a dictionary.
answer: Dict[str, wrappers.Method] = collections.OrderedDict()
for meth_pb, i in zip(methods, range(0, sys.maxsize)):
lro = None
# If the output type is google.longrunning.Operation, we use
# a specialized object in its place.
if meth_pb.output_type.endswith('google.longrunning.Operation'):
op = meth_pb.options.Extensions[operations_pb2.operation_info]
if not op.response_type or not op.metadata_type:
raise TypeError(
f'rpc {meth_pb.name} returns a google.longrunning.'
'Operation, but is missing a response type or '
'metadata type.', )
lro = wrappers.OperationInfo(
response_type=self.api_messages[service_address.resolve(
op.response_type, )],
metadata_type=self.api_messages[service_address.resolve(
op.metadata_type, )],
)
# If we got a gRPC service config, get the appropriate retry
# and timeout information from it.
retry = None
timeout = None
# This object should be a dictionary that conforms to the
# gRPC service config proto:
# Repo: https://github.com/grpc/grpc-proto/
# Filename: grpc/service_config/service_config.proto
#
# We only care about a small piece, so we are just leaving
# it as a dictionary and parsing accordingly.
if self.opts.retry:
# The gRPC service config uses a repeated `name` field
# with a particular format, which we match against.
# This defines the expected selector for *this* method.
selector = {
'service':
'{package}.{service_name}'.format(
package='.'.join(service_address.package),
service_name=service_address.name,
),
'method':
meth_pb.name,
}
# Find the method config that applies to us, if any.
mc = next((i for i in self.opts.retry.get('methodConfig', [])
if selector in i.get('name')), None)
if mc:
# Set the timeout according to this method config.
if mc.get('timeout'):
timeout = self._to_float(mc['timeout'])
# Set the retry according to this method config.
if 'retryPolicy' in mc:
r = mc['retryPolicy']
retry = wrappers.RetryInfo(
max_attempts=r.get('maxAttempts', 0),
initial_backoff=self._to_float(
r.get('initialBackoff', '0s'), ),
max_backoff=self._to_float(
r.get('maxBackoff', '0s'), ),
backoff_multiplier=r.get('backoffMultiplier', 0.0),
retryable_exceptions=frozenset(
exceptions.exception_class_for_grpc_status(
getattr(grpc.StatusCode, code), )
for code in r.get('retryableStatusCodes', [])),
)
# Create the method wrapper object.
answer[meth_pb.name] = wrappers.Method(
input=self.api_messages[meth_pb.input_type.lstrip('.')],
lro=lro,
method_pb=meth_pb,
meta=metadata.Metadata(
address=service_address.child(meth_pb.name, path + (i, )),
documentation=self.docs.get(path + (i, ), self.EMPTY),
),
output=self.api_messages[meth_pb.output_type.lstrip('.')],
retry=retry,
timeout=timeout,
)
# Done; return the answer.
return answer
