java_collections.py
17.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
# -*- coding: UTF-8 -*-
"""
Module responsible for converting Java collection classes to Python collection
classes. This module is optional but loaded by default.
Created on Jan 22, 2010
:author: Barthelemy Dagenais
"""
from __future__ import unicode_literals, absolute_import
from collections import (
MutableMapping, Sequence, MutableSequence,
MutableSet, Set)
import sys
from py4j.compat import (
iteritems, next, hasattr2, isbytearray,
ispython3bytestr, basestring)
from py4j.java_gateway import JavaObject, JavaMember, get_method, JavaClass
from py4j import protocol as proto
from py4j.protocol import (
Py4JError, get_command_part, get_return_value, register_input_converter,
register_output_converter)
class JavaIterator(JavaObject):
"""Maps a Python list iterator to a Java list iterator.
The `JavaIterator` follows the Python iterator protocol and raises a
`StopIteration` error when the iterator can no longer iterate."""
def __init__(self, target_id, gateway_client):
JavaObject.__init__(self, target_id, gateway_client)
self._next_name = "next"
# To bind lifecycle of this iterator to the java iterator. To prevent
# gc of the iterator.
def __iter__(self):
return self
def next(self):
"""This next method wraps the `next` method in Java iterators.
The `Iterator.next()` method is called and if an exception occur (e.g.,
NoSuchElementException), a StopIteration exception is raised."""
if self._next_name not in self._methods:
self._methods[self._next_name] = JavaMember(
self._next_name, self,
self._target_id, self._gateway_client)
try:
return self._methods[self._next_name]()
except Py4JError:
raise StopIteration()
__next__ = next
class JavaMap(JavaObject, MutableMapping):
"""Maps a Python Dictionary to a Java Map.
All operations possible on a Python dict are implemented."""
def __init__(self, target_id, gateway_client):
JavaObject.__init__(self, target_id, gateway_client)
self._get = get_method(self, "get")
def __getitem__(self, key):
return self._get(key)
def __setitem__(self, key, value):
self.put(key, value)
def __len__(self):
return self.size()
def __delitem__(self, key):
self.remove(key)
def __iter__(self):
return self.keySet().iterator()
def __contains__(self, key):
return self.containsKey(key)
def __str__(self):
return self.__repr__()
def __repr__(self):
items = (
"{0}: {1}".format(repr(k), repr(v))
for k, v in iteritems(self))
return "{{{0}}}".format(", ".join(items))
class JavaSet(JavaObject, MutableSet):
"""Maps a Python Set to a Java Set.
All operations possible on a Python set are implemented."""
__EMPTY_SET = "set([])" if sys.version_info.major < 3 else "set()"
__SET_TEMPLATE = "set([{0}])" if sys.version_info.major < 3 else "{{{0}}}"
def __init__(self, target_id, gateway_client):
JavaObject.__init__(self, target_id, gateway_client)
self._add = get_method(self, "add")
self._clear = get_method(self, "clear")
self._remove = get_method(self, "remove")
def add(self, value):
self._add(value)
def discard(self, value):
self.remove(value)
def remove(self, value):
if value not in self:
raise KeyError()
else:
self._remove(value)
def clear(self):
self._clear()
def __len__(self):
return self.size()
def __iter__(self):
return self.iterator()
def __contains__(self, value):
return self.contains(value)
def __str__(self):
return self.__repr__()
def __repr__(self):
if len(self):
return self.__SET_TEMPLATE.format(", ".join(
(repr(x) for x in self)))
return self.__EMPTY_SET
class JavaArray(JavaObject, Sequence):
"""Maps a Java Array to a Semi-Mutable Sequence: elements inside the
sequence can be modified, but the length of the sequence cannot change.
The backing collection is a Sequence and not a Python array because
these arrays only accept primitives whereas Java arrays work for any types.
"""
def __init__(self, target_id, gateway_client):
JavaObject.__init__(self, target_id, gateway_client)
def __compute_index(self, key, adjustLast=False):
size = len(self)
if 0 <= key < size:
return key
elif key < 0 and abs(key) <= size:
return size + key
elif adjustLast:
return size
else:
raise IndexError("list index out of range")
def __compute_item(self, key):
new_key = self.__compute_index(key)
command = proto.ARRAY_COMMAND_NAME +\
proto.ARRAY_GET_SUB_COMMAND_NAME +\
self._get_object_id() + "\n"
command += get_command_part(new_key)
command += proto.END_COMMAND_PART
answer = self._gateway_client.send_command(command)
return get_return_value(answer, self._gateway_client)
def __get_slice(self, indices):
command = proto.ARRAY_COMMAND_NAME +\
proto.ARRAY_SLICE_SUB_COMMAND_NAME +\
self._get_object_id() + "\n"
for index in indices:
command += get_command_part(index)
command += proto.END_COMMAND_PART
answer = self._gateway_client.send_command(command)
return get_return_value(answer, self._gateway_client)
def __getitem__(self, key):
if isinstance(key, slice):
indices = key.indices(len(self))
return self.__get_slice(range(*indices))
elif isinstance(key, int):
return self.__compute_item(key)
else:
raise TypeError("array indices must be integers, not {0}".format(
key.__class__.__name__))
def __repl_item_from_slice(self, range, iterable):
value_iter = iter(iterable)
for i in range:
value = next(value_iter)
self.__set_item(i, value)
def __set_item(self, key, value):
new_key = self.__compute_index(key)
command = proto.ARRAY_COMMAND_NAME +\
proto.ARRAY_SET_SUB_COMMAND_NAME +\
self._get_object_id() + "\n"
command += get_command_part(new_key)
command += get_command_part(value)
command += proto.END_COMMAND_PART
answer = self._gateway_client.send_command(command)
return get_return_value(answer, self._gateway_client)
def __setitem__(self, key, value):
if isinstance(key, slice):
self_len = len(self)
indices = key.indices(self_len)
self_range = range(*indices)
lenr = len(self_range)
lenv = len(value)
if lenr != lenv:
raise ValueError(
"attempt to assign sequence of size "
"{0} to extended slice of size {1}".format(lenv, lenr))
else:
return self.__repl_item_from_slice(self_range, value)
elif isinstance(key, int):
return self.__set_item(key, value)
else:
raise TypeError("list indices must be integers, not {0}".format(
key.__class__.__name__))
def __len__(self):
command = proto.ARRAY_COMMAND_NAME +\
proto.ARRAY_LEN_SUB_COMMAND_NAME +\
self._get_object_id() + "\n"
command += proto.END_COMMAND_PART
answer = self._gateway_client.send_command(command)
return get_return_value(answer, self._gateway_client)
class JavaList(JavaObject, MutableSequence):
"""Maps a Python list to a Java list.
All operations possible on a Python list are implemented. For example,
slicing (e.g., list[1:3]) will create a copy of the list on the JVM.
Slicing is thus not equivalent to subList(), because a modification to a
slice such as the addition of a new element will not affect the original
list."""
def __init__(self, target_id, gateway_client):
JavaObject.__init__(self, target_id, gateway_client)
self.java_remove = get_method(self, "remove")
def __len__(self):
return self.size()
def __iter__(self):
return self.iterator()
def __compute_index(self, key, adjustLast=False):
size = self.size()
if 0 <= key < size:
return key
elif key < 0 and abs(key) <= size:
return size + key
elif adjustLast:
return size
else:
raise IndexError("list index out of range")
def __compute_item(self, key):
new_key = self.__compute_index(key)
return self.get(new_key)
def __set_item(self, key, value):
new_key = self.__compute_index(key)
self.set(new_key, value)
def __set_item_from_slice(self, indices, iterable):
offset = 0
last = 0
value_iter = iter(iterable)
# First replace and delete if from_slice > to_slice
for i in range(*indices):
try:
value = next(value_iter)
self.__set_item(i, value)
except StopIteration:
self.__del_item(i)
offset -= 1
last = i + 1
# Then insert if from_slice < to_slice
for elem in value_iter:
self.insert(last, elem)
last += 1
def __insert_item_from_slice(self, indices, iterable):
index = indices[0]
for elem in iterable:
self.insert(index, elem)
index += 1
def __repl_item_from_slice(self, range, iterable):
value_iter = iter(iterable)
for i in range:
value = value = next(value_iter)
self.__set_item(i, value)
def __append_item_from_slice(self, range, iterable):
for value in iterable:
self.append(value)
def __del_item(self, key):
new_key = self.__compute_index(key)
self.java_remove(new_key)
def __setitem__(self, key, value):
if isinstance(key, slice):
self_len = len(self)
indices = key.indices(self_len)
if indices[0] >= self_len:
self.__append_item_from_slice(range, value)
elif indices[0] == indices[1]:
self.__insert_item_from_slice(indices, value)
elif indices[2] == 1:
self.__set_item_from_slice(indices, value)
else:
self_range = range(*indices)
lenr = len(self_range)
lenv = len(value)
if lenr != lenv:
raise ValueError(
"attempt to assign sequence of size "
"{0} to extended slice of size {1}".format(lenv, lenr))
else:
return self.__repl_item_from_slice(self_range, value)
elif isinstance(key, int):
return self.__set_item(key, value)
else:
raise TypeError("list indices must be integers, not {0}".format(
key.__class__.__name__))
def __get_slice(self, indices):
command = proto.LIST_COMMAND_NAME +\
proto.LIST_SLICE_SUBCOMMAND_NAME +\
self._get_object_id() + "\n"
for index in indices:
command += get_command_part(index)
command += proto.END_COMMAND_PART
answer = self._gateway_client.send_command(command)
return get_return_value(answer, self._gateway_client)
def __getitem__(self, key):
if isinstance(key, slice):
indices = key.indices(len(self))
return self.__get_slice(range(*indices))
elif isinstance(key, int):
return self.__compute_item(key)
else:
raise TypeError("list indices must be integers, not {0}".format(
key.__class__.__name__))
def __delitem__(self, key):
if isinstance(key, slice):
indices = key.indices(len(self))
offset = 0
for i in range(*indices):
self.__del_item(i + offset)
offset -= 1
elif isinstance(key, int):
return self.__del_item(key)
else:
raise TypeError("list indices must be integers, not {0}".format(
key.__class__.__name__))
def __contains__(self, item):
return self.contains(item)
def __add__(self, other):
command = proto.LIST_COMMAND_NAME +\
proto.LIST_CONCAT_SUBCOMMAND_NAME +\
self._get_object_id() + "\n" + other._get_object_id() +\
"\n" + proto.END_COMMAND_PART
answer = self._gateway_client.send_command(command)
return get_return_value(answer, self._gateway_client)
def __radd__(self, other):
return self.__add__(other)
def __iadd__(self, other):
self.extend(other)
return self
def __mul__(self, other):
command = proto.LIST_COMMAND_NAME + proto.LIST_MULT_SUBCOMMAND_NAME +\
self._get_object_id() + "\n" + get_command_part(other) +\
proto.END_COMMAND_PART
answer = self._gateway_client.send_command(command)
return get_return_value(answer, self._gateway_client)
def __rmul__(self, other):
return self.__mul__(other)
def __imul__(self, other):
command = proto.LIST_COMMAND_NAME +\
proto.LIST_IMULT_SUBCOMMAND_NAME +\
self._get_object_id() + "\n" + get_command_part(other) +\
proto.END_COMMAND_PART
self._gateway_client.send_command(command)
return self
def append(self, value):
self.add(value)
def insert(self, key, value):
if isinstance(key, int):
new_key = self.__compute_index(key, True)
return self.add(new_key, value)
else:
raise TypeError("list indices must be integers, not {0}".format(
key.__class__.__name__))
def extend(self, other_list):
self.addAll(other_list)
def pop(self, key=None):
if key is None:
new_key = self.size() - 1
else:
new_key = self.__compute_index(key)
return self.java_remove(new_key)
def index(self, value):
return self.indexOf(value)
def count(self, value):
command = proto.LIST_COMMAND_NAME +\
proto.LIST_COUNT_SUBCOMMAND_NAME +\
self._get_object_id() + "\n" + get_command_part(value) +\
proto.END_COMMAND_PART
answer = self._gateway_client.send_command(command)
return get_return_value(answer, self._gateway_client)
def sort(self):
command = proto.LIST_COMMAND_NAME + proto.LIST_SORT_SUBCOMMAND_NAME +\
self._get_object_id() + "\n" + proto.END_COMMAND_PART
self._gateway_client.send_command(command)
def reverse(self):
command = proto.LIST_COMMAND_NAME +\
proto.LIST_REVERSE_SUBCOMMAND_NAME +\
self._get_object_id() + "\n" + proto.END_COMMAND_PART
self._gateway_client.send_command(command)
def remove(self, value):
# Ensures that we are deleting the int value and not the index
# (Java API)
if isinstance(value, int):
new_value = self.indexOf(value)
else:
new_value = value
success = self.java_remove(new_value)
if not success:
raise ValueError("java_list.remove(x): x not in java_list")
def __str__(self):
return self.__repr__()
def __repr__(self):
items = (repr(x) for x in self)
return "[{0}]".format(", ".join(items))
class SetConverter(object):
def can_convert(self, object):
return isinstance(object, Set)
def convert(self, object, gateway_client):
JavaSet = JavaClass("java.util.HashSet", gateway_client)
java_set = JavaSet()
for element in object:
java_set.add(element)
return java_set
class ListConverter(object):
def can_convert(self, object):
# Check for iterator protocol and should not be an instance of byte
# array (taken care of by protocol)
return hasattr2(object, "__iter__") and not isbytearray(object) and\
not ispython3bytestr(object) and not isinstance(object, basestring)
def convert(self, object, gateway_client):
ArrayList = JavaClass("java.util.ArrayList", gateway_client)
java_list = ArrayList()
for element in object:
java_list.add(element)
return java_list
class MapConverter(object):
def can_convert(self, object):
return hasattr2(object, "keys") and hasattr2(object, "__getitem__")
def convert(self, object, gateway_client):
HashMap = JavaClass("java.util.HashMap", gateway_client)
java_map = HashMap()
for key in object.keys():
java_map[key] = object[key]
return java_map
register_input_converter(SetConverter())
register_input_converter(MapConverter())
register_input_converter(ListConverter())
register_output_converter(
proto.MAP_TYPE, lambda target_id, gateway_client:
JavaMap(target_id, gateway_client))
register_output_converter(
proto.LIST_TYPE, lambda target_id, gateway_client:
JavaList(target_id, gateway_client))
register_output_converter(
proto.ARRAY_TYPE, lambda target_id, gateway_client:
JavaArray(target_id, gateway_client))
register_output_converter(
proto.SET_TYPE, lambda target_id, gateway_client:
JavaSet(target_id, gateway_client))
register_output_converter(
proto.ITERATOR_TYPE, lambda target_id, gateway_client:
JavaIterator(target_id, gateway_client))