def test_coerce_to(self):
types = Types()
cases = [
(42.0, 42, 'double'),
(42.0, 42, 'float'),
(42, 42.0, 'int32'),
(42, 42L, 'int32'),
(42L, 42.0, 'int64'),
(42L, 42, 'int64'),
(42, 42.0, 'uint32'),
(42, 42L, 'uint32'),
(42L, 42.0, 'uint64'),
(42L, 42, 'uint64'),
(list(), tuple(), 'List(string)'),
((0,1,2), [0,1,2], 'Tuple(int32,int32,int32)'),
([0,1,2], (0,1,2), 'List(int32)'),
]
for expected, value, typ in cases:
coerced_value = types.coerce_to(value, types.as_type(typ))
self.assertEqual(expected, coerced_value)
self.assertEqual(type(expected), type(coerced_value))
self.assertEqual(['foo','bar'], types.coerce_to(['foo','bar'], types.as_type('List(string)')))
self.assertRaises(ValueError, types.coerce_to, None, types.as_type('float'))
self.assertRaises(ValueError, types.coerce_to, '', types.as_type('float'))
self.assertRaises(ValueError, types.coerce_to, True, types.as_type('float'))
self.assertRaises(ValueError, types.coerce_to, list(), types.as_type('Tuple(int32)'))
self.assertRaises(ValueError, types.coerce_to, ["foo",2], types.as_type('Tuple(string)'))
self.assertRaises(ValueError, types.coerce_to, [1], types.as_type('Tuple(string)'))
def test_coerce_to(self):
types = Types()
cases = [
(42.0, 42, types.double_type),
(42.0, 42, types.float_type),
(42, 42.0, types.sint32_type),
(42, 42L, types.sint32_type),
(42L, 42.0, types.sint64_type),
(42L, 42, types.sint64_type),
(42, 42.0, types.uint32_type),
(42, 42L, types.uint32_type),
(42L, 42.0, types.uint64_type),
(42L, 42, types.uint64_type),
(list(), tuple(), types.list_type(types.string_type)),
((0, 1, 2), [0, 1, 2],
types.tuple_type(types.sint32_type,
types.sint32_type,
types.sint32_type)),
([0, 1, 2], (0, 1, 2),
types.list_type(types.sint32_type)),
(['foo', 'bar'], ['foo', 'bar'],
types.list_type(types.string_type))
]
for expected, value, typ in cases:
coerced_value = types.coerce_to(value, typ)
self.assertEqual(expected, coerced_value)
self.assertEqual(type(expected), type(coerced_value))
strings = [
u'foo',
u'\xe2\x84\xa2',
u'Mystery Goo\xe2\x84\xa2 Containment Unit'
]
for string in strings:
self.assertEqual(
string, types.coerce_to(string, types.string_type))
self.assertRaises(ValueError, types.coerce_to,
None, types.float_type)
self.assertRaises(ValueError, types.coerce_to,
'', types.float_type)
self.assertRaises(ValueError, types.coerce_to,
True, types.float_type)
self.assertRaises(ValueError, types.coerce_to,
list(), types.tuple_type(types.uint32_type))
self.assertRaises(ValueError, types.coerce_to,
['foo', 2], types.tuple_type(types.string_type))
self.assertRaises(ValueError, types.coerce_to,
[1], types.tuple_type(types.string_type))
def test_coerce_to(self):
types = Types()
cases = [
(42.0, 42, 'double'),
(42.0, 42, 'float'),
(42, 42.0, 'int32'),
(42, 42L, 'int32'),
(42L, 42.0, 'int64'),
(42L, 42, 'int64'),
(42, 42.0, 'uint32'),
(42, 42L, 'uint32'),
(42L, 42.0, 'uint64'),
(42L, 42, 'uint64'),
(list(), tuple(), 'List(string)'),
((0, 1, 2), [0, 1, 2], 'Tuple(int32,int32,int32)'),
([0, 1, 2], (0, 1, 2), 'List(int32)'),
]
for expected, value, typ in cases:
coerced_value = types.coerce_to(value, types.as_type(typ))
self.assertEqual(expected, coerced_value)
self.assertEqual(type(expected), type(coerced_value))
strings = [
u'foo', u'\xe2\x84\xa2',
u'Mystery Goo\xe2\x84\xa2 Containment Unit'
]
for string in strings:
self.assertEqual(string,
types.coerce_to(string, types.as_type('string')))
self.assertEqual(['foo', 'bar'],
types.coerce_to(['foo', 'bar'],
types.as_type('List(string)')))
self.assertRaises(ValueError, types.coerce_to, None,
types.as_type('float'))
self.assertRaises(ValueError, types.coerce_to, '',
types.as_type('float'))
self.assertRaises(ValueError, types.coerce_to, True,
types.as_type('float'))
self.assertRaises(ValueError, types.coerce_to, list(),
types.as_type('Tuple(int32)'))
self.assertRaises(ValueError, types.coerce_to, ['foo', 2],
types.as_type('Tuple(string)'))
self.assertRaises(ValueError, types.coerce_to, [1],
types.as_type('Tuple(string)'))
def test_coerce_to(self):
types = Types()
cases = [
(42.0, 42, 'double'),
(42.0, 42, 'float'),
(42, 42.0, 'int32'),
(42, 42L, 'int32'),
(42L, 42.0, 'int64'),
(42L, 42, 'int64'),
(42, 42.0, 'uint32'),
(42, 42L, 'uint32'),
(42L, 42.0, 'uint64'),
(42L, 42, 'uint64'),
(list(), tuple(), 'List(string)'),
((0, 1, 2), [0, 1, 2], 'Tuple(int32,int32,int32)'),
([0, 1, 2], (0, 1, 2), 'List(int32)'),
]
for expected, value, typ in cases:
coerced_value = types.coerce_to(value, types.as_type(typ))
self.assertEqual(expected, coerced_value)
self.assertEqual(type(expected), type(coerced_value))
self.assertEqual(['foo', 'bar'],
types.coerce_to(['foo', 'bar'],
types.as_type('List(string)')))
self.assertRaises(ValueError, types.coerce_to, None,
types.as_type('float'))
self.assertRaises(ValueError, types.coerce_to, '',
types.as_type('float'))
self.assertRaises(ValueError, types.coerce_to, True,
types.as_type('float'))
self.assertRaises(ValueError, types.coerce_to, list(),
types.as_type('Tuple(int32)'))
self.assertRaises(ValueError, types.coerce_to, ["foo", 2],
types.as_type('Tuple(string)'))
self.assertRaises(ValueError, types.coerce_to, [1],
types.as_type('Tuple(string)'))
def test_coerce_to(self):
types = Types()
cases = [
(42.0, 42, 'double'),
(42.0, 42, 'float'),
(42, 42.0, 'int32'),
(42, 42L, 'int32'),
(42L, 42.0, 'int64'),
(42L, 42, 'int64'),
(42, 42.0, 'uint32'),
(42, 42L, 'uint32'),
(42L, 42.0, 'uint64'),
(42L, 42, 'uint64'),
(list(), tuple(), 'List(string)'),
((0, 1, 2), [0, 1, 2], 'Tuple(int32,int32,int32)'),
([0, 1, 2], (0, 1, 2), 'List(int32)'),
]
for expected, value, typ in cases:
coerced_value = types.coerce_to(value, types.as_type(typ))
self.assertEqual(expected, coerced_value)
self.assertEqual(type(expected), type(coerced_value))
strings = [
u'foo',
u'\xe2\x84\xa2',
u'Mystery Goo\xe2\x84\xa2 Containment Unit'
]
for string in strings:
self.assertEqual(string, types.coerce_to(string, types.as_type('string')))
self.assertEqual(['foo', 'bar'], types.coerce_to(['foo', 'bar'], types.as_type('List(string)')))
self.assertRaises(ValueError, types.coerce_to, None, types.as_type('float'))
self.assertRaises(ValueError, types.coerce_to, '', types.as_type('float'))
self.assertRaises(ValueError, types.coerce_to, True, types.as_type('float'))
self.assertRaises(ValueError, types.coerce_to, list(), types.as_type('Tuple(int32)'))
self.assertRaises(ValueError, types.coerce_to, ['foo', 2], types.as_type('Tuple(string)'))
self.assertRaises(ValueError, types.coerce_to, [1], types.as_type('Tuple(string)'))
def test_coerce_to(self):
types = Types()
cases = [(42.0, 42, types.double_type), (42.0, 42, types.float_type),
(42, 42.0, types.sint32_type), (42, 42L, types.sint32_type),
(42L, 42.0, types.sint64_type), (42L, 42, types.sint64_type),
(42, 42.0, types.uint32_type), (42, 42L, types.uint32_type),
(42L, 42.0, types.uint64_type), (42L, 42, types.uint64_type),
(list(), tuple(), types.list_type(types.string_type)),
((0, 1, 2), [0, 1, 2],
types.tuple_type(types.sint32_type, types.sint32_type,
types.sint32_type)),
([0, 1, 2], (0, 1, 2), types.list_type(types.sint32_type)),
(['foo', 'bar'], ['foo',
'bar'], types.list_type(types.string_type))]
for expected, value, typ in cases:
coerced_value = types.coerce_to(value, typ)
self.assertEqual(expected, coerced_value)
self.assertEqual(type(expected), type(coerced_value))
strings = [
u'foo', u'\xe2\x84\xa2',
u'Mystery Goo\xe2\x84\xa2 Containment Unit'
]
for string in strings:
self.assertEqual(string, types.coerce_to(string,
types.string_type))
self.assertRaises(ValueError, types.coerce_to, None, types.float_type)
self.assertRaises(ValueError, types.coerce_to, '', types.float_type)
self.assertRaises(ValueError, types.coerce_to, True, types.float_type)
self.assertRaises(ValueError, types.coerce_to, list(),
types.tuple_type(types.uint32_type))
self.assertRaises(ValueError, types.coerce_to, ['foo', 2],
types.tuple_type(types.string_type))
self.assertRaises(ValueError, types.coerce_to, [1],
types.tuple_type(types.string_type))
class Client(object):
"""
A kRPC client, through which all Remote Procedure Calls are made.
Services provided by the server that the client connects to are automatically added.
RPCs can be made using client.ServiceName.ProcedureName(parameter)
"""
def __init__(self, rpc_connection, stream_connection):
self._types = Types()
self._rpc_connection = rpc_connection
self._rpc_connection_lock = threading.Lock()
self._stream_connection = stream_connection
self._request_type = self._types.as_type("KRPC.Request")
self._response_type = self._types.as_type("KRPC.Response")
# Set up the main KRPC service
self.krpc = KRPC(self)
services = self.krpc.get_services().services
# Create class types
# TODO: is this needed?!?
for service in services:
for procedure in service.procedures:
try:
name = Attributes.get_class_name(procedure.attributes)
self._types.as_type("Class(" + service.name + "." + name + ")")
except ValueError:
pass
# Set up services
for service in services:
if service.name != "KRPC":
setattr(self, _to_snake_case(service.name), create_service(self, service))
# Set up stream update thread
if stream_connection is not None:
self._stream_thread = threading.Thread(target=krpc.stream.update_thread, args=(stream_connection,))
self._stream_thread.daemon = True
self._stream_thread.start()
else:
self._stream_thread = None
def close(self):
self._rpc_connection.close()
if self._stream_connection is not None:
self._stream_connection.close()
def __enter__(self):
return self
def __exit__(self, typ, value, traceback):
self.close()
def add_stream(self, func, *args, **kwargs):
if self._stream_connection is None:
raise RuntimeError("Not connected to stream server")
return krpc.stream.add_stream(self, func, *args, **kwargs)
@contextmanager
def stream(self, func, *args, **kwargs):
""" 'with' support """
s = self.add_stream(func, *args, **kwargs)
try:
yield s
finally:
s.remove()
def _invoke(self, service, procedure, args=[], kwargs={}, param_names=[], param_types=[], return_type=None):
""" Execute an RPC """
# Build the request
request = self._build_request(service, procedure, args, kwargs, param_names, param_types, return_type)
# Send the request
with self._rpc_connection_lock:
self._send_request(request)
response = self._receive_response()
# Check for an error response
if response.HasField("error"):
raise RPCError(response.error)
# Decode the response and return the (optional) result
result = None
if return_type is not None:
result = Decoder.decode(response.return_value, return_type)
return result
def _build_request(self, service, procedure, args=[], kwargs={}, param_names=[], param_types=[], return_type=None):
""" Build a KRPC.Request object """
def encode_argument(i, value):
typ = param_types[i]
if type(value) != typ.python_type:
# Try coercing to the correct type
try:
value = self._types.coerce_to(value, typ)
except ValueError:
raise TypeError(
"%s.%s() argument %d must be a %s, got a %s"
% (service, procedure, i, typ.python_type, type(value))
)
return Encoder.encode(value, typ)
if len(args) > len(param_types):
raise TypeError(
"%s.%s() takes exactly %d arguments (%d given)" % (service, procedure, len(param_types), len(args))
)
arguments = []
nargs = len(args)
for i, param in enumerate(param_names):
add = False
if i < nargs and not isinstance(args[i], DefaultArgument):
arg = args[i]
add = True
elif param in kwargs:
arg = args[param]
add = True
if add:
argument = krpc.schema.KRPC.Argument()
argument.position = i
argument.value = encode_argument(i, arg)
arguments.append(argument)
# Build the request object
request = krpc.schema.KRPC.Request()
request.service = service
request.procedure = procedure
request.arguments.extend(arguments)
return request
def _send_request(self, request):
""" Send a KRPC.Request object to the server """
data = Encoder.encode_delimited(request, self._request_type)
self._rpc_connection.send(data)
def _receive_response(self):
""" Receive data from the server and decode it into a KRPC.Response object """
# Read the size and position of the response message
data = b""
while True:
try:
data += self._rpc_connection.partial_receive(1)
size, position = Decoder.decode_size_and_position(data)
break
except IndexError:
pass
# Read and decode the response message
data = self._rpc_connection.receive(size)
return Decoder.decode(data, self._response_type)
class Client(object):
"""
A kRPC client, through which all Remote Procedure Calls are made.
Services provided by the server that the client connects
to are automatically added. RPCs can be made using
client.ServiceName.ProcedureName(parameter)
"""
def __init__(self, rpc_connection, stream_connection):
self._types = Types()
self._rpc_connection = rpc_connection
self._rpc_connection_lock = threading.Lock()
self._stream_connection = stream_connection
self._stream_manager = StreamManager(self)
# Get the services
services = self._invoke('KRPC', 'GetServices', [], [], [],
self._types.services_type).services
# Set up services
for service in services:
setattr(self, snake_case(service.name),
create_service(self, service))
# Set up stream update thread
if stream_connection is not None:
self._stream_thread_stop = threading.Event()
self._stream_thread = threading.Thread(
target=krpc.streammanager.update_thread,
args=(self._stream_manager, stream_connection,
self._stream_thread_stop))
self._stream_thread.daemon = True
self._stream_thread.start()
else:
self._stream_thread = None
def close(self):
self._rpc_connection.close()
if self._stream_thread is not None:
self._stream_thread_stop.set()
self._stream_thread.join()
def __enter__(self):
return self
def __exit__(self, typ, value, traceback):
self.close()
def add_stream(self, func, *args, **kwargs):
""" Add a stream to the server """
if self._stream_connection is None:
raise StreamError('Not connected to stream server')
if func == setattr:
raise StreamError('Cannot stream a property setter')
return_type = self._get_return_type(func, *args, **kwargs)
call = self.get_call(func, *args, **kwargs)
return krpc.stream.Stream.from_call(self, return_type, call)
@contextmanager
def stream(self, func, *args, **kwargs):
""" 'with' support for add_stream """
stream = self.add_stream(func, *args, **kwargs)
try:
yield stream
finally:
stream.remove()
@property
def stream_update_condition(self):
""" Condition variable that is notified when
a stream update message has finished being processed. """
return self._stream_manager.update_condition
def wait_for_stream_update(self, timeout=None):
""" Wait until the next stream update message or a timeout occurs.
The condition variable must be locked before calling this method.
When timeout is not None, it should be a floating point number
specifying the timeout in seconds for the operation. """
self._stream_manager.wait_for_update(timeout)
def add_stream_update_callback(self, callback):
""" Add a callback that is invoked whenever
a stream update message has finished being processed. """
self._stream_manager.add_update_callback(callback)
def remove_stream_update_callback(self, callback):
""" Remove a stream update callback. """
self._stream_manager.remove_update_callback(callback)
@staticmethod
def get_call(func, *args, **kwargs):
""" Convert a remote procedure call to a KRPC.ProcedureCall message """
if func == getattr:
# A property or class property getter
attr = func(args[0].__class__, args[1])
return attr.fget._build_call(args[0])
elif func == setattr:
# A property setter
raise StreamError('Cannot create a call for a property setter')
elif hasattr(func, '__self__'):
# A method
return func._build_call(func.__self__, *args, **kwargs)
else:
# A class method
return func._build_call(*args, **kwargs)
@staticmethod
def _get_return_type(func, *args, **kwargs): # pylint: disable=unused-argument
""" Get the return type for a remote procedure call """
if func == getattr:
# A property or class property getter
attr = func(args[0].__class__, args[1])
return attr.fget._return_type
elif func == setattr:
# A property setter
raise StreamError('Cannot get return type for a property setter')
elif hasattr(func, '__self__'):
# A method
return func._return_type
else:
# A class method
return func._return_type
def _invoke(self, service, procedure, args, param_names, param_types,
return_type):
""" Execute an RPC """
# Build the request
call = self._build_call(service, procedure, args, param_names,
param_types, return_type)
request = KRPC.Request()
request.calls.extend([call])
# Send the request
with self._rpc_connection_lock:
self._rpc_connection.send_message(request)
response = self._rpc_connection.receive_message(KRPC.Response)
# Check for an error response
if response.HasField('error'):
raise self._build_error(response.error)
# Check for an error in the procedure results
if response.results[0].HasField('error'):
raise self._build_error(response.results[0].error)
# Decode the response and return the (optional) result
result = None
if return_type is not None:
result = Decoder.decode(response.results[0].value, return_type)
if isinstance(result, KRPC.Event):
result = Event(self, result)
return result
def _build_call(self, service, procedure, args, param_names, param_types,
return_type):
# pylint: disable=unused-argument
""" Build a KRPC.ProcedureCall object """
call = KRPC.ProcedureCall()
call.service = service
call.procedure = procedure
for i, (value, typ) in enumerate(itertools.izip(args, param_types)):
if isinstance(value, DefaultArgument):
continue
if not isinstance(value, typ.python_type):
try:
value = self._types.coerce_to(value, typ)
except ValueError:
raise TypeError(
'%s.%s() argument %d must be a %s, got a %s' %
(service, procedure, i, typ.python_type, type(value)))
call.arguments.add(position=i, value=Encoder.encode(value, typ))
return call
def _build_error(self, error):
""" Build an exception from an error message that
can be thrown to the calling code """
# TODO: modify the stack trace of the thrown exception so it looks like
# it came from the local call
if error.service and error.name:
service_name = snake_case(error.service)
type_name = error.name
if not hasattr(self, service_name):
raise RuntimeError(
'Error building exception; service \'%s\' not found' %
service_name)
service = getattr(self, service_name)
if not hasattr(service, type_name):
raise RuntimeError(
'Error building exception; type \'%s.%s\' not found' %
(service_name, type_name))
return getattr(service, type_name)(self._error_message(error))
return RPCError(self._error_message(error))
@staticmethod
def _error_message(error):
msg = error.description
if error.stack_trace:
msg += '\nServer stack trace:\n' + error.stack_trace
return msg
class Client(object):
"""
A kRPC client, through which all Remote Procedure Calls are made.
Services provided by the server that the client connects
to are automatically added. RPCs can be made using
client.ServiceName.ProcedureName(parameter)
"""
def __init__(self, rpc_connection, stream_connection):
self._types = Types()
self._rpc_connection = rpc_connection
self._rpc_connection_lock = threading.Lock()
self._stream_connection = stream_connection
self._stream_cache = {}
self._stream_cache_lock = threading.Lock()
self._request_type = self._types.as_type('KRPC.Request')
self._response_type = self._types.as_type('KRPC.Response')
# Get the services
services = self._invoke('KRPC', 'GetServices', [], [], [],
self._types.as_type('KRPC.Services')).services
# Set up services
for service in services:
setattr(self, snake_case(service.name),
create_service(self, service))
# Set up stream update thread
if stream_connection is not None:
self._stream_thread_stop = threading.Event()
self._stream_thread = threading.Thread(
target=krpc.stream.update_thread,
args=(stream_connection, self._stream_thread_stop,
self._stream_cache, self._stream_cache_lock))
self._stream_thread.daemon = True
self._stream_thread.start()
else:
self._stream_thread = None
def close(self):
self._rpc_connection.close()
if self._stream_thread is not None:
self._stream_thread_stop.set()
self._stream_thread.join()
def __enter__(self):
return self
def __exit__(self, typ, value, traceback):
self.close()
def add_stream(self, func, *args, **kwargs):
if self._stream_connection is None:
raise RuntimeError('Not connected to stream server')
return krpc.stream.add_stream(self, func, *args, **kwargs)
@contextmanager
def stream(self, func, *args, **kwargs):
""" 'with' support """
stream = self.add_stream(func, *args, **kwargs)
try:
yield stream
finally:
stream.remove()
def _invoke(self, service, procedure, args,
param_names, param_types, return_type):
""" Execute an RPC """
# Build the request
request = self._build_request(
service, procedure, args, param_names, param_types, return_type)
# Send the request
with self._rpc_connection_lock:
self._send_request(request)
response = self._receive_response()
# Check for an error response
if response.has_error:
raise RPCError(response.error)
# Decode the response and return the (optional) result
result = None
if return_type is not None:
result = Decoder.decode(response.return_value, return_type)
return result
# pylint: disable=unused-argument
def _build_request(self, service, procedure, args,
param_names, param_types, return_type):
""" Build a KRPC.Request object """
request = KRPC.Request(service=service, procedure=procedure)
for i, (value, typ) in enumerate(itertools.izip(args, param_types)):
if isinstance(value, DefaultArgument):
continue
if not isinstance(value, typ.python_type):
try:
value = self._types.coerce_to(value, typ)
except ValueError:
raise TypeError(
'%s.%s() argument %d must be a %s, got a %s' %
(service, procedure, i, typ.python_type, type(value)))
request.arguments.add(position=i, value=Encoder.encode(value, typ))
return request
def _send_request(self, request):
""" Send a KRPC.Request object to the server """
data = Encoder.encode_delimited(request, self._request_type)
self._rpc_connection.send(data)
def _receive_response(self):
""" Receive data from the server and
decode it into a KRPC.Response object """
# Read the size and position of the response message
data = b''
while True:
try:
data += self._rpc_connection.partial_receive(1)
size, _ = Decoder.decode_size_and_position(data)
break
except IndexError:
pass
# Read and decode the response message
data = self._rpc_connection.receive(size)
return Decoder.decode(data, self._response_type)
class Client(object):
"""
A kRPC client, through which all Remote Procedure Calls are made.
Services provided by the server that the client connects to are automatically added.
RPCs can be made using client.ServiceName.ProcedureName(parameter)
"""
def __init__(self, rpc_connection, stream_connection):
self._types = Types()
self._rpc_connection = rpc_connection
self._rpc_connection_lock = threading.Lock()
self._stream_connection = stream_connection
self._stream_cache = {}
self._stream_cache_lock = threading.Lock()
self._request_type = self._types.as_type('KRPC.Request')
self._response_type = self._types.as_type('KRPC.Response')
# Get the services
services = self._invoke('KRPC', 'GetServices', [], [], [], self._types.as_type('KRPC.Services')).services
# Set up services
for service in services:
setattr(self, snake_case(service.name), create_service(self, service))
# Set up stream update thread
if stream_connection is not None:
self._stream_thread_stop = threading.Event()
self._stream_thread = threading.Thread(target=krpc.stream.update_thread,
args=(stream_connection, self._stream_thread_stop,
self._stream_cache, self._stream_cache_lock))
self._stream_thread.daemon = True
self._stream_thread.start()
else:
self._stream_thread = None
def close(self):
self._rpc_connection.close()
if self._stream_thread is not None:
self._stream_thread_stop.set()
self._stream_thread.join()
def __enter__(self):
return self
def __exit__(self, typ, value, traceback):
self.close()
def add_stream(self, func, *args, **kwargs):
if self._stream_connection is None:
raise RuntimeError('Not connected to stream server')
return krpc.stream.add_stream(self, func, *args, **kwargs)
@contextmanager
def stream(self, func, *args, **kwargs):
""" 'with' support """
stream = self.add_stream(func, *args, **kwargs)
try:
yield stream
finally:
stream.remove()
def _invoke(self, service, procedure, args, param_names, param_types, return_type):
""" Execute an RPC """
# Build the request
request = self._build_request(service, procedure, args, param_names, param_types, return_type)
# Send the request
with self._rpc_connection_lock:
self._send_request(request)
response = self._receive_response()
# Check for an error response
if response.has_error:
raise RPCError(response.error)
# Decode the response and return the (optional) result
result = None
if return_type is not None:
result = Decoder.decode(response.return_value, return_type)
return result
def _build_request(self, service, procedure, args,
param_names, param_types, return_type): #pylint: disable=unused-argument
""" Build a KRPC.Request object """
request = krpc.schema.KRPC.Request(service=service, procedure=procedure)
for i, (value, typ) in enumerate(itertools.izip(args, param_types)):
if isinstance(value, DefaultArgument):
continue
if not isinstance(value, typ.python_type):
try:
value = self._types.coerce_to(value, typ)
except ValueError:
raise TypeError('%s.%s() argument %d must be a %s, got a %s' % \
(service, procedure, i, typ.python_type, type(value)))
request.arguments.add(position=i, value=Encoder.encode(value, typ))
return request
def _send_request(self, request):
""" Send a KRPC.Request object to the server """
data = Encoder.encode_delimited(request, self._request_type)
self._rpc_connection.send(data)
def _receive_response(self):
""" Receive data from the server and decode it into a KRPC.Response object """
# Read the size and position of the response message
data = b''
while True:
try:
data += self._rpc_connection.partial_receive(1)
size, _ = Decoder.decode_size_and_position(data)
break
except IndexError:
pass
# Read and decode the response message
data = self._rpc_connection.receive(size)
return Decoder.decode(data, self._response_type)
class Client(object):
"""
A kRPC client, through which all Remote Procedure Calls are made.
Services provided by the server that the client connects to are automatically added.
RPCs can be made using client.ServiceName.ProcedureName(parameter)
"""
def __init__(self, rpc_connection, stream_connection):
self._types = Types()
self._rpc_connection = rpc_connection
self._rpc_connection_lock = threading.Lock()
self._stream_connection = stream_connection
self._request_type = self._types.as_type('KRPC.Request')
self._response_type = self._types.as_type('KRPC.Response')
# Get the services
services = self._invoke(
'KRPC',
'GetServices',
return_type=self._types.as_type('KRPC.Services')).services
# Set up services
for service in services:
setattr(self, snake_case(service.name),
create_service(self, service))
# Set up stream update thread
if stream_connection is not None:
self._stream_thread_stop = threading.Event()
self._stream_thread = threading.Thread(
target=krpc.stream.update_thread,
args=(stream_connection, self._stream_thread_stop))
self._stream_thread.daemon = True
self._stream_thread.start()
else:
self._stream_thread = None
def close(self):
self._rpc_connection.close()
if self._stream_thread is not None:
self._stream_thread_stop.set()
self._stream_thread.join()
def __enter__(self):
return self
def __exit__(self, typ, value, traceback):
self.close()
def add_stream(self, func, *args, **kwargs):
if self._stream_connection is None:
raise RuntimeError('Not connected to stream server')
return krpc.stream.add_stream(self, func, *args, **kwargs)
@contextmanager
def stream(self, func, *args, **kwargs):
""" 'with' support """
s = self.add_stream(func, *args, **kwargs)
try:
yield s
finally:
s.remove()
def _invoke(self,
service,
procedure,
args=[],
kwargs={},
param_names=[],
param_types=[],
return_type=None):
""" Execute an RPC """
# Build the request
request = self._build_request(service, procedure, args, kwargs,
param_names, param_types, return_type)
# Send the request
with self._rpc_connection_lock:
self._send_request(request)
response = self._receive_response()
# Check for an error response
if response.has_error:
raise RPCError(response.error)
# Decode the response and return the (optional) result
result = None
if return_type is not None:
result = Decoder.decode(response.return_value, return_type)
return result
def _build_request(self,
service,
procedure,
args=[],
kwargs={},
param_names=[],
param_types=[],
return_type=None):
""" Build a KRPC.Request object """
def encode_argument(i, value):
typ = param_types[i]
if type(value) != typ.python_type:
# Try coercing to the correct type
try:
value = self._types.coerce_to(value, typ)
except ValueError:
raise TypeError('%s.%s() argument %d must be a %s, got a %s' % \
(service, procedure, i, typ.python_type, type(value)))
return Encoder.encode(value, typ)
if len(args) > len(param_types):
raise TypeError('%s.%s() takes exactly %d arguments (%d given)' % \
(service, procedure, len(param_types), len(args)))
arguments = []
nargs = len(args)
for i, param in enumerate(param_names):
add = False
if i < nargs and not isinstance(args[i], DefaultArgument):
arg = args[i]
add = True
elif param in kwargs:
arg = kwargs[param]
add = True
if add:
argument = krpc.schema.KRPC.Argument()
argument.position = i
argument.value = encode_argument(i, arg)
arguments.append(argument)
# Build the request object
request = krpc.schema.KRPC.Request()
request.service = service
request.procedure = procedure
request.arguments.extend(arguments)
return request
def _send_request(self, request):
""" Send a KRPC.Request object to the server """
data = Encoder.encode_delimited(request, self._request_type)
self._rpc_connection.send(data)
def _receive_response(self):
""" Receive data from the server and decode it into a KRPC.Response object """
# Read the size and position of the response message
data = b''
while True:
try:
data += self._rpc_connection.partial_receive(1)
size, position = Decoder.decode_size_and_position(data)
break
except IndexError:
pass
# Read and decode the response message
data = self._rpc_connection.receive(size)
return Decoder.decode(data, self._response_type)
